home *** CD-ROM | disk | FTP | other *** search
/ Usenet 1994 January / usenetsourcesnewsgroupsinfomagicjanuary1994.iso / sources / unix / volume4 / rcsit2 / rcsit.1 < prev    next >
Encoding:
Text File  |  1986-11-30  |  4.9 KB  |  203 lines

  1. ...
  2. ... $Header: rcsit.1,v 1.12 86/03/27 14:05:08 mcooper Exp $
  3. ... 
  4. ... $Log:    rcsit.1,v $
  5. ... Revision 1.12  86/03/27  14:05:08  mcooper
  6. ... fixed syntax errors.
  7. ... 
  8. ... Revision 1.11  86/03/12  14:11:05  mcooper
  9. ... *** empty log message ***
  10. ... 
  11. ... Revision 1.10  86/02/03  14:23:07  mcooper
  12. ... Added description of ``Pascal'' types.
  13. ... Cleaned up table displays.
  14. ... Deleted most of the log messages.
  15. ... 
  16. ... Revision 1.9  85/12/19  14:22:41  mcooper
  17. ... Added updates from Joe Chapman for TeX.
  18. ... 
  19. ... Revision 1.8  85/12/16  17:33:33  mcooper
  20. ... Changed .template.* --> .header.*
  21. ... More appropriate name.
  22. ... 
  23. ...
  24. .TH RCSIT 1l
  25. .SH NAME
  26. rcsit \- A program to prepare files for RCS
  27. .SH SYNOPSIS
  28. rcsit
  29. [
  30. .B \-chfsmMxp
  31. ] [
  32. .B \-qad
  33. ] [
  34. \-I\fIflags\fR
  35. ] [
  36. \-R\fIflags\fR
  37. ] [
  38. \-H\fIdirectory\fR
  39. ] [
  40. \-F\fIheader-file\fR
  41. ]
  42. .B file
  43. [
  44. .B file1 file2 ...
  45. ]
  46. .SH DESCRIPTION
  47. .I Rcsit
  48. is a semi-intelligent program to prepare files for 
  49. .I rcs(1).
  50. This
  51. involves putting the correct type of headings at the top of the file so
  52. that 
  53. .I rcs(1)
  54. will update a header and log changes in the file.
  55. .PP 
  56. By default, 
  57. .I rcsit
  58. will use default headers ``hard-wired'' into itself for each different file
  59. type that it ``knows'' about.  (See below for list of known file types).
  60. .PP
  61. If the \-H\fIdirectory\fR option is specified, then
  62. .I rcsit
  63. will use ``.header.suffix'' files
  64. (where ``suffix'' is a suffix that 
  65. .I rcsit
  66. ``knows'' about)
  67. found in 
  68. .I directory.
  69. If a directory name is not specified on the command line, then
  70. the environment variable TEMPLATES is used.
  71. If TEMPLATES is not set, then the environment varialble, HOME is tried.
  72. .LP
  73. The following template files are recognized:
  74. .sp
  75. .DS
  76.  Template Name             File Type
  77.  -------------------------------------------
  78.  .header.c                 Standard C
  79.  .header.h                 C Include
  80.  .header.f                 Fortran
  81.  .header.sh                Shell Script
  82.  .header.make              Makefile
  83.  .header.man               Manual
  84.  .header.p                 Pascal
  85.  .header.tex               TeX
  86. .DE
  87. .PP
  88. .I Rcsit
  89. is ``semi-intelligent'' in that it can guess the type of headers to put in
  90. the file by the type of file (C program, C include, makefile, shell script,
  91. or manual).
  92. It determines the file type by looking at the name of the file.
  93. If the name of the file is ``Makefile'' or ``makefile'', then the
  94. file type is taken to be for 
  95. .I make(1).
  96. The suffix after the last ``.'' in the file name is then used.
  97. The following table shows the suffixes that 
  98. .I rcsit
  99. knows about:
  100. .sp
  101. .DS
  102.  Suffix         File Type
  103.  ----------------------------------------
  104.  c              C Program
  105.  h              C Include
  106.  f              Fortran
  107.  mk             \fIMake(1)\fR file
  108.  sh             Shell Script
  109.  csh            Shell Script
  110.  [1-9]          Manual (digits 1 - 9)
  111.  p              Pascal
  112.  tex            TeX
  113. .DE
  114. .PP
  115. If the environment variable ``RCSDIR'' is present, then 
  116. .I rcsit
  117. will attempt to make a symbolic link from it to ``RCS'' in
  118. the current directory if the \-\fII\fR option is used and
  119. there is no directory called ``RCS'' already, in the current
  120. directory.  
  121. If the \-\fII\fR option is used and ``RCSDIR'' is not specified
  122. in the environment, then a normal directory called ``RCS'' will be
  123. created.
  124. This feature can be overrided with the \-\fId\fR option.
  125. .SH OPTIONS
  126. .TP 10
  127. .B "c"
  128. Force file type to be ``Standard C''.
  129. .TP 10
  130. .B "h"
  131. Force file type to be ``C Include''.
  132. .TP 10
  133. .B "f"
  134. Force file type to be ``Fortran''.
  135. .TP 10
  136. .B "M"
  137. Force file type to be ``Manual''.
  138. Note: If you also specify the ``I\fIflags\fR'' option,
  139. .I rcsit
  140. will run 
  141. .I rcs(1)
  142. to tell rcs what kind of comment string to use for the manual file.
  143. .TP 10
  144. .B "s"
  145. Force file type to be ``Shell Script''.
  146. .TP 10
  147. .B "m"
  148. Force file type to be ``Makefile''.  Note that this does the same thing as
  149. the -s option does.  It just prints a different message.
  150. .TP 10
  151. .B "p"
  152. Force file type to be ``Pascal''.
  153. .TP 10
  154. .B "x"
  155. Force file type to be ``TeX''.
  156. .TP 10
  157. .B "F\fIheader-file\fR"
  158. Use
  159. .I header-file
  160. as the header file.  (i.e. This file
  161. is prepended to each of the files to be processed.)
  162. .TP 10
  163. .B "t"
  164. Do not use any Template files for the headers.
  165. .TP 10
  166. .B "q"
  167. Be quiet.  Don't print out what is going on.  Only error messages are
  168. printed.
  169. .TP 10
  170. .B "d"
  171. Do not attempt to make the directory ``RCS''.
  172. See above for more info.
  173. .TP 10
  174. .B "a"
  175. Turn off auto guessing of file type.
  176. .TP 10
  177. .B "I\fIflags\fR"
  178. Check In file.
  179. Run RCS's 
  180. .I ci(1)
  181. on the file with ``flags'' being passed onto 
  182. .I ci(1) 
  183. as the command line arguments.
  184. .TP 10
  185. .B "R\fIflags\fR"
  186. Run 
  187. .I rcs(1)
  188. with ``flags'' as the command line arguments.
  189. .SH FILES
  190. /tmp/rcsit*    - temporary buffer
  191. .br
  192. ~/.header.*   - template files to use as the header.
  193. .br
  194. .SH AUTHOR
  195. Michael Cooper (mcooper@usc-oberon.ARPA)
  196. .SH SEE ALSO
  197. ci(1), make(1), rcs(1)
  198. .SH DIAGNOSTICS
  199. Complains about the usual stuff.  (i.e. - the specified file doesn't exist,
  200. or it can't read it...just things like that.)
  201. .SH BUGS
  202. Acts oddly in the presence of beautiful women.
  203.