• merge latest version of rannotate code from corecode
[alioth/cvs.git] / contrib / sandbox_status.man
1 .\" Contributed by Lowell Skoog <fluke!lowell@uunet.uu.net>
2 .TH CVSCHECK LOCAL "4 March 1991" FLUKE
3 .SH NAME
4 sandbox_status \- identify files added, changed, or removed in a CVS working
5 directory
6 .SH SYNOPSIS
7 .B sandbox_status
8 .SH DESCRIPTION
9 This command is a housekeeping aid.  It should be run in a working
10 directory that has been checked out using CVS.  It identifies files
11 that have been added, changed, or removed in the working directory, but
12 not CVS
13 .BR commit ted.
14 It also determines whether the files have been CVS
15 .BR add ed
16 or CVS
17 .BR remove d.
18 For directories, this command determines only whether they have been
19 .BR add ed.
20 It operates in the current directory only.
21 .LP
22 This command provides information that is available using CVS
23 .B status
24 and CVS
25 .BR diff .
26 The advantage of
27 .B sandbox_status
28 is that its output is very concise.  It saves you the strain (and
29 potential error) of interpreting the output of CVS
30 .B status
31 and
32 .BR diff .
33 .LP
34 See
35 .BR cvs (local)
36 or
37 .BR cvshelp (local)
38 for instructions on how to add or remove a file or directory in a
39 CVS-controlled package.
40 .SH DIAGNOSTICS
41 The exit status is 0 if no files have been added, changed, or removed
42 from the current directory.  Otherwise, the command returns a count of
43 the adds, changes, and deletes.
44 .SH SEE ALSO
45 .BR cvs (local),
46 .BR cvshelp (local)
47 .SH AUTHOR
48 Lowell Skoog
49 .br
50 Software Technology Group
51 .br
52 Technical Computing