Docs/robohdrs.1

   1 .de EX          \"Begin example
   2 .ne 5
   3 .if n .sp 1
   4 .if t .sp .5
   5 .nf
   6 .in +.5i
   7 ..
   8 .de EE
   9 .fi
  10 .in -.5i
  11 .if n .sp 1
  12 .if t .sp .5
  13 ..
  14 .TH robohdrs "1" "August 2003" "robohdrs 0.02"
  15 .SH NAME
  16 robohdrs \- insert ROBODoc headers to source code.
  17 .SH SYNOPSIS
  18 .B robohdrs
  19 .B [options]
  20 <source file>
  21
  22 .SH DESCRIPTION
  23
  24 robohdrs inserts ROBODoc headers to source code files.  This program
  25 processes one source file at the time. Existing ROBODoc headers, if
  26 any, are not checked for. Beware since this may result in double
  27 headers. Current working directory should be the same as where the
  28 source file is located.
  29
  30 By default NAME and SYNOPSIS items are included in the template
  31 header.
  32
  33 .SH OPTIONS
  34
  35 .IP -h
  36 Show brief help on usage and exit.
  37 .IP -i
  38 Specify an extra header item to be included in template header. Repeat
  39 if multiple extra items are desired.
  40 .IP -l
  41 Specify source code language (default C/C++) Supported options are:
  42 fortran, fortran90, script, and tex.
  43 .IP -p
  44 Specify project name for source file header.
  45 .IP -s
  46 Include SOURCE item.
  47 .IP -t
  48 Specify version control tag to be included in the main header.
  49 .IP -x
  50 Specify path to ctags binary which is used.
  51
  52 .SH EXAMPLES
  53
  54 .EX
  55 robohdrs -s -p myproj -i "MODIFICATION HISTORY" -i IDEAS test.c
  56 .EE
  57
  58 Specifies project name myproj and inserts extra items MODIFICATION
  59 HISTORY, IDEAS, and SOURCE to all template headers (excluding source
  60 file header).
  61
  62 .EX
  63 robohdrs -s -p myproj -l script test.tcl
  64 .EE
  65
  66 Insert headers to a Tcl/Tk script.
  67
  68 .SH COPYRIGHT
  69
  70 Copyright \(co 2003 Frans Slothouber and Petteri Kettunen and Jacco van Weert.
  71 .br
  72 This is free software; see the source for copying conditions.  There is NO
  73 warranty; not even for MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
  74
  75 .SH SEE ALSO
  76
  77 .BR robodoc(1)
  78
  79
  80