Skip to content

Commit bf3af6c

Browse files
committed
Changelog and man-page updates.
1 parent 51b2114 commit bf3af6c

File tree

4 files changed

+48
-82
lines changed

4 files changed

+48
-82
lines changed

CHANGELOG

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,8 @@ function.
1515
The history file is now really configurable. This issue was reported
1616
in Debian's bugtracker.
1717

18-
bpython has now some basic support for Python 3 (requires Pygments >=1.1.1)
18+
bpython has now some basic support for Python 3 (requires Pygments >=1.1.1).
19+
As a result, setuptools is now optional.
1920

2021
The pastebin URL is now configurable and the default pastebin is now
2122
bpaste.net

bpython/cli.py

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1199,9 +1199,7 @@ def repl(self):
11991199

12001200
# Use our own helper function because Python's will use real stdin and
12011201
# stdout instead of our wrapped
1202-
self.push('from bpython import _internal\n')
1203-
self.push('help = _internal._help')
1204-
self.push('del _internal')
1202+
self.push('from bpython._internal import _help as help\n')
12051203

12061204
self.iy, self.ix = self.scr.getyx()
12071205
more = False

doc/bpython-config.5

Lines changed: 4 additions & 39 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
.\" First parameter, NAME, should be all caps
33
.\" Second parameter, SECTION, should be 1-8, maybe w/ subsection
44
.\" other parameters are allowed: see man(7), man(1)
5-
.TH BPYTHON-CONFIG 5 "August 13, 2008"
5+
.TH BPYTHON-CONFIG 5 "September 21, 2009"
66
.\" Please adjust this date whenever revising the manpage.
77
.\"
88
.\" Some roff macros, for reference:
@@ -22,45 +22,10 @@ config \- user configuration file for bpython
2222
.SH DESCRIPTION
2323
The
2424
.B config
25-
contains various options controlling the behaviour of
26-
.B bpython
27-
.
25+
contains various options controlling the behaviour of \fBbpython\fR.
2826

29-
Boolean values are
30-
.B True, False
31-
32-
The various options are:
33-
34-
.B auto_display_list
35-
.BI boolean
36-
(default: True)
37-
.RS
38-
Display the autocomplete list as you type. When this is off, you can hit tab to see the suggestions.
39-
.RE
40-
41-
.B syntax
42-
.BI boolean
43-
(default: True)
44-
.RS
45-
Syntax highlighting as you type.
46-
.RE
47-
48-
.B arg_spec
49-
.BI boolean
50-
(default: True)
51-
.RS
52-
Display the arg spec (list of arguments) for callables, when possible.
53-
.RE
54-
55-
.B tab_length
56-
.BI integer
57-
(default: 4)
58-
.RS
59-
The number of spaces a soft tab equals.
60-
.RE
61-
62-
.SH SEE ALSO
63-
.BR bpython (1).
27+
See http://docs.bpython-interpreter.org/configuration.html for a full
28+
description of the configuration file.
6429

6530
.SH AUTHOR
6631
bpython was written by Robert Anthony Farrell <robertanthonyfarrel@gmail.com> and his bunch of loyal followers.

doc/bpython.1

Lines changed: 41 additions & 39 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
.\" First parameter, NAME, should be all caps
33
.\" Second parameter, SECTION, should be 1-8, maybe w/ subsection
44
.\" other parameters are allowed: see man(7), man(1)
5-
.TH BPYTHON 1 "August 13, 2008"
5+
.TH BPYTHON 1 "September 21, 2009"
66
.\" Please adjust this date whenever revising the manpage.
77
.\"
88
.\" Some roff macros, for reference:
@@ -19,7 +19,7 @@
1919
bpython \- a fancy curses interface to the Python interactive interpreter
2020
.SH SYNOPSIS
2121
.B bpython
22-
.I ini file
22+
[\fIoptions\fR] [\fIfile\fR [\fIargs\fR]]
2323
.SH DESCRIPTION
2424
The idea is to provide the user with all the features
2525
in\-line, much like modern IDEs, but in a simple,
@@ -51,53 +51,55 @@ This posts the current buffer to a pastebin (paste.pocoo.org) or writes it to a
5151
Unlike other curses apps, bpython dumps the screen data to stdout when you quit, so you see what you've done in the buffer of your terminal.
5252
.RE
5353

54+
.SH OPTIONS
55+
The long and short forms of options, shown here as alternatives, are
56+
equivalent. If bpython sees an argument it does not know, execution falls
57+
back to the regular Python interpreter.
58+
.IP "\fB\-c\fR \fIconfig\fR" 4
59+
.PD 0
60+
.IP "\fB\-\-config=\fR\fIconfig\fR" 4
61+
.PD
62+
Use \fIconfig\fR instead of default config file.
63+
.IP "\fB\-h\fR" 4
64+
.PD 0
65+
.IP "\fB\-\-help\fR" 4
66+
.PD
67+
Show the help message and exit.
68+
.IP "\fB\-i\fR" 4
69+
.PD 0
70+
.IP "\fB\-\-interactive\fR" 4
71+
.PD
72+
Drop to bpython shell after running \fIfile\fR instead of exiting.
73+
.IP "\fB\-q\fR" 4
74+
.PD 0
75+
.IP "\fB\-\-quiet\fR" 4
76+
.PD
77+
Do not flush the output to stdout.
78+
.IP "\fB\-V\fR" 4
79+
.PD 0
80+
.IP "\fB\-\-version\fR" 4
81+
.PD
82+
Print bpython's version and exit.
83+
5484
.SH KEYS
55-
.B <C\-d>
56-
Exit
57-
.RS
58-
Exits the interpreter, like normal interactive Python.
59-
.RE
60-
.B <C\-r>
61-
Rewind
62-
.RS
63-
Rewinds and "undoes" the last statement, read
64-
.B DESCRIPTION
65-
for more info.
66-
.RE
67-
.B <F2>
68-
Save
69-
.RS
70-
Saves the current buffer to a file.
71-
.RE
72-
.B <F8>
73-
Pastebin
74-
.RS
75-
Posts the current buffer to
76-
.B http://paste.pocoo.org/
77-
(will probably become configurable), and displays the URL.
78-
.RE
79-
.B <Tab>
80-
Autocomplete
81-
.RS
82-
If there's an unambigious completion of the expression, fill it in.
83-
.RE
85+
bpython's keys are fully configurable. See
86+
http://docs.bpython-interpreter.org/configuration.html#keyboard
8487

8588
.SH FILES
86-
~/.bpython.ini
89+
~/.bpython/config
8790
.RS
88-
Your bpython config. See sample.ini (in /usr/share/docs/bpython/examples on Debian) for various options you can use, or read
89-
.BR bpython.ini (5)
91+
Your bpython config. See sample-config (in /usr/share/docs/bpython/examples on Debian) for various options you can use, or read
92+
.BR bpython-config (5)
9093
.
9194
.RE
9295

96+
.SH KNOWN BUGS
97+
See http://bitbucket.org/bobf/bpython/issues/ for a list of known issues.
98+
9399
.SH SEE ALSO
94-
.BR bpython.ini (5),
100+
.BR bpython-config (5),
95101
.BR python (1).
96102

97-
.SH KNOWN BUGS
98-
Triple quoted strings over multiple lines work, but they're not highlighted
99-
properly.
100-
101103
.SH AUTHOR
102104
bpython was written by Robert Anthony Farrell <robertanthonyfarrel@gmail.com> and his bunch of loyal followers.
103105
.PP

0 commit comments

Comments
 (0)