xref: /original-bsd/usr.bin/uucp/uucico/uucico.8 (revision e79a6a26)
1.\" Copyright (c) 1988, 1991, 1993
2.\"	The Regents of the University of California.  All rights reserved.
3.\"
4.\" %sccs.include.redist.man%
5.\"
6.\"     @(#)uucico.8	8.1 (Berkeley) 06/06/93
7.\"
8.Dd
9.Dt UUCICO 8
10.Os BSD 4.3
11.Sh NAME
12.Nm uucico ,
13.Nm uucpd
14.Nd transfer files queued by uucp or uux
15.Sh SYNOPSIS
16.Nm uucico
17.Op Fl L
18.Op Fl R
19.Op Fl d Ns Ar spooldir
20.Op Fl g Ns Ar grade
21.Op Fl r Ns Ar role
22.Op Fl s Ns Ar system
23.Op Fl x Ns Ar debug
24.Op Fl t Ns Ar turnaround
25.Nm uucpd
26.Sh DESCRIPTION
27.Nm Uucico
28performs the actual work involved in transferring files between
29systems.
30.Xr Uucp 1
31and
32.Xr uux 1
33merely queue requests for data transfer which
34.Nm uucico
35processes.
36.Pp
37The following options are available.
38.Bl -tag -width Ds
39.It Fl L
40Only call
41.Dq local
42sites. A site is considered local if the device-type field in
43.Xr L.sys 5
44is one of
45.Tn LOCAL , DIR
46or
47.Tn TCP .
48.It Fl R
49Reverse roles.  When used with the
50.Fl r Ns Ar 1
51option, this tells the remote system to begin sending its
52jobs first, instead of waiting for the local machine to finish.
53.It Fl d Ns Ar spooldir
54Use
55.Ar spooldir
56as the spool directory. The default is
57.Pa /var/spool/uucp.
58.It Fl g Ns Ar grade
59Only send jobs of grade
60.Ar grade
61or higher this transfer.
62The grade of a job is specified when the job is queued by
63.Xr uucp 1
64or
65.Xr uux 1 .
66.It Fl r Ns Ar role
67.Ar role
68is either 1 or 0; it indicates whether
69.Nm uucico
70is to start up in
71master or slave role, respectively. 1 is used when running
72.Nm uucico
73by hand or from
74.Xr cron 8 .
750 is used when another system calls the local system.
76Slave role is the default.
77.It Fl s Ns Ar system
78Call only system
79.Ar system .
80If
81.Fl s
82is not specified, and
83.Fl r Ns Ar 1
84is specified,
85.Nm uucico
86will attempt to call all systems for which there is work.
87If
88.Fl s
89is specified, a call will be made even if there is
90no work for that system. This is useful for polling.
91.It Fl t Ns Ar turnaround
92Use
93.Ar turnaround
94as the line turnaround time (in minutes) instead of the default 30.  If
95.Ar turnaround
96is missing or 0, line turnaround will be disabled.
97After
98.Nm uucico
99has been running in slave role for
100.Ar turnaround
101minutes, it will attempt to run in master role by negotiating with the
102remote machine.
103In earlier versions of
104.Nm uucico ,
105a transfer of many large files in one direction would hold up mail
106going in the other direction.
107With the turnaround code working, the message flow will be more
108bidirectional in the short term.
109This option only works with newer
110.Nm uucico Ns 's
111and is ignored by older ones.
112.It Fl x Ns Ar debug
113Turn on debugging at level
114.Ar debug .
115Level 5 is a good start when trying to find out why a call
116failed. Level 9 is very detailed. Level 99 is absurdly verbose.
117If
118.Ar role
119is 1 (master), output is written to the standard error
120.Em stderr .
121If
122.Em stderr
123is unavailable, output is written to
124.Pa /var/spool/uucp/AUDIT/ Ns Ar system .
125When
126.Ar role
127is 0 (slave), debugging output is always written to the
128AUDIT
129file.
130.El
131.Pp
132If
133.Nm uucico
134receives a
135.Dv SIGFPE
136(see
137.Xr kill 1 ) ,
138it will toggle the debugging on or off.
139.Pp
140.Nm Uucpd
141is the server for supporting uucp connections over networks.
142.Nm Uucpd
143listens for service requests at the port indicated in the ``uucp''
144service specification; see
145.Xr services 5 .
146The server provides login name and password authentication before starting up
147.Nm uucico
148for the rest of the transaction.
149.Pp
150.Nm Uucico
151is commonly used either of two ways: as a daemon run periodically by
152.Xr cron 8
153to call out to remote systems, and as a ``shell'' for remote systems
154who call in.
155For calling out periodically, a typical line in
156.Xr crontab
157would be:
158.Bd -literal
1590    *    *    *    *    /usr/lib/uucp/uucico -r1
160.Ed
161.Pp
162This will run
163.Nm uucico
164every hour in master role.
165For each system that has transfer requests queued,
166.Nm uucico
167calls the system, logs in, and executes the transfers. The file
168.Xr L.sys 5
169is consulted for information about how to log in, while
170.Xr L-devices 5
171specifies available lines and modems for calling.
172.Pp
173For remote systems to dial in, an entry in the
174.Xr passwd 5
175file must be created, with a login ``shell'' of
176.Nm uucico .
177For example:
178.Bd -literal
179nuucp:Password:6:1::/var/spool/uucppublic:/usr/lib/uucp/uucico
180.Ed
181.Pp
182The
183.Tn UID
184for
185.Tn UUCP
186remote logins is not critical, so long as it differs from
187the
188.Tn UUCP
189Administrative login.
190The latter owns the
191.Tn UUCP
192files, and assigning
193this
194.Tn UID
195to a remote login would be an extreme security hazard.
196.Sh FILES
197.Bl -tag -width /var/spool/uucp/D.hostnameX/ -compact
198.It Pa /usr/lib/uucp/
199.Tn UUCP
200internal files/utilities
201.It Pa /usr/lib/uucp/L-devices
202Local device descriptions
203.It Pa /usr/lib/uucp/L-dialcodes
204Phone numbers and prefixes
205.It Pa /usr/lib/uucp/L.aliases
206Hostname aliases
207.It Pa /usr/lib/uucp/L.cmds
208Remote command permissions list
209.It Pa /usr/lib/uucp/L.sys
210Host connection specifications
211.It Pa /usr/lib/uucp/USERFILE
212Remote directory tree permissions list
213.It Pa /var/spool/uucp/
214Spool directory
215.It Pa /var/spool/uucp/AUDIT/*
216Debugging audit trails
217.It Pa /var/spool/uucp/C./
218Control files directory
219.It Pa /var/spool/uucp/D./
220Incoming data file directory
221.It Pa /var/spool/uucp/D.hostname/
222Outgoing data file directory
223.It Pa /var/spool/uucp/D.hostnameX/
224Outgoing execution file directory
225.It Pa /var/spool/uucp/CORRUPT/
226Place for corrupted C. and D. files
227.It Pa /var/spool/uucp/ERRLOG
228.Tn UUCP
229internal error log
230.It Pa /var/spool/uucp/LOGFILE
231.Tn UUCP
232system activity log
233.It Pa /var/spool/uucp/LCK/LCK..*
234Device lock files
235.It Pa /var/spool/uucp/
236.Tn SYSLOG
237File transfer statistics log
238.It Pa /var/spool/uucp/STST/*
239System status files
240.It Pa /var/spool/uucp/TM./
241File transfer temp directory
242.It Pa /var/spool/uucp/X./
243Incoming execution file directory
244.It Pa /var/spool/uucppublic
245Public access directory
246.El
247.Sh SEE ALSO
248.Xr uucp 1 ,
249.Xr uuq 1 ,
250.Xr uux 1 ,
251.Xr L-devices 5 ,
252.Xr L-dialcodes 5 ,
253.Xr L.aliases 5 ,
254.Xr L.cmds 5 ,
255.Xr L.sys 5 ,
256.Xr uuclean 8 ,
257.Xr uupoll 8 ,
258.Xr uusnap 8 ,
259.Xr uuxqt 8
260.Rs
261.%A D. A. Nowitz
262.%A M. E. Lesk
263.%T "A Dial-Up Network of UNIX Systems"
264.Re
265.Rs
266.%A D. A. Nowitz
267.%T "Uucp Implementation Description"
268.Re
269.Sh HISTORY
270The
271.Nm
272command appeared in
273.Bx 4.3 .
274