summaryrefslogtreecommitdiffstats
path: root/Doc
diff options
context:
space:
mode:
authorSteve Dower <steve.dower@python.org>2023-01-16 17:01:04 (GMT)
committerGitHub <noreply@github.com>2023-01-16 17:01:04 (GMT)
commit30753c37c6d00929af6afb5e0bc20bed4656d6b6 (patch)
treee9ed607af54b9ca5b0d6070a2154731968635913 /Doc
parentdf10571a130c46d67756239e76ad69a3d730a990 (diff)
downloadcpython-30753c37c6d00929af6afb5e0bc20bed4656d6b6.zip
cpython-30753c37c6d00929af6afb5e0bc20bed4656d6b6.tar.gz
cpython-30753c37c6d00929af6afb5e0bc20bed4656d6b6.tar.bz2
gh-100247: Improve documentation for custom shebang commands in py.exe launcher (GH-101083)
Diffstat (limited to 'Doc')
-rw-r--r--Doc/using/windows.rst9
1 files changed, 5 insertions, 4 deletions
diff --git a/Doc/using/windows.rst b/Doc/using/windows.rst
index 69bca4d..b2a0214 100644
--- a/Doc/using/windows.rst
+++ b/Doc/using/windows.rst
@@ -880,14 +880,15 @@ The environment variable :envvar:`PYLAUNCHER_NO_SEARCH_PATH` may be set
Shebang lines that do not match any of these patterns are looked up in the
``[commands]`` section of the launcher's :ref:`.INI file <launcher-ini>`.
This may be used to handle certain commands in a way that makes sense for your
-system. The name of the command must be a single argument (no spaces),
-and the value substituted is the full path to the executable (no arguments
-may be added).
+system. The name of the command must be a single argument (no spaces in the
+shebang executable), and the value substituted is the full path to the
+executable (additional arguments specified in the .INI will be quoted as part
+of the filename).
.. code-block:: ini
[commands]
- /bin/sh=C:\Program Files\Bash\bash.exe
+ /bin/xpython=C:\Program Files\XPython\python.exe
Any commands not found in the .INI file are treated as **Windows** executable
paths that are absolute or relative to the directory containing the script file.