mirrors/cpython
1
0
Fork 0
mirror of https://github.com/python/cpython.git synced 2025-07-24 11:44:31 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 8

[3.13] Escape hyphens in manpage (GH-132291) (#132334)

Browse source 
Co-authored-by: Stefano Rivera <stefano@rivera.za.net>
This commit is contained in:
Miss Islington (bot) 2025-04-10 00:47:32 +02:00 • committed by GitHub
parent c2538bf77f
commit f30a2512d2
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
1 changed files with 44 additions and 44 deletions
Download patch file Download diff file Expand all files Collapse all files

88
Misc/python.man
View file

@ -80,7 +80,7 @@ python \- an interpreted, interactive, object-oriented programming language
] ]
.br .br
[ [
.B \--check-hash-based-pycs .B \-\-check-hash-based-pycs
.I default .I default
| |
.I always .I always
@ -89,16 +89,16 @@ python \- an interpreted, interactive, object-oriented programming language
] ]
.br .br
[ [
.B \--help .B \-\-help
] ]
[ [
.B \--help-env .B \-\-help\-env
] ]
[ [
.B \--help-xoptions .B \-\-help\-xoptions
] ]
[ [
.B \--help-all .B \-\-help\-all
] ]
.br .br
[ [
@ -144,14 +144,14 @@ files on import. See also PYTHONDONTWRITEBYTECODE.
.TP .TP
.B \-b .B \-b
Issue warnings about str(bytes_instance), str(bytearray_instance) 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 .TP
.BI "\-c " command .BI "\-c " command
Specify the command to execute (see next section). Specify the command to execute (see next section).
This terminates the option list (following options are passed as This terminates the option list (following options are passed as
arguments to the command). arguments to the command).
.TP .TP
.BI "\-\-check-hash-based-pycs " mode .BI "\-\-check\-hash\-based\-pycs " mode
Configure how Python evaluates the up-to-dateness of hash-based .pyc files. Configure how Python evaluates the up-to-dateness of hash-based .pyc files.
.TP .TP
.B \-d .B \-d
@ -185,7 +185,7 @@ raises an exception.
.B \-I .B \-I
Run Python in isolated mode. This also implies \fB\-E\fP, \fB\-P\fP and \fB\-s\fP. In 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 isolated mode sys.path contains neither the script's directory nor the user's
site-packages directory. All PYTHON* environment variables are ignored, too. site\-packages directory. All PYTHON* environment variables are ignored, too.
Further restrictions may be imposed to prevent the user from injecting Further restrictions may be imposed to prevent the user from injecting
malicious code. malicious code.
.TP .TP
@ -203,7 +203,7 @@ __debug__; augment the filename for compiled (bytecode) files by
adding .opt-1 before the .pyc extension. adding .opt-1 before the .pyc extension.
.TP .TP
.B \-OO .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. compiled (bytecode) files by adding .opt-2 before the .pyc extension.
.TP .TP
.B \-P .B \-P
@ -266,16 +266,16 @@ emitted by a process (even those that are otherwise ignored by default):
The action names can be abbreviated as desired and the interpreter will resolve The action names can be abbreviated as desired and the interpreter will resolve
them to the appropriate action name. For example, them to the appropriate action name. For example,
.B -Wi .B \-Wi
is the same as is the same as
.B -Wignore . .B \-Wignore .
The full form of argument is: 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 Empty fields match all values; trailing empty fields may be omitted. For
example example
.B -W ignore::DeprecationWarning .B \-W ignore::DeprecationWarning
ignores all DeprecationWarning warnings. ignores all DeprecationWarning warnings.
The The
@ -304,10 +304,10 @@ field matches the line number, where zero matches all line numbers and is thus
equivalent to an omitted line number. equivalent to an omitted line number.
Multiple Multiple
.B -W .B \-W
options can be given; when a warning matches more than one option, the action options can be given; when a warning matches more than one option, the action
for the last matching option is performed. Invalid for the last matching option is performed. Invalid
.B -W .B \-W
options are ignored (though, a warning message is printed about invalid options options are ignored (though, a warning message is printed about invalid options
when the first warning is issued). when the first warning is issued).
@ -321,15 +321,15 @@ a regular expression on the warning message.
.BI "\-X " option .BI "\-X " option
Set implementation-specific option. The following options are available: Set implementation-specific option. The following options are available:
\fB-X cpu_count=\fIN\fR: override the return value of \fIos.cpu_count()\fR; \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=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 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 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 warnings are only emitted when an issue is detected. Effect of the
developer mode: 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 * Install debug hooks on memory allocators: see the
PyMem_SetupDebugHooks() C function PyMem_SetupDebugHooks() C function
* Enable the faulthandler module to dump the Python traceback on a * Enable the faulthandler module to dump the Python traceback on a
@ -338,59 +338,59 @@ Set implementation-specific option. The following options are available:
* Set the dev_mode attribute of sys.flags to True * Set the dev_mode attribute of sys.flags to True
* io.IOBase destructor logs close() exceptions * 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 cumulative time (including nested imports) and self time (excluding
nested imports). Note that its output may be broken in multi-threaded nested imports). Note that its output may be broken in multi-threaded
application. Typical usage is application. Typical usage is
\fBpython3 -X importtime -c 'import asyncio'\fR \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. should be used.
The default is "on" (or "off" if you are running a local build). 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 \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. This helps avoid denial of service attacks when parsing untrusted data.
The default is sys.int_info.default_max_str_digits. 0 disables. 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 location information (end line, start column offset and end column
offset) to every instruction in code objects. This is useful when offset) to every instruction in code objects. This is useful when
smaller code objects and pyc files are desired as well as suppressing smaller code objects and pyc files are desired as well as suppressing
the extra visual location indicators when the interpreter displays the extra visual location indicators when the interpreter displays
tracebacks. 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 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. 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. 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 memory blocks when the program finishes or after each statement in the
interactive interpreter. This only works on debug builds 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 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 of a trace. Use \-X tracemalloc=NFRAME to start tracing with a
traceback limit of NFRAME frames traceback limit of NFRAME frames
\fB-X utf8\fR: enable UTF-8 mode for operating system interfaces, \fB\-X utf8\fR: enable UTF-8 mode for operating system interfaces,
overriding the default locale-aware mode. \fB-X utf8=0\fR explicitly overriding the default locale-aware mode. \fB\-X utf8=0\fR explicitly
disables UTF-8 mode (even when it would otherwise activate disables UTF-8 mode (even when it would otherwise activate
automatically). See \fBPYTHONUTF8\fR for more details 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'
.TP .TP
.B \-x .B \-x
@ -430,7 +430,7 @@ is an empty string; if
is used, is used,
.I sys.argv[0] .I sys.argv[0]
contains the string contains the string
.I '-c'. .I '\-c'.
Note that options interpreted by the Python interpreter itself Note that options interpreted by the Python interpreter itself
are not placed in are not placed in
.IR sys.argv . .IR sys.argv .
@ -513,7 +513,7 @@ If this environment variable is set to a non-empty string,
is called at startup: install a handler for SIGSEGV, SIGFPE, SIGABRT, SIGBUS is called at startup: install a handler for SIGSEGV, SIGFPE, SIGABRT, SIGBUS
and SIGILL signals to dump the Python traceback. and SIGILL signals to dump the Python traceback.
.IP .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 .IP PYTHON_FROZEN_MODULES
If this variable is set to \fBon\fR or \fBoff\fR, it determines whether or not 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 frozen modules are ignored by the import machinery. A value of \fBon\fR means
@ -524,12 +524,12 @@ See also the \fB\-X frozen_modules\fR option.
.IP PYTHON_GIL .IP PYTHON_GIL
If this variable is set to 1, the global interpreter lock (GIL) will be forced 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 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 .IP PYTHON_HISTORY
This environment variable can be used to set the location of a history file This environment variable can be used to set the location of a history file
(on Unix, it is \fI~/.python_history\fP by default). (on Unix, it is \fI~/.python_history\fP by default).
.IP .IP
This is equivalent to the \fB-X gil\fR option. This is equivalent to the \fB\-X gil\fR option.
.IP PYTHONNODEBUGRANGES .IP PYTHONNODEBUGRANGES
If this variable is set, it disables the inclusion of the tables mapping If this variable is set, it disables the inclusion of the tables mapping
extra location information (end line, start column offset and end column extra location information (end line, start column offset and end column
@ -576,7 +576,7 @@ when converting from a string and when converting an int back to a str.
A value of 0 disables the limit. Conversions to or from bases 2, 4, 8, A value of 0 disables the limit. Conversions to or from bases 2, 4, 8,
16, and 32 are never limited. 16, and 32 are never limited.
.IP .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 .IP PYTHONIOENCODING
If this is set before running the interpreter, it overrides the encoding used If this is set before running the interpreter, it overrides the encoding used
for stdin/stdout/stderr, in the syntax for stdin/stdout/stderr, in the syntax
@ -686,7 +686,7 @@ If this is set to a non-empty string it is equivalent to specifying
the \fB\-u\fP option. the \fB\-u\fP option.
.IP PYTHONUSERBASE .IP PYTHONUSERBASE
Defines the user base directory, which is used to compute the path of the user Defines the user base directory, which is used to compute the path of the user
.IR site-packages .IR site\-packages
directory and installation paths for directory and installation paths for
.IR "python \-m pip install \-\-user" . .IR "python \-m pip install \-\-user" .
.IP PYTHONUTF8 .IP PYTHONUTF8
@ -704,7 +704,7 @@ specifying the \fB\-W\fP option for each separate value.
.SS Debug-mode variables .SS Debug-mode variables
Setting these variables only has an effect in a debug build of Python, that is, Setting these variables only has an effect in a debug build of Python, that is,
if Python was configured with the if Python was configured with the
\fB\--with-pydebug\fP build option. \fB\-\-with\-pydebug\fP build option.
.IP PYTHONDUMPREFS .IP PYTHONDUMPREFS
If this environment variable is set, Python will dump objects and reference If this environment variable is set, Python will dump objects and reference
counts still alive after shutting down the interpreter. counts still alive after shutting down the interpreter.
@ -718,7 +718,7 @@ early in the interpreter lifecycle, before the \fIsite\fR module is
executed, and before the \fI__main__\fR module is created. executed, and before the \fI__main__\fR module is created.
This only works on debug builds. This only works on debug builds.
.IP .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 .SH AUTHOR
The Python Software Foundation: https://www.python.org/psf/ The Python Software Foundation: https://www.python.org/psf/
.SH INTERNET RESOURCES .SH INTERNET RESOURCES