Skip to content

Commit 3620666

Browse files
committed
Manpage formatting tweaks
Following on from GH-132291 this is the second part of the patch from https://bugs.debian.org/1101406 This tweaks the formatting of a few bits of the manpage.
1 parent 1c598e0 commit 3620666

1 file changed

Lines changed: 19 additions & 17 deletions

File tree

Misc/python.man

Lines changed: 19 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -162,7 +162,7 @@ compilation options).
162162
Ignore environment variables like PYTHONPATH and PYTHONHOME that modify
163163
the behavior of the interpreter.
164164
.TP
165-
.B \-h ", " \-? ", "\-\-help
165+
.BR \-h ", " \-? ", " \-\-help
166166
Prints the usage for the interpreter executable and exits.
167167
.TP
168168
.B "\-\-help\-env"
@@ -171,7 +171,6 @@ Prints help about Python-specific environment variables and exits.
171171
.B "\-\-help\-xoptions"
172172
Prints help about implementation-specific \fB\-X\fP options and exits.
173173
.TP
174-
.TP
175174
.B "\-\-help\-all"
176175
Prints complete usage information and exits.
177176
.TP
@@ -243,7 +242,7 @@ twice, print a message for each file that is checked for when
243242
searching for a module. Also provides information on module cleanup
244243
at exit.
245244
.TP
246-
.B \-V ", " \-\-version
245+
.BR \-V ", " \-\-version
247246
Prints the Python version number of the executable and exits. When given
248247
twice, print more information about the build.
249248

@@ -256,22 +255,24 @@ to
256255
The simplest settings apply a particular action unconditionally to all warnings
257256
emitted by a process (even those that are otherwise ignored by default):
258257

259-
-Wdefault # Warn once per call location
260-
-Werror # Convert to exceptions
261-
-Walways # Warn every time
262-
-Wall # Same as -Walways
263-
-Wmodule # Warn once per calling module
264-
-Wonce # Warn once per Python process
265-
-Wignore # Never warn
258+
.nf
259+
\-Wdefault # Warn once per call location
260+
\-Werror # Convert to exceptions
261+
\-Walways # Warn every time
262+
\-Wall # Same as \-Walways
263+
\-Wmodule # Warn once per calling module
264+
\-Wonce # Warn once per Python process
265+
\-Wignore # Never warn
266+
.fi
266267

267268
The action names can be abbreviated as desired and the interpreter will resolve
268269
them to the appropriate action name. For example,
269270
.B \-Wi
270271
is the same as
271-
.B \-Wignore .
272+
.BR \-Wignore .
272273

273274
The full form of argument is:
274-
.IB action:message:category:module:lineno
275+
.IB action : message : category : module : lineno
275276

276277
Empty fields match all values; trailing empty fields may be omitted. For
277278
example
@@ -320,7 +321,7 @@ a regular expression on the warning message.
320321
.TP
321322
.BI "\-X " option
322323
Set implementation-specific option. The following options are available:
323-
324+
.nf
324325
\fB\-X cpu_count=\fIN\fR: override the return value of \fIos.cpu_count()\fR;
325326
\fB\-X cpu_count=default\fR cancels overriding; also \fBPYTHON_CPU_COUNT\fI
326327

@@ -395,6 +396,7 @@ Set implementation-specific option. The following options are available:
395396
automatically). See \fBPYTHONUTF8\fR for more details
396397

397398
\fB\-X warn_default_encoding\fR: enable opt-in EncodingWarning for 'encoding=None'
399+
.fi
398400

399401
.TP
400402
.B \-x
@@ -434,7 +436,7 @@ is an empty string; if
434436
is used,
435437
.I sys.argv[0]
436438
contains the string
437-
.I '\-c'.
439+
.RI ' \-c "' ."
438440
Note that options interpreted by the Python interpreter itself
439441
are not placed in
440442
.IR sys.argv .
@@ -561,8 +563,8 @@ purpose is to allow repeatable hashing, such as for selftests for the
561563
interpreter itself, or to allow a cluster of python processes to share hash
562564
values.
563565

564-
The integer must be a decimal number in the range [0,4294967295]. Specifying
565-
the value 0 will disable hash randomization.
566+
The integer must be a decimal number in the range [0,4\|294\|967\|295].
567+
Specifying the value 0 will disable hash randomization.
566568
.IP PYTHONHOME
567569
Change the location of the standard Python libraries. By default, the
568570
libraries are searched in ${prefix}/lib/python<version> and
@@ -584,7 +586,7 @@ This is equivalent to the \fB\-X int_max_str_digits=\fINUMBER\fR option.
584586
.IP PYTHONIOENCODING
585587
If this is set before running the interpreter, it overrides the encoding used
586588
for stdin/stdout/stderr, in the syntax
587-
.IB encodingname ":" errorhandler
589+
.IB encodingname : errorhandler
588590
The
589591
.IB errorhandler
590592
part is optional and has the same meaning as in str.encode. For stderr, the

0 commit comments

Comments
 (0)