blob: b542a6a2e82ad0bd02a15697bbe62a131555f542 [file] [log] [blame]
Richard Lowec10c16d2011-03-14 14:05:30 -04001'\" te
2.\" Copyright (c) 1996, Sun Microsystems, Inc. All Rights Reserved.
3.\" Copyright 1989 AT&T
4.\" 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.
5.\" 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.
6.\" 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]
Yuri Pankoved22c712011-10-03 04:36:40 -07007.TH UUCLEANUP 1M "May 19, 1993"
Richard Lowec10c16d2011-03-14 14:05:30 -04008.SH NAME
9uucleanup \- uucp spool directory clean-up
10.SH SYNOPSIS
11.LP
12.nf
Yuri Pankoved22c712011-10-03 04:36:40 -070013\fB/usr/lib/uucp/uucleanup\fR [\fB-C\fR\fItime\fR] [\fB-D\fR\fItime\fR] [\fB-m\fR\fIstring\fR]
Richard Lowec10c16d2011-03-14 14:05:30 -040014 [\fB-o\fR\fItime\fR] [\fB-s\fR\fIsystem\fR] [\fB-W\fR\fItime\fR] [\fB-x\fR\fIdebug-level\fR] [\fB-X\fR\fItime\fR]
15.fi
16
17.SH DESCRIPTION
Richard Lowec10c16d2011-03-14 14:05:30 -040018.LP
19\fBuucleanup\fR will scan the spool directories for old files and take
20appropriate action to remove them in a useful way:
21.RS +4
22.TP
23.ie t \(bu
24.el o
25Inform the requester of send/receive requests for systems that can not be
26reached.
27.RE
28.RS +4
29.TP
30.ie t \(bu
31.el o
32Return undeliverable mail to the sender.
33.RE
34.RS +4
35.TP
36.ie t \(bu
37.el o
38Deliver \fBrnews\fR files addressed to the local system.
39.RE
40.RS +4
41.TP
42.ie t \(bu
43.el o
44Remove all other files.
45.RE
46.sp
47.LP
48In addition, there is a provision to warn users of requests that have been
49waiting for a given number of days (default 1 day). Note: \fBuucleanup\fR will
50process as if all option \fBtimes\fR were specified to the default values
51unless \fBtime\fR is specifically set.
52.sp
53.LP
54This program is typically started by the shell \fBuudemon.cleanup\fR, which
55should be started by \fBcron\fR(1M).
56.SH OPTIONS
Richard Lowec10c16d2011-03-14 14:05:30 -040057.ne 2
Richard Lowec10c16d2011-03-14 14:05:30 -040058.na
59\fB\fB-C\fR\fBtime\fR\fR
60.ad
61.RS 17n
Richard Lowec10c16d2011-03-14 14:05:30 -040062Remove any \fBC.\fR files greater or equal to \fBtime\fR days old and send
63appropriate information to the requester (default 7 days).
64.RE
65
66.sp
67.ne 2
Richard Lowec10c16d2011-03-14 14:05:30 -040068.na
69\fB\fB-D\fR\fBtime\fR\fR
70.ad
71.RS 17n
Richard Lowec10c16d2011-03-14 14:05:30 -040072Remove any \fBD.\fR files greater or equal to \fBtime\fR days old, make an
73attempt to deliver mail messages, and execute \fBrnews\fR when appropriate
74(default 7 days).
75.RE
76
77.sp
78.ne 2
Richard Lowec10c16d2011-03-14 14:05:30 -040079.na
80\fB\fB-m\fR\fIstring\fR\fR
81.ad
82.RS 17n
Richard Lowec10c16d2011-03-14 14:05:30 -040083Include \fIstring\fR in the warning message generated by the \fB-W\fR option.
84The default line is "See your local administrator to locate the problem".
85.RE
86
87.sp
88.ne 2
Richard Lowec10c16d2011-03-14 14:05:30 -040089.na
90\fB\fB-o\fR\fBtime\fR\fR
91.ad
92.RS 17n
Richard Lowec10c16d2011-03-14 14:05:30 -040093Delete other files whose age is more than \fBtime\fR days (default 2 days).
94.RE
95
96.sp
97.ne 2
Richard Lowec10c16d2011-03-14 14:05:30 -040098.na
99\fB\fB-s\fR\fIsystem\fR\fR
100.ad
101.RS 17n
Richard Lowec10c16d2011-03-14 14:05:30 -0400102Execute for \fIsystem\fR spool directory only.
103.RE
104
105.sp
106.ne 2
Richard Lowec10c16d2011-03-14 14:05:30 -0400107.na
108\fB\fB-W\fR\fBtime\fR\fR
109.ad
110.RS 17n
Richard Lowec10c16d2011-03-14 14:05:30 -0400111Any \fBC.\fR files equal to \fBtime\fR days old will cause a mail message to be
112sent to the requester warning about the delay in contacting the remote. The
113message includes the \fIJOBID\fR, and in the case of mail, the mail message.
114The administrator may include a message line telling whom to call to check the
115problem (\fB-m\fR option) (default 1 day).
116.RE
117
118.sp
119.ne 2
Richard Lowec10c16d2011-03-14 14:05:30 -0400120.na
121\fB\fB-x\fR\fIdebug-level\fR\fR
122.ad
123.RS 17n
Peter Tribble03270632018-12-10 21:26:43 +0000124Produce debugging output on standard output. \fIdebug-level\fR is a single digit
Richard Lowec10c16d2011-03-14 14:05:30 -0400125between 0 and 9; higher numbers give more detailed debugging information. (This
126option may not be available on all systems.)
127.RE
128
129.sp
130.ne 2
Richard Lowec10c16d2011-03-14 14:05:30 -0400131.na
132\fB\fB-X\fR\fBtime\fR\fR
133.ad
134.RS 17n
Richard Lowec10c16d2011-03-14 14:05:30 -0400135Any \fBX.\fR files greater or equal to \fBtime\fR days old will be removed. The
136\fBD.\fR files are probably not present (if they were, the \fBX.\fR could get
137executed). But if there are \fBD.\fR files, they will be taken care of by D.
138processing (default 2 days).
139.RE
140
141.SH FILES
Richard Lowec10c16d2011-03-14 14:05:30 -0400142.ne 2
Richard Lowec10c16d2011-03-14 14:05:30 -0400143.na
144\fB\fB/usr/lib/uucp\fR\fR
145.ad
146.RS 19n
Richard Lowec10c16d2011-03-14 14:05:30 -0400147directory with commands used by \fBuucleanup\fR internally
148.RE
149
150.sp
151.ne 2
Richard Lowec10c16d2011-03-14 14:05:30 -0400152.na
153\fB\fB/var/spool/uucp\fR\fR
154.ad
155.RS 19n
Richard Lowec10c16d2011-03-14 14:05:30 -0400156spool directory
157.RE
158
159.SH SEE ALSO
Richard Lowec10c16d2011-03-14 14:05:30 -0400160.LP
161\fBuucp\fR(1C), \fBuux\fR(1C), \fBcron\fR(1M), \fBattributes\fR(5)