fixed for man command; added reference

[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 8d0d784..6a7031d 100644 (file)
--- a/usr/src/usr.bin/sccs/sccs.1
+++ b/usr/src/usr.bin/sccs/sccs.1
@@ -1,5 +1,4 @@
-.TH SCCS 1
-.UC
+.TH SCCS LOCAL

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


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

+.BI \-d path
+] [

 .BI \-p path
 ] command [ flags ] [ args ]
 .SH DESCRIPTION
 .I Sccs
 is a front end
 .BI \-p path
 ] command [ flags ] [ args ]
 .SH DESCRIPTION
 .I Sccs
 is a front end

-to csvax:eric.
-that make them mesh more cleanly
+to the
+.SM SCCS
+programs
+that help them mesh more cleanly

 with the rest of UNIX.
 It also includes the capability to run
 ``set user id'' to another user
 with the rest of UNIX.
 It also includes the capability to run
 ``set user id'' to another user


@@ -31,11 +34,8 @@ and
 .I args.
 Each
 argument
 .I args.
 Each
 argument

-is modified to be prepended
-with ``SCCS/s.''
-unless it begins with ``s.'',
-contains a `\|/\|' character,
-or specifies a directory.
+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


@@ -51,6 +51,58 @@ argument.
 These flags are specific to the command
 and are discussed in the documentation for that command.
 .PP
 These flags are specific to the command
 and are discussed in the documentation for that command.
 .PP

+Besides the usual
+.SM SCCS
+commands,
+several ``pseudo-commands'' can be issued.
+These are:
+.IP edit 1i
+Equivalent to ``get \-e''.
+.IP delget
+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.
+.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 editing phase.
+.IP fix
+Must be followed by a
+.B \-r
+flag.
+This command essentially removes the named delta,
+but leaves you with a copy of the delta
+with the changes that were in it.
+It is useful for fixing small compiler bugs, etc.
+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.
+It will not remove any files being edited.
+.IP unedit
+This is the opposite of an ``edit''
+or a ``get \-e''.
+It should be used with extreme caution,
+since any changes you made since the get
+will be irretrievably lost.
+.IP info
+Gives a listing of all files being edited.
+.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.
+.PP

 The
 .B \-r
 flag runs
 The
 .B \-r
 flag runs


@@ -60,12 +112,37 @@ 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.
 ``SCCS'' is the default.

+The
+.B \-p
+flag differs from the
+.B \-d
+flag in that the
+.B \-d
+argument is prepended to the entire pathname
+and the
+.B \-p
+argument is inserted before the final component of the
+pathname.
+For example,
+``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''.

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


@@ -74,35 +151,34 @@ 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

-% sccs get \-e file.c
-% ex file.c
-% sccs delta file.c
+sccs get \-e file.c
+ex file.c
+sccs delta file.c

 .EX
 To get a file from another directory:
 .BX
 .EX
 To get a file from another directory:
 .BX

-% sccs \-p/usr/src/sccs/s. get cc.c
+sccs \-p/usr/src/sccs/s. get cc.c

 .EX
 or
 .BX
 .EX
 or
 .BX

-% sccs get /usr/src/sccs/s.cc.c
+sccs get /usr/src/sccs/s.cc.c

 .EX
 To make a delta of a large number of files
 in the current directory:
 .BX
 .EX
 To make a delta of a large number of files
 in the current directory:
 .BX

-% sccs delta *.c
+sccs delta *.c

 .EX
 In a makefile, to get source files
 from an
 .EX
 In a makefile, to get source files
 from an


@@ -110,10 +186,6 @@ from an
 file if it does not already exist:
 .BX
 SRCS = <list of source files>
 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


@@ -127,14 +199,16 @@ help(SCCS),
 prt(SCCS),
 rmdel(SCCS),
 sccsdiff(SCCS),
 prt(SCCS),
 rmdel(SCCS),
 sccsdiff(SCCS),

-what(SCCS),
-.SH AUTHOR
-Eric Allman (csvax:eric)
+what(SCCS)
+.br
+Eric Allman,
+.ul
+An Introduction to the Source Code Control System

 .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
+comments & suggestions

 to csvax:eric.
 to csvax:eric.