9103 opengroup acknowledgement should be properly formatted in man pages
[unleashed.git] / usr / src / man / man1c / uucp.1c
blob53bbd17cf63a5fbd0ba915f60f07b5e534428725
1 .\"
2 .\" Sun Microsystems, Inc. gratefully acknowledges The Open Group for
3 .\" permission to reproduce portions of its copyrighted documentation.
4 .\" Original documentation from The Open Group can be obtained online at
5 .\" http://www.opengroup.org/bookstore/.
6 .\"
7 .\" The Institute of Electrical and Electronics Engineers and The Open
8 .\" Group, have given us permission to reprint portions of their
9 .\" documentation.
10 .\"
11 .\" In the following statement, the phrase ``this text'' refers to portions
12 .\" of the system documentation.
13 .\"
14 .\" Portions of this text are reprinted and reproduced in electronic form
15 .\" in the SunOS Reference Manual, from IEEE Std 1003.1, 2004 Edition,
16 .\" Standard for Information Technology -- Portable Operating System
17 .\" Interface (POSIX), The Open Group Base Specifications Issue 6,
18 .\" Copyright (C) 2001-2004 by the Institute of Electrical and Electronics
19 .\" Engineers, Inc and The Open Group.  In the event of any discrepancy
20 .\" between these versions and the original IEEE and The Open Group
21 .\" Standard, the original IEEE and The Open Group Standard is the referee
22 .\" document.  The original Standard can be obtained online at
23 .\" http://www.opengroup.org/unix/online.html.
24 .\"
25 .\" This notice shall appear on any product containing this material.
26 .\"
27 .\" The contents of this file are subject to the terms of the
28 .\" Common Development and Distribution License (the "License").
29 .\" You may not use this file except in compliance with the License.
30 .\"
31 .\" You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE
32 .\" or http://www.opensolaris.org/os/licensing.
33 .\" See the License for the specific language governing permissions
34 .\" and limitations under the License.
35 .\"
36 .\" When distributing Covered Code, include this CDDL HEADER in each
37 .\" file and include the License file at usr/src/OPENSOLARIS.LICENSE.
38 .\" If applicable, add the following below this CDDL HEADER, with the
39 .\" fields enclosed by brackets "[]" replaced with your own identifying
40 .\" information: Portions Copyright [yyyy] [name of copyright owner]
41 .\"
42 .\"
43 .\" Copyright 1989 AT&T
44 .\" Portions Copyright (c) 1992, X/Open Company Limited.  All Rights Reserved.
45 .\" Copyright (c) 2005, Sun Microsystems, Inc. All Rights Reserved.
46 .\"
47 .TH UUCP 1C "Mar 9, 2005"
48 .SH NAME
49 uucp, uulog, uuname \- UNIX-to-UNIX system copy
50 .SH SYNOPSIS
51 .LP
52 .nf
53 \fBuucp\fR [\fB-c\fR | \fB-C\fR] [\fB-d\fR | \fB-f\fR] [\fB-g\fR\fIgrade\fR] [\fB-jmr\fR] [\fB-n\fR\fIuser\fR] [\fB-s\fR\fIfile\fR]
54      [\fB-x\fR\fIdebug_level\fR] \fIsource-file\fR \fIdestination-file\fR
55 .fi
57 .LP
58 .nf
59 \fBuulog\fR [\fB-s\fR\fIsys\fR] [\fB-f\fR\fIsystem\fR] [\fB-x\fR] [\fB-number\fR] \fIsystem\fR
60 .fi
62 .LP
63 .nf
64 \fBuuname\fR [\fB-c\fR | \fB-l\fR]
65 .fi
67 .SH DESCRIPTION
68 .SS "uucp"
69 .sp
70 .LP
71 The \fBuucp\fR utility copies files named by the \fIsource-file\fR arguments to
72 the \fIdestination-file\fR argument.
73 .SS "uulog"
74 .sp
75 .LP
76 The \fBuulog\fR utility queries a log file of \fBuucp\fR or \fBuuxqt\fR
77 transactions in file \fB/var/uucp/.Log/uucico/\fIsystem\fR\fR or
78 \fB/var/uucp/.Log/uuxqt/\fIsystem\fR\fR.
79 .SS "uuname"
80 .sp
81 .LP
82 The \fBuuname\fR utility lists the names of systems known to \fBuucp\fR.
83 .SH OPTIONS
84 .SS "uucp"
85 .sp
86 .LP
87 The following options are supported by \fBuucp\fR:
88 .sp
89 .ne 2
90 .na
91 \fB\fB-c\fR\fR
92 .ad
93 .RS 18n
94 Does not copy local file to the spool directory for transfer to the remote
95 machine (default).
96 .RE
98 .sp
99 .ne 2
101 \fB\fB-C\fR\fR
103 .RS 18n
104 Forces the copy of local files to the spool directory for transfer.
108 .ne 2
110 \fB\fB-d\fR\fR
112 .RS 18n
113 Makes all necessary directories for the file copy (default).
117 .ne 2
119 \fB\fB-f\fR\fR
121 .RS 18n
122 Does not make intermediate directories for the file copy.
126 .ne 2
128 \fB\fB-g\fR \fIgrade\fR\fR
130 .RS 18n
131 \fIgrade\fR can be either a single letter, number, or a string of alphanumeric
132 characters defining a service grade. The \fBuuglist\fR command can determine
133 whether it is appropriate to use the single letter, number, or a string of
134 alphanumeric characters as a service grade. The output from the \fBuuglist\fR
135 command is a list of service grades that are available, or a message that says
136 to use a single letter or number as a grade of service.
140 .ne 2
142 \fB\fB-j\fR\fR
144 .RS 18n
145 Prints the \fBuucp\fR job identification string on standard output. This job
146 identification can be used by \fBuustat\fR to obtain the status of a \fBuucp\fR
147 job or to terminate a \fBuucp\fR job. The \fBuucp\fR job is valid as long as
148 the job remains queued on the local system.
152 .ne 2
154 \fB\fB-m\fR\fR
156 .RS 18n
157 Sends mail to the requester when the copy is complete.
161 .ne 2
163 \fB\fB-n\fR \fIuser\fR\fR
165 .RS 18n
166 Notifies \fIuser\fR on the remote system that a file was sent.
168 When multiple \fB-n\fR options are passed in, \fBuucp\fR only retains the value
169 specified for the last \fB-n\fR option. This is the only user notified.
173 .ne 2
175 \fB\fB-r\fR\fR
177 .RS 18n
178 Does not start the file transfer, just queue the job.
182 .ne 2
184 \fB\fB-s\fR \fIfile\fR\fR
186 .RS 18n
187 Reports status of the transfer to \fIfile\fR. This option is accepted for
188 compatibility, but it is ignored because it is insecure.
192 .ne 2
194 \fB\fB-x\fR \fIdebug_level\fR\fR
196 .RS 18n
197 Produce debugging output on standard output. \fIdebug_level\fR is a number
198 between 0 and 9. As \fIdebug_level\fR increases to 9, more detailed debugging
199 information is given. This option may not be available on all systems.
202 .SS "uulog"
205 The following options cause \fBuulog\fR to print logging information:
207 .ne 2
209 \fB\fB-s\fR \fIsys\fR\fR
211 .RS 13n
212 Prints information about file transfer work involving system \fIsys\fR.
216 .ne 2
218 \fB\fB-f\fR \fIsystem\fR\fR
220 .RS 13n
221 Executes a \fBtail\fR \fB-f\fR command of the file transfer log for
222 \fIsystem\fR. You must press BREAK to exit this function.
227 Other options used in conjunction with the above options are:
229 .ne 2
231 \fB\fB-x\fR\fR
233 .RS 11n
234 Looks in the \fBuuxqt\fR log file for the given system.
238 .ne 2
240 \fB\fB-\fR\fInumber\fR\fR
242 .RS 11n
243 Executes a \fBtail\fR command of \fInumber\fR lines.
246 .SS "uuname"
249 The following options are supported by \fBuuname\fR:
251 .ne 2
253 \fB\fB-c\fR\fR
255 .RS 6n
256 Displays the names of systems known to \fBcu\fR. The two lists are the same,
257 unless your machine is using different \fBSystems\fR files for \fBcu\fR and
258 \fBuucp\fR. See the \fBSysfiles\fR file.
262 .ne 2
264 \fB\fB-l\fR\fR
266 .RS 6n
267 Displays the local system name.
270 .SH OPERANDS
273 The source file name may be a path name on your machine, or may have the form:
275 .in +2
277 \fIsystem-name\fR!\fIpathname\fR
279 .in -2
284 where \fIsystem-name\fR is taken from a list of system names that \fBuucp\fR
285 knows about. \fIsource_file\fR is restricted to no more than one
286 \fIsystem-name\fR. The destination \fIsystem-name\fR may also include a list of
287 system names such as
289 .in +2
291 \fIsystem-name\fR!\fIsystem-name\fR!...!\fIsystem-name\fR!\fIpathname\fR
293 .in -2
298 In this case, an attempt is made to send the file, using the specified route,
299 to the destination. Care should be taken to ensure that intermediate nodes in
300 the route are willing to forward information. See \fBNOTES\fR for restrictions.
303 For C-Shell users, the exclamation point (\fB!\fR) character must be surrounded
304 by single quotes (\fB\&'\fR), or preceded by a backslash (\fB\e\fR).
307 The shell metacharacters \fB?\fR, \fB*\fR and \fB[...]\fR appearing in
308 \fIpathname\fR are expanded on the appropriate system.
311 Pathnames may be one of the following:
312 .RS +4
315 An absolute pathname.
317 .RS +4
320 A pathname preceded by \fB~\fR\fIuser\fR where \fIuser\fR is a login name on
321 the specified system and is replaced by that user's login directory.
323 .RS +4
326 A pathname preceded by \fB~\fR/\fIdestination\fR where \fIdestination\fR is
327 appended to \fB/var/spool/uucppublic\fR. This destination is treated as a
328 filename unless more than one file is being transferred by this request or the
329 destination is already a directory. To ensure that the destination is a
330 directory, follow it with a forward slash (\fB/\fR). For example, \fB~/dan/\fR
331 as the destination creates the directory \fB/var/spool/uucppublic/dan\fR if it
332 does not exist and put the requested file(s) in that directory.
336 Anything else is prefixed by the current directory.
339 If the result is an erroneous path name for the remote system, the copy fails.
340 If the \fIdestination-file\fR is a directory, the last part of the
341 \fIsource-file\fR name is used.
344 Invoking \fBuucp\fR with shell wildcard characters as the remote
345 \fIsource-file\fR invokes the \fBuux\fR(1C) command to execute the \fBuucp\fR
346 command on the remote machine. The remote \fBuucp\fR command spools the files
347 on the remote machine. After the first session terminates, if the remote
348 machine is configured to transfer the spooled files to the local machine, the
349 remote machine initiates a call and send the files; otherwise, the user must
350 "call" the remote machine to transfer the files from the spool directory to the
351 local machine. This call can be done manually using \fBUutry\fR(1M), or as a
352 side effect of another \fBuux\fR(1C) or \fBuucp\fR call.
355 Notice that the local machine must have permission to execute the uucp command
356 on the remote machine in order for the remote machine to send the spooled
357 files.
360 \fBuucp\fR removes execute permissions across the transmission and gives
361 \fB0666\fR read and write permissions (see \fBchmod\fR(2)).
362 .SH ENVIRONMENT VARIABLES
365 See \fBenviron\fR(5) for descriptions of the following environment variables
366 that affect the execution of \fBuucp\fR: \fBLANG\fR, \fBLC_ALL\fR,
367 \fBLC_COLLATE\fR, \fBLC_CTYPE\fR, \fBLC_MESSAGES\fR, \fBLC_TIME\fR,
368 \fBNLSPATH\fR, and \fBTZ\fR.
369 .SH EXIT STATUS
372 The following exit values are returned:
374 .ne 2
376 \fB\fB0\fR\fR
378 .RS 6n
379 Successful completion.
383 .ne 2
385 \fB\fB>0\fR\fR
387 .RS 6n
388 An error occurred.
391 .SH FILES
393 .ne 2
395 \fB\fB/etc/uucp/*\fR\fR
397 .RS 27n
398 other data files
402 .ne 2
404 \fB\fB/var/spool/uucp\fR\fR
406 .RS 27n
407 spool directories
411 .ne 2
413 \fB\fB/usr/lib/uucp/*\fR\fR
415 .RS 27n
416 other program files
420 .ne 2
422 \fB\fB/var/spool/uucppublic/*\fR\fR
424 .RS 27n
425 public directory for receiving and sending
428 .SH ATTRIBUTES
431 See \fBattributes\fR(5) for descriptions of the following attributes:
436 box;
437 c | c
438 l | l .
439 ATTRIBUTE TYPE  ATTRIBUTE VALUE
441 Interface Stability     Standard
444 .SH SEE ALSO
447 \fBmail\fR(1), \fBuuglist\fR(1C), \fBuustat\fR(1C), \fBuux\fR(1C),
448 \fBUutry\fR(1M), \fBuuxqt\fR(1M), \fBchmod\fR(2), \fBattributes\fR(5),
449 \fBenviron\fR(5), \fBstandards\fR(5)
450 .SH NOTES
453 For security reasons, the domain of remotely accessible files may be severely
454 restricted. You probably are not able to access files by path name. Ask a
455 responsible person on the remote system to send them to you. For the same
456 reasons you are probably not able to send files to arbitrary path names. As
457 distributed, the remotely accessible files are those whose names begin
458 \fB/var/spool/uucppublic\fR (equivalent to \fB~/\fR).
461 All files received by \fBuucp\fR are owned by \fBuucp\fR.
464 The \fB-m\fR option only works when sending files or receiving a single file.
465 Receiving multiple files specified by special shell characters \fB?\fR,
466 \fB&\fR, and \fB[\|.\|.\|.\|]\fR does not activate the \fB-m\fR option.
469 The forwarding of files through other systems may not be compatible with the
470 previous version of \fBuucp\fR. If forwarding is used, all systems in the route
471 must have compatible versions of \fBuucp\fR.
474 Protected files and files that are in protected directories that are owned by
475 the requester can be sent by \fBuucp\fR. However, if the requester is root, and
476 the directory is not searchable by "other" or the file is not readable by
477 "other", the request fails.
480 Strings that are passed to remote systems may not be evaluated in the same
481 locale as the one in use by the process that invoked \fBuucp\fR on the local
482 system.
485 Configuration files must be treated as C (or POSIX) locale text files.