Skip to content

Commit ea6569b

Browse files
committed
Document -X opt also in the man page
1 parent e55beb8 commit ea6569b

File tree

1 file changed

+39
-1
lines changed

1 file changed

+39
-1
lines changed

Misc/python.man

Lines changed: 39 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -273,7 +273,45 @@ field matches the line number, where zero matches all line numbers and
273273
is thus equivalent to an omitted line number.
274274
.TP
275275
.BI "\-X " option
276-
Set implementation specific option.
276+
Set implementation specific option. The following options are available:
277+
278+
-X faulthandler: enable faulthandler
279+
280+
-X showrefcount: output the total reference count and number of used
281+
memory blocks when the program finishes or after each statement in the
282+
interactive interpreter. This only works on debug builds
283+
284+
-X tracemalloc: start tracing Python memory allocations using the
285+
tracemalloc module. By default, only the most recent frame is stored in a
286+
traceback of a trace. Use -X tracemalloc=NFRAME to start tracing with a
287+
traceback limit of NFRAME frames
288+
289+
-X showalloccount: output the total count of allocated objects for each
290+
type when the program finishes. This only works when Python was built with
291+
COUNT_ALLOCS defined
292+
293+
-X importtime: show how long each import takes. It shows module name,
294+
cumulative time (including nested imports) and self time (excluding
295+
nested imports). Note that its output may be broken in multi-threaded
296+
application. Typical usage is python3 -X importtime -c 'import asyncio'
297+
298+
-X dev: enable CPython’s “development mode”, introducing additional runtime
299+
checks which are too expensive to be enabled by default. It will not be
300+
more verbose than the default if the code is correct: new warnings are
301+
only emitted when an issue is detected. Effect of the developer mode:
302+
* Add default warning filter, as -W default
303+
* Install debug hooks on memory allocators: see the PyMem_SetupDebugHooks() C function
304+
* Enable the faulthandler module to dump the Python traceback on a crash
305+
* Enable asyncio debug mode
306+
* Set the dev_mode attribute of sys.flags to True
307+
* io.IOBase destructor logs close() exceptions
308+
309+
-X utf8: enable UTF-8 mode for operating system interfaces, overriding the default
310+
locale-aware mode. -X utf8=0 explicitly disables UTF-8 mode (even when it would
311+
otherwise activate automatically). See PYTHONUTF8 for more details
312+
313+
-X pycache_prefix=PATH: enable writing .pyc files to a parallel tree rooted at the
314+
given directory instead of to the code tree.
277315
.TP
278316
.B \-x
279317
Skip the first line of the source. This is intended for a DOS

0 commit comments

Comments
 (0)