| blob | deabee526e3ecde8a2eaeed0b9e5bf9882abd714 |
1 '\" te
2 .\" Copyright 1989 AT&T Copyright (c) 1995, Sun Microsystems, Inc. All Rights Reserved Portions Copyright (c) 1992, X/Open Company Limited All Rights Reserved
3 .\" Sun Microsystems, Inc. gratefully acknowledges The Open Group for permission to reproduce portions of its copyrighted documentation. Original documentation from The Open Group can be obtained online at
4 .\" http://www.opengroup.org/bookstore/.
5 .\" The Institute of Electrical and Electronics Engineers and The Open Group, have given us permission to reprint portions of their documentation. In the following statement, the phrase "this text" refers to portions of the system documentation. Portions of this text are reprinted and reproduced in electronic form in the Sun OS Reference Manual, from IEEE Std 1003.1, 2004 Edition, Standard for Information Technology -- Portable Operating System Interface (POSIX), The Open Group Base Specifications Issue 6, Copyright (C) 2001-2004 by the Institute of Electrical and Electronics Engineers, Inc and The Open Group. In the event of any discrepancy between these versions and the original IEEE and The Open Group Standard, the original IEEE and The Open Group Standard is the referee document. The original Standard can be obtained online at http://www.opengroup.org/unix/online.html.
6 .\" This notice shall appear on any product containing this material.
7 .\" The contents of this file are subject to the terms of the Common Development and Distribution License (the "License"). You may not use this file except in compliance with the License.
8 .\" You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing. See the License for the specific language governing permissions and limitations under the License.
9 .\" When distributing Covered Code, include this CDDL HEADER in each file and include the License file at usr/src/OPENSOLARIS.LICENSE. If applicable, add the following below this CDDL HEADER, with the fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner]
10 .TH UUX 1C "Mar 28, 1995"
11 .SH NAME
12 uux \- UNIX-to-UNIX system command execution
13 .SH SYNOPSIS
14 .LP
15 .nf
16 \fBuux\fR [\fB-\fR] [\fB-bcCjnprz\fR] [\fB-a\fR \fIname\fR] [\fB-g\fR \fIgrade\fR]
17 [\fB-s\fR \fIfilename\fR] [\fB-x\fR \fIdebug_level\fR] \fIcommand-string\fR
18 .fi
20 .SH DESCRIPTION
21 .sp
22 .LP
23 The \fBuux\fR utility will gather zero or more files from various systems,
24 execute a command on a specified system and then send standard output to a file
25 on a specified system.
26 .sp
27 .LP
28 \fBNote:\fR For security reasons, most installations limit the list of
29 commands executable on behalf of an incoming request from \fBuux\fR, permitting
30 only the receipt of mail (see \fBmail\fR(1)). (Remote execution permissions are
31 defined in \fB/etc/uucp/Permissions\fR.)
32 .sp
33 .LP
34 The \fIcommand-string\fR is made up of one or more arguments that look like a
35 shell command line, except that the command and file names may be prefixed by
36 \fIsystem-name\fR\fB!\fR. A null \fIsystem-name\fR is interpreted as the local
37 system.
38 .sp
39 .LP
40 File names may be one of the following:
41 .RS +4
42 .TP
43 .ie t \(bu
44 .el o
45 An absolute path name.
46 .RE
47 .RS +4
48 .TP
49 .ie t \(bu
50 .el o
51 A path name preceded by \fB~\fR\fIxxx\fR, where \fIxxx\fR is a login name on
52 the specified system and is replaced by that user's login directory.
53 .RE
54 .sp
55 .LP
56 Anything else is prefixed by the current directory.
57 .sp
58 .LP
59 As an example, the command:
60 .sp
61 .in +2
62 .nf
63 example% \fBuux "!diff sys1!/home/dan/filename1 \e
64 sys2!/a4/dan/filename2 > !~/dan/filename.diff"\fR
65 .fi
66 .in -2
67 .sp
69 .sp
70 .LP
71 will get the \fBfilename1\fR and \fBfilename2\fR files from the \fBsys1\fR and
72 \fBsys2\fR machines, execute a \fBdiff\fR(1) command and put the results in
73 \fBfilename.diff\fR in the local \fIPUBDIR\fR\fB/dan/\fR directory.
74 \fIPUBDIR\fR is a public directory defined in the \fBuucp\fR source. By
75 default, this directory is \fB/var/spool/uucppublic\fR.
76 .sp
77 .LP
78 Any special shell characters (such as \fB< > ; |\fR) should be quoted either by
79 quoting the entire \fIcommand-string\fR, or quoting the special characters as
80 individual arguments. The redirection operators \fB>>\fR, \fB<<\fR, \fB>|\fR,
81 and \fB>&\fR cannot be used.
82 .sp
83 .LP
84 \fBuux\fR will attempt to get all appropriate files to the specified system
85 where they will be processed. For files that are output files, the file name
86 must be escaped using parentheses. For example, the command:
87 .sp
88 .in +2
89 .nf
90 example% \fBuux "a!cut -f1 b!/usr/filename > c!/usr/filename"\fR
91 .fi
92 .in -2
93 .sp
95 .sp
96 .LP
97 gets \fB/usr/filename\fR from system \fBb\fR and sends it to system \fBa\fR,
98 performs a \fBcut\fR command on that file and sends the result of the \fBcut\fR
99 command to system \fBc\fR.
100 .sp
101 .LP
102 \fBuux\fR will notify you if the requested command on the remote system was
103 disallowed. This notification can be turned off by the \fB-n\fR option. The
104 response comes by remote mail from the remote machine.
105 .SH OPTIONS
106 .sp
107 .LP
108 The following options are supported:
109 .sp
110 .ne 2
111 .na
112 \fB\fB\(mi\fR\fR
113 .ad
114 .RS 18n
115 The standard input to \fBuux\fR is made the standard input to the
116 \fIcommand-string\fR.
117 .RE
119 .sp
120 .ne 2
121 .na
122 \fB\fB-a\fR \fIname\fR\fR
123 .ad
124 .RS 18n
125 Uses \fIname\fR as the user job identification replacing the initiator user-id.
126 (Notification will be returned to user-id \fIname\fR.)
127 .RE
129 .sp
130 .ne 2
131 .na
132 \fB\fB-b\fR\fR
133 .ad
134 .RS 18n
135 Returns whatever standard input was provided to the \fBuux\fR command if the
136 exit status is non-zero.
137 .RE
139 .sp
140 .ne 2
141 .na
142 \fB\fB-c\fR\fR
143 .ad
144 .RS 18n
145 Does not copy local file to the spool directory for transfer to the remote
146 machine (default).
147 .RE
149 .sp
150 .ne 2
151 .na
152 \fB\fB-C\fR\fR
153 .ad
154 .RS 18n
155 Forces the copy of local files to the spool directory for transfer.
156 .RE
158 .sp
159 .ne 2
160 .na
161 \fB\fB-g\fR \fIgrade\fR\fR
162 .ad
163 .RS 18n
164 \fIgrade\fR can be either a single letter, number, or a string of alphanumeric
165 characters defining a service grade. The \fBuuglist\fR(1C) command determines
166 whether it is appropriate to use the single letter, number, or a string of
167 alphanumeric characters as a service grade. The output from the \fIuuglist\fR
168 command will be a list of service grades that are available or a message that
169 says to use a single letter or number as a grade of service.
170 .RE
172 .sp
173 .ne 2
174 .na
175 \fB\fB-j\fR\fR
176 .ad
177 .RS 18n
178 Outputs the jobid string on the standard output which is the job
179 identification. This job identification can be used by \fBuustat\fR(1C) to
180 obtain the status or terminate a job.
181 .RE
183 .sp
184 .ne 2
185 .na
186 \fB\fB-n\fR\fR
187 .ad
188 .RS 18n
189 Does not notify the user if the command fails.
190 .RE
192 .sp
193 .ne 2
194 .na
195 \fB\fB-p\fR\fR
196 .ad
197 .RS 18n
198 Same as \fB\(mi\fR\&. The standard input to \fBuux\fR is made the standard
199 input to the \fIcommand-string\fR.
200 .RE
202 .sp
203 .ne 2
204 .na
205 \fB\fB-r\fR\fR
206 .ad
207 .RS 18n
208 Does not start the file transfer, but just queues the job.
209 .RE
211 .sp
212 .ne 2
213 .na
214 \fB\fB-s\fR \fIfilename\fR\fR
215 .ad
216 .RS 18n
217 Reports status of the transfer in \fIfilename\fR. This option is accepted for
218 compatibility, but it is ignored because it is insecure.
219 .RE
221 .sp
222 .ne 2
223 .na
224 \fB\fB-x\fR \fIdebug_level\fR\fR
225 .ad
226 .RS 18n
227 Produces debugging output on the standard output. \fIdebug_level\fR is a number
228 between 0 and 9. As \fIdebug_level\fR increases to 9, more detailed debugging
229 information is given.
230 .RE
232 .sp
233 .ne 2
234 .na
235 \fB\fB-z\fR\fR
236 .ad
237 .RS 18n
238 Sends success notification to the user.
239 .RE
241 .SH ENVIRONMENT VARIABLES
242 .sp
243 .LP
244 See \fBenviron\fR(5) for descriptions of the following environment variables
245 that affect the execution of \fBuux\fR: \fBLANG\fR, \fBLC_ALL\fR,
246 \fBLC_CTYPE\fR, \fBLC_MESSAGES\fR, and \fBNLSPATH\fR.
247 .SH EXIT STATUS
248 .sp
249 .LP
250 The following exit values are returned:
251 .sp
252 .ne 2
253 .na
254 \fB\fB0\fR\fR
255 .ad
256 .RS 6n
257 Successful completion.
258 .RE
260 .sp
261 .ne 2
262 .na
263 \fB\fB>0\fR\fR
264 .ad
265 .RS 6n
266 An error occurred.
267 .RE
269 .SH FILES
270 .sp
271 .ne 2
272 .na
273 \fB\fB/etc/uucp/*\fR\fR
274 .ad
275 .RS 25n
276 other data and programs
277 .RE
279 .sp
280 .ne 2
281 .na
282 \fB\fB/etc/uucp/Permissions\fR\fR
283 .ad
284 .RS 25n
285 remote execution permissions
286 .RE
288 .sp
289 .ne 2
290 .na
291 \fB\fB/usr/lib/uucp/*\fR\fR
292 .ad
293 .RS 25n
294 other programs
295 .RE
297 .sp
298 .ne 2
299 .na
300 \fB\fB/var/spool/uucp\fR\fR
301 .ad
302 .RS 25n
303 spool directories
304 .RE
306 .SH ATTRIBUTES
307 .sp
308 .LP
309 See \fBattributes\fR(5) for descriptions of the following attributes:
310 .sp
312 .sp
313 .TS
314 box;
315 c | c
316 l | l .
317 ATTRIBUTE TYPE ATTRIBUTE VALUE
318 _
319 Interface Stability Standard
320 .TE
322 .SH SEE ALSO
323 .sp
324 .LP
325 \fBcut\fR(1), \fBmail\fR(1), \fBuucp\fR(1C), \fBuuglist\fR(1C),
326 \fBuustat\fR(1C), \fBattributes\fR(5), \fBenviron\fR(5), \fBstandards\fR(5)
327 .SH NOTES
328 .sp
329 .LP
330 The execution of commands on remote systems takes place in an execution
331 directory known to the \fBuucp\fR system.
332 .sp
333 .LP
334 All files required for the execution will be put into this directory unless
335 they already reside on that machine. Therefore, the simple file name (without
336 path or machine reference) must be unique within the \fBuux\fR request. The
337 following command will NOT work:
338 .sp
339 .in +2
340 .nf
341 example% \fBuux "a!diff b!/home/dan/xyz c!/home/dan/xyz > !xyz.diff"\fR
342 .fi
343 .in -2
344 .sp
346 .sp
347 .LP
348 But the command:
349 .sp
350 .in +2
351 .nf
352 example% \fBuux "a!diff a!/home/dan/xyz c!/home/dan/xyz > !xyz.diff"\fR
353 .fi
354 .in -2
355 .sp
357 .sp
358 .LP
359 \fIwill\fR work (if \fBdiff\fR is a permitted command.)
360 .sp
361 .LP
362 Protected files and files that are in protected directories that are owned by
363 the requester can be sent in commands using \fBuux\fR. However, if the
364 requester is root, and the directory is not searchable by "other", the request
365 will fail.
366 .sp
367 .LP
368 The following restrictions apply to the shell pipeline processed by \fBuux\fR:
369 .RS +4
370 .TP
371 .ie t \(bu
372 .el o
373 In gathering files from different systems, pathname expansion in not performed
374 by \fBuux\fR. Thus, a request such as
375 .sp
376 .in +2
377 .nf
378 \fBuux "c89 remsys!~/*.c"\fR
379 .fi
380 .in -2
381 .sp
383 would attempt to copy the file named literally \fB*.c\fR to the local system.
384 .RE
385 .RS +4
386 .TP
387 .ie t \(bu
388 .el o
389 Only the first command of a shell pipeline may have a \fIsystem-name\fR\fB!\fR.
390 All other commands are executed on the system of the first command.
391 .RE
392 .RS +4
393 .TP
394 .ie t \(bu
395 .el o
396 The use of the shell metacharacter \fB*\fR will probably not do what you want
397 it to do.
398 .RE
399 .RS +4
400 .TP
401 .ie t \(bu
402 .el o
403 The shell tokens \fB<<\fR and \fB>>\fR are not implemented.
404 .RE
405 .RS +4
406 .TP
407 .ie t \(bu
408 .el o
409 The redirection operators \fB>>\fR, \fB<<\fR, \fB>|\fR, and \fB>&\fR cannot be
410 used.
411 .RE
412 .RS +4
413 .TP
414 .ie t \(bu
415 .el o
416 The reserved word \fB!\fR cannot be used at the head of the pipeline to modify
417 the exit status.
418 .RE
419 .RS +4
420 .TP
421 .ie t \(bu
422 .el o
423 Alias substitution is not performed.
424 .RE