summaryrefslogtreecommitdiffstats
path: root/Doc/using
diff options
context:
space:
mode:
authorÉric <earaujo@caravan.coop>2022-06-01 09:50:01 (GMT)
committerGitHub <noreply@github.com>2022-06-01 09:50:01 (GMT)
commit8aa9d40b00741213c5a53b1ae15509998893ae31 (patch)
tree75b85a42e550b8190cfaf915113ebb486f459752 /Doc/using
parent132e563703ed634312e54c04a9b1636f8b0e2923 (diff)
downloadcpython-8aa9d40b00741213c5a53b1ae15509998893ae31.zip
cpython-8aa9d40b00741213c5a53b1ae15509998893ae31.tar.gz
cpython-8aa9d40b00741213c5a53b1ae15509998893ae31.tar.bz2
gh-90300: split --help output into separate options (#30331)
Make --help output shorter and add new help options. --help-env, --help-xoptions and --help-all command-line options are added to complement --help.
Diffstat (limited to 'Doc/using')
-rw-r--r--Doc/using/cmdline.rst27
1 files changed, 26 insertions, 1 deletions
diff --git a/Doc/using/cmdline.rst b/Doc/using/cmdline.rst
index 07c05a9..d9f6afb 100644
--- a/Doc/using/cmdline.rst
+++ b/Doc/using/cmdline.rst
@@ -183,6 +183,8 @@ automatically enabled, if available on your platform (see
Automatic enabling of tab-completion and history editing.
+.. _using-on-generic-options:
+
Generic options
~~~~~~~~~~~~~~~
@@ -190,8 +192,28 @@ Generic options
-h
--help
- Print a short description of all command line options.
+ Print a short description of all command line options and corresponding
+ environment variables and exit.
+
+.. cmdoption:: --help-env
+
+ Print a short description of Python-specific environment variables
+ and exit.
+
+ .. versionadded:: 3.11
+
+.. cmdoption:: --help-xoptions
+ Print a description of implementation-specific :option:`-X` options
+ and exit.
+
+ .. versionadded:: 3.11
+
+.. cmdoption:: --help-all
+
+ Print complete usage information and exit.
+
+ .. versionadded:: 3.11
.. cmdoption:: -V
--version
@@ -212,6 +234,7 @@ Generic options
.. versionadded:: 3.6
The ``-VV`` option.
+
.. _using-on-misc-options:
Miscellaneous options
@@ -460,6 +483,7 @@ Miscellaneous options
See :ref:`warning-filter` and :ref:`describing-warning-filters` for more
details.
+
.. cmdoption:: -x
Skip the first line of the source, allowing use of non-Unix forms of
@@ -553,6 +577,7 @@ Miscellaneous options
The ``-X frozen_modules`` option.
+
Options you shouldn't use
~~~~~~~~~~~~~~~~~~~~~~~~~