Usenet 1994 January/usenetsourcesnewsgroupsinfomagicjanuary1994.iso/sources/unix/volume3/rcsit/rcsit.1

Text File | 1986-11-30 | 4.7 KB | 193 lines

...
... $Header: rcsit.1,v 1.7 85/11/26 16:57:21 mcooper Exp $
...
... $Log:    rcsit.1,v $
... Revision 1.7  85/11/26  16:57:21  mcooper
... Noted changes to the -t option.
...
... Revision 1.6  85/11/11  21:20:17  mcooper
... Added AUTHOR.
...
... Revision 1.5  85/11/11  20:13:39  mcooper
... Added description of new Fortran recognition.
...
... Revision 1.4  85/10/27  19:18:15  mcooper
... Cleaned up table display.
...
... Revision 1.3  85/10/27  14:55:22  mcooper
... Added description of new template feature.
...
... Revision 1.2  85/09/28  14:22:52  mcooper
... Documented new features of checkdir (symbolic
... linking and RCSDIR).
...
... Revision 1.1  85/09/19  15:44:22  mcooper
... Initial revision
...
...
.TH RCSIT 1l
.SH NAME
rcsit \- A program to prepare files for RCS
.SH SYNOPSIS
rcsit
[
.B \-chfsmM
] [
.B \-qad
] [
\-I\fIflags\fR
] [
\-R\fIflags\fR
] [
\-t\fIdirectory\fR
]
.B file
[
.B file1, file2, ...
]
.SH DESCRIPTION
.I Rcsit
is a semi-intelligent program to prepare files for
.I rcs(1).
This
involves putting the correct type of headings at the top of the file so
that
.I rcs(1)
will update a header and log changes in the file.
.PP
By default,
.I rcsit
will use default headers ``hard-wired'' into itself for each different file
type that it ``knows'' about.  (See below for list of known file types).
.PP
If the \-t\fIdirectory\fR option is specified, then
.I rcsit
will use ``.template.suffix'' files
(where ``suffix'' is a suffix that
.I rcsit
``knows'' about)
found in
.I directory.
If a directory name is not specified on the command line, then
the environment variable TEMPLATES is used.
If $TEMPLATES is not set, then the environment varialble, HOME is tried.
.LP
The following template files are recognized:
.sp 2
.in 10
.nf
 Template Name               File Type
 -------------------------------------------
 .template.c                 Standard C
 .template.h                 C Include
 .template.f                 Fortran
 .template.sh                Shell Script
 .template.make              Makefile
 .template.man               Manual
.sp 2
.in -10
.fi
.PP
.I Rcsit
is ``semi-intelligent'' in that it can guess the type of headers to put in
the file by the type of file (C program, C include, makefile, shell script,
or manual).
It determines the file type by looking at the name of the file.
If the name of the file is ``Makefile'' or ``makefile'', then the
file type is taken to be for
.I make(1).
The suffix after the last ``.'' in the file name is then used.
The following table shows the suffixes that
.I rcsit
knows about:
.nf
.sp 2
.in 10
Suffix         File Type
----------------------------------------
c              C Program
h              C Include
f              Fortran
mk             \fIMake(1)\fR file
sh             Shell Script
csh            Shell Script
[1-9]          Manual (digits 1 - 9)
.fi
.PP
If the environement variable ``RCSDIR'' is present, then
.I rcsit
will attempt to make a symbolic link from it to ``RCS'' in
the current directory if the \-\fII\fR option is used and
there is no directory called ``RCS'' already, in the current
directory.
If the \-\fII\fR option is used and ``RCSDIR'' is not specified
in the environment, then a normal directory called ``RCS'' will be
created.
This feature can be overrided with the \-\fId\fR option.
.SH OPTIONS
.TP 10
.B "c"
Force file type to be ``Standard C''.
.TP 10
.B "h"
Force file type to be ``C Include''.
.TP 10
.B "f"
Force file type to be ``Fortran''.
.TP 10
.B "M"
Force file type to be ``Manual''.
Note: If you also specify the ``I\fIflags\fR'' option,
.I rcsit
will run
.I rcs(1)
to tell rcs what kind of comment string to use for the manual file.
.TP 10
.B "s"
Force file type to be ``Shell Script''.
.TP 10
.B "m"
Force file type to be ``Makefile''.  Note that this does the same thing as
the -s option does.  It just prints a different message.
.TP 10
.B "t"
Do not use any Template files for the headers.
.TP 10
.B "q"
Be quiet.  Don't print out what is going on.  Only error messages are
printed.
.TP 10
.B "d"
Do not attempt to make the directory ``RCS''.
See above for more info.
.TP 10
.B "a"
Turn off auto guessing of file type.
.TP 10
.B "I\fIflags\fR"
Check In file.
Run RCS's
.I ci(1)
on the file with ``flags'' being passed onto
.I ci(1)
as the command line arguments.
.TP 10
.B "R\fIflags\fR"
Run
.I rcs(1)
with ``flags'' as the command line arguments.
.SH FILES
/tmp/rcsit*    - temporary buffer
.br
~/.template.*   - template files to use as the header.
.br
.SH AUTHOR
Michael Cooper ([e-mail])
.SH SEE ALSO
ci(1), make(1), rcs(1)
.SH DIAGNOSTICS
Complains about the usual stuff.  (i.e. - the specified file doesn't exist,
or it can't read it...just things like that.)
.SH BUGS
Acts oddly in the presence of beautiful women.