Debian Codegraph @

upstream/debian-unstable/man1/uux.1

raw
1 .\" ''' $Id: uux.1,v 1.15 2002/03/05 22:20:48 ian Rel $
2 .TH uux 1 "Taylor UUCP 1.07"
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 /usr/spool/uucppublic or
44 /var/spool/uucppublic) on the appropriate system. A pathname may
45 begin with ~name/, in which case it is relative to the home directory
46 of the named user on the 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
77 The exit status of
78 .I uux
79 is one of the codes found in the header file
80 .B sysexits.h.
81 In particular,
82 .B EX_OK
83 (
84 .B 0
85 ) indicates success, and
86 .B EX_TEMPFAIL
87 (
88 .B 75
89 ) indicates a temporary failure.
90 .SH OPTIONS
91 The following options may be given to
92 .I uux.
93 .TP 5
94 .B \-, \-p, \-\-stdin
95 Read standard input and use it as the standard input for the command
96 to be executed.
97 .TP 5
98 .B \-c, \-\-nocopy
99 Do not copy local files to the spool directory. This is the default.
100 If they are
101 removed before being processed by the
102 .I uucico
103 (8) daemon, the copy will fail. The files must be readable by the
104 .I uucico
105 (8) daemon,
106 as well as the by the invoker of
107 .I uux.
108 .TP 5
109 .B \-C, \-\-copy
110 Copy local files to the spool directory.
111 .TP 5
112 .B \-l, \-\-link
113 Link local files into the spool directory. If a file can not be
114 linked because it is on a different device, it will be copied unless
115 one of the
116 .B \-c
117 or
118 .B \-\-nocopy
119 options also appears (in other words, use of
120 .B \-\-link
121 switches the default from
122 .B \-\-nocopy
123 to
124 .B \-\-copy).
125 If the files are changed before being processed by the
126 .I uucico
127 (8) daemon, the changed versions will be used. The files must be
128 readable by the
129 .I uucico
130 (8) daemon, as well as by the invoker of
131 .I uux.
132 .TP 5
133 .B \-g grade, \-\-grade grade
134 Set the grade of the file transfer command. Jobs of a higher grade
135 are executed first. Grades run 0 ... 9 A ... Z a ... z from high to
136 low.
137 .TP 5
138 .B \-n, \-\-notification=no
139 Do not send mail about the status of the job, even if it fails.
140 .TP 5
141 .B \-z, \-\-notification=error
142 Send mail about the status of the job if an error occurs. For many
143 .I uuxqt
144 daemons, including the Taylor UUCP
145 .I uuxqt,
146 this is the default action; for those,
147 .B \-\-notification=error
148 will have no effect. However, some
149 .I uuxqt
150 daemons will send mail if the job succeeds unless the
151 .B \-\-notification=error
152 option is used, and some other
153 .I uuxqt
154 daemons will not send mail if the job fails unless the
155 .B \-\-notification=error
156 option is used.
157 .TP 5
158 .B \-r, \-\-nouucico
159 Do not start the
160 .I uucico
161 (8) daemon immediately; merely queue up the execution request for later
162 processing.
163 .TP 5
164 .B \-j, \-\-jobid
165 Print jobids on standard output. A jobid will be generated for each
166 file copy operation required to perform the operation. These file
167 copies may be cancelled by passing the jobid to the
168 .B \-\-kill
169 switch of
170 .I uustat
171 (1), which will make the execution impossible to complete.
172 .TP 5
173 .B \-a address, \-\-requestor address
174 Report job status to the specified e-mail address.
175 .TP 5
176 .B \-x type, \-\-debug type
177 Turn on particular debugging types. The following types are
178 recognized: abnormal, chat, handshake, uucp-proto, proto, port,
179 config, spooldir, execute, incoming, outgoing. Only abnormal, config,
180 spooldir and execute are meaningful for
181 .I uux.
182
183 Multiple types may be given, separated by commas, and the
184 .B \-\-debug
185 option may appear multiple times. A number may also be given, which
186 will turn on that many types from the foregoing list; for example,
187 .B \-\-debug 2
188 is equivalent to
189 .B \-\-debug abnormal,chat.
190 .TP 5
191 .B \-I file, \-\-config file
192 Set configuration file to use. This option may not be available,
193 depending upon how
194 .I uux
195 was compiled.
196 .TP 5
197 .B \-v, \-\-version
198 Report version information and exit.
199 .TP 5
200 .B \-\-help
201 Print a help message and exit.
202 .SH EXAMPLES
203 .br
204 .nf
205 uux \-z \- sys1!rmail user1
206 .fi
207 Execute the command ``rmail user1'' on the system sys1, giving it as
208 standard input whatever is given to
209 .I uux
210 as standard input. If a failure occurs, send a message using
211 .I mail
212 (1).
213
214 .br
215 .nf
216 uux 'diff \-c sys1!~user1/file1 sys2!~user2/file2 >!file.diff'
217 .fi
218 Fetch the two named files from system sys1 and system sys2 and execute
219 .I diff
220 putting the result in file.diff in the current directory. The current
221 directory must be writable by the
222 .I uuxqt
223 (8) daemon for this to work.
224
225 .br
226 .nf
227 uux 'sys1!uucp ~user1/file1 (sys2!~user2/file2)'
228 .fi
229 Execute
230 .I uucp
231 on the system sys1 copying file1 (on system sys1) to sys2. This
232 illustrates the use of parentheses for quoting.
233 .SH RESTRICTIONS
234 The remote system may not permit you to execute certain commands.
235 Many remote systems only permit the execution of
236 .I rmail
237 and
238 .I rnews.
239
240 Some of the options are dependent on the capabilities of the
241 .I uuxqt
242 (8) daemon on the remote system.
243 .SH SEE ALSO
244 mail(1), uustat(1), uucp(1), uucico(8), uuxqt(8)
245 .SH BUGS
246 Files can not be referenced across multiple systems.
247
248 Too many jobids are output by
249 .B \-\-jobid,
250 and there is no good way to cancel a local execution requiring remote
251 files.
252 .SH AUTHOR
253 Ian Lance Taylor
254 ([email protected])