Skip to content

Commit 52490b3

Browse files
Jack Desertjonathanslenders
authored andcommitted
Demonstrate Help Menu in README
1 parent 5449dc4 commit 52490b3

File tree

1 file changed

+35
-1
lines changed

1 file changed

+35
-1
lines changed

README.rst

Lines changed: 35 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -50,6 +50,40 @@ Features
5050
[2] If the terminal supports it (most terminals do), this allows pasting
5151
without going into paste mode. It will keep the indentation.
5252

53+
Command Line Options
54+
********************
55+
56+
The help menu shows basic command-line options.
57+
58+
::
59+
60+
$ ptpython --help
61+
usage: ptpython [-h] [--vi] [-i] [--light-bg] [--dark-bg] [--config-file CONFIG_FILE]
62+
[--history-file HISTORY_FILE] [-V]
63+
[args ...]
64+
65+
ptpython: Interactive Python shell.
66+
67+
positional arguments:
68+
args Script and arguments
69+
70+
optional arguments:
71+
-h, --help show this help message and exit
72+
--vi Enable Vi key bindings
73+
-i, --interactive Start interactive shell after executing this file.
74+
--light-bg Run on a light background (use dark colors for text).
75+
--dark-bg Run on a dark background (use light colors for text).
76+
--config-file CONFIG_FILE
77+
Location of configuration file.
78+
--history-file HISTORY_FILE
79+
Location of history file.
80+
-V, --version show program's version number and exit
81+
82+
environment variables:
83+
PTPYTHON_CONFIG_HOME: a configuration directory to use
84+
PYTHONSTARTUP: file executed on interactive startup (no default)
85+
86+
5387
__pt_repr__: A nicer repr with colors
5488
*************************************
5589

@@ -211,7 +245,7 @@ FAQ
211245

212246
**Q**: The ``Meta``-key doesn't work.
213247

214-
**A**: For some terminals you have to enable the Alt-key to act as meta key, but you
248+
**A**: For some terminals you have to enable the Alt-key to act as meta key, but you
215249
can also type ``Escape`` before any key instead.
216250

217251

0 commit comments

Comments
 (0)