various wording fixes for documentation

git-svn-id: svn://svn.savannah.gnu.org/nano/trunk/nano@3460 35c25a1d-7b9e-4130-9fde-d3aeb78583b8
2006-05-01 13:22:47 +00:00 · 2006-05-01 13:22:47 +00:00 · e7f9813284
parent 12c1b5913a
commit e7f9813284
4 changed files with 44 additions and 39 deletions
--- a/4
+++ b/4
@ -182,10 +182,13 @@ CVS code -
 	- Explicitly mention that all regexes should be extended regular
 	  expressions. (DLR, suggested by John M. Gabriele)
 	- Miscellaneous minor fixes. (DLR)
+	- Add various wording fixes. (Benno Schulenberg and DLR)
 - doc/nanorc.5:
 	- Mention that the nanorc file should not be in DOS or Mac
 	  format. (DLR)
 	- Add various wording fixes. (DLR)
+- doc/rnano.1:
+	- Add various wording fixes. (Benno Schulenberg and DLR)
 - doc/nano.texi:
 	- Change license to GPL, in order to match the rest of the
 	  documentation, and because the current license is incompatible
@ -196,6 +199,7 @@ CVS code -
 	  help text, and with nano's current feature set. (DLR)
 	- Add a "Nanorc Files" section to explain the nanorc file format
 	  in detail, using text from nanorc.5. (DLR)
+	- Add various wording fixes. (Benno Schulenberg and DLR)
 - doc/man/fr/nano.1, doc/man/fr/nanorc.5, doc/man/fr/rnano.1:
 	- Updated manpage translations by Jean-Philippe Guérard.
 - doc/nanorc.sample:
--- a/doc/man/nano.1
+++ b/doc/man/nano.1
@ -7,7 +7,7 @@
 .\" warranty.
 .\"
 .\" $Id$
-.TH NANO 1 "version 1.3.12" "April 27, 2006"
+.TH NANO 1 "version 1.3.12" "May 1, 2006"
 .\" Please adjust this date whenever revising the manpage.
 .\"

@ -92,11 +92,11 @@ Set the quoting string for justifying.  The default is
 available, or "\fI>\ \fP" otherwise.
 .TP
 .B \-R (\-\-restricted)
-Restricted mode: Don't read or write to any file not specified on the
-command line, read any nanorc files, allow suspending, or allow a file
+Restricted mode: don't read or write to any file not specified on the
+command line; read any nanorc files; allow suspending; allow a file
 to be appended to, prepended to, or saved under a different name if it
-already has one.  Also accessible by invoking \fBnano\fP with any name
-beginning with 'r' (e.g. "rnano").
+already has one; or use backup files or spell checking.  Also accessible
+by invoking \fBnano\fP with any name beginning with 'r' (e.g. "rnano").
 .TP
 .B \-S (\-\-smooth)
 Enable smooth scrolling.  Text will scroll line-by-line, instead of the
@ -111,7 +111,7 @@ Do quick statusbar blanking.  Statusbar messages will disappear after 1
 keystroke instead of 25.  Note that \fB-c\fP cancels this out.
 .TP
 .B \-V (\-\-version)
-Show the current version number and author.
+Show the current version number and exit.
 .TP
 .B \-W (\-\-wordbounds)
 Detect word boundaries more accurately by treating punctuation
@ -131,7 +131,7 @@ work properly.  You should only need to use this option if Backspace
 acts like Delete on your system.
 .TP
 .B \-h (\-\-help)
-Display a summary of command line options.
+Show a summary of command line options and exit.
 .TP
 .B \-i (\-\-autoindent)
 Indent new lines to the previous line's indentation.  Useful when
--- a/doc/man/rnano.1
+++ b/doc/man/rnano.1
@ -8,7 +8,7 @@
 .\" warranty.
 .\"
 .\" $Id$
-.TH RNANO 1 "version 1.3.12" "April 27, 2006"
+.TH RNANO 1 "version 1.3.12" "May 1, 2006"
 .\" Please adjust this date whenever revising the manpage.
 .\"
 .SH NAME
@ -55,10 +55,10 @@ use backup files or spell checking.
 Same as \fB-h (\-\-help)\fP.
 .TP
 .B \-h (\-\-help)
-Display a summary of command line options.
+Show a summary of command line options and exit.
 .TP
 .B \-V (\-\-version)
-Show the current version number and author.
+Show the current version number and exit.
 .PP
 See the \fBnano\fP(1) manpage for the complete documentation of
 \fBnano\fP.
--- a/doc/texinfo/nano.texi
+++ b/doc/texinfo/nano.texi
@ -9,7 +9,7 @@
@smallbook
@set EDITION 0.1
@set VERSION 1.3.12
-@set UPDATED 27 Apr 2006
+@set UPDATED 01 May 2006

@dircategory Editors
@direntry
@ -147,14 +147,15 @@ if extended regular expression support is available, or "> " otherwise.
 Note that @code{\t} above stands for a literal Tab character.

@item -R, --restricted
-Restricted mode: Don't read or write to any file not specified on the
+Restricted mode: don't read or write to any file not specified on the
 command line; read any nanorc files; allow suspending; allow a file to
 be appended to, prepended to, or saved under a different name if it
 already has one; or use backup files or spell checking.  Also accessible
 by invoking @code{nano} with any name beginning with 'r' (e.g. "rnano").

@item -S, --smooth
-Enable smooth scrolling.
+Enable smooth scrolling.  Text will scroll line-by-line, instead of the
+usual chunk-by-chunk behavior.

@item -T [num], --tabsize=[#cols]
 Set the displayed tab length to #cols columns.  The value of #cols must
@ -165,7 +166,7 @@ Do quick statusbar blanking.  Statusbar messages will disappear after 1
 keystroke instead of 25.  Note that -c cancels this out.

@item -V, --version
-Print the version number and copyright and quit.
+Show the current version number and exit.

@item -W, --wordbounds
 Detect word boundaries more accurately by treating punctuation
@ -185,7 +186,7 @@ work properly.  You should only need to use this option if Backspace
 acts like Delete on your system.

@item -h, --help
-Print the usage and exit.
+Show a summary of command line options and exit.

@item -i, --autoindent
 Automatically indent new lines to the same number of spaces and tabs as
@ -212,7 +213,7 @@ editor can be can be stopped and started.

@item -r [#cols], --fill=[#cols].
 Wrap lines at column #cols.  If this value is 0 or less, wrapping will
-occur at #cols less the width of the screen, allowing it to vary along
+occur at the width of the screen less #cols, allowing it to vary along
 with the width of the screen if the screen is resized.  The default
 value is -8.

@ -229,9 +230,9 @@ composer of a mailer program.

@anchor{Expert Mode}
@item -x, --nohelp
-In Expert Mode, the Shortcut Lists will not appear at the bottom of the
-screen.  This affects the location of the statusbar as well, as in
-Expert Mode it is located at the very bottom of the editor.
+Expert Mode: don't show the Shortcut Lists at the bottom of the screen.
+This affects the location of the statusbar as well, as in Expert Mode it
+is located at the very bottom of the editor.

 Note: When accessing the help system, Expert Mode is temporarily
 disabled to display the help system navigation keys.
@ -287,11 +288,10 @@ the desired key.
 Pressing Esc twice and then typing a three-digit number from 000 to 255
 will enter the character with the corresponding value.
@item
-Meta key sequences can be entered in a number of possible ways: Pressing
-the Esc key, then releasing it and pressing the desired key, or holding
-down the Alt key while pressing the desired key.  This varies from
-keyboard to keyboard, and certain commercial operating systems "swallow"
-the Alt key so that it never reaches the application.  If your operating
+Meta key sequences are entered by holding down the Meta key (normally
+the Alt key) and pressing the desired key, or by pressing the Esc key
+once and pressing the desired key.  Certain operating systems "swallow"
+the Alt key so that it never reaches the application; if your operating
 system does this, you should use the Esc key to generate Meta key
 sequences.
@end itemize
@ -313,9 +313,9 @@ section will display the current directory instead of the filename.  See
@node The Statusbar, Shortcut Lists, The Titlebar, Editor Basics
@section The Statusbar

-The statusbar is located three lines from the bottom of the screen, or
-the bottom line in Expert Mode.  See @xref{Expert Mode}, for more info.
-It shows important and informational messages.  Any error messages that
+The statusbar is the third line from the bottom of the screen, or the
+bottom line in Expert Mode.  See @xref{Expert Mode}, for more info.  It
+shows important and informational messages.  Any error messages that
 occur from using the editor will appear on the statusbar.  Any questions
 that are asked of the user will be asked on the statusbar, and any user
 input (search strings, file names, etc.) will be input on the statusbar.
@ -338,10 +338,10 @@ and ^V (Page Down) keys.  ^X exits the help system.
@node Feature Toggles, Nanorc Files, Online Help, Top
@chapter Feature Toggles

-Toggles allow you to change certain aspects of the editor that
-would normally be done via command line options.  They are invoked via
-certain Meta key sequences.  See @xref{Special Functions}, for more
-info.  The following global toggles are available:
+Toggles allow you to change certain aspects of the editor that would
+normally be done via command line options.  They are invoked via Meta
+key sequences.  See @xref{Special Functions}, for more info.  The
+following global toggles are available:

@table @code

@ -463,7 +463,7 @@ Do case sensitive searches by default.
 Constantly display the cursor position in the status bar.

@item set/unset cut
-Use cut to end of line by default.
+Use cut to end of line by default, instead of cutting the whole line.

@item set fill "n"
 Wrap lines at column number "n".  If "n" is 0 or less, the maximum line
@ -487,8 +487,8 @@ default value is
 Allow use of the blank line below the titlebar as extra editing space.

@item set/unset mouse
-Enable mouse support, so that mouse clicks can be used to set the mark
-and run shortcuts.
+Enable mouse support, so that mouse clicks can be used to place the
+cursor, set the mark (with a double click), or execute shortcuts.

@item set/unset multibuffer
 Allow inserting files into their own buffers.
@ -511,7 +511,7 @@ Don't wrap text at all.
@item set operatingdir "directory"
@code{nano} will only read and write files inside "directory" and its
 subdirectories.  Also, the current directory is changed to here, so
-files are inserted from this diractory.  By default, the operating
+files are inserted from this directory.  By default, the operating
 directory feature is turned off.

@item set/unset preserve
@ -688,11 +688,11 @@ the given column position, as well as the row and total character
 position of the cursor.

@item Interactive Replace and Spell Checker
-It is worth noting that the @code{nano} replace function is interactive,
+It is worth noting that @code{nano}'s replace function is interactive,
 i.e, it does not stop after one search string is found and automatically
-replace it.  The @code{nano} implementation will stop at each search
+replace it.  The @code{nano} implementation will pause at each search
 string found and query whether to replace this instance or not.  The
-internal spell checker operates similarly.  Note that these is no way to
+internal spell checker operates similarly.  Note that there is no way to
 force these functions to behave in the Pico fashion.  As of version
 1.1.99pre1, misspelled words are sorted and trimmed for uniqueness in
 the internal spell checker such that the words 'apple' and 'Apple' will
@ -714,8 +714,9 @@ familiar with compiling programs with autoconf support:
@item make install
@end itemize

-@table @code
+The possible options to @code{./configure} are:

+@table @code

@item --disable-browser
 Disable the mini file browser when reading or writing files.