Package: python3.13-minimal
Version: 3.13.2-2
Severity: minor
Tags: patch
* What led up to the situation?
Checking for defects with a new version
test-[g|n]roff -mandoc -t -K utf8 -rF0 -rHY=0 -rCHECKSTYLE=10 -ww -z < "man
page"
[Use "grep -e ' $' -e '\\~$' <file>" to find obvious trailing spaces.]
["test-groff" is a script in the repository for "groff"; is not shipped]
(local copy and "troff" slightly changed by me).
[The fate of "test-nroff" was decided in groff bug #55941.]
* What was the outcome of this action?
an.tmac:<stdin>:1: style: .TH missing third argument; consider document
modification date in ISO 8601 format (YYYY-MM-DD)
an.tmac:<stdin>:1: style: .TH missing fourth argument; consider package/project
name and version (e.g., "groff 1.23.0")
an.tmac:<stdin>:32: style: 7 leading space(s) on input line
an.tmac:<stdin>:61: style: 7 leading space(s) on input line
an.tmac:<stdin>:82: style: 7 leading space(s) on input line
an.tmac:<stdin>:91: style: 7 leading space(s) on input line
an.tmac:<stdin>:104: style: 7 leading space(s) on input line
an.tmac:<stdin>:174: warning: cannot nest .TP or .TQ inside .TP; supply a tag
an.tmac:<stdin>:259: style: 2 leading space(s) on input line
an.tmac:<stdin>:260: style: 2 leading space(s) on input line
an.tmac:<stdin>:261: style: 2 leading space(s) on input line
an.tmac:<stdin>:262: style: 2 leading space(s) on input line
an.tmac:<stdin>:263: style: 2 leading space(s) on input line
an.tmac:<stdin>:264: style: 2 leading space(s) on input line
an.tmac:<stdin>:265: style: 2 leading space(s) on input line
an.tmac:<stdin>:274: misuse, warning: .IB is for at least 2 arguments, got 1
Use macro '.I' for one argument or split argument.
an.tmac:<stdin>:324: style: 4 leading space(s) on input line
an.tmac:<stdin>:325: style: 7 leading space(s) on input line
an.tmac:<stdin>:327: style: 4 leading space(s) on input line
an.tmac:<stdin>:328: style: 8 leading space(s) on input line
an.tmac:<stdin>:329: style: 8 leading space(s) on input line
an.tmac:<stdin>:330: style: 8 leading space(s) on input line
an.tmac:<stdin>:331: style: 8 leading space(s) on input line
an.tmac:<stdin>:332: style: 11 leading space(s) on input line
an.tmac:<stdin>:333: style: 11 leading space(s) on input line
an.tmac:<stdin>:334: style: 13 leading space(s) on input line
an.tmac:<stdin>:335: style: 11 leading space(s) on input line
an.tmac:<stdin>:336: style: 13 leading space(s) on input line
an.tmac:<stdin>:337: style: 11 leading space(s) on input line
an.tmac:<stdin>:338: style: 11 leading space(s) on input line
an.tmac:<stdin>:339: style: 11 leading space(s) on input line
an.tmac:<stdin>:341: style: 4 leading space(s) on input line
an.tmac:<stdin>:342: style: 8 leading space(s) on input line
an.tmac:<stdin>:343: style: 8 leading space(s) on input line
an.tmac:<stdin>:344: style: 8 leading space(s) on input line
an.tmac:<stdin>:345: style: 8 leading space(s) on input line
an.tmac:<stdin>:347: style: 4 leading space(s) on input line
an.tmac:<stdin>:349: style: 4 leading space(s) on input line
an.tmac:<stdin>:350: style: 7 leading space(s) on input line
an.tmac:<stdin>:351: style: 7 leading space(s) on input line
an.tmac:<stdin>:353: style: 4 leading space(s) on input line
an.tmac:<stdin>:354: style: 7 leading space(s) on input line
an.tmac:<stdin>:355: style: 7 leading space(s) on input line
an.tmac:<stdin>:357: style: 4 leading space(s) on input line
an.tmac:<stdin>:358: style: 7 leading space(s) on input line
an.tmac:<stdin>:359: style: 7 leading space(s) on input line
an.tmac:<stdin>:361: style: 4 leading space(s) on input line
an.tmac:<stdin>:362: style: 7 leading space(s) on input line
an.tmac:<stdin>:363: style: 7 leading space(s) on input line
an.tmac:<stdin>:364: style: 7 leading space(s) on input line
an.tmac:<stdin>:365: style: 7 leading space(s) on input line
an.tmac:<stdin>:366: style: 7 leading space(s) on input line
an.tmac:<stdin>:368: style: 4 leading space(s) on input line
an.tmac:<stdin>:370: style: 4 leading space(s) on input line
an.tmac:<stdin>:371: style: 7 leading space(s) on input line
an.tmac:<stdin>:373: style: 4 leading space(s) on input line
an.tmac:<stdin>:374: style: 7 leading space(s) on input line
an.tmac:<stdin>:376: style: 4 leading space(s) on input line
an.tmac:<stdin>:377: style: 7 leading space(s) on input line
an.tmac:<stdin>:379: style: 4 leading space(s) on input line
an.tmac:<stdin>:380: style: 8 leading space(s) on input line
an.tmac:<stdin>:381: style: 8 leading space(s) on input line
an.tmac:<stdin>:383: style: 4 leading space(s) on input line
an.tmac:<stdin>:384: style: 8 leading space(s) on input line
an.tmac:<stdin>:385: style: 8 leading space(s) on input line
an.tmac:<stdin>:386: style: 8 leading space(s) on input line
an.tmac:<stdin>:388: style: 4 leading space(s) on input line
an.tmac:<stdin>:389: style: 8 leading space(s) on input line
an.tmac:<stdin>:390: style: 8 leading space(s) on input line
an.tmac:<stdin>:391: style: 8 leading space(s) on input line
an.tmac:<stdin>:393: style: 4 leading space(s) on input line
an.tmac:<stdin>:507: misuse, warning: .IB is for at least 2 arguments, got 1
Use macro '.I' for one argument or split argument.
an.tmac:<stdin>:512: misuse, warning: .IR is for at least 2 arguments, got 1
Use macro '.I' for one argument or split argument.
an.tmac:<stdin>:585: misuse, warning: .IB is for at least 2 arguments, got 1
Use macro '.I' for one argument or split argument.
an.tmac:<stdin>:587: misuse, warning: .IB is for at least 2 arguments, got 1
Use macro '.I' for one argument or split argument.
an.tmac:<stdin>:592: misuse, warning: .IR is for at least 2 arguments, got 1
Use macro '.I' for one argument or split argument.
an.tmac:<stdin>:602: misuse, warning: .IR is for at least 2 arguments, got 1
Use macro '.I' for one argument or split argument.
an.tmac:<stdin>:682: misuse, warning: .IB is for at least 2 arguments, got 1
Use macro '.I' for one argument or split argument.
an.tmac:<stdin>:689: misuse, warning: .IR is for at least 2 arguments, got 1
Use macro '.I' for one argument or split argument.
* What outcome did you expect instead?
No output (no warnings).
-.-
General remarks and further material, if a diff-file exist, are in the
attachments.
-- System Information:
Debian Release: trixie/sid
APT prefers testing
APT policy: (500, 'testing')
Architecture: amd64 (x86_64)
Kernel: Linux 6.12.19-amd64 (SMP w/2 CPU threads; PREEMPT)
Locale: LANG=is_IS.iso88591, LC_CTYPE=is_IS.iso88591 (charmap=ISO-8859-1),
LANGUAGE not set
Shell: /bin/sh linked to /usr/bin/dash
Init: sysvinit (via /sbin/init)
Versions of packages python3.13-minimal depends on:
ii libc6 2.41-6
ii libexpat1 2.6.4-1
ii libpython3.13-minimal 3.13.2-2
ii zlib1g 1:1.3.dfsg+really1.3.1-1+b1
Versions of packages python3.13-minimal recommends:
ii python3.13 3.13.2-2
Versions of packages python3.13-minimal suggests:
ii binfmt-support 2.2.2-7
-- no debconf information
Input file is python3.13.1
Output from "mandoc -T lint python3.13.1": (shortened list)
1 input text line longer than 80 bytes: Run Python in isolat...
1 input text line longer than 80 bytes: as the current direc...
1 line scope broken: TP breaks TP
1 missing date, using "": TH
5 skipping paragraph macro: br before text line with leading blank
-.-.
Output from "test-nroff -mandoc -t -ww -z python3.13.1": (shortened list)
9 Use macro '.I' for one argument or split argument.
5 .IB is for at least 2 arguments, got 1
4 .IR is for at least 2 arguments, got 1
1 cannot nest .TP or .TQ inside .TP; supply a tag
-.-.
Change two HYPHEN-MINUSES (code 0x2D) to an em-dash (\(em),
if one is intended.
" \(em " creates a too big gap in the text (in "troff").
An en-dash is usually surrounded by a space,
while an em-dash is used without spaces.
"man" (1 byte characters in input) transforms an en-dash (\(en) to one
HYPHEN-MINUS,
and an em-dash to two HYPHEN-MINUSES without considering the space
around it.
If "--" are two single "-"
(begin of an option or end of options)
then use "\-\-".
python3.13.1:83:.B \--check-hash-based-pycs
python3.13.1:92:.B \--help
python3.13.1:95:.B \--help-env
python3.13.1:98:.B \--help-xoptions
python3.13.1:101:.B \--help-all
python3.13.1:355: Only available in builds configured with
\fB--disable-gil\fR.
python3.13.1:527:with \fB--disable-gil\fP.
python3.13.1:707:\fB\--with-pydebug\fP build option.
-.-.
Reduce space between words.
Use no-fill text block.
python3.13.1:32: [
python3.13.1:61: [
python3.13.1:82: [
python3.13.1:91: [
python3.13.1:104: [
python3.13.1:259: -Wdefault # Warn once per call location
python3.13.1:260: -Werror # Convert to exceptions
python3.13.1:261: -Walways # Warn every time
python3.13.1:262: -Wall # Same as -Walways
python3.13.1:263: -Wmodule # Warn once per calling module
python3.13.1:264: -Wonce # Warn once per Python process
python3.13.1:265: -Wignore # Never warn
python3.13.1:325: \fB-X cpu_count=default\fR cancels overriding; also
\fBPYTHON_CPU_COUNT\fI
python3.13.1:328: runtime checks which are too expensive to be enabled
by default. It
python3.13.1:329: will not be more verbose than the default if the code
is correct: new
python3.13.1:330: warnings are only emitted when an issue is detected.
Effect of the
python3.13.1:331: developer mode:
python3.13.1:332: * Add default warning filter, as \fB-W default\fR
python3.13.1:333: * Install debug hooks on memory allocators: see the
python3.13.1:334: PyMem_SetupDebugHooks() C function
python3.13.1:335: * Enable the faulthandler module to dump the Python
traceback on a
python3.13.1:336: crash
python3.13.1:337: * Enable asyncio debug mode
python3.13.1:338: * Set the dev_mode attribute of sys.flags to True
python3.13.1:339: * io.IOBase destructor logs close() exceptions
python3.13.1:342: cumulative time (including nested imports) and self
time (excluding
python3.13.1:343: nested imports). Note that its output may be broken in
multi-threaded
python3.13.1:344: application. Typical usage is
python3.13.1:345: \fBpython3 -X importtime -c 'import asyncio'\fR
python3.13.1:350: should be used.
python3.13.1:351: The default is "on" (or "off" if you are running a
local build).
python3.13.1:354: \fBPYTHON_GIL\fR
python3.13.1:355: Only available in builds configured with
\fB--disable-gil\fR.
python3.13.1:358: This helps avoid denial of service attacks when parsing
untrusted data.
python3.13.1:359: The default is sys.int_info.default_max_str_digits. 0
disables.
python3.13.1:362: location information (end line, start column offset and
end column
python3.13.1:363: offset) to every instruction in code objects. This is
useful when
python3.13.1:364: smaller code objects and pyc files are desired as well
as suppressing
python3.13.1:365: the extra visual location indicators when the
interpreter displays
python3.13.1:366: tracebacks.
python3.13.1:371: also \fBPYTHON_PERF_JIT_SUPPORT=1\fR
python3.13.1:374: This only works on debug builds.
python3.13.1:377: tree rooted at the given directory instead of to the
code tree.
python3.13.1:380: memory blocks when the program finishes or after each
statement in the
python3.13.1:381: interactive interpreter. This only works on debug
builds
python3.13.1:384: tracemalloc module. By default, only the most recent
frame is stored in a
python3.13.1:385: traceback of a trace. Use -X tracemalloc=NFRAME to
start tracing with a
python3.13.1:386: traceback limit of NFRAME frames
python3.13.1:389: overriding the default locale-aware mode. \fB-X
utf8=0\fR explicitly
python3.13.1:390: disables UTF-8 mode (even when it would otherwise
activate
python3.13.1:391: automatically). See \fBPYTHONUTF8\fR for more details
-.-.
Change -- in x--y to \(em (em-dash), or, if an
option, to \-\-
355: Only available in builds configured with \fB--disable-gil\fR.
527:with \fB--disable-gil\fP.
-.-.
Remove space in the first column, if not indented.
Use ".in +<number>n" and ".in" to end it;
Or use ".nf" and ".fi" to end
it, for an extra indention.
python3.13.1:32: [
python3.13.1:61: [
python3.13.1:82: [
python3.13.1:91: [
python3.13.1:104: [
python3.13.1:259: -Wdefault # Warn once per call location
python3.13.1:260: -Werror # Convert to exceptions
python3.13.1:261: -Walways # Warn every time
python3.13.1:262: -Wall # Same as -Walways
python3.13.1:263: -Wmodule # Warn once per calling module
python3.13.1:264: -Wonce # Warn once per Python process
python3.13.1:265: -Wignore # Never warn
python3.13.1:324: \fB-X cpu_count=\fIN\fR: override the return value of
\fIos.cpu_count()\fR;
python3.13.1:325: \fB-X cpu_count=default\fR cancels overriding; also
\fBPYTHON_CPU_COUNT\fI
python3.13.1:327: \fB-X dev\fR: enable CPython's "development mode",
introducing additional
python3.13.1:328: runtime checks which are too expensive to be enabled
by default. It
python3.13.1:329: will not be more verbose than the default if the code
is correct: new
python3.13.1:330: warnings are only emitted when an issue is detected.
Effect of the
python3.13.1:331: developer mode:
python3.13.1:332: * Add default warning filter, as \fB-W default\fR
python3.13.1:333: * Install debug hooks on memory allocators: see the
python3.13.1:334: PyMem_SetupDebugHooks() C function
python3.13.1:335: * Enable the faulthandler module to dump the Python
traceback on a
python3.13.1:336: crash
python3.13.1:337: * Enable asyncio debug mode
python3.13.1:338: * Set the dev_mode attribute of sys.flags to True
python3.13.1:339: * io.IOBase destructor logs close() exceptions
python3.13.1:341: \fB-X importtime\fR: show how long each import takes. It
shows module name,
python3.13.1:342: cumulative time (including nested imports) and self
time (excluding
python3.13.1:343: nested imports). Note that its output may be broken in
multi-threaded
python3.13.1:344: application. Typical usage is
python3.13.1:345: \fBpython3 -X importtime -c 'import asyncio'\fR
python3.13.1:347: \fB-X faulthandler\fR: enable faulthandler
python3.13.1:349: \fB-X frozen_modules=\fR[\fBon\fR|\fBoff\fR]: whether or
not frozen modules
python3.13.1:350: should be used.
python3.13.1:351: The default is "on" (or "off" if you are running a
local build).
python3.13.1:353: \fB-X gil=\fR[\fB0\fR|\fB1\fR]: enable (1) or disable (0)
the GIL; also
python3.13.1:354: \fBPYTHON_GIL\fR
python3.13.1:355: Only available in builds configured with
\fB--disable-gil\fR.
python3.13.1:357: \fB-X int_max_str_digits=\fInumber\fR: limit the size of
int<->str conversions.
python3.13.1:358: This helps avoid denial of service attacks when parsing
untrusted data.
python3.13.1:359: The default is sys.int_info.default_max_str_digits. 0
disables.
python3.13.1:361: \fB-X no_debug_ranges\fR: disable the inclusion of the
tables mapping extra
python3.13.1:362: location information (end line, start column offset and
end column
python3.13.1:363: offset) to every instruction in code objects. This is
useful when
python3.13.1:364: smaller code objects and pyc files are desired as well
as suppressing
python3.13.1:365: the extra visual location indicators when the
interpreter displays
python3.13.1:366: tracebacks.
python3.13.1:368: \fB-X perf\fR: support the Linux "perf" profiler; also
\fBPYTHONPERFSUPPORT=1\fR
python3.13.1:370: \fB-X perf_jit\fR: support the Linux "perf" profiler with
DWARF support;
python3.13.1:371: also \fBPYTHON_PERF_JIT_SUPPORT=1\fR
python3.13.1:373: \fB-X presite=\fIMOD\fR: import this module before site;
also \fBPYTHON_PRESITE\fR
python3.13.1:374: This only works on debug builds.
python3.13.1:376: \fB-X pycache_prefix=\fIPATH\fR: enable writing .pyc files
to a parallel
python3.13.1:377: tree rooted at the given directory instead of to the
code tree.
python3.13.1:379: \fB-X showrefcount\fR: output the total reference count
and number of used
python3.13.1:380: memory blocks when the program finishes or after each
statement in the
python3.13.1:381: interactive interpreter. This only works on debug
builds
python3.13.1:383: \fB-X tracemalloc\fR: start tracing Python memory
allocations using the
python3.13.1:384: tracemalloc module. By default, only the most recent
frame is stored in a
python3.13.1:385: traceback of a trace. Use -X tracemalloc=NFRAME to
start tracing with a
python3.13.1:386: traceback limit of NFRAME frames
python3.13.1:388: \fB-X utf8\fR: enable UTF-8 mode for operating system
interfaces,
python3.13.1:389: overriding the default locale-aware mode. \fB-X
utf8=0\fR explicitly
python3.13.1:390: disables UTF-8 mode (even when it would otherwise
activate
python3.13.1:391: automatically). See \fBPYTHONUTF8\fR for more details
python3.13.1:393: \fB-X warn_default_encoding\fR: enable opt-in
EncodingWarning for 'encoding=None'
-.-.
Change a HYPHEN-MINUS (code 0x2D) to a minus(-dash) (\-),
if it
is in front of a name for an option,
is a symbol for standard input,
is a single character used to indicate an option,
or is in the NAME section (man-pages(7)).
N.B. - (0x2D), processed as a UTF-8 file, is changed to a hyphen
(0x2010, groff \[u2010] or \[hy]) in the output.
83:.B \--check-hash-based-pycs
92:.B \--help
95:.B \--help-env
98:.B \--help-xoptions
101:.B \--help-all
147:and comparing bytes/bytearray with str. (-bb: issue errors)
206:Do \fB-O\fP and also discard docstrings; change the filename for
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
269:.B -Wi
271:.B -Wignore .
278:.B -W ignore::DeprecationWarning
307:.B -W
310:.B -W
324: \fB-X cpu_count=\fIN\fR: override the return value of
\fIos.cpu_count()\fR;
325: \fB-X cpu_count=default\fR cancels overriding; also
\fBPYTHON_CPU_COUNT\fI
327: \fB-X dev\fR: enable CPython's "development mode", introducing
additional
332: * Add default warning filter, as \fB-W default\fR
341: \fB-X importtime\fR: show how long each import takes. It shows module
name,
345: \fBpython3 -X importtime -c 'import asyncio'\fR
347: \fB-X faulthandler\fR: enable faulthandler
349: \fB-X frozen_modules=\fR[\fBon\fR|\fBoff\fR]: whether or not frozen
modules
353: \fB-X gil=\fR[\fB0\fR|\fB1\fR]: enable (1) or disable (0) the GIL; also
355: Only available in builds configured with \fB--disable-gil\fR.
357: \fB-X int_max_str_digits=\fInumber\fR: limit the size of int<->str
conversions.
361: \fB-X no_debug_ranges\fR: disable the inclusion of the tables mapping
extra
368: \fB-X perf\fR: support the Linux "perf" profiler; also
\fBPYTHONPERFSUPPORT=1\fR
370: \fB-X perf_jit\fR: support the Linux "perf" profiler with DWARF support;
373: \fB-X presite=\fIMOD\fR: import this module before site; also
\fBPYTHON_PRESITE\fR
376: \fB-X pycache_prefix=\fIPATH\fR: enable writing .pyc files to a parallel
379: \fB-X showrefcount\fR: output the total reference count and number of
used
383: \fB-X tracemalloc\fR: start tracing Python memory allocations using the
385: traceback of a trace. Use -X tracemalloc=NFRAME to start tracing
with a
388: \fB-X utf8\fR: enable UTF-8 mode for operating system interfaces,
389: overriding the default locale-aware mode. \fB-X utf8=0\fR explicitly
393: \fB-X warn_default_encoding\fR: enable opt-in EncodingWarning for
'encoding=None'
433:.I '-c'.
516:This is equivalent to the \fB-X faulthandler\fP option.
527:with \fB--disable-gil\fP.
532:This is equivalent to the \fB-X gil\fR option.
579:This is equivalent to the \fB-X int_max_str_digits=\fINUMBER\fR option.
707:\fB\--with-pydebug\fP build option.
721:This is equivalent to the \fB-X presite=\fImodule\fR option.
-.-.
Wrong distance (not two spaces) between sentences in the input file.
Separate the sentences and subordinate clauses; each begins on a new
line. See man-pages(7) ("Conventions for source file layout") and
"info groff" ("Input Conventions").
The best procedure is to always start a new sentence on a new line,
at least, if you are typing on a computer.
Remember coding: Only one command ("sentence") on each (logical) line.
E-mail: Easier to quote exactly the relevant lines.
Generally: Easier to edit the sentence.
Patches: Less unaffected text.
Search for two adjacent words is easier, when they belong to the same line,
and the same phrase.
The amount of space between sentences in the output can then be
controlled with the ".ss" request.
Mark a final abbreviation point as such by suffixing it with "\&".
Some sentences (etc.) do not begin on a new line.
Split (sometimes) lines after a punctuation mark; before a conjunction.
Lines with only one (or two) space(s) between sentences could be split,
so latter sentences begin on a new line.
Use
#!/usr/bin/sh
sed -e '/^\./n' \
-e 's/\([[:alpha:]]\)\. */\1.\n/g' $1
to split lines after a sentence period.
Check result with the difference between the formatted outputs.
See also the attachment "general.bugs"
[List of affected lines removed.]
-.-.
Split lines longer than 80 characters into two or more lines.
Appropriate break points are the end of a sentence and a subordinate
clause; after punctuation marks.
Add "\:" to split the string for the output, "\<newline>" in the source.
Line 186, length 85
Run Python in isolated mode. This also implies \fB\-E\fP, \fB\-P\fP and
\fB\-s\fP. In
Line 211, length 81
as the current directory, the script's directory or an empty string. See also
the
Line 325, length 81
\fB-X cpu_count=default\fR cancels overriding; also
\fBPYTHON_CPU_COUNT\fI
Line 357, length 83
\fB-X int_max_str_digits=\fInumber\fR: limit the size of int<->str
conversions.
Line 368, length 84
\fB-X perf\fR: support the Linux "perf" profiler; also
\fBPYTHONPERFSUPPORT=1\fR
Line 373, length 86
\fB-X presite=\fIMOD\fR: import this module before site; also
\fBPYTHON_PRESITE\fR
Line 384, length 81
tracemalloc module. By default, only the most recent frame is stored in
a
Line 393, length 85
\fB-X warn_default_encoding\fR: enable opt-in EncodingWarning for
'encoding=None'
Longest line is number 373 with 86 characters
-.-.
Split a punctuation from a single argument, if a two-font macro is meant.
433:.I '-c'.
-.-.
Put a parenthetical sentence, phrase on a separate line,
if not part of a code.
See man-pages(7), item "semantic newline".
[List of affected lines removed.]
-.-
Only one space character after a possible end of sentence
(after a punctuation, that can end a sentence).
[List of affected lines removed.]
-.-.
Use thousand markers to make large numbers easy to read
560:The integer must be a decimal number in the range [0,4294967295].
Specifying
-.-.
Put a subordinate sentence (after a comma) on a new line.
[List of affected lines removed.]
-.-.
Remove quotes when there is a printable
but no space character between them
and the quotes are not for emphasis (markup),
for example as an argument to a macro.
python3.13.1:1:.TH PYTHON "1"
python3.13.1:168:.B "\-\-help\-env"
python3.13.1:171:.B "\-\-help\-xoptions"
python3.13.1:175:.B "\-\-help\-all"
python3.13.1:583:.IB encodingname ":" errorhandler
-.-.
Put a (long) web address on a new line to reduce the posibility of
splitting the address between two output lines.
Or inhibit hyphenation with "\%" in front of the name.
723:The Python Software Foundation: https://www.python.org/psf/
725:Main website: https://www.python.org/
727:Documentation: https://docs.python.org/
729:Developer resources: https://devguide.python.org/
731:Downloads: https://www.python.org/downloads/
733:Module repository: https://pypi.org/
-.-.
Output from "test-groff -mandoc -t -K utf8 -rF0 -rHY=0 -rCHECKSTYLE=10 -ww -z
":
an.tmac:<stdin>:1: style: .TH missing third argument; consider document
modification date in ISO 8601 format (YYYY-MM-DD)
an.tmac:<stdin>:1: style: .TH missing fourth argument; consider package/project
name and version (e.g., "groff 1.23.0")
an.tmac:<stdin>:32: style: 7 leading space(s) on input line
an.tmac:<stdin>:61: style: 7 leading space(s) on input line
an.tmac:<stdin>:82: style: 7 leading space(s) on input line
an.tmac:<stdin>:91: style: 7 leading space(s) on input line
an.tmac:<stdin>:104: style: 7 leading space(s) on input line
an.tmac:<stdin>:174: warning: cannot nest .TP or .TQ inside .TP; supply a tag
an.tmac:<stdin>:259: style: 2 leading space(s) on input line
an.tmac:<stdin>:260: style: 2 leading space(s) on input line
an.tmac:<stdin>:261: style: 2 leading space(s) on input line
an.tmac:<stdin>:262: style: 2 leading space(s) on input line
an.tmac:<stdin>:263: style: 2 leading space(s) on input line
an.tmac:<stdin>:264: style: 2 leading space(s) on input line
an.tmac:<stdin>:265: style: 2 leading space(s) on input line
an.tmac:<stdin>:274: misuse, warning: .IB is for at least 2 arguments, got 1
Use macro '.I' for one argument or split argument.
an.tmac:<stdin>:324: style: 4 leading space(s) on input line
an.tmac:<stdin>:325: style: 7 leading space(s) on input line
an.tmac:<stdin>:327: style: 4 leading space(s) on input line
an.tmac:<stdin>:328: style: 8 leading space(s) on input line
an.tmac:<stdin>:329: style: 8 leading space(s) on input line
an.tmac:<stdin>:330: style: 8 leading space(s) on input line
an.tmac:<stdin>:331: style: 8 leading space(s) on input line
an.tmac:<stdin>:332: style: 11 leading space(s) on input line
an.tmac:<stdin>:333: style: 11 leading space(s) on input line
an.tmac:<stdin>:334: style: 13 leading space(s) on input line
an.tmac:<stdin>:335: style: 11 leading space(s) on input line
an.tmac:<stdin>:336: style: 13 leading space(s) on input line
an.tmac:<stdin>:337: style: 11 leading space(s) on input line
an.tmac:<stdin>:338: style: 11 leading space(s) on input line
an.tmac:<stdin>:339: style: 11 leading space(s) on input line
an.tmac:<stdin>:341: style: 4 leading space(s) on input line
an.tmac:<stdin>:342: style: 8 leading space(s) on input line
an.tmac:<stdin>:343: style: 8 leading space(s) on input line
an.tmac:<stdin>:344: style: 8 leading space(s) on input line
an.tmac:<stdin>:345: style: 8 leading space(s) on input line
an.tmac:<stdin>:347: style: 4 leading space(s) on input line
an.tmac:<stdin>:349: style: 4 leading space(s) on input line
an.tmac:<stdin>:350: style: 7 leading space(s) on input line
an.tmac:<stdin>:351: style: 7 leading space(s) on input line
an.tmac:<stdin>:353: style: 4 leading space(s) on input line
an.tmac:<stdin>:354: style: 7 leading space(s) on input line
an.tmac:<stdin>:355: style: 7 leading space(s) on input line
an.tmac:<stdin>:357: style: 4 leading space(s) on input line
an.tmac:<stdin>:358: style: 7 leading space(s) on input line
an.tmac:<stdin>:359: style: 7 leading space(s) on input line
an.tmac:<stdin>:361: style: 4 leading space(s) on input line
an.tmac:<stdin>:362: style: 7 leading space(s) on input line
an.tmac:<stdin>:363: style: 7 leading space(s) on input line
an.tmac:<stdin>:364: style: 7 leading space(s) on input line
an.tmac:<stdin>:365: style: 7 leading space(s) on input line
an.tmac:<stdin>:366: style: 7 leading space(s) on input line
an.tmac:<stdin>:368: style: 4 leading space(s) on input line
an.tmac:<stdin>:370: style: 4 leading space(s) on input line
an.tmac:<stdin>:371: style: 7 leading space(s) on input line
an.tmac:<stdin>:373: style: 4 leading space(s) on input line
an.tmac:<stdin>:374: style: 7 leading space(s) on input line
an.tmac:<stdin>:376: style: 4 leading space(s) on input line
an.tmac:<stdin>:377: style: 7 leading space(s) on input line
an.tmac:<stdin>:379: style: 4 leading space(s) on input line
an.tmac:<stdin>:380: style: 8 leading space(s) on input line
an.tmac:<stdin>:381: style: 8 leading space(s) on input line
an.tmac:<stdin>:383: style: 4 leading space(s) on input line
an.tmac:<stdin>:384: style: 8 leading space(s) on input line
an.tmac:<stdin>:385: style: 8 leading space(s) on input line
an.tmac:<stdin>:386: style: 8 leading space(s) on input line
an.tmac:<stdin>:388: style: 4 leading space(s) on input line
an.tmac:<stdin>:389: style: 8 leading space(s) on input line
an.tmac:<stdin>:390: style: 8 leading space(s) on input line
an.tmac:<stdin>:391: style: 8 leading space(s) on input line
an.tmac:<stdin>:393: style: 4 leading space(s) on input line
an.tmac:<stdin>:507: misuse, warning: .IB is for at least 2 arguments, got 1
Use macro '.I' for one argument or split argument.
an.tmac:<stdin>:512: misuse, warning: .IR is for at least 2 arguments, got 1
Use macro '.I' for one argument or split argument.
an.tmac:<stdin>:585: misuse, warning: .IB is for at least 2 arguments, got 1
Use macro '.I' for one argument or split argument.
an.tmac:<stdin>:587: misuse, warning: .IB is for at least 2 arguments, got 1
Use macro '.I' for one argument or split argument.
an.tmac:<stdin>:592: misuse, warning: .IR is for at least 2 arguments, got 1
Use macro '.I' for one argument or split argument.
an.tmac:<stdin>:602: misuse, warning: .IR is for at least 2 arguments, got 1
Use macro '.I' for one argument or split argument.
an.tmac:<stdin>:682: misuse, warning: .IB is for at least 2 arguments, got 1
Use macro '.I' for one argument or split argument.
an.tmac:<stdin>:689: misuse, warning: .IR is for at least 2 arguments, got 1
Use macro '.I' for one argument or split argument.
-.-.
Generally:
Split (sometimes) lines after a punctuation mark; before a conjunction.
--- python3.13.1 2025-03-27 01:28:22.758345982 +0000
+++ python3.13.1.new 2025-03-27 02:00:14.774808801 +0000
@@ -1,7 +1,7 @@
-.TH PYTHON "1"
+.TH PYTHON 1
.\" To view this file while editing, run it through groff:
-.\" groff -Tascii -man python.man | less
+.\" groff -Tascii -man -ww python.man |& less
.SH NAME
python \- an interpreted, interactive, object-oriented programming language
@@ -80,7 +80,7 @@ python \- an interpreted, interactive, o
]
.br
[
-.B \--check-hash-based-pycs
+.B \-\-check-hash-based-pycs
.I default
|
.I always
@@ -89,16 +89,16 @@ python \- an interpreted, interactive, o
]
.br
[
-.B \--help
+.B \-\-help
]
[
-.B \--help-env
+.B \-\-help-env
]
[
-.B \--help-xoptions
+.B \-\-help-xoptions
]
[
-.B \--help-all
+.B \-\-help-all
]
.br
[
@@ -144,7 +144,7 @@ files on import. See also PYTHONDONTWRIT
.TP
.B \-b
Issue warnings about str(bytes_instance), str(bytearray_instance)
-and comparing bytes/bytearray with str. (-bb: issue errors)
+and comparing bytes/bytearray with str. (\-bb: issue errors)
.TP
.BI "\-c " command
Specify the command to execute (see next section).
@@ -165,14 +165,13 @@ the behavior of the interpreter.
.B \-h ", " \-? ", "\-\-help
Prints the usage for the interpreter executable and exits.
.TP
-.B "\-\-help\-env"
+.B \-\-help\-env
Prints help about Python-specific environment variables and exits.
.TP
-.B "\-\-help\-xoptions"
+.B \-\-help\-xoptions
Prints help about implementation-specific \fB\-X\fP options and exits.
.TP
-.TP
-.B "\-\-help\-all"
+.B \-\-help\-all
Prints complete usage information and exits.
.TP
.B \-i
@@ -183,8 +182,10 @@ useful to inspect global variables or a
raises an exception.
.TP
.B \-I
-Run Python in isolated mode. This also implies \fB\-E\fP, \fB\-P\fP and
\fB\-s\fP. In
-isolated mode sys.path contains neither the script's directory nor the user's
+Run Python in isolated mode.
+This also implies \fB\-E\fP, \fB\-P\fP and \fB\-s\fP.
+In isolated mode sys.path contains
+neither the script's directory nor the user's
site-packages directory. All PYTHON* environment variables are ignored, too.
Further restrictions may be imposed to prevent the user from injecting
malicious code.
@@ -203,12 +204,13 @@ __debug__; augment the filename for comp
adding .opt-1 before the .pyc extension.
.TP
.B \-OO
-Do \fB-O\fP and also discard docstrings; change the filename for
+Do \fB\-O\fP and also discard docstrings; change the filename for
compiled (bytecode) files by adding .opt-2 before the .pyc extension.
.TP
.B \-P
Don't automatically prepend a potentially unsafe path to \fBsys.path\fP such
-as the current directory, the script's directory or an empty string. See also
the
+as the current directory, the script's directory or an empty string
+See also the
\fBPYTHONSAFEPATH\fP environment variable.
.TP
.B \-q
@@ -256,26 +258,28 @@ to
The simplest settings apply a particular action unconditionally to all warnings
emitted by a process (even those that are otherwise ignored by default):
- -Wdefault # Warn once per call location
- -Werror # Convert to exceptions
- -Walways # Warn every time
- -Wall # Same as -Walways
- -Wmodule # Warn once per calling module
- -Wonce # Warn once per Python process
- -Wignore # Never warn
+.nf
+ \-Wdefault # Warn once per call location
+ \-Werror # Convert to exceptions
+ \-Walways # Warn every time
+ \-Wall # Same as \-Walways
+ \-Wmodule # Warn once per calling module
+ \-Wonce # Warn once per Python process
+ \-Wignore # Never warn
+.fi
The action names can be abbreviated as desired and the interpreter will resolve
them to the appropriate action name. For example,
-.B -Wi
+.B \-Wi
is the same as
-.B -Wignore .
+.B \-Wignore .
The full form of argument is:
-.IB action:message:category:module:lineno
+.IB action : message : category : module : lineno
Empty fields match all values; trailing empty fields may be omitted. For
example
-.B -W ignore::DeprecationWarning
+.B \-W ignore::DeprecationWarning
ignores all DeprecationWarning warnings.
The
@@ -304,10 +308,10 @@ field matches the line number, where zer
equivalent to an omitted line number.
Multiple
-.B -W
+.B \-W
options can be given; when a warning matches more than one option, the action
for the last matching option is performed. Invalid
-.B -W
+.B \-W
options are ignored (though, a warning message is printed about invalid options
when the first warning is issued).
@@ -320,16 +324,16 @@ a regular expression on the warning mess
.TP
.BI "\-X " option
Set implementation-specific option. The following options are available:
+.nf
+ \fB\-X cpu_count=\fIN\fR: override the return value of
\fIos.cpu_count()\fR;
+ \fB\-X cpu_count=default\fR cancels overriding; also
\fBPYTHON_CPU_COUNT\fI
- \fB-X cpu_count=\fIN\fR: override the return value of \fIos.cpu_count()\fR;
- \fB-X cpu_count=default\fR cancels overriding; also
\fBPYTHON_CPU_COUNT\fI
-
- \fB-X dev\fR: enable CPython's "development mode", introducing additional
+ \fB\-X dev\fR: enable CPython's "development mode", introducing additional
runtime checks which are too expensive to be enabled by default. It
will not be more verbose than the default if the code is correct: new
warnings are only emitted when an issue is detected. Effect of the
developer mode:
- * Add default warning filter, as \fB-W default\fR
+ * Add default warning filter, as \fB\-W default\fR
* Install debug hooks on memory allocators: see the
PyMem_SetupDebugHooks() C function
* Enable the faulthandler module to dump the Python traceback on a
@@ -338,59 +342,60 @@ Set implementation-specific option. The
* Set the dev_mode attribute of sys.flags to True
* io.IOBase destructor logs close() exceptions
- \fB-X importtime\fR: show how long each import takes. It shows module name,
+ \fB\-X importtime\fR: show how long each import takes. It shows module
name,
cumulative time (including nested imports) and self time (excluding
nested imports). Note that its output may be broken in multi-threaded
application. Typical usage is
\fBpython3 -X importtime -c 'import asyncio'\fR
- \fB-X faulthandler\fR: enable faulthandler
+ \fB\-X faulthandler\fR: enable faulthandler
- \fB-X frozen_modules=\fR[\fBon\fR|\fBoff\fR]: whether or not frozen modules
+ \fB\-X frozen_modules=\fR[\fBon\fR|\fBoff\fR]: whether or not frozen
modules
should be used.
The default is "on" (or "off" if you are running a local build).
- \fB-X gil=\fR[\fB0\fR|\fB1\fR]: enable (1) or disable (0) the GIL; also
+ \fB\-X gil=\fR[\fB0\fR|\fB1\fR]: enable (1) or disable (0) the GIL; also
\fBPYTHON_GIL\fR
- Only available in builds configured with \fB--disable-gil\fR.
+ Only available in builds configured with \fB\-\-disable-gil\fR.
- \fB-X int_max_str_digits=\fInumber\fR: limit the size of int<->str
conversions.
+ \fB\-X int_max_str_digits=\fInumber\fR: limit the size of int<->str
conversions.
This helps avoid denial of service attacks when parsing untrusted data.
The default is sys.int_info.default_max_str_digits. 0 disables.
- \fB-X no_debug_ranges\fR: disable the inclusion of the tables mapping extra
+ \fB\-X no_debug_ranges\fR: disable the inclusion of the tables mapping
extra
location information (end line, start column offset and end column
offset) to every instruction in code objects. This is useful when
smaller code objects and pyc files are desired as well as suppressing
the extra visual location indicators when the interpreter displays
tracebacks.
- \fB-X perf\fR: support the Linux "perf" profiler; also
\fBPYTHONPERFSUPPORT=1\fR
+ \fB\-X perf\fR: support the Linux "perf" profiler; also
\fBPYTHONPERFSUPPORT=1\fR
- \fB-X perf_jit\fR: support the Linux "perf" profiler with DWARF support;
+ \fB\-X perf_jit\fR: support the Linux "perf" profiler with DWARF support;
also \fBPYTHON_PERF_JIT_SUPPORT=1\fR
- \fB-X presite=\fIMOD\fR: import this module before site; also
\fBPYTHON_PRESITE\fR
+ \fB\-X presite=\fIMOD\fR: import this module before site; also
\fBPYTHON_PRESITE\fR
This only works on debug builds.
- \fB-X pycache_prefix=\fIPATH\fR: enable writing .pyc files to a parallel
+ \fB\-X pycache_prefix=\fIPATH\fR: enable writing .pyc files to a parallel
tree rooted at the given directory instead of to the code tree.
- \fB-X showrefcount\fR: output the total reference count and number of used
+ \fB\-X showrefcount\fR: output the total reference count and number of used
memory blocks when the program finishes or after each statement in the
interactive interpreter. This only works on debug builds
- \fB-X tracemalloc\fR: start tracing Python memory allocations using the
+ \fB\-X tracemalloc\fR: start tracing Python memory allocations using the
tracemalloc module. By default, only the most recent frame is stored
in a
traceback of a trace. Use -X tracemalloc=NFRAME to start tracing with a
traceback limit of NFRAME frames
- \fB-X utf8\fR: enable UTF-8 mode for operating system interfaces,
- overriding the default locale-aware mode. \fB-X utf8=0\fR explicitly
+ \fB\-X utf8\fR: enable UTF-8 mode for operating system interfaces,
+ overriding the default locale-aware mode. \fB\-X utf8=0\fR explicitly
disables UTF-8 mode (even when it would otherwise activate
automatically). See \fBPYTHONUTF8\fR for more details
- \fB-X warn_default_encoding\fR: enable opt-in EncodingWarning for
'encoding=None'
+ \fB\-X warn_default_encoding\fR: enable opt-in EncodingWarning for
'encoding=None'
+.fi
.TP
.B \-x
@@ -430,7 +435,7 @@ is an empty string; if
is used,
.I sys.argv[0]
contains the string
-.I '-c'.
+.RI ' \-c '.
Note that options interpreted by the Python interpreter itself
are not placed in
.IR sys.argv .
@@ -504,16 +509,16 @@ the \fB\-d\fP option. If set to an integ
specifying \fB\-d\fP multiple times.
.IP PYTHONEXECUTABLE
If this environment variable is set,
-.IB sys.argv[0]
+.IB sys.argv [0]
will be set to its value instead of the value got through the C runtime. Only
works on Mac OS X.
.IP PYTHONFAULTHANDLER
If this environment variable is set to a non-empty string,
-.IR faulthandler.enable()
+.IR faulthandler.enable ()
is called at startup: install a handler for SIGSEGV, SIGFPE, SIGABRT, SIGBUS
and SIGILL signals to dump the Python traceback.
.IP
-This is equivalent to the \fB-X faulthandler\fP option.
+This is equivalent to the \fB\-X faulthandler\fP option.
.IP PYTHON_FROZEN_MODULES
If this variable is set to \fBon\fR or \fBoff\fR, it determines whether or not
frozen modules are ignored by the import machinery. A value of \fBon\fR means
@@ -524,12 +529,12 @@ See also the \fB\-X frozen_modules\fR op
.IP PYTHON_GIL
If this variable is set to 1, the global interpreter lock (GIL) will be forced
on. Setting it to 0 forces the GIL off. Only available in builds configured
-with \fB--disable-gil\fP.
+with \fB\-\-disable-gil\fP.
.IP PYTHON_HISTORY
This environment variable can be used to set the location of a history file
(on Unix, it is \fI~/.python_history\fP by default).
.IP
-This is equivalent to the \fB-X gil\fR option.
+This is equivalent to the \fB\-X gil\fR option.
.IP PYTHONNODEBUGRANGES
If this variable is set, it disables the inclusion of the tables mapping
extra location information (end line, start column offset and end column
@@ -557,8 +562,8 @@ purpose is to allow repeatable hashing,
interpreter itself, or to allow a cluster of python processes to share hash
values.
-The integer must be a decimal number in the range [0,4294967295]. Specifying
-the value 0 will disable hash randomization.
+The integer must be a decimal number in the range [0,4\|294\|967\|295].
+Specifying the value 0 will disable hash randomization.
.IP PYTHONHOME
Change the location of the standard Python libraries. By default, the
libraries are searched in ${prefix}/lib/python<version> and
@@ -576,20 +581,20 @@ when converting from a string and when c
A value of 0 disables the limit. Conversions to or from bases 2, 4, 8,
16, and 32 are never limited.
.IP
-This is equivalent to the \fB-X int_max_str_digits=\fINUMBER\fR option.
+This is equivalent to the \fB\-X int_max_str_digits=\fINUMBER\fR option.
.IP PYTHONIOENCODING
If this is set before running the interpreter, it overrides the encoding used
for stdin/stdout/stderr, in the syntax
-.IB encodingname ":" errorhandler
+.IB encodingname : errorhandler
The
-.IB errorhandler
+.I errorhandler
part is optional and has the same meaning as in str.encode. For stderr, the
-.IB errorhandler
+.I errorhandler
part is ignored; the handler will always be \'backslashreplace\'.
.IP PYTHONMALLOC
Set the Python memory allocators and/or install debug hooks. The available
memory allocators are
-.IR malloc
+.I malloc
and
.IR pymalloc .
The available debug hooks are
@@ -599,7 +604,7 @@ and
.IR pymalloc_debug .
.IP
When Python is compiled in debug mode, the default is
-.IR pymalloc_debug
+.I pymalloc_debug
and the debug hooks are automatically used. Otherwise, the default is
.IR pymalloc .
.IP PYTHONMALLOCSTATS
@@ -679,14 +684,14 @@ Python memory allocations using the trac
.IP
The value of the variable is the maximum number of frames stored in a
traceback of a trace. For example,
-.IB PYTHONTRACEMALLOC=1
+.B PYTHONTRACEMALLOC=1
stores only the most recent frame.
.IP PYTHONUNBUFFERED
If this is set to a non-empty string it is equivalent to specifying
the \fB\-u\fP option.
.IP PYTHONUSERBASE
Defines the user base directory, which is used to compute the path of the user
-.IR site-packages
+.I site-packages
directory and installation paths for
.IR "python \-m pip install \-\-user" .
.IP PYTHONUTF8
@@ -704,7 +709,7 @@ specifying the \fB\-W\fP option for each
.SS Debug-mode variables
Setting these variables only has an effect in a debug build of Python, that is,
if Python was configured with the
-\fB\--with-pydebug\fP build option.
+\fB\-\-with-pydebug\fP build option.
.IP PYTHONDUMPREFS
If this environment variable is set, Python will dump objects and reference
counts still alive after shutting down the interpreter.
@@ -718,7 +723,7 @@ early in the interpreter lifecycle, befo
executed, and before the \fI__main__\fR module is created.
This only works on debug builds.
.IP
-This is equivalent to the \fB-X presite=\fImodule\fR option.
+This is equivalent to the \fB\-X presite=\fImodule\fR option.
.SH AUTHOR
The Python Software Foundation: https://www.python.org/psf/
.SH INTERNET RESOURCES
Any program (person), that produces man pages, should check the output
for defects by using (both groff and nroff)
[gn]roff -mandoc -t -ww -b -z -K utf8 <man page>
The same goes for man pages that are used as an input.
For a style guide use
mandoc -T lint
-.-
Any "autogenerator" should check its products with the above mentioned
'groff', 'mandoc', and additionally with 'nroff ...'.
It should also check its input files for too long (> 80) lines.
This is just a simple quality control measure.
The "autogenerator" may have to be corrected to get a better man page,
the source file may, and any additional file may.
Common defects:
Not removing trailing spaces (in in- and output).
The reason for these trailing spaces should be found and eliminated.
"git" has a "tool" to point out whitespace,
see for example "git-apply(1)" and git-config(1)")
Not beginning each input sentence on a new line.
Line length and patch size should thus be reduced.
The script "reportbug" uses 'quoted-printable' encoding when a line is
longer than 1024 characters in an 'ascii' file.
See man-pages(7), item "semantic newline".
-.-
The difference between the formatted output of the original and patched file
can be seen with:
nroff -mandoc <file1> > <out1>
nroff -mandoc <file2> > <out2>
diff -d -u <out1> <out2>
and for groff, using
\"printf '%s\n%s\n' '.kern 0' '.ss 12 0' | groff -mandoc -Z - \"
instead of 'nroff -mandoc'
Add the option '-t', if the file contains a table.
Read the output from 'diff -d -u ...' with 'less -R' or similar.
-.-.
If 'man' (man-db) is used to check the manual for warnings,
the following must be set:
The option \"-warnings=w\"
The environmental variable:
export MAN_KEEP_STDERR=yes (or any non-empty value)
or
(produce only warnings):
export MANROFFOPT=\"-ww -b -z\"
export MAN_KEEP_STDERR=yes (or any non-empty value)
-.-
