add "tell" command
[unix-history] / usr / src / usr.bin / sccs / sccs.1
CommitLineData
a2a3f7d9 1.TH SCCS LOCAL
797b9789 2.UC
39ae1365
EA
3.SH NAME
4sccs \- front end for the
5.SM SCCS
6subsystem
7.SH SYNOPSIS
8.B sccs
9[
10.B \-r
11] [
e5b52011 12.BI \-d path
c3a8e591
EA
13] [
14.BI \-p path
39ae1365
EA
15] command [ flags ] [ args ]
16.SH DESCRIPTION
17.I Sccs
18is a front end
2de7ab2b
EA
19to the
20.SM SCCS
21programs
22that help them mesh more cleanly
39ae1365 23with the rest of UNIX.
af83554c
EA
24It also includes the capability to run
25``set user id'' to another user
26to provide additional protection.
39ae1365
EA
27.PP
28Basically,
29.I sccs
30runs the
31.I command
32with the specified
33.I flags
34and
35.I args.
36Each
37argument
c3a8e591
EA
38is normally modified to be prepended
39with ``SCCS/s.''.
39ae1365
EA
40.PP
41Flags to be interpreted by the
42.I sccs
43program must be before the
44.I command
45argument.
46Flags to be passed to the actual
47.SM SCCS
48program
49must come after the
50.I command
51argument.
52These flags are specific to the command
53and are discussed in the documentation for that command.
54.PP
9e6171bb
EA
55Besides the usual
56.SM SCCS
57commands,
58several ``pseudo-commands'' can be issued.
59These are:
94d25808
EA
60.IP edit 1i
61Equivalent to ``get \-e''.
62.IP delget
9e6171bb
EA
63Perform a delta on the named files
64and then get new versions.
65The new versions will have id keywords expanded,
66and will not be editable.
1087bf95
EA
67The \-m, \-p, \-r, \-s, and \-y flags
68will be passed to delta,
69and the \-b, \-c, \-e, \-i, \-k, \-l, \-s, and \-x flags
70will be passed to get.
b7991d06 71.IP deledit
94d25808
EA
72Equivalent to ``delget'' except that the
73``get'' phase includes the ``\-e'' flag.
74This option is useful for making a ``checkpoint''
c3a8e591 75of your current editing phase.
1087bf95
EA
76The same flags will be passed to delta
77as described above,
78and all the flags listed for ``get''
79above except \-e and \-k
80are passed to ``edit''.
9e6171bb
EA
81.IP fix
82Must be followed by a
83.B \-r
84flag.
85This command essentially removes the named delta,
86but leaves you with a copy of the delta
87with the changes that were in it.
88It is useful for fixing small compiler bugs, etc.
89Since it doesn't leave audit trails,
90it should be used carefully.
91.IP clean
92Takes no arguments.
93This routine removes everything from the current directory
94that can be recreated from SCCS files.
c3a8e591 95It will not remove any files being edited.
9ef9beda
EA
96.IP unedit
97This is the opposite of an ``edit''
98or a ``get \-e''.
99It should be used with extreme caution,
100since any changes you made since the get
101will be irretrievably lost.
94d25808 102.IP info
c3a8e591 103Gives a listing of all files being edited.
a2a3f7d9
EA
104.IP check
105Like ``info''
106except that nothing is printed if nothing is being edited,
107and a non-zero exit status is returned if anything
108is being edited.
109The intent is to have this included in an ``install''
110entry in a makefile
111to insure that everything is included into the
112.SM SCCS
113file
114before a version is installed.
aad1cfb4
EA
115.IP tell
116Gives a newline-separated list
117of the files being edited
118on the standard output.
ecf8b19b
EA
119.IP diffs
120Gives a ``diff'' listing between the current version of the
121program(s) you have out for editing and the versions
122in
123.SM SCCS
124format.
125The arguments look exactly like the arguments to a get,
126which specify the version to diff against.
9e6171bb 127.PP
39ae1365
EA
128The
129.B \-r
130flag runs
131.I sccs
132as the real user
af83554c
EA
133rather than as whatever effective user
134.I sccs
135is ``set user id'' to.
39ae1365 136The
c3a8e591
EA
137.B \-d
138flag gives a root directory for the
139.SM SCCS
140files.
141The default is the current directory.
142The
39ae1365 143.B \-p
70caf673 144flag defines the pathname of the directory
c3a8e591 145in which the
39ae1365 146.SM SCCS
c3a8e591 147files will be found;
70caf673 148``SCCS'' is the default.
e5b52011 149The
e5b52011 150.B \-p
c3a8e591
EA
151flag differs from the
152.B \-d
153flag in that the
e5b52011
EA
154.B \-d
155argument is prepended to the entire pathname
156and the
157.B \-p
158argument is inserted before the final component of the
159pathname.
160For example,
161``sccs -d/x -py get a/b''
162will convert to
163``get /x/a/y/s.b''.
164The intent here is to create aliases such as
165``alias syssccs sccs -d/usr/src''
166which will be used as
167``syssccs get cmd/who.c''.
70caf673
EA
168.PP
169Certain commands (such as
170.IR admin )
af83554c
EA
171cannot be run ``set user id'' by all users,
172since this would allow anyone to change the authorizations.
173These commands are always run as the real user.
39ae1365
EA
174.SH EXAMPLES
175.de BX
813d780e 176.PP
39ae1365
EA
177.nf
178.in +0.5i
39ae1365
EA
179..
180.de EX
181.fi
813d780e 182.PP
39ae1365 183..
c3a8e591 184To get a file for editing,
39ae1365
EA
185edit it,
186and produce a new delta:
187.BX
2de7ab2b
EA
188sccs get \-e file.c
189ex file.c
190sccs delta file.c
39ae1365
EA
191.EX
192To get a file from another directory:
193.BX
2de7ab2b 194sccs \-p/usr/src/sccs/s. get cc.c
39ae1365
EA
195.EX
196or
197.BX
2de7ab2b 198sccs get /usr/src/sccs/s.cc.c
39ae1365
EA
199.EX
200To make a delta of a large number of files
201in the current directory:
202.BX
2de7ab2b 203sccs delta *.c
39ae1365
EA
204.EX
205In a makefile, to get source files
206from an
207.SM SCCS
208file if it does not already exist:
209.BX
210SRCS = <list of source files>
70caf673
EA
211$(SRCS):
212 sccs get $(REL) $@
39ae1365
EA
213.EX
214.SH "SEE ALSO"
215admin(SCCS),
216chghist(SCCS),
217comb(SCCS),
218delta(SCCS),
219get(SCCS),
220help(SCCS),
221prt(SCCS),
222rmdel(SCCS),
223sccsdiff(SCCS),
813d780e
EA
224what(SCCS)
225.br
226Eric Allman,
227.ul
228An Introduction to the Source Code Control System
d35f5db1
EA
229.SH BUGS
230It should be able to take directory arguments on pseudo-commands
231like the
232.SM SCCS
233commands do.
39ae1365
EA
234.SH DISCLAIMER
235Since it is not yet clear
236what this program should do,
237it should not be considered
238a stable program product.
239Please send any
c3a8e591
EA
240comments & suggestions
241to csvax:eric.