Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly
Appearance settings

Commit e523754

Browse filesBrowse files
stefanorstefanor
authored
Escape hyphens in manpage (#132291)
1 parent 20926c7 commit e523754
Copy full SHA for e523754

File tree

1 file changed

+44
-44
lines changed
Filter options

1 file changed

+44
-44
lines changed

‎Misc/python.man

Copy file name to clipboardExpand all lines: Misc/python.man
+44-44Lines changed: 44 additions & 44 deletions
Original file line numberDiff line numberDiff line change
@@ -80,7 +80,7 @@ python \- an interpreted, interactive, object-oriented programming language
8080
]
8181
.br
8282
[
83-
.B \--check-hash-based-pycs
83+
.B \-\-check-hash-based-pycs
8484
.I default
8585
|
8686
.I always
@@ -89,16 +89,16 @@ python \- an interpreted, interactive, object-oriented programming language
8989
]
9090
.br
9191
[
92-
.B \--help
92+
.B \-\-help
9393
]
9494
[
95-
.B \--help-env
95+
.B \-\-help\-env
9696
]
9797
[
98-
.B \--help-xoptions
98+
.B \-\-help\-xoptions
9999
]
100100
[
101-
.B \--help-all
101+
.B \-\-help\-all
102102
]
103103
.br
104104
[
@@ -144,14 +144,14 @@ files on import. See also PYTHONDONTWRITEBYTECODE.
144144
.TP
145145
.B \-b
146146
Issue warnings about str(bytes_instance), str(bytearray_instance)
147-
and comparing bytes/bytearray with str. (-bb: issue errors)
147+
and comparing bytes/bytearray with str. (\-bb: issue errors)
148148
.TP
149149
.BI "\-c " command
150150
Specify the command to execute (see next section).
151151
This terminates the option list (following options are passed as
152152
arguments to the command).
153153
.TP
154-
.BI "\-\-check-hash-based-pycs " mode
154+
.BI "\-\-check\-hash\-based\-pycs " mode
155155
Configure how Python evaluates the up-to-dateness of hash-based .pyc files.
156156
.TP
157157
.B \-d
@@ -185,7 +185,7 @@ raises an exception.
185185
.B \-I
186186
Run Python in isolated mode. This also implies \fB\-E\fP, \fB\-P\fP and \fB\-s\fP. In
187187
isolated mode sys.path contains neither the script's directory nor the user's
188-
site-packages directory. All PYTHON* environment variables are ignored, too.
188+
site\-packages directory. All PYTHON* environment variables are ignored, too.
189189
Further restrictions may be imposed to prevent the user from injecting
190190
malicious code.
191191
.TP
@@ -203,7 +203,7 @@ __debug__; augment the filename for compiled (bytecode) files by
203203
adding .opt-1 before the .pyc extension.
204204
.TP
205205
.B \-OO
206-
Do \fB-O\fP and also discard docstrings; change the filename for
206+
Do \fB\-O\fP and also discard docstrings; change the filename for
207207
compiled (bytecode) files by adding .opt-2 before the .pyc extension.
208208
.TP
209209
.B \-P
@@ -266,16 +266,16 @@ emitted by a process (even those that are otherwise ignored by default):
266266

267267
The action names can be abbreviated as desired and the interpreter will resolve
268268
them to the appropriate action name. For example,
269-
.B -Wi
269+
.B \-Wi
270270
is the same as
271-
.B -Wignore .
271+
.B \-Wignore .
272272

273273
The full form of argument is:
274274
.IB action:message:category:module:lineno
275275

276276
Empty fields match all values; trailing empty fields may be omitted. For
277277
example
278-
.B -W ignore::DeprecationWarning
278+
.B \-W ignore::DeprecationWarning
279279
ignores all DeprecationWarning warnings.
280280

281281
The
@@ -304,10 +304,10 @@ field matches the line number, where zero matches all line numbers and is thus
304304
equivalent to an omitted line number.
305305

306306
Multiple
307-
.B -W
307+
.B \-W
308308
options can be given; when a warning matches more than one option, the action
309309
for the last matching option is performed. Invalid
310-
.B -W
310+
.B \-W
311311
options are ignored (though, a warning message is printed about invalid options
312312
when the first warning is issued).
313313

@@ -321,15 +321,15 @@ a regular expression on the warning message.
321321
.BI "\-X " option
322322
Set implementation-specific option. The following options are available:
323323

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
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
326326

327-
\fB-X dev\fR: enable CPython's "development mode", introducing additional
327+
\fB\-X dev\fR: enable CPython's "development mode", introducing additional
328328
runtime checks which are too expensive to be enabled by default. It
329329
will not be more verbose than the default if the code is correct: new
330330
warnings are only emitted when an issue is detected. Effect of the
331331
developer mode:
332-
* Add default warning filter, as \fB-W default\fR
332+
* Add default warning filter, as \fB\-W default\fR
333333
* Install debug hooks on memory allocators: see the
334334
PyMem_SetupDebugHooks() C function
335335
* Enable the faulthandler module to dump the Python traceback on a
@@ -338,59 +338,59 @@ Set implementation-specific option. The following options are available:
338338
* Set the dev_mode attribute of sys.flags to True
339339
* io.IOBase destructor logs close() exceptions
340340

341-
\fB-X importtime\fR: show how long each import takes. It shows module name,
341+
\fB\-X importtime\fR: show how long each import takes. It shows module name,
342342
cumulative time (including nested imports) and self time (excluding
343343
nested imports). Note that its output may be broken in multi-threaded
344344
application. Typical usage is
345-
\fBpython3 -X importtime -c 'import asyncio'\fR
345+
\fBpython3 \-X importtime \-c 'import asyncio'\fR
346346

347-
\fB-X faulthandler\fR: enable faulthandler
347+
\fB\-X faulthandler\fR: enable faulthandler
348348

349-
\fB-X frozen_modules=\fR[\fBon\fR|\fBoff\fR]: whether or not frozen modules
349+
\fB\-X frozen_modules=\fR[\fBon\fR|\fBoff\fR]: whether or not frozen modules
350350
should be used.
351351
The default is "on" (or "off" if you are running a local build).
352352

353-
\fB-X gil=\fR[\fB0\fR|\fB1\fR]: enable (1) or disable (0) the GIL; also
353+
\fB\-X gil=\fR[\fB0\fR|\fB1\fR]: enable (1) or disable (0) the GIL; also
354354
\fBPYTHON_GIL\fR
355-
Only available in builds configured with \fB--disable-gil\fR.
355+
Only available in builds configured with \fB\-\-disable\-gil\fR.
356356

357-
\fB-X int_max_str_digits=\fInumber\fR: limit the size of int<->str conversions.
357+
\fB\-X int_max_str_digits=\fInumber\fR: limit the size of int<->str conversions.
358358
This helps avoid denial of service attacks when parsing untrusted data.
359359
The default is sys.int_info.default_max_str_digits. 0 disables.
360360

361-
\fB-X no_debug_ranges\fR: disable the inclusion of the tables mapping extra
361+
\fB\-X no_debug_ranges\fR: disable the inclusion of the tables mapping extra
362362
location information (end line, start column offset and end column
363363
offset) to every instruction in code objects. This is useful when
364364
smaller code objects and pyc files are desired as well as suppressing
365365
the extra visual location indicators when the interpreter displays
366366
tracebacks.
367367

368-
\fB-X perf\fR: support the Linux "perf" profiler; also \fBPYTHONPERFSUPPORT=1\fR
368+
\fB\-X perf\fR: support the Linux "perf" profiler; also \fBPYTHONPERFSUPPORT=1\fR
369369

370-
\fB-X perf_jit\fR: support the Linux "perf" profiler with DWARF support;
370+
\fB\-X perf_jit\fR: support the Linux "perf" profiler with DWARF support;
371371
also \fBPYTHON_PERF_JIT_SUPPORT=1\fR
372372

373-
\fB-X presite=\fIMOD\fR: import this module before site; also \fBPYTHON_PRESITE\fR
373+
\fB\-X presite=\fIMOD\fR: import this module before site; also \fBPYTHON_PRESITE\fR
374374
This only works on debug builds.
375375

376-
\fB-X pycache_prefix=\fIPATH\fR: enable writing .pyc files to a parallel
376+
\fB\-X pycache_prefix=\fIPATH\fR: enable writing .pyc files to a parallel
377377
tree rooted at the given directory instead of to the code tree.
378378

379-
\fB-X showrefcount\fR: output the total reference count and number of used
379+
\fB\-X showrefcount\fR: output the total reference count and number of used
380380
memory blocks when the program finishes or after each statement in the
381381
interactive interpreter. This only works on debug builds
382382

383-
\fB-X tracemalloc\fR: start tracing Python memory allocations using the
383+
\fB\-X tracemalloc\fR: start tracing Python memory allocations using the
384384
tracemalloc module. By default, only the most recent frame is stored in a
385-
traceback of a trace. Use -X tracemalloc=NFRAME to start tracing with a
385+
traceback of a trace. Use \-X tracemalloc=NFRAME to start tracing with a
386386
traceback limit of NFRAME frames
387387

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
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
390390
disables UTF-8 mode (even when it would otherwise activate
391391
automatically). See \fBPYTHONUTF8\fR for more details
392392

393-
\fB-X warn_default_encoding\fR: enable opt-in EncodingWarning for 'encoding=None'
393+
\fB\-X warn_default_encoding\fR: enable opt-in EncodingWarning for 'encoding=None'
394394

395395
.TP
396396
.B \-x
@@ -430,7 +430,7 @@ is an empty string; if
430430
is used,
431431
.I sys.argv[0]
432432
contains the string
433-
.I '-c'.
433+
.I '\-c'.
434434
Note that options interpreted by the Python interpreter itself
435435
are not placed in
436436
.IR sys.argv .
@@ -513,7 +513,7 @@ If this environment variable is set to a non-empty string,
513513
is called at startup: install a handler for SIGSEGV, SIGFPE, SIGABRT, SIGBUS
514514
and SIGILL signals to dump the Python traceback.
515515
.IP
516-
This is equivalent to the \fB-X faulthandler\fP option.
516+
This is equivalent to the \fB\-X faulthandler\fP option.
517517
.IP PYTHON_FROZEN_MODULES
518518
If this variable is set to \fBon\fR or \fBoff\fR, it determines whether or not
519519
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.
524524
.IP PYTHON_GIL
525525
If this variable is set to 1, the global interpreter lock (GIL) will be forced
526526
on. Setting it to 0 forces the GIL off. Only available in builds configured
527-
with \fB--disable-gil\fP.
527+
with \fB\-\-disable\-gil\fP.
528528
.IP PYTHON_HISTORY
529529
This environment variable can be used to set the location of a history file
530530
(on Unix, it is \fI~/.python_history\fP by default).
531531
.IP
532-
This is equivalent to the \fB-X gil\fR option.
532+
This is equivalent to the \fB\-X gil\fR option.
533533
.IP PYTHONNODEBUGRANGES
534534
If this variable is set, it disables the inclusion of the tables mapping
535535
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.
576576
A value of 0 disables the limit. Conversions to or from bases 2, 4, 8,
577577
16, and 32 are never limited.
578578
.IP
579-
This is equivalent to the \fB-X int_max_str_digits=\fINUMBER\fR option.
579+
This is equivalent to the \fB\-X int_max_str_digits=\fINUMBER\fR option.
580580
.IP PYTHONIOENCODING
581581
If this is set before running the interpreter, it overrides the encoding used
582582
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
686686
the \fB\-u\fP option.
687687
.IP PYTHONUSERBASE
688688
Defines the user base directory, which is used to compute the path of the user
689-
.IR site-packages
689+
.IR site\-packages
690690
directory and installation paths for
691691
.IR "python \-m pip install \-\-user" .
692692
.IP PYTHONUTF8
@@ -704,7 +704,7 @@ specifying the \fB\-W\fP option for each separate value.
704704
.SS Debug-mode variables
705705
Setting these variables only has an effect in a debug build of Python, that is,
706706
if Python was configured with the
707-
\fB\--with-pydebug\fP build option.
707+
\fB\-\-with\-pydebug\fP build option.
708708
.IP PYTHONDUMPREFS
709709
If this environment variable is set, Python will dump objects and reference
710710
counts still alive after shutting down the interpreter.
@@ -718,7 +718,7 @@ early in the interpreter lifecycle, before the \fIsite\fR module is
718718
executed, and before the \fI__main__\fR module is created.
719719
This only works on debug builds.
720720
.IP
721-
This is equivalent to the \fB-X presite=\fImodule\fR option.
721+
This is equivalent to the \fB\-X presite=\fImodule\fR option.
722722
.SH AUTHOR
723723
The Python Software Foundation: https://www.python.org/psf/
724724
.SH INTERNET RESOURCES

0 commit comments

Comments
0 (0)
Morty Proxy This is a proxified and sanitized view of the page, visit original site.