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 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214
|
# Description: Make minor tweaks to manpage syntax.
# Author: Kenneth J. Pronovici <pronovic@debian.org>
# Forwarded: https://sourceforge.net/tracker/?func=detail&aid=3027938&group_id=32455&atid=405620
--- a/man/epydoc.1
+++ b/man/epydoc.1
@@ -83,7 +83,7 @@
Directory names specify packages, and are expanded to include
all sub-modules and sub-packages. If you wish to exclude
certain sub-modules or sub-packages, use the
-.B --exclude
+.B \-\-exclude
option (described below).
.\" --config
.TP
@@ -164,7 +164,7 @@
because importing it would cause undesired side-effects.
.\" --introspect-only
.TP
-.BI "\-\-introspect-only"
+.BI "\-\-introspect\-only"
Gather all information about the documented objects by introspection;
in particular, do
.I not
@@ -176,12 +176,12 @@
expression pattern.
.\" --exclude-introspect=PATTERN
.TP
-.BI "\-\-exclude-introspect " PATTERN
+.BI "\-\-exclude\-introspect " PATTERN
Do not use introspection to gather information about any object whose
name matches the given regular expression.
.\" --exclude-parse=PATTERN
.TP
-.BI "\-\-exclude-parse " PATTERN
+.BI "\-\-exclude\-parse " PATTERN
Do not use Python source code parsing to gather information about any
object whose name matches the given regular expression.
.\" --inheritance
@@ -277,12 +277,12 @@
.BI "\-\-help\-file " file
An alternate help file.
.B file
-should contain the body of an HTML file -- navigation bars will be
+should contain the body of an HTML file \-\- navigation bars will be
added to it.
.\" --show-frames, --no-frames
.TP
.B \-\-show\-frames, \-\-no\-frames
-These options control whether HMTL output will include a frames-base
+These options control whether HMTL output will include a frames-based
table of contents page. By default, the frames-based table of
contents is included.
.\" --separate-classes
@@ -319,16 +319,16 @@
executable.
.\"--graph-font
.TP
-.BI "--graph-font " font
+.BI "\-\-graph\-font " font
The name of the font used to generate Graphviz graphs. (e.g.,
helvetica or times).
.\"--graph-font-size
.TP
-.BI "--graph-font-size " size
+.BI "\-\-graph\-font\-size " size
The size of the font used to generate Graphviz graphs, in points.
.\"--pstat
.TP
-.BI "--pstat " file
+.BI "\-\-pstat " file
A pstat output file, to be used in generating call graphs.
.RE
.PP
@@ -394,10 +394,10 @@
.IR module .
This page includes links back to the API documentation pages.
.TP
-.B module-tree.html
+.B module\-tree.html
The module hierarchy.
.TP
-.B class-tree.html
+.B class\-tree.html
The class hierarchy. This page is only generated if at least one
class is documented.
.PP
@@ -405,19 +405,19 @@
.B INDICES
.RS 4
.TP
-.B identifier-index.html
+.B identifier\-index.html
An index of all documented identifiers. If the identifier index
contains more than 3,000 entries, then it will be split into separate
pages for each letter, named
-.BR identifier-index-a.html ,
-.BR identifier-index-b.html ", etc."
+.BR identifier\-index\-a.html ,
+.BR identifier\-index\-b.html ", etc."
.TP
-.B term-index.html
+.B term\-index.html
An index of all explicitly marked definitional terms. This page is
only generated if at least one definition term is marked in a
formatted docstring.
.TP
-.B bug-index.html
+.B bug\-index.html
An index of all explicitly marked
.B @bug
fields. This page is only
@@ -425,7 +425,7 @@
.B @bug
field is listed in a formatted docstring.
.TP
-.B todo-index.html
+.B todo\-index.html
An index of all explicitly marked
.B @todo
fields. This page is only
@@ -433,7 +433,7 @@
.B @todo
field is listed in a formatted docstring.
.TP
-.B changed-index.html
+.B changed\-index.html
An index of all explicitly marked
.B @changed
fields. This page is only
@@ -441,7 +441,7 @@
.B @changed
field is listed in a formatted docstring.
.TP
-.B deprecated-index.html
+.B deprecated\-index.html
An index of all explicitly marked
.B @deprecated
fields. This page is only
@@ -449,7 +449,7 @@
.B @deprecated
field is listed in a formatted docstring.
.TP
-.B since-index.html
+.B since\-index.html
An index of all explicitly marked
.B @since
fields. This page is only
@@ -509,7 +509,7 @@
loading the page
.B <redirect.html#epydoc.apidoc.DottedName>
will automatically redirect the browser to
-.BR <epydoc.apidoc-module.html#DottedName> .
+.BR <epydoc.apidoc\-module.html#DottedName> .
.TP
.B epydoc.css
The CSS stylesheet used to display all HTML pages.
@@ -556,14 +556,14 @@
.B \-\-pdf
option.
.TP
-.IB module -module.tex
+.IB module \-module.tex
The API documentation for a module.
.I module
is the complete dotted name of the module, such as
.B sys or
.BR epydoc.epytext .
.TP
-.IB class -class.tex
+.IB class \-class.tex
The API documentation for a class, exception, or type.
.I class
is the complete dotted name of the class, such as
@@ -651,7 +651,7 @@
.B Wrong underline character for heading.
The underline character used for this section heading does not
indicate an appopriate section level. The "=" character should be
-used to underline sections; "-" for subsections; and "~" for
+used to underline sections; "\-" for subsections; and "~" for
subsubsections.
.TP
.B Possible mal-formatted field item.
--- a/man/epydocgui.1
+++ b/man/epydocgui.1
@@ -77,7 +77,7 @@
.B index.html
will redirect the user to the project's top page.
.TP
-.BI m- module .html
+.BI m\-module.html
The API documentation for a module.
.I module
is the complete dotted name of the module, such as
@@ -85,9 +85,9 @@
or
.BR epydoc.epytext .
.TP
-.BI c- class .html
+.BI c\-class.html
The API documentation for a class, exception, or type.
-.I class
+.I "c"
is the complete dotted name of the class, such as
.B epydoc.epytext.Token
or
@@ -269,7 +269,7 @@
.B Wrong underline character for heading.
The underline character used for this section heading does not
indicate an appopriate section level. The "=" character should be
-used to underline sections; "-" for subsections; and "~" for
+used to underline sections; "\-" for subsections; and "~" for
subsubsections.
.RE
.PP
|