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