gnu/usr.bin/rcs/rcsclean/rcsclean.1

   1 .\"     $NetBSD: rcsclean.1,v 1.4 1996/10/15 07:00:37 veego Exp $
   2 .\"
   3 .de Id
   4 .ds Rv \\$3
   5 .ds Dt \\$4
   6 ..
   7 .\" Id: rcsclean.1,v 1.12 1993/11/03 17:42:27 eggert Exp
   8 .ds r \&\s-1RCS\s0
   9 .if n .ds - \%--
  10 .if t .ds - \(em
  11 .TH RCSCLEAN 1 \*(Dt GNU
  12 .SH NAME
  13 rcsclean \- clean up working files
  14 .SH SYNOPSIS
  15 .B rcsclean
  16 .RI [ options "] [ " file " .\|.\|. ]"
  17 .SH DESCRIPTION
  18 .B rcsclean
  19 removes files that are not being worked on.
  20 .B "rcsclean \-u"
  21 also unlocks and removes files that are being worked on
  22 but have not changed.
  23 .PP
  24 For each
  25 .I file
  26 given,
  27 .B rcsclean
  28 compares the working file and a revision in the corresponding
  29 \*r file.  If it finds a difference, it does nothing.
  30 Otherwise, it first unlocks the revision if the
  31 .B \-u
  32 option is given,
  33 and then removes the working file
  34 unless the working file is writable and the revision is locked.
  35 It logs its actions by outputting the corresponding
  36 .B "rcs \-u"
  37 and
  38 .B "rm \-f"
  39 commands on the standard output.
  40 .PP
  41 Files are paired as explained in
  42 .BR ci (1).
  43 If no
  44 .I file
  45 is given, all working files in the current directory are cleaned.
  46 Pathnames matching an \*r suffix denote \*r files;
  47 all others denote working files.
  48 .PP
  49 The number of the revision to which the working file is compared
  50 may be attached to any of the options
  51 .BR \-n ,
  52 .BR \-q ,
  53 .BR \-r ,
  54 or
  55 .BR \-u .
  56 If no revision number is specified, then if the
  57 .B \-u
  58 option is given and the caller has one revision locked,
  59 .B rcsclean
  60 uses that revision; otherwise
  61 .B rcsclean
  62 uses the latest revision on the default branch, normally the root.
  63 .PP
  64 .B rcsclean
  65 is useful for
  66 .B clean
  67 targets in makefiles.
  68 See also
  69 .BR rcsdiff (1),
  70 which prints out the differences,
  71 and
  72 .BR ci (1),
  73 which
  74 normally reverts to the previous revision
  75 if a file was not changed.
  76 .SH OPTIONS
  77 .TP
  78 .BI \-k subst
  79 Use
  80 .I subst
  81 style keyword substitution when retrieving the revision for comparison.
  82 See
  83 .BR co (1)
  84 for details.
  85 .TP
  86 .BR \-n [\f2rev\fP]
  87 Do not actually remove any files or unlock any revisions.
  88 Using this option will tell you what
  89 .B rcsclean
  90 would do without actually doing it.
  91 .TP
  92 .BR \-q [\f2rev\fP]
  93 Do not log the actions taken on standard output.
  94 .TP
  95 .BR \-r [\f2rev\fP]
  96 This option has no effect other than specifying the revision for comparison.
  97 .TP
  98 .B \-T
  99 Preserve the modification time on the \*r file
 100 even if the \*r file changes because a lock is removed.
 101 This option can suppress extensive recompilation caused by a
 102 .BR make (1)
 103 dependency of some other copy of the working file on the \*r file.
 104 Use this option with care; it can suppress recompilation even when it is needed,
 105 i.e. when the lock removal
 106 would mean a change to keyword strings in the other working file.
 107 .TP
 108 .BR \-u [\f2rev\fP]
 109 Unlock the revision if it is locked and no difference is found.
 110 .TP
 111 .BI \-V
 112 Print \*r's version number.
 113 .TP
 114 .BI \-V n
 115 Emulate \*r version
 116 .IR n .
 117 See
 118 .BR co (1)
 119 for details.
 120 .TP
 121 .BI \-x "suffixes"
 122 Use
 123 .I suffixes
 124 to characterize \*r files.
 125 See
 126 .BR ci (1)
 127 for details.
 128 .TP
 129 .BI \-z zone
 130 Use
 131 .I zone
 132 as the time zone for keyword substitution;
 133 see
 134 .BR co (1)
 135 for details.
 136 .SH EXAMPLES
 137 .LP
 138 .RS
 139 .ft 3
 140 rcsclean  *.c  *.h
 141 .ft
 142 .RE
 143 .LP
 144 removes all working files ending in
 145 .B .c
 146 or
 147 .B .h
 148 that were not changed
 149 since their checkout.
 150 .LP
 151 .RS
 152 .ft 3
 153 rcsclean
 154 .ft
 155 .RE
 156 .LP
 157 removes all working files in the current directory
 158 that were not changed since their checkout.
 159 .SH FILES
 160 .B rcsclean
 161 accesses files much as
 162 .BR ci (1)
 163 does.
 164 .SH ENVIRONMENT
 165 .TP
 166 .B \s-1RCSINIT\s0
 167 options prepended to the argument list, separated by spaces.
 168 A backslash escapes spaces within an option.
 169 The
 170 .B \s-1RCSINIT\s0
 171 options are prepended to the argument lists of most \*r commands.
 172 Useful
 173 .B \s-1RCSINIT\s0
 174 options include
 175 .BR \-q ,
 176 .BR \-V ,
 177 .BR \-x ,
 178 and
 179 .BR \-z .
 180 .SH DIAGNOSTICS
 181 The exit status is zero if and only if all operations were successful.
 182 Missing working files and \*r files are silently ignored.
 183 .SH IDENTIFICATION
 184 Author: Walter F. Tichy.
 185 .br
 186 Manual Page Revision: \*(Rv; Release Date: \*(Dt.
 187 .br
 188 Copyright \(co 1982, 1988, 1989 Walter F. Tichy.
 189 .br
 190 Copyright \(co 1990, 1991, 1992, 1993 Paul Eggert.
 191 .SH "SEE ALSO"
 192 ci(1), co(1), ident(1), rcs(1), rcsdiff(1), rcsintro(1), rcsmerge(1), rlog(1),
 193 rcsfile(5)
 194 .br
 195 Walter F. Tichy,
 196 \*r\*-A System for Version Control,
 197 .I "Software\*-Practice \*[Am] Experience"
 198 .BR 15 ,
 199 7 (July 1985), 637-654.
 200 .SH BUGS
 201 At least one
 202 .I file
 203 must be given in older Unix versions that
 204 do not provide the needed directory scanning operations.
 205 .br