summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorFred Drake <fdrake@acm.org>2001-07-12 02:09:51 (GMT)
committerFred Drake <fdrake@acm.org>2001-07-12 02:09:51 (GMT)
commit682d5f3cdace81b656d0d76e298f657e2da75b03 (patch)
tree86c8cf801b9b44ce50dc45801d97d4d60ca83e6b
parent07178d237ac180a9daa48af2a4c7b5b00d07dcfc (diff)
downloadcpython-682d5f3cdace81b656d0d76e298f657e2da75b03.zip
cpython-682d5f3cdace81b656d0d76e298f657e2da75b03.tar.gz
cpython-682d5f3cdace81b656d0d76e298f657e2da75b03.tar.bz2
Follow the recommended practices for keystroke representation; this
improves internal consistency in the documentation.
-rw-r--r--Doc/lib/libcmd.tex8
-rw-r--r--Doc/lib/libcurses.tex38
-rw-r--r--Doc/lib/libexcs.tex2
3 files changed, 25 insertions, 23 deletions
diff --git a/Doc/lib/libcmd.tex b/Doc/lib/libcmd.tex
index 54d924f..847aa20 100644
--- a/Doc/lib/libcmd.tex
+++ b/Doc/lib/libcmd.tex
@@ -33,10 +33,10 @@ The optional argument is a banner or intro string to be issued before the
first prompt (this overrides the \member{intro} class member).
If the \module{readline} module is loaded, input will automatically
-inherit \program{bash}-like history-list editing (e.g. \kbd{Ctrl-P}
-scrolls back to the last command, \kbd{Ctrl-N} forward to the next
-one, \kbd{Ctrl-F} moves the cursor to the right non-destructively,
-\kbd{Ctrl-B} moves the cursor to the left non-destructively, etc.).
+inherit \program{bash}-like history-list editing (e.g. \kbd{Control-P}
+scrolls back to the last command, \kbd{Control-N} forward to the next
+one, \kbd{Control-F} moves the cursor to the right non-destructively,
+\kbd{Control-B} moves the cursor to the left non-destructively, etc.).
An end-of-file on input is passed back as the string \code{'EOF'}.
diff --git a/Doc/lib/libcurses.tex b/Doc/lib/libcurses.tex
index ebe78a5..605cc26 100644
--- a/Doc/lib/libcurses.tex
+++ b/Doc/lib/libcurses.tex
@@ -1304,20 +1304,22 @@ Process a single command keystroke. Here are the supported special
keystrokes:
\begin{tableii}{l|l}{kbd}{Keystroke}{Action}
- \lineii{Ctrl-A}{Go to left edge of window.}
- \lineii{Ctrl-B}{Cursor left, wrapping to previous line if appropriate.}
- \lineii{Ctrl-D}{Delete character under cursor.}
- \lineii{Ctrl-E}{Go to right edge (stripspaces off) or end of line
+ \lineii{Control-A}{Go to left edge of window.}
+ \lineii{Control-B}{Cursor left, wrapping to previous line if appropriate.}
+ \lineii{Control-D}{Delete character under cursor.}
+ \lineii{Control-E}{Go to right edge (stripspaces off) or end of line
(stripspaces on).}
- \lineii{Ctrl-F}{Cursor right, wrapping to next line when appropriate.}
- \lineii{Ctrl-G}{Terminate, returning the window contents.}
- \lineii{Ctrl-H}{Delete character backward.}
- \lineii{Ctrl-J}{Terminate if the window is 1 line, otherwise insert newline.}
- \lineii{Ctrl-K}{If line is blank, delete it, otherwise clear to end of line.}
- \lineii{Ctrl-L}{Refresh screen.}
- \lineii{Ctrl-N}{Cursor down; move down one line.}
- \lineii{Ctrl-O}{Insert a blank line at cursor location.}
- \lineii{Ctrl-P}{Cursor up; move up one line.}
+ \lineii{Control-F}{Cursor right, wrapping to next line when appropriate.}
+ \lineii{Control-G}{Terminate, returning the window contents.}
+ \lineii{Control-H}{Delete character backward.}
+ \lineii{Control-J}{Terminate if the window is 1 line, otherwise
+ insert newline.}
+ \lineii{Control-K}{If line is blank, delete it, otherwise clear to
+ end of line.}
+ \lineii{Control-L}{Refresh screen.}
+ \lineii{Control-N}{Cursor down; move down one line.}
+ \lineii{Control-O}{Insert a blank line at cursor location.}
+ \lineii{Control-P}{Cursor up; move up one line.}
\end{tableii}
Move operations do nothing if the cursor is at an edge where the
@@ -1325,11 +1327,11 @@ movement is not possible. The following synonyms are supported where
possible:
\begin{tableii}{l|l}{constant}{Constant}{Keystroke}
- \lineii{KEY_LEFT}{\kbd{Ctrl-B}}
- \lineii{KEY_RIGHT}{\kbd{Ctrl-F}}
- \lineii{KEY_UP}{\kbd{Ctrl-P}}
- \lineii{KEY_DOWN}{\kbd{Ctrl-N}}
- \lineii{KEY_BACKSPACE}{\kbd{Ctrl-h}}
+ \lineii{KEY_LEFT}{\kbd{Control-B}}
+ \lineii{KEY_RIGHT}{\kbd{Control-F}}
+ \lineii{KEY_UP}{\kbd{Control-P}}
+ \lineii{KEY_DOWN}{\kbd{Control-N}}
+ \lineii{KEY_BACKSPACE}{\kbd{Control-h}}
\end{tableii}
All other keystrokes are treated as a command to insert the given
diff --git a/Doc/lib/libexcs.tex b/Doc/lib/libexcs.tex
index 7e34bd0..65b1dd8 100644
--- a/Doc/lib/libexcs.tex
+++ b/Doc/lib/libexcs.tex
@@ -177,7 +177,7 @@ Raised when an \keyword{assert} statement fails.
\begin{excdesc}{KeyboardInterrupt}
Raised when the user hits the interrupt key (normally
- \kbd{Control-C} or \kbd{DEL}). During execution, a check for
+ \kbd{Control-C} or \kbd{Delete}). During execution, a check for
interrupts is made regularly.
% XXXJH xrefs here
Interrupts typed when a built-in function \function{input()} or