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