]> git.ipfire.org Git - thirdparty/Python/cpython.git/commitdiff
gh-100247: Improve documentation for custom shebang commands in py.exe launcher ...
authorMiss Islington (bot) <31488909+miss-islington@users.noreply.github.com>
Mon, 16 Jan 2023 17:13:47 +0000 (09:13 -0800)
committerGitHub <noreply@github.com>
Mon, 16 Jan 2023 17:13:47 +0000 (09:13 -0800)
(cherry picked from commit 30753c37c6d00929af6afb5e0bc20bed4656d6b6)

Co-authored-by: Steve Dower <steve.dower@python.org>
Doc/using/windows.rst

index 7272f1b62c65f3bc73759581f00aa2da95a1870f..ce1d55e6e2e2fb231e38da2527bdda72dfd05552 100644 (file)
@@ -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.