missing arg

[unix-history] / usr / src / usr.bin / sccs / sccs.1

diff --git a/usr/src/usr.bin/sccs/sccs.1 b/usr/src/usr.bin/sccs/sccs.1
index e918631..18d37c9 100644 (file)
--- a/usr/src/usr.bin/sccs/sccs.1
+++ b/usr/src/usr.bin/sccs/sccs.1
@@ -1,4 +1,5 @@
-.TH SCCS 1
+.TH SCCS LOCAL
+.UC

 .SH NAME
 sccs \- front end for the
 .SM SCCS
 .SH NAME
 sccs \- front end for the
 .SM SCCS


@@ -8,9 +9,9 @@ subsystem
 [
 .B \-r
 ] [
 [
 .B \-r
 ] [

-.BI \-p path
-] [

 .BI \-d path
 .BI \-d path

+] [
+.BI \-p path

 ] command [ flags ] [ args ]
 .SH DESCRIPTION
 .I Sccs
 ] command [ flags ] [ args ]
 .SH DESCRIPTION
 .I Sccs


@@ -34,13 +35,8 @@ and
 .I args.
 Each
 argument
 .I args.
 Each
 argument

-is modified to be prepended
-with ``SCCS/s.''
-unless
-it specifies a directory
-or the final component
-of the pathname
-begins with ``s.''.
+is normally modified to be prepended
+with ``SCCS/s.''.

 .PP
 Flags to be interpreted by the
 .I sccs
 .PP
 Flags to be interpreted by the
 .I sccs


@@ -68,11 +64,32 @@ Perform a delta on the named files
 and then get new versions.
 The new versions will have id keywords expanded,
 and will not be editable.
 and then get new versions.
 The new versions will have id keywords expanded,
 and will not be editable.

+The \-m, \-p, \-r, \-s, and \-y flags
+will be passed to delta,
+and the \-b, \-c, \-e, \-i, \-k, \-l, \-s, and \-x flags
+will be passed to get.

 .IP deledit
 Equivalent to ``delget'' except that the
 ``get'' phase includes the ``\-e'' flag.
 This option is useful for making a ``checkpoint''
 .IP deledit
 Equivalent to ``delget'' except that the
 ``get'' phase includes the ``\-e'' flag.
 This option is useful for making a ``checkpoint''

-of your current editting phase.
+of your current editing phase.
+The same flags will be passed to delta
+as described above,
+and all the flags listed for ``get''
+above except \-e and \-k
+are passed to ``edit''.
+.IP create
+Creates an
+.SM SCCS
+file,
+taking the initial contents from the file of the same name.
+Any flags to ``admin'' are accepted.
+If the creation is successful,
+the files are renamed with a comma on the front.
+These should be removed when you are convinced that
+the
+.SM SCCS
+files have been created successfully.

 .IP fix
 Must be followed by a
 .B \-r
 .IP fix
 Must be followed by a
 .B \-r


@@ -84,10 +101,15 @@ It is useful for fixing small compiler bugs, etc.
 Since it doesn't leave audit trails,
 it should be used carefully.
 .IP clean
 Since it doesn't leave audit trails,
 it should be used carefully.
 .IP clean

-Takes no arguments.

 This routine removes everything from the current directory
 that can be recreated from SCCS files.
 This routine removes everything from the current directory
 that can be recreated from SCCS files.

-It will not remove any files being editted.
+It will not remove any files being edited.
+If the
+.B \-b
+flag is given, branches are ignored in the determination
+of whether they are being edited;
+this is dangerous if you are keeping the branches in the
+same directory.

 .IP unedit
 This is the opposite of an ``edit''
 or a ``get \-e''.
 .IP unedit
 This is the opposite of an ``edit''
 or a ``get \-e''.


@@ -95,7 +117,75 @@ It should be used with extreme caution,
 since any changes you made since the get
 will be irretrievably lost.
 .IP info
 since any changes you made since the get
 will be irretrievably lost.
 .IP info

-Gives a listing of all files being editted.
+Gives a listing of all files being edited.
+If the
+.B \-b
+flag is given,
+branches (i.e.,
+\s-1SID\s0's with two or fewer components)
+are ignored.
+If the
+.B \-u
+flag is given
+(with an optional argument)
+then only files being edited by you
+(or the named user)
+are listed.
+.IP check
+Like ``info''
+except that nothing is printed if nothing is being edited,
+and a non-zero exit status is returned if anything
+is being edited.
+The intent is to have this included in an ``install''
+entry in a makefile
+to insure that everything is included into the
+.SM SCCS
+file
+before a version is installed.
+.IP tell
+Gives a newline-separated list
+of the files being edited
+on the standard output.
+Takes the
+.B \-b
+and
+.B \-u
+flags like 
+``info'' and ``check''.
+.IP diffs
+Gives a ``diff'' listing between the current version of the
+program(s) you have out for editing and the versions
+in
+.SM SCCS
+format.
+The
+.B \-r,
+.B \-c,
+.B \-i,
+.B \-x,
+and
+.B \-t
+flags are passed to
+.I get\c
+; the
+.B \-l,
+.B \-s,
+.B \-e,
+.B \-f,
+.B \-h,
+and
+.B \-b
+options are passed to
+.I diff.
+The
+.B \-C
+flag is passed to
+.I diff
+as
+.B \-c.
+.IP print
+This command prints out verbose information
+about the named files.

 .PP
 The
 .B \-r
 .PP
 The
 .B \-r


@@ -106,19 +196,23 @@ rather than as whatever effective user
 .I sccs
 is ``set user id'' to.
 The
 .I sccs
 is ``set user id'' to.
 The

+.B \-d
+flag gives a root directory for the
+.SM SCCS
+files.
+The default is the current directory.
+The

 .B \-p
 flag defines the pathname of the directory
 .B \-p
 flag defines the pathname of the directory

-in which
+in which the

 .SM SCCS
 .SM SCCS

-will be found;
+files will be found;

 ``SCCS'' is the default.
 The
 ``SCCS'' is the default.
 The

-.B \-d
-flag gives a base directory
-for the pathname search;
-it differs from

 .B \-p
 .B \-p

-in that the
+flag differs from the
+.B \-d
+flag in that the

 .B \-d
 argument is prepended to the entire pathname
 and the
 .B \-d
 argument is prepended to the entire pathname
 and the


@@ -126,13 +220,25 @@ and the
 argument is inserted before the final component of the
 pathname.
 For example,
 argument is inserted before the final component of the
 pathname.
 For example,

-``sccs -d/x -py get a/b''
+``sccs \-d/x \-py get a/b''

 will convert to
 ``get /x/a/y/s.b''.
 The intent here is to create aliases such as
 ``alias syssccs sccs -d/usr/src''
 which will be used as
 ``syssccs get cmd/who.c''.
 will convert to
 ``get /x/a/y/s.b''.
 The intent here is to create aliases such as
 ``alias syssccs sccs -d/usr/src''
 which will be used as
 ``syssccs get cmd/who.c''.

+Also, if the environment variable
+PROJECT
+is set,
+its value is used to determine the
+.B \-d flag.
+If it begins with a slash,
+it is taken directly;
+otherwise,
+the home directory of a user of that name
+is examined for a subdirectory ``src'' or ``source''.
+If such a directory is found,
+it is used.

 .PP
 Certain commands (such as
 .IR admin )
 .PP
 Certain commands (such as
 .IR admin )


@@ -141,16 +247,15 @@ since this would allow anyone to change the authorizations.
 These commands are always run as the real user.
 .SH EXAMPLES
 .de BX
 These commands are always run as the real user.
 .SH EXAMPLES
 .de BX

+.PP

 .nf
 .in +0.5i
 .nf
 .in +0.5i

-.sp 0.3

 ..
 .de EX
 .fi
 ..
 .de EX
 .fi

-.in -0.5i
-.sp 0.3
+.PP

 ..
 ..

-To get a file for editting,
+To get a file for editing,

 edit it,
 and produce a new delta:
 .BX
 edit it,
 and produce a new delta:
 .BX


@@ -171,16 +276,20 @@ in the current directory:
 .BX
 sccs delta *.c
 .EX
 .BX
 sccs delta *.c
 .EX

+To get a list of files being edited that are not on branches:
+.BX
+sccs info \-b
+.EX
+To delta everything being edited by you:
+.BX
+sccs delta \`sccs tell \-u\`
+.EX

 In a makefile, to get source files
 from an
 .SM SCCS
 file if it does not already exist:
 .BX
 SRCS = <list of source files>
 In a makefile, to get source files
 from an
 .SM SCCS
 file if it does not already exist:
 .BX
 SRCS = <list of source files>

-OBJS = <list of object files>
-.sp 0.4
-$(OBJS): $(SRCS)
-.sp 0.4

 $(SRCS):
        sccs get $(REL) $@
 .EX
 $(SRCS):
        sccs get $(REL) $@
 .EX


@@ -194,14 +303,21 @@ help(SCCS),
 prt(SCCS),
 rmdel(SCCS),
 sccsdiff(SCCS),
 prt(SCCS),
 rmdel(SCCS),
 sccsdiff(SCCS),

-what(SCCS),
-.SH AUTHOR
-Eric Allman (ingres:eric)
+what(SCCS)
+.br
+Eric Allman,
+.ul
+An Introduction to the Source Code Control System
+.SH BUGS
+It should be able to take directory arguments on pseudo-commands
+like the
+.SM SCCS
+commands do.

 .SH DISCLAIMER
 Since it is not yet clear
 what this program should do,
 it should not be considered
 a stable program product.
 Please send any
 .SH DISCLAIMER
 Since it is not yet clear
 what this program should do,
 it should not be considered
 a stable program product.
 Please send any

-constructive suggestions
-to ingres:eric.
+comments & suggestions
+to csvax:eric.