summaryrefslogtreecommitdiffstats
path: root/Doc/using
diff options
context:
space:
mode:
authorMiss Islington (bot) <31488909+miss-islington@users.noreply.github.com>2023-01-16 17:13:47 (GMT)
committerGitHub <noreply@github.com>2023-01-16 17:13:47 (GMT)
commita3510c3a4e7922987e083dffc19ecd93c85d153b (patch)
tree0e70e7afd258190d0007c3b58671a76497545505 /Doc/using
parent87ade7ebda2e04aa9fb1930894fd3cadb88eee0b (diff)
downloadcpython-a3510c3a4e7922987e083dffc19ecd93c85d153b.zip
cpython-a3510c3a4e7922987e083dffc19ecd93c85d153b.tar.gz
cpython-a3510c3a4e7922987e083dffc19ecd93c85d153b.tar.bz2
gh-100247: Improve documentation for custom shebang commands in py.exe launcher (GH-101083)
(cherry picked from commit 30753c37c6d00929af6afb5e0bc20bed4656d6b6) Co-authored-by: Steve Dower <steve.dower@python.org>
Diffstat (limited to 'Doc/using')
-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 7272f1b..ce1d55e 100644
--- a/Doc/using/windows.rst
+++ b/Doc/using/windows.rst
@@ -867,14 +867,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.