.ig
 Copyright (C) 1993,1994 by the author(s).
 
 This software is published in the hope that it will be useful, but
 WITHOUT ANY WARRANTY for any part of this software to work correctly
 or as described in the manuals. See the ShapeTools Public License
 for details.

 Permission is granted to use, copy, modify, or distribute any part of
 this software but only under the conditions described in the ShapeTools 
 Public License. A copy of this license is supposed to have been given
 to you along with ShapeTools in a file named LICENSE. Among other
 things, this copyright notice and the Public License must be
 preserved on all copies.


Authors: Michael Cooper (mcooper@usc-oberon.ARPA)
         Axel Mahler (Axel.Mahler@cs.tu-berlin.de)

$Header: atfsit.1[4.0] Tue Jun 29 16:29:16 1993 andy@cs.tu-berlin.de frozen $
..
.TH atfsit 1 "Tue Jun 29 16:29:16 1993" "atfsit-1.15" "ShapeTools"
.SH NAME
atfsit \- A program to prepare files for version control
.SH SYNOPSIS
atfsit
[
.B \-cFhfsmM
] [
.B \-qad
] [
\fB-I\fP\fIflags\fP
] [
\fB-R\fP\fIflags\fP
] [
\fB-t\fP\fIdirectory\fP
] file1 ...
.SH DESCRIPTION
.I Atfsit
is a semi-intelligent program to prepare files for 
.I ShapeTools version control.
This
involves putting the correct type of headings at the top of the file so
that 
.I retrv
will update a header and log changes in the file.
.PP 
By default, 
.I atfsit
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\fP option is specified, then
.I atfsit
will use ``.template.suffix'' files
(where ``suffix'' is a suffix that 
.I atfsit
``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 variable, HOME is tried.
.LP
The following template files are recognized:
.sp 2
.ta 2c 5c
.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
.fi
.sp 2
.PP
.I Atfsit
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 atfsit
knows about:
.nf
.sp 2
.ta 2c 5c
	Suffix	File Type
	---------------------------------------------
	c	C Program
	F	C Program (with compile flags)
	h	C Include
	f	Fortran
	mk	\fIMake(1)\fP file
	sh	Shell Script
	csh	Shell Script
	[1-9]	Manual (digits 1 - 9)
.fi
.PP
If the environment variable ``ATFSDIR'' is present, then 
.I atfsit
will attempt to make a link from it to ``AtFS'' in
the current directory if the \-\fII\fP option is used and
there is no directory called ``AtFS'' already, in the current
directory.  
If the \-\fII\fP option is used and ``ATFSDIR'' is not specified
in the environment, then a normal directory called ``AtFS'' will be
created.
This feature can be overrided with the \-\fId\fP option.
.SH OPTIONS
.TP 10
.B "c"
Force file type to be ``Standard C''.
.TP 10
.B "F"
Force file type to be ``Standard C''. Add a special header-line for
recording of compile-time options in addition to the default header.
The inserted line has the form \fCstatic char *ConfFlg = CFFLGS\fP.
CFFLGS must be a string value. As it is very inconvenient, to define
the proper value of CFFLGS from the command-line, this feature is 
more intended to be used from within Makefiles.
.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\fP'' option,
.I atfsit
will run 
.I vadm(1)
to tell ShapeTools 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 ``AtFS''.
See above for more info.
.TP 10
.B "a"
Turn off auto guessing of file type.
.TP 10
.B "I\fIflags\fP"
Check In file.
Run 
.I save(1)
on the file with ``flags'' being passed onto 
.I save(1) 
as the command line arguments.
.TP 10
.B "R\fIflags\fP"
Run 
.I vadm(1)
with ``flags'' as the command line arguments.
.SH FILES
/tmp/atfsit*	- temporary buffer
.br
~/.template.*   - template files to use as the header.
.br
.SH AUTHOR
Michael Cooper (mcooper@usc-oberon.ARPA)
.br
Modified for use with \fIShapeTools\fP by Axel.Mahler@cs.tu-berlin.de
.SH SEE ALSO
save(1), vadm(1), retrv(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.)