xref: /openbsd-src/usr.bin/rcs/rcsclean.1 (revision f1c64ac4de90b4f8a835a7530957a2950b33193d)
1.\"	$OpenBSD: rcsclean.1,v 1.22 2010/09/03 11:09:29 jmc Exp $
2.\"
3.\" Copyright (c) 2005 Joris Vink <joris@openbsd.org>
4.\" All rights reserved.
5.\"
6.\" Permission to use, copy, modify, and distribute this software for any
7.\" purpose with or without fee is hereby granted, provided that the above
8.\" copyright notice and this permission notice appear in all copies.
9.\"
10.\" THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
11.\" WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
12.\" MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
13.\" ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
14.\" WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
15.\" ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
16.\" OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
17.Dd $Mdocdate: September 3 2010 $
18.Dt RCSCLEAN 1
19.Os
20.Sh NAME
21.Nm rcsclean
22.Nd clean up working files
23.Sh SYNOPSIS
24.Nm
25.Op Fl TV
26.Op Fl k Ns Ar mode
27.Op Fl n Ns Op Ar rev
28.Op Fl q Ns Op Ar rev
29.Op Fl r Ns Op Ar rev
30.Op Fl u Ns Op Ar rev
31.Op Fl x Ns Ar suffixes
32.Op Fl z Ns Ar tz
33.Op Ar
34.Sh DESCRIPTION
35The
36.Nm
37program is used to clean up (remove) files that are not being worked on.
38Only checked out files from the current working directory are removed \(en
39.Nm
40does not remove files from the RCS repository.
41.Pp
42If no
43.Ar file
44operand is specified,
45.Nm
46cleans up all working files in the current directory.
47.Pp
48.Nm
49also supports
50keyword substitution \(en
51see the
52.Xr rcs 1
53man page for more information.
54.Pp
55The following options are supported:
56.Bl -tag -width Ds
57.It Fl k Ns Ar mode
58Specify the keyword substitution mode.
59.It Fl n Ns Op Ar rev
60Dry-run mode.
61When this option is specified,
62.Nm
63will show you what it would normally do without doing it.
64.It Fl q Ns Op Ar rev
65Be quiet about reporting.
66.It Fl r Ns Op Ar rev
67Remove revision
68.Ar rev .
69If
70.Ar rev
71does not match the revision of the currently checked out file,
72.Nm
73will do nothing.
74.It Fl T
75Preserve the modification time of RCS files.
76.It Fl u Ns Op Ar rev
77Unlock the revision if it's currently locked.
78This is only possible if no changes have been made to the file
79since it was checked out.
80.It Fl V
81Print RCS's version number.
82.It Fl x Ns Ar suffixes
83Specify the suffixes for RCS files.
84Suffixes should be separated by the
85.Sq /
86character.
87.It Fl z Ns Ar tz
88Specify the time zone for keyword substitution.
89.El
90.Sh ENVIRONMENT
91.Bl -tag -width RCSINIT
92.It Ev RCSINIT
93If set, this variable should contain a list of space-delimited options that
94are prepended to the argument list.
95.El
96.Sh EXIT STATUS
97.Ex -std rcsclean
98.Sh EXAMPLES
99Remove all working files (locked or not) in the current directory that were
100not changed since last checkout:
101.Pp
102.Dl $ rcsclean -u
103.Sh SEE ALSO
104.Xr ci 1 ,
105.Xr co 1 ,
106.Xr ident 1 ,
107.Xr rcs 1 ,
108.Xr rcsdiff 1 ,
109.Xr rcsmerge 1 ,
110.Xr rlog 1
111