summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorTerry Jan Reedy <tjreedy@udel.edu>2015-09-23 07:52:23 (GMT)
committerTerry Jan Reedy <tjreedy@udel.edu>2015-09-23 07:52:23 (GMT)
commit968e285a8cf8a2e90d752165c235898e31ef3cba (patch)
tree28e3b0e90eebd5714f2a1f865a5f91e1a795d941
parent6f5cdfefa10e89e57c26ddf358bacd044eb7cfc6 (diff)
downloadcpython-968e285a8cf8a2e90d752165c235898e31ef3cba.zip
cpython-968e285a8cf8a2e90d752165c235898e31ef3cba.tar.gz
cpython-968e285a8cf8a2e90d752165c235898e31ef3cba.tar.bz2
Issue #25219: Update doc for Idle command line options.
Some were missing and notes were not correct.
-rw-r--r--Doc/library/idle.rst31
-rw-r--r--Lib/idlelib/help.html33
2 files changed, 33 insertions, 31 deletions
diff --git a/Doc/library/idle.rst b/Doc/library/idle.rst
index ecc7115..24914e4 100644
--- a/Doc/library/idle.rst
+++ b/Doc/library/idle.rst
@@ -504,27 +504,28 @@ Command line usage
::
- idle.py [-c command] [-d] [-e] [-s] [-t title] [arg] ...
-
- -c command run this command
- -d enable debugger
- -e edit mode; arguments are files to be edited
- -s run $IDLESTARTUP or $PYTHONSTARTUP first
+ idle.py [-c command] [-d] [-e] [-h] [-i] [-r file] [-s] [-t title] [-] [arg] ...
+
+ -c command run command in the shell window
+ -d enable debugger and open shell window
+ -e open editor window
+ -h print help message with legal combinatios and exit
+ -i open shell window
+ -r file run file in shell window
+ -s run $IDLESTARTUP or $PYTHONSTARTUP first, in shell window
-t title set title of shell window
+ - run stdin in shell (- must be last option before args)
If there are arguments:
-#. If ``-e`` is used, arguments are files opened for editing and
- ``sys.argv`` reflects the arguments passed to IDLE itself.
+* If ``-``, ``-c``, or ``r`` is used, all arguments are placed in
+ ``sys.argv[1:...]`` and ``sys.argv[0]`` is set to ``''``, ``'-c'``,
+ or ``'-r'``. No editor window is opened, even if that is the default
+ set in the Options dialog.
-#. Otherwise, if ``-c`` is used, all arguments are placed in
- ``sys.argv[1:...]``, with ``sys.argv[0]`` set to ``'-c'``.
+* Otherwise, arguments are files opened for editing and
+ ``sys.argv`` reflects the arguments passed to IDLE itself.
-#. Otherwise, if neither ``-e`` nor ``-c`` is used, the first
- argument is a script which is executed with the remaining arguments in
- ``sys.argv[1:...]`` and ``sys.argv[0]`` set to the script name. If the
- script name is '-', no script is executed but an interactive Python session
- is started; the arguments are still available in ``sys.argv``.
Running without a subprocess
^^^^^^^^^^^^^^^^^^^^^^^^^^^^
diff --git a/Lib/idlelib/help.html b/Lib/idlelib/help.html
index 7623203..bb76275 100644
--- a/Lib/idlelib/help.html
+++ b/Lib/idlelib/help.html
@@ -478,27 +478,28 @@ executed in the Tk namespace, so this file is not useful for importing
functions to be used from IDLE&#8217;s Python shell.</p>
<div class="section" id="command-line-usage">
<h3>25.5.4.1. Command line usage<a class="headerlink" href="#command-line-usage" title="Permalink to this headline">¶</a></h3>
-<div class="highlight-python3"><div class="highlight"><pre>idle.py [-c command] [-d] [-e] [-s] [-t title] [arg] ...
+<div class="highlight-python3"><div class="highlight"><pre>idle.py [-c command] [-d] [-e] [-h] [-i] [-r file] [-s] [-t title] [-] [arg] ...
--c command run this command
--d enable debugger
--e edit mode; arguments are files to be edited
--s run $IDLESTARTUP or $PYTHONSTARTUP first
+-c command run command in the shell window
+-d enable debugger and open shell window
+-e open editor window
+-h print help message with legal combinatios and exit
+-i open shell window
+-r file run file in shell window
+-s run $IDLESTARTUP or $PYTHONSTARTUP first, in shell window
-t title set title of shell window
+- run stdin in shell (- must be last option before args)
</pre></div>
</div>
<p>If there are arguments:</p>
-<ol class="arabic simple">
-<li>If <tt class="docutils literal"><span class="pre">-e</span></tt> is used, arguments are files opened for editing and
+<ul class="simple">
+<li>If <tt class="docutils literal"><span class="pre">-</span></tt>, <tt class="docutils literal"><span class="pre">-c</span></tt>, or <tt class="docutils literal"><span class="pre">r</span></tt> is used, all arguments are placed in
+<tt class="docutils literal"><span class="pre">sys.argv[1:...]</span></tt> and <tt class="docutils literal"><span class="pre">sys.argv[0]</span></tt> is set to <tt class="docutils literal"><span class="pre">''</span></tt>, <tt class="docutils literal"><span class="pre">'-c'</span></tt>,
+or <tt class="docutils literal"><span class="pre">'-r'</span></tt>. No editor window is opened, even if that is the default
+set in the Options dialog.</li>
+<li>Otherwise, arguments are files opened for editing and
<tt class="docutils literal"><span class="pre">sys.argv</span></tt> reflects the arguments passed to IDLE itself.</li>
-<li>Otherwise, if <tt class="docutils literal"><span class="pre">-c</span></tt> is used, all arguments are placed in
-<tt class="docutils literal"><span class="pre">sys.argv[1:...]</span></tt>, with <tt class="docutils literal"><span class="pre">sys.argv[0]</span></tt> set to <tt class="docutils literal"><span class="pre">'-c'</span></tt>.</li>
-<li>Otherwise, if neither <tt class="docutils literal"><span class="pre">-e</span></tt> nor <tt class="docutils literal"><span class="pre">-c</span></tt> is used, the first
-argument is a script which is executed with the remaining arguments in
-<tt class="docutils literal"><span class="pre">sys.argv[1:...]</span></tt> and <tt class="docutils literal"><span class="pre">sys.argv[0]</span></tt> set to the script name. If the
-script name is &#8216;-&#8216;, no script is executed but an interactive Python session
-is started; the arguments are still available in <tt class="docutils literal"><span class="pre">sys.argv</span></tt>.</li>
-</ol>
+</ul>
</div>
<div class="section" id="running-without-a-subprocess">
<h3>25.5.4.2. Running without a subprocess<a class="headerlink" href="#running-without-a-subprocess" title="Permalink to this headline">¶</a></h3>
@@ -661,7 +662,7 @@ are currently:</p>
The Python Software Foundation is a non-profit corporation.
<a href="https://www.python.org/psf/donations/">Please donate.</a>
<br />
- Last updated on Sep 12, 2015.
+ Last updated on Sep 23, 2015.
<a href="../bugs.html">Found a bug</a>?
<br />
Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 1.2.3.