Debian Codegraph @

upstream/opensuse-tumbleweed/man1/uux.1

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