1robohdrs(1)                 General Commands Manual                robohdrs(1)
2
3
4

NAME

6       robohdrs - insert ROBODoc headers to source code.
7

SYNOPSIS

9       robohdrs [options] <source file>
10
11

DESCRIPTION

13       robohdrs  inserts  ROBODoc  headers to source code files.  This program
14       processes one source file at the time.  Existing  ROBODoc  headers,  if
15       any,  are not checked for. Beware since this may result in double head‐
16       ers. Current working directory should be the same as where  the  source
17       file is located.
18
19       By default NAME and SYNOPSIS items are included in the template header.
20
21

OPTIONS

23       -h     Show brief help on usage and exit.
24
25       -i     Specify  an extra header item to be included in template header.
26              Repeat if multiple extra items are desired.
27
28       -l     Specify source code language (default C/C++)  Supported  options
29              are: fortran, fortran90, script, and tex.
30
31       -p     Specify project name for source file header.
32
33       -s     Include SOURCE item.
34
35       -t     Specify version control tag to be included in the main header.
36
37       -x     Specify path to ctags binary which is used.
38
39

EXAMPLES

41       robohdrs -s -p myproj -i "MODIFICATION HISTORY" -i IDEAS test.c
42
43       Specifies project name myproj and inserts extra items MODIFICATION HIS‐
44       TORY, IDEAS, and SOURCE to all template headers (excluding source  file
45       header).
46
47       robohdrs -s -p myproj -l script test.tcl
48
49       Insert headers to a Tcl/Tk script.
50
51

53       Copyright  ©  2003  Frans Slothouber and Petteri Kettunen and Jacco van
54       Weert.
55       This is free software; see the source for copying conditions.  There is
56       NO  warranty;  not even for MERCHANTABILITY or FITNESS FOR A PARTICULAR
57       PURPOSE.
58
59

SEE ALSO

61       robodoc(1)
62
63
64
65
66
67
68robohdrs 0.01                     August 2003                      robohdrs(1)
Impressum