home *** CD-ROM | disk | FTP | other *** search
/ OS/2 Professional / OS2PRO194.ISO / os2 / prgramer / unix / doc / rcsclean.man < prev    next >
Text File  |  1992-02-19  |  4KB  |  113 lines
  1. NAME
  2.      rcsclean - clean up working files
  3.  
  4. SYNOPSIS
  5.      rcsclean [options] [ file ... ]
  6.  
  7. DESCRIPTION
  8.      rcsclean removes working files that were checked out and
  9.      never modified.  For each file given, rcsclean compares the
  10.      working file and a revision in the corresponding RCS file.
  11.      If it finds a difference, it does nothing.  Otherwise, it
  12.      first unlocks the revision if the -u option is given, and
  13.      then removes the working file unless the working file is
  14.      writable and the revision is locked.  It logs its actions by
  15.      outputting the corresponding rcs -u and rm -f commands on
  16.      the standard output.
  17.  
  18.      File names are paired as explained in ci(1).  If no file is
  19.      given, all working files in the current directory are
  20.      cleaned.  Pathnames matching an RCS suffix denote RCS files;
  21.      all others denote working files.
  22.  
  23.      The number of the revision to which the working file is
  24.      compared may be attached to any of the options -n, -q, -r,
  25.      or -u.  If no revision number is specified, then if the -u
  26.      option is given and the caller has one revision locked,
  27.      rcsclean uses that revision; otherwise rcsclean uses the
  28.      latest revision on the default branch, normally the root.
  29.  
  30.      rcsclean is useful for clean targets in makefiles.  See also
  31.      rcsdiff(1), which prints out the differences, and ci(1),
  32.      which normally reverts to the previous revision if a file
  33.      was not changed.
  34.  
  35. OPTIONS
  36.      -ksubst
  37.           Use subst style keyword substitution when retrieving
  38.           the revision for comparison.  See co(1) for details.
  39.  
  40.      -n[rev]
  41.           Do not actually remove any files or unlock any
  42.           revisions.  Using this option will tell you what
  43.           rcsclean would do without actually doing it.
  44.  
  45.      -q[rev]
  46.           Do not log the actions taken on standard output.
  47.  
  48.      -r[rev]
  49.           This option has no effect other than specifying the
  50.           revision for comparison.
  51.  
  52.      -T   Preserve the modification time on the RCS file even if
  53.           the RCS file changes because a lock is removed.  This
  54.           option can suppress extensive recompilation caused by a
  55.           make(1) dependency of some other copy of the working
  56.           file on the RCS file.  Use this option with care; it
  57.           can suppress recompilation even when it is needed, i.e.
  58.           when the lock removal would mean a change to keyword
  59.           strings in the other working file.
  60.  
  61.      -u[rev]
  62.           Unlock the revision if it is locked and no difference
  63.           is found.
  64.  
  65.      -Vn  Emulate RCS version n.  See co(1) for details.
  66.  
  67.      -xsuffixes
  68.           Use suffixes to characterize RCS files.  See ci(1) for
  69.           details.
  70.  
  71. EXAMPLES
  72.           rcsclean  *.c  *.h
  73.  
  74.      removes all working files ending in .c or .h that were not
  75.      changed since their checkout.
  76.  
  77.           rcsclean
  78.  
  79.      removes all working files in the current directory that were
  80.      not changed since their checkout.
  81.  
  82. FILES
  83.      rcsclean accesses files much as ci(1) does.
  84.  
  85. ENVIRONMENT
  86.      RCSINIT
  87.           options prepended to the argument list, separated by
  88.           spaces.  A backslash escapes spaces within an option.
  89.           The RCSINIT options are prepended to the argument lists
  90.           of most RCS commands.  Useful RCSINIT options include
  91.           -q, -V, and -x.
  92.  
  93. DIAGNOSTICS
  94.      The exit status is zero if and only if all operations were
  95.      successful.  Missing working files and RCS files are
  96.      silently ignored.
  97.  
  98. IDENTIFICATION
  99.      Author: Walter F. Tichy.
  100.      Revision Number: 1.10; Release Date: 1992/02/17.
  101.      Copyright 1982, 1988, 1989 by Walter F. Tichy.
  102.      Copyright 1990, 1991, 1992 by Paul Eggert.
  103.  
  104. SEE ALSO
  105.      ci(1), co(1), ident(1), rcs(1), rcsdiff(1), rcsintro(1),
  106.      rcsmerge(1), rlog(1), rcsfile(5)
  107.      Walter F. Tichy, RCS--A System for Version Control,
  108.      Software--Practice & Experience 15, 7 (July 1985), 637-654.
  109.  
  110. BUGS
  111.      At least one file must be given in older Unix versions that
  112.      do not provide the needed directory scanning operations.
  113.