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
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
|
Escape dashes with backslashes and correct manpage date.
Submitted to upstream on 2010-07-07:
<http://sourceforge.net/tracker/?func=detail&atid=307245&aid=3026389&group_id=7245>
--- a/Docs/robodoc.1.in
+++ b/Docs/robodoc.1.in
@@ -18,9 +18,9 @@
.SH SYNOPSIS
.B robodoc
-.I --src
+.I \-\-src
<source>
-.I --doc
+.I \-\-doc
<destination>
.B [options]
@@ -32,46 +32,46 @@
.SH OPTIONS
-.IP -c
+.IP \-c
Show the copyright message.
-.IP --version
+.IP \-\-version
Print version information and exit.
-.IP --doc
+.IP \-\-doc
Define the documentation directory or documentation file.
A directory should start with a '/' or a './' and
should not include any '..'.
-.IP --src
+.IP \-\-src
Define the source directory or source file. A directory should start
with a '/' or a './' and should not include any '..'.
-.IP --ascii
+.IP \-\-ascii
Generate documentation in ASCII format.
-.IP --html
+.IP \-\-html
Generate documentation in HTML format.
-.IP --dbxml
+.IP \-\-dbxml
Generate documentation in XML DocBook format.
-.IP --latex
+.IP \-\-latex
Generate documentation in LaTeX format.
-.IP --rtf
+.IP \-\-rtf
Generate documentation in RTF format.
-.IP --index
+.IP \-\-index
Create an additional master index file.
-.IP --multidoc
-Store all documentation in seperate files.
+.IP \-\-multidoc
+Store all documentation in separate files.
-.IP --singledoc
+.IP \-\-singledoc
Store all documentation in a single file.
-.IP --singlefile
+.IP \-\-singlefile
Generate a single document from a single file
.EE
@@ -81,25 +81,25 @@
.SH EXAMPLES
.EX
-robodoc --src ./ --doc myproject --singledoc --html
+robodoc \-\-src ./ \-\-doc myproject \-\-singledoc \-\-html
.EE
Creates a document called myproject.html from all source files
in the current directory.
.EX
-robodoc --src ./myproject/
- --doc ./myprojectdoc --multidoc --html --index
+robodoc \-\-src ./myproject/
+ \-\-doc ./myprojectdoc \-\-multidoc \-\-html \-\-index
.EE
-Creates seperate documents for all the source files found in
+Creates separate documents for all the source files found in
the directory ./myproject they are stored in the directory ./myprojectdoc.
A master index file called ./myprojectdoc/masterindex.html is also
created. This provides links to all the individual files.
.SH COPYRIGHT
-Copyright \(co 1994-2008 Frans Slothouber, Petteri Kettunen, Gergely Budai
+Copyright \(co 1994\(hy2008 Frans Slothouber, Petteri Kettunen, Gergely Budai
and Jacco van Weert.
.br
--- a/Docs/robohdrs.1.in
+++ b/Docs/robohdrs.1.in
@@ -32,27 +32,27 @@
.SH OPTIONS
-.IP -h
+.IP \-h
Show brief help on usage and exit.
-.IP -i
+.IP \-i
Specify an extra header item to be included in template header. Repeat
if multiple extra items are desired.
-.IP -l
+.IP \-l
Specify source code language (default C/C++) Supported options are:
fortran, fortran90, script, and tex.
-.IP -p
+.IP \-p
Specify project name for source file header.
-.IP -s
+.IP \-s
Include SOURCE item.
-.IP -t
+.IP \-t
Specify version control tag to be included in the main header.
-.IP -x
+.IP \-x
Specify path to ctags binary which is used.
.SH EXAMPLES
.EX
-robohdrs -s -p myproj -i "MODIFICATION HISTORY" -i IDEAS test.c
+robohdrs \-s \-p myproj \-i "MODIFICATION HISTORY" \-i IDEAS test.c
.EE
Specifies project name myproj and inserts extra items MODIFICATION
@@ -60,7 +60,7 @@
file header).
.EX
-robohdrs -s -p myproj -l script test.tcl
+robohdrs \-s \-p myproj \-l script test.tcl
.EE
Insert headers to a Tcl/Tk script.
|
