gnu/libexec/uucp/uux/uux.1

   1 ''' $FreeBSD$
   2 .TH uux 1 "Taylor UUCP 1.06"
   3 .SH NAME
   4 uux \- Remote command execution over UUCP
   5 .SH SYNOPSIS
   6 .B uux
   7 [ options ] command
   8 .SH DESCRIPTION
   9 The
  10 .I uux
  11 command is used to execute a command on a remote system, or to execute
  12 a command on the local system using files from remote systems.
  13 The command
  14 is not executed immediately; the request is queued until the
  15 .I uucico
  16 (8) daemon calls the system and executes it.  The daemon is
  17 started automatically unless one of the
  18 .B \-r
  19 or
  20 .B \-\-nouucico
  21 options is given.
  22
  23 The actual command execution is done by the
  24 .I uuxqt
  25 (8) daemon.
  26
  27 File arguments can be gathered from remote systems to the execution
  28 system, as can standard input.  Standard output may be directed to a
  29 file on a remote system.
  30
  31 The command name may be preceded by a system name followed by an
  32 exclamation point if it is to be executed on a remote system.  An
  33 empty system name is taken as the local system.
  34
  35 Each argument that contains an exclamation point is treated as naming
  36 a file.  The system which the file is on is before the exclamation
  37 point, and the pathname on that system follows it.  An empty system
  38 name is taken as the local system; this must be used to transfer a
  39 file to a command being executed on a remote system.  If the path is
  40 not absolute, it will be appended to the current working directory on
  41 the local system; the result may not be meaningful on the remote
  42 system.  A pathname may begin with ~/, in which case it is relative to
  43 the UUCP public directory (usually /var/spool/uucppublic) on the
  44 appropriate system.  A pathname may begin with ~name/, in which case
  45 it is relative to the home directory of the named user on the
  46 appropriate system.
  47
  48 Standard input and output may be redirected as usual; the pathnames
  49 used may contain exclamation points to indicate that they are on
  50 remote systems.  Note that the redirection characters must be quoted
  51 so that they are passed to
  52 .I uux
  53 rather than interpreted by the shell.  Append redirection (>>) does
  54 not work.
  55
  56 All specified files are gathered together into a single directory
  57 before execution of the command begins.  This means that each file
  58 must have a distinct base name.  For example,
  59 .br
  60 .in +0.5i
  61 .nf
  62 uux 'sys1!diff sys2!~user1/foo sys3!~user2/foo >!foo.diff'
  63 .fi
  64 .in -0.5i
  65 will fail because both files will be copied to sys1 and stored under
  66 the name foo.
  67
  68 Arguments may be quoted by parentheses to avoid interpretation of
  69 exclamation points.  This is useful when executing the
  70 .I uucp
  71 command on a remote system.
  72
  73 A request to execute an empty command (e.g.,
  74 .I uux sys!)
  75 will create a poll file for the specified system.
  76 .SH OPTIONS
  77 The following options may be given to
  78 .I uux.
  79 .TP 5
  80 .B \-, \-p, \-\-stdin
  81 Read standard input and use it as the standard input for the command
  82 to be executed.
  83 .TP 5
  84 .B \-c, \-\-nocopy
  85 Do not copy local files to the spool directory.  This is the default.
  86 If they are
  87 removed before being processed by the
  88 .I uucico
  89 (8) daemon, the copy will fail.  The files must be readable by the
  90 .I uucico
  91 (8) daemon,
  92 as well as the by the invoker of
  93 .I uux.
  94 .TP 5
  95 .B \-C, \-\-copy
  96 Copy local files to the spool directory.
  97 .TP 5
  98 .B \-l, \-\-link
  99 Link local files into the spool directory.  If a file can not be
 100 linked because it is on a different device, it will be copied unless
 101 one of the
 102 .B \-c
 103 or
 104 .B \-\-nocopy
 105 options also appears (in other words, use of
 106 .B \-\-link
 107 switches the default from
 108 .B \-\-nocopy
 109 to
 110 .B \-\-copy).
 111 If the files are changed before being processed by the
 112 .I uucico
 113 (8) daemon, the changed versions will be used.  The files must be
 114 readable by the
 115 .I uucico
 116 (8) daemon, as well as by the invoker of
 117 .I uux.
 118 .TP 5
 119 .B \-g grade, \-\-grade grade
 120 Set the grade of the file transfer command.  Jobs of a higher grade
 121 are executed first.  Grades run 0 ... 9 A ... Z a ... z from high to
 122 low.
 123 .TP 5
 124 .B \-n, \-\-notification=no
 125 Do not send mail about the status of the job, even if it fails.
 126 .TP 5
 127 .B \-z, \-\-notification=error
 128 Send mail about the status of the job if an error occurs.  For many
 129 .I uuxqt
 130 daemons, including the Taylor UUCP
 131 .I uuxqt,
 132 this is the default action; for those,
 133 .B \-\-notification=error
 134 will have no effect.  However, some
 135 .I uuxqt
 136 daemons will send mail if the job succeeds unless the
 137 .B \-\-notification=error
 138 option is used, and some other
 139 .I uuxqt
 140 daemons will not send mail if the job fails unless the
 141 .B \-\-notification=error
 142 option is used.
 143 .TP 5
 144 .B \-r, \-\-nouucico
 145 Do not start the
 146 .I uucico
 147 (8) daemon immediately; merely queue up the execution request for later
 148 processing.
 149 .TP 5
 150 .B \-j, \-\-jobid
 151 Print jobids on standard output.  A jobid will be generated for each
 152 file copy operation required to perform the operation.  These file
 153 copies may be cancelled by passing the jobid to the
 154 .B \-\-kill
 155 switch of
 156 .I uustat
 157 (1), which will make the execution impossible to complete.
 158 .TP 5
 159 .B \-a address, \-\-requestor address
 160 Report job status to the specified e-mail address.
 161 .TP 5
 162 .B \-x type, \-\-debug type
 163 Turn on particular debugging types.  The following types are
 164 recognized: abnormal, chat, handshake, uucp-proto, proto, port,
 165 config, spooldir, execute, incoming, outgoing.  Only abnormal, config,
 166 spooldir and execute are meaningful for
 167 .I uux.
 168
 169 Multiple types may be given, separated by commas, and the
 170 .B \-\-debug
 171 option may appear multiple times.  A number may also be given, which
 172 will turn on that many types from the foregoing list; for example,
 173 .B \-\-debug 2
 174 is equivalent to
 175 .B \-\-debug abnormal,chat.
 176 .TP 5
 177 .B \-I file, \-\-config file
 178 Set configuration file to use.  This option may not be available,
 179 depending upon how
 180 .I uux
 181 was compiled.
 182 .TP 5
 183 .B \-v, \-\-version
 184 Report version information and exit.
 185 .TP 5
 186 .B \-\-help
 187 Print a help message and exit.
 188 .SH EXAMPLES
 189 .br
 190 .nf
 191 uux -z - sys1!rmail user1
 192 .fi
 193 Execute the command ``rmail user1'' on the system sys1, giving it as
 194 standard input whatever is given to
 195 .I uux
 196 as standard input.  If a failure occurs, send a message using
 197 .I mail
 198 (1).
 199
 200 .br
 201 .nf
 202 uux 'diff -c sys1!~user1/file1 sys2!~user2/file2 >!file.diff'
 203 .fi
 204 Fetch the two named files from system sys1 and system sys2 and execute
 205 .I diff
 206 putting the result in file.diff in the current directory.  The current
 207 directory must be writable by the
 208 .I uuxqt
 209 (8) daemon for this to work.
 210
 211 .br
 212 .nf
 213 uux 'sys1!uucp ~user1/file1 (sys2!~user2/file2)'
 214 .fi
 215 Execute
 216 .I uucp
 217 on the system sys1 copying file1 (on system sys1) to sys2.  This
 218 illustrates the use of parentheses for quoting.
 219 .SH RESTRICTIONS
 220 The remote system may not permit you to execute certain commands.
 221 Many remote systems only permit the execution of
 222 .I rmail
 223 and
 224 .I rnews.
 225
 226 Some of the options are dependent on the capabilities of the
 227 .I uuxqt
 228 (8) daemon on the remote system.
 229 .SH FILES
 230 The file names may be changed at compilation time or by the
 231 configuration file, so these are only approximations.
 232
 233 .br
 234 /etc/uucp/config - Configuration file.
 235 .br
 236 /var/spool/uucp -
 237 UUCP spool directory.
 238 .br
 239 /var/spool/uucp/Log -
 240 UUCP log file.
 241 .br
 242 /var/spool/uucppublic -
 243 Default UUCP public directory.
 244 .SH SEE ALSO
 245 mail(1), uustat(1), uucp(1), uucico(8), uuxqt(8)
 246 .SH BUGS
 247 Files can not be referenced across multiple systems.
 248
 249 Too many jobids are output by
 250 .B \-\-jobid,
 251 and there is no good way to cancel a local execution requiring remote
 252 files.
 253 .SH AUTHOR
 254 Ian Lance Taylor
 255 (ian@airs.com)