various wording fixes for documentation

git-svn-id: svn://svn.savannah.gnu.org/nano/trunk/nano@3460 35c25a1d-7b9e-4130-9fde-d3aeb78583b8
master
David Lawrence Ramsey 2006-05-01 13:22:47 +00:00
parent 12c1b5913a
commit e7f9813284
4 changed files with 44 additions and 39 deletions

View File

@ -182,10 +182,13 @@ CVS code -
- Explicitly mention that all regexes should be extended regular - Explicitly mention that all regexes should be extended regular
expressions. (DLR, suggested by John M. Gabriele) expressions. (DLR, suggested by John M. Gabriele)
- Miscellaneous minor fixes. (DLR) - Miscellaneous minor fixes. (DLR)
- Add various wording fixes. (Benno Schulenberg and DLR)
- doc/nanorc.5: - doc/nanorc.5:
- Mention that the nanorc file should not be in DOS or Mac - Mention that the nanorc file should not be in DOS or Mac
format. (DLR) format. (DLR)
- Add various wording fixes. (DLR) - Add various wording fixes. (DLR)
- doc/rnano.1:
- Add various wording fixes. (Benno Schulenberg and DLR)
- doc/nano.texi: - doc/nano.texi:
- Change license to GPL, in order to match the rest of the - Change license to GPL, in order to match the rest of the
documentation, and because the current license is incompatible documentation, and because the current license is incompatible
@ -196,6 +199,7 @@ CVS code -
help text, and with nano's current feature set. (DLR) help text, and with nano's current feature set. (DLR)
- Add a "Nanorc Files" section to explain the nanorc file format - Add a "Nanorc Files" section to explain the nanorc file format
in detail, using text from nanorc.5. (DLR) 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: - doc/man/fr/nano.1, doc/man/fr/nanorc.5, doc/man/fr/rnano.1:
- Updated manpage translations by Jean-Philippe Guérard. - Updated manpage translations by Jean-Philippe Guérard.
- doc/nanorc.sample: - doc/nanorc.sample:

View File

@ -7,7 +7,7 @@
.\" warranty. .\" warranty.
.\" .\"
.\" $Id$ .\" $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. .\" 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. available, or "\fI>\ \fP" otherwise.
.TP .TP
.B \-R (\-\-restricted) .B \-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, or allow a file 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 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 already has one; or use backup files or spell checking. Also accessible
beginning with 'r' (e.g. "rnano"). by invoking \fBnano\fP with any name beginning with 'r' (e.g. "rnano").
.TP .TP
.B \-S (\-\-smooth) .B \-S (\-\-smooth)
Enable smooth scrolling. Text will scroll line-by-line, instead of the 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. keystroke instead of 25. Note that \fB-c\fP cancels this out.
.TP .TP
.B \-V (\-\-version) .B \-V (\-\-version)
Show the current version number and author. Show the current version number and exit.
.TP .TP
.B \-W (\-\-wordbounds) .B \-W (\-\-wordbounds)
Detect word boundaries more accurately by treating punctuation 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. acts like Delete on your system.
.TP .TP
.B \-h (\-\-help) .B \-h (\-\-help)
Display a summary of command line options. Show a summary of command line options and exit.
.TP .TP
.B \-i (\-\-autoindent) .B \-i (\-\-autoindent)
Indent new lines to the previous line's indentation. Useful when Indent new lines to the previous line's indentation. Useful when

View File

@ -8,7 +8,7 @@
.\" warranty. .\" warranty.
.\" .\"
.\" $Id$ .\" $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. .\" Please adjust this date whenever revising the manpage.
.\" .\"
.SH NAME .SH NAME
@ -55,10 +55,10 @@ use backup files or spell checking.
Same as \fB-h (\-\-help)\fP. Same as \fB-h (\-\-help)\fP.
.TP .TP
.B \-h (\-\-help) .B \-h (\-\-help)
Display a summary of command line options. Show a summary of command line options and exit.
.TP .TP
.B \-V (\-\-version) .B \-V (\-\-version)
Show the current version number and author. Show the current version number and exit.
.PP .PP
See the \fBnano\fP(1) manpage for the complete documentation of See the \fBnano\fP(1) manpage for the complete documentation of
\fBnano\fP. \fBnano\fP.

View File

@ -9,7 +9,7 @@
@smallbook @smallbook
@set EDITION 0.1 @set EDITION 0.1
@set VERSION 1.3.12 @set VERSION 1.3.12
@set UPDATED 27 Apr 2006 @set UPDATED 01 May 2006
@dircategory Editors @dircategory Editors
@direntry @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. Note that @code{\t} above stands for a literal Tab character.
@item -R, --restricted @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 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 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 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"). by invoking @code{nano} with any name beginning with 'r' (e.g. "rnano").
@item -S, --smooth @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] @item -T [num], --tabsize=[#cols]
Set the displayed tab length to #cols columns. The value of #cols must 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. keystroke instead of 25. Note that -c cancels this out.
@item -V, --version @item -V, --version
Print the version number and copyright and quit. Show the current version number and exit.
@item -W, --wordbounds @item -W, --wordbounds
Detect word boundaries more accurately by treating punctuation 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. acts like Delete on your system.
@item -h, --help @item -h, --help
Print the usage and exit. Show a summary of command line options and exit.
@item -i, --autoindent @item -i, --autoindent
Automatically indent new lines to the same number of spaces and tabs as 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]. @item -r [#cols], --fill=[#cols].
Wrap lines at column #cols. If this value is 0 or less, wrapping will 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 with the width of the screen if the screen is resized. The default
value is -8. value is -8.
@ -229,9 +230,9 @@ composer of a mailer program.
@anchor{Expert Mode} @anchor{Expert Mode}
@item -x, --nohelp @item -x, --nohelp
In Expert Mode, the Shortcut Lists will not appear at the bottom of the Expert Mode: don't show the Shortcut Lists at the bottom of the screen.
screen. This affects the location of the statusbar as well, as in This affects the location of the statusbar as well, as in Expert Mode it
Expert Mode it is located at the very bottom of the editor. is located at the very bottom of the editor.
Note: When accessing the help system, Expert Mode is temporarily Note: When accessing the help system, Expert Mode is temporarily
disabled to display the help system navigation keys. 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 Pressing Esc twice and then typing a three-digit number from 000 to 255
will enter the character with the corresponding value. will enter the character with the corresponding value.
@item @item
Meta key sequences can be entered in a number of possible ways: Pressing Meta key sequences are entered by holding down the Meta key (normally
the Esc key, then releasing it and pressing the desired key, or holding the Alt key) and pressing the desired key, or by pressing the Esc key
down the Alt key while pressing the desired key. This varies from once and pressing the desired key. Certain operating systems "swallow"
keyboard to keyboard, and certain commercial operating systems "swallow" the Alt key so that it never reaches the application; if your operating
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 system does this, you should use the Esc key to generate Meta key
sequences. sequences.
@end itemize @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 @node The Statusbar, Shortcut Lists, The Titlebar, Editor Basics
@section The Statusbar @section The Statusbar
The statusbar is located three lines from the bottom of the screen, or The statusbar is the third line from the bottom of the screen, or the
the bottom line in Expert Mode. See @xref{Expert Mode}, for more info. bottom line in Expert Mode. See @xref{Expert Mode}, for more info. It
It shows important and informational messages. Any error messages that shows important and informational messages. Any error messages that
occur from using the editor will appear on the statusbar. Any questions 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 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. 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 @node Feature Toggles, Nanorc Files, Online Help, Top
@chapter Feature Toggles @chapter Feature Toggles
Toggles allow you to change certain aspects of the editor that Toggles allow you to change certain aspects of the editor that would
would normally be done via command line options. They are invoked via normally be done via command line options. They are invoked via Meta
certain Meta key sequences. See @xref{Special Functions}, for more key sequences. See @xref{Special Functions}, for more info. The
info. The following global toggles are available: following global toggles are available:
@table @code @table @code
@ -463,7 +463,7 @@ Do case sensitive searches by default.
Constantly display the cursor position in the status bar. Constantly display the cursor position in the status bar.
@item set/unset cut @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" @item set fill "n"
Wrap lines at column number "n". If "n" is 0 or less, the maximum line 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. Allow use of the blank line below the titlebar as extra editing space.
@item set/unset mouse @item set/unset mouse
Enable mouse support, so that mouse clicks can be used to set the mark Enable mouse support, so that mouse clicks can be used to place the
and run shortcuts. cursor, set the mark (with a double click), or execute shortcuts.
@item set/unset multibuffer @item set/unset multibuffer
Allow inserting files into their own buffers. Allow inserting files into their own buffers.
@ -511,7 +511,7 @@ Don't wrap text at all.
@item set operatingdir "directory" @item set operatingdir "directory"
@code{nano} will only read and write files inside "directory" and its @code{nano} will only read and write files inside "directory" and its
subdirectories. Also, the current directory is changed to here, so 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. directory feature is turned off.
@item set/unset preserve @item set/unset preserve
@ -688,11 +688,11 @@ the given column position, as well as the row and total character
position of the cursor. position of the cursor.
@item Interactive Replace and Spell Checker @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 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 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 force these functions to behave in the Pico fashion. As of version
1.1.99pre1, misspelled words are sorted and trimmed for uniqueness in 1.1.99pre1, misspelled words are sorted and trimmed for uniqueness in
the internal spell checker such that the words 'apple' and 'Apple' will 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 @item make install
@end itemize @end itemize
@table @code The possible options to @code{./configure} are:
@table @code
@item --disable-browser @item --disable-browser
Disable the mini file browser when reading or writing files. Disable the mini file browser when reading or writing files.