diff options
| -rw-r--r-- | docutils/HISTORY.txt | 4 | ||||
| -rw-r--r-- | docutils/docutils/writers/manpage.py | 2 | ||||
| -rw-r--r-- | docutils/test/functional/expected/standalone_rst_manpage.man | 4 | ||||
| -rw-r--r-- | docutils/test/test_writers/test_manpage.py | 6 | ||||
| -rw-r--r-- | sandbox/manpage-writer/expected/man-de.1.man | 26 | ||||
| -rw-r--r-- | sandbox/manpage-writer/expected/optionslisttest.man | 8 | ||||
| -rw-r--r-- | sandbox/manpage-writer/expected/optionstoo.man | 2 | ||||
| -rw-r--r-- | sandbox/manpage-writer/expected/test.man | 4 |
8 files changed, 30 insertions, 26 deletions
diff --git a/docutils/HISTORY.txt b/docutils/HISTORY.txt index 5adbfd60a..b2aa12ca1 100644 --- a/docutils/HISTORY.txt +++ b/docutils/HISTORY.txt @@ -61,6 +61,10 @@ Changes Since 0.16 __ docs/user/latex.html#classes +* docutils/writers/manpage.py + + - [ Fix #380 ] commandline option problem in sphinx. + .. _pip: https://pypi.org/project/pip/ .. _legacy_class_functions: docs/user/config.html#legacy-class-functions diff --git a/docutils/docutils/writers/manpage.py b/docutils/docutils/writers/manpage.py index cd7bf73b0..035a479ca 100644 --- a/docutils/docutils/writers/manpage.py +++ b/docutils/docutils/writers/manpage.py @@ -900,7 +900,7 @@ class Translator(nodes.NodeVisitor): # options with parameter bold italic, .BI, -f file # # we do not know if .B or .BI - self.context.append('.B') # blind guess + self.context.append('.B ') # blind guess. Add blank for spinx see docutils/bugs/380 self.context.append(len(self.body)) # to be able to insert later self.context.append(0) # option counter diff --git a/docutils/test/functional/expected/standalone_rst_manpage.man b/docutils/test/functional/expected/standalone_rst_manpage.man index fbc9272eb..4bf8d28c3 100644 --- a/docutils/test/functional/expected/standalone_rst_manpage.man +++ b/docutils/test/functional/expected/standalone_rst_manpage.man @@ -67,10 +67,10 @@ docinfo, see this document as an example. .BI \-\-config\fB= <file> Read configuration settings from <file>, if it exists. .TP -.B \-\-version\fP,\fB \-V +.B \-\-version\fP,\fB \-V Show this program\(aqs version number and exit. .TP -.B \-\-help\fP,\fB \-h +.B \-\-help\fP,\fB \-h Show this help message and exit. .UNINDENT .sp diff --git a/docutils/test/test_writers/test_manpage.py b/docutils/test/test_writers/test_manpage.py index f0adec7e8..53b42cc6f 100644 --- a/docutils/test/test_writers/test_manpage.py +++ b/docutils/test/test_writers/test_manpage.py @@ -171,10 +171,10 @@ General rule of life. .BI \-\-config\fB= <file> Read configuration settings from <file>, if it exists. .TP -.B \-\-version\fP,\fB \-V +.B \-\-version\fP,\fB \-V Show this program\(aqs version number and exit. .TP -.B \-\-help\fP,\fB \-h +.B \-\-help\fP,\fB \-h Show this help message and exit. .UNINDENT .SH OTHER SECTION @@ -381,7 +381,7 @@ r""".INDENT 0.0 .B optional arguments: .INDENT 7.0 .TP -.B \-h\fP,\fB \-\-help +.B \-h\fP,\fB \-\-help show this help .TP .BI \-\-output \ FILE\fR,\fB \ \-o \ FILE diff --git a/sandbox/manpage-writer/expected/man-de.1.man b/sandbox/manpage-writer/expected/man-de.1.man index e668a7719..00f44569a 100644 --- a/sandbox/manpage-writer/expected/man-de.1.man +++ b/sandbox/manpage-writer/expected/man-de.1.man @@ -363,7 +363,7 @@ beiden doppelt vorkommt , ist nicht schaedlich. Fuer Optionen, die ein Argument benötigen, überschreibt jedes Duplikat den vorhergehenden Wert. .INDENT 0.0 .TP -.B \-l\fP,\fB \-\-local\-file +.B \-l\fP,\fB \-\-local\-file Aktiviert den lokalen Modus. Formatiert und zeigt lokale Manualdateien an, anstatt die System\-Manualsammlung zu durchsuchen. Jedes Manualseiten\-Argument wird als nroff\-Quelle im richtigen @@ -384,7 +384,7 @@ den. Man beachte, dass dieser Effekt erst beim konkreten Suchen der Seite in Erscheinung tritt. Daher werden Ausgaben wie die Hilfeseite immer in der urspruenglichen Sprache ausgegeben. .TP -.B \-D\fP,\fB \-\-default +.B \-D\fP,\fB \-\-default Diese Option wird normalerweise nur als allererste angegeben und setzt das Verhalten von man in allen Belangen wieder zum Nor\- malverhalten zurueck. Der Zweck dieser Option ist es, Optionen @@ -452,18 +452,18 @@ definiert bei Benutzung dieser Option die Reihenfolge, in der die Abschnitte durchsucht werden. Diese Option ueberschreibt die Umgebungsvariable $MANSECT. .TP -.B \-a\fP,\fB \-\-all +.B \-a\fP,\fB \-\-all Wird eine Manualseite in einem Abschnitt gefunden, so terminiert man nach Anzeige dieser Seite. Wird jedoch diese Option angegeben, so werden alle passenden Manualseiten nacheinander angezeigt. .TP -.B \-c\fP,\fB \-\-catman +.B \-c\fP,\fB \-\-catman Diese Option ueberprueft nur, ob die zur angegebenen Manualseite passende cat\-Seite aktuell ist und erzeugt ggf. eine neue. Es wird dabei nichts angezeigt. .TP -.B \-d\fP,\fB \-\-debug +.B \-d\fP,\fB \-\-debug Bei dieser Option werden keine Manualseiten angezeigt, sondern nur eine Menge von Diagnoseinformation. .TP @@ -485,14 +485,14 @@ Suche auf Seiten mit der Erweiterung \fB*tcl\fP, wenn es mit \fB\-e tcl\fP aufgerufen wurde. Die Suche wird dabei in allen Abschnitten durchgeführt. .TP -.B \-f\fP,\fB \-\-whatis +.B \-f\fP,\fB \-\-whatis Diese Option ist das AEquivalent zu whatis. Es wird eine Kurzbeschreibung der gewuenschten Manualseite angezeigt, wenn sie gefunden wurde. Zu Details siehe whatis(1). Mit dieser Option ist nur eine Standardsuche moeglich. Verbesserte Such\- moeglichkeiten bieten die Optionen von whatis. .TP -.B \-k\fP,\fB \-\-apropos +.B \-k\fP,\fB \-\-apropos Diese Option ist das AEquivalent zu apropos. Es werden die Kurzbeschreibungen zu allen Manualseiten nach dem angegebenen Stichwort durchsucht. Zu Details siehe apropos(1). Mit dieser @@ -524,7 +524,7 @@ refer (r). Diese Option ueberschreibt die Umgebungsvariable $MANROFFSEQ. Der Praeprozessor zsoelim wird immer als erster gestartet. .TP -.B \-u\fP,\fB \-\-update +.B \-u\fP,\fB \-\-update Die Indexdatenbanken werden immer waehrend des laufenden Betriebes auf neuestem Stand gehalten, was insbesondere bedeutet, dass mandb nicht benoetigt wird, um sie konsistent zu @@ -536,7 +536,7 @@ seiten im Dateisystem darstellt. Wenn dieser Test auf Inode\- Ebene durchgefuehrt werden soll, muss man die Option \-u benutzen. .TP -.B \-t\fP,\fB \-\-troff +.B \-t\fP,\fB \-\-troff Mit dieser Option wird groff \-mandoc verwendet, um die Manual\- seite zu formatieren und an die Standardausgabe zu liefern. Im Zusammenhang mit \-T oder \-Z ist diese Option nicht noetig. @@ -551,7 +551,7 @@ beinhalten dvi, latin1, ps, utf8, X75 und X100. .UNINDENT .INDENT 0.0 .TP -.B \-Z\fP,\fB \-\-ditroff +.B \-Z\fP,\fB \-\-ditroff Das traditionelle troff erzeugt ditroff. groff startet zunaechst troff und leitet danach dessen Ausgabe an einen fuer das gewaehlte Ausgabeformat geeigneten Postprozessor weiter. @@ -559,16 +559,16 @@ Wenn groff \-mandoc groff ist, zwingt diese Option groff dazu, traditionelles troff zu emulieren und impliziert \-t, andernfalls wird es ignoriert. .TP -.B \-w\fP,\fB \-\-where\fP,\fB \-\-location +.B \-w\fP,\fB \-\-where\fP,\fB \-\-location Zeigt nicht die Manualseiten, sondern die Position der Dateien im Dateisystem an, die formatiert oder angezeigt wuerden. Wenn die Datei eine cat\-Seite ist, wird auch der Ort ihrer nroff\- Quelldatei angezeigt. .TP -.B \-h\fP,\fB \-\-help +.B \-h\fP,\fB \-\-help Zeigt einen Hilfstext an. .TP -.B \-V\fP,\fB \-\-version +.B \-V\fP,\fB \-\-version Zeigt Programmversion und Autor an. .UNINDENT .SH UMGEBUNG diff --git a/sandbox/manpage-writer/expected/optionslisttest.man b/sandbox/manpage-writer/expected/optionslisttest.man index 4eccd222e..aa5577568 100644 --- a/sandbox/manpage-writer/expected/optionslisttest.man +++ b/sandbox/manpage-writer/expected/optionslisttest.man @@ -52,7 +52,7 @@ This line must be in indented. .BI \-o \ x an option .TP -.B \-b +.B \-b another .sp This option does the following points: @@ -65,7 +65,7 @@ second point .INDENT 3.5 .INDENT 0.0 .TP -.B \-\-ccc +.B \-\-ccc option lists may be nested, even if this is rarely used. .UNINDENT @@ -73,7 +73,7 @@ used. .UNINDENT .UNINDENT .TP -.B \-k +.B \-k and even another .sp This option does the following points: @@ -92,7 +92,7 @@ For all other options see \fB\-\-help\fP\&. This line must be intented. .BI \-o \ x an option .TP -.B \-b +.B \-b another .TP .BI \-m \ MESSAGE\fR,\fB \ \-\-message\fB= MESSAGE diff --git a/sandbox/manpage-writer/expected/optionstoo.man b/sandbox/manpage-writer/expected/optionstoo.man index c4e6dea52..0d0d2dcbb 100644 --- a/sandbox/manpage-writer/expected/optionstoo.man +++ b/sandbox/manpage-writer/expected/optionstoo.man @@ -56,7 +56,7 @@ install install help .B optional arguments: .INDENT 7.0 .TP -.B \-h\fP,\fB \-\-help +.B \-h\fP,\fB \-\-help show this help message and exit .TP .BI \-\-general \ GENERAL\fR,\fB \ \-G \ GENERAL diff --git a/sandbox/manpage-writer/expected/test.man b/sandbox/manpage-writer/expected/test.man index 1e4ebc047..fd526b5fe 100644 --- a/sandbox/manpage-writer/expected/test.man +++ b/sandbox/manpage-writer/expected/test.man @@ -46,10 +46,10 @@ Run it and examine output. .BI \-o \ x an option .TP -.B \-b +.B \-b another .TP -.B \-f\fP,\fB \-\-force +.B \-f\fP,\fB \-\-force really do it .UNINDENT .sp |