ariadne
/
smol
2
1
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

Synchronizing the documentation, and tweaking some wording. 

git-svn-id: svn://svn.savannah.gnu.org/nano/trunk/nano@4846 35c25a1d-7b9e-4130-9fde-d3aeb78583b8
master
Benno Schulenberg 2014-05-06 20:43:00 +00:00
parent aa9b1eeeaa
commit c1c67d8a14
4 changed files with 98 additions and 81 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
ChangeLog
View File

@ -3,6 +3,8 @@
* doc/syntax/texinfo.nanorc: New file, colouring for Texinfo files.
* doc/texinfo/nano.texi: Add sections on the Cutbuffer and the Mark,
remove option '-?', and make some other tweaks.
* doc/man/{nano.1,nanorc.5}, doc/texinfo/nano.texi: Synchronize the
documentation, and tweak some wording here and there.
2014-05-05 Benno Schulenberg <bensberg@justemail.net>
* doc/man/nanorc.5: Give syntax highlighting its own section,

60
doc/man/nano.1
View File

@ -45,9 +45,6 @@ Places the cursor on line number \fIline\fP and at column number \fIcolumn\fP
(at least one of which must be specified) on startup, instead of the
default line 1, column 1.
.TP
.B \-?
Same as \fB\-h (\-\-help)\fP.
.TP
.B \-A (\-\-smarthome)
Make the Home key smarter. When Home is pressed anywhere but at the
very beginning of non-whitespace characters on a line, the cursor will
@ -57,10 +54,10 @@ line.
.TP
.B \-B (\-\-backup)
When saving a file, back up the previous version of it to the current
filename suffixed with a ~.
filename suffixed with a tilde (\fB~\fP).
.TP
.B \-C \fIdir\fP (\-\-backupdir=\fIdir\fP)
Set the directory where \fBnano\fP puts unique backup files if file
Set the directory where \fBnano\fP puts unique backup files, if file
backups are enabled.
.TP
.B \-D (\-\-boldtext)
@ -109,19 +106,19 @@ Tab.
.TP
.B \-R (\-\-restricted)
Restricted mode: don't read or write to any file not specified on the
command line; read any \fInanorc\fP 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 \fBnano\fP with any name beginning with 'r' (e.g.
"rnano").
command line; don't read any \fInanorc\fP files; don't allow suspending;
don't allow a file to be appended to, prepended to, or saved under a
different name if it already has one; don't use backup files nor spell
checking. This restricted mode is 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
usual chunk-by-chunk behavior.
.TP
.B \-T \fIcols\fP (\-\-tabsize=\fIcols\fP)
Set the size (width) of a tab to \fIcols\fP columns. The value of
\fIcols\fP must be greater than 0. The default value is 8.
.B \-T \fInumber\fP (\-\-tabsize=\fInumber\fP)
Set the size (width) of a tab to \fInumber\fP columns. The value of
\fInumber\fP must be greater than 0. The default value is 8.
.TP
.B \-U (\-\-quickblank)
Do quick statusbar blanking. Statusbar messages will disappear after 1
@ -154,7 +151,8 @@ Indent new lines to the previous line's indentation. Useful when
editing source code.
.TP
.B \-k (\-\-cut)
Enable cut from cursor to end of line.
Make the 'Cut Text' command (normally ^K) cut from the current cursor
position to the end of the line, instead of cutting the entire line.
.TP
.B \-l (\-\-nofollow)
If the file being edited is a symbolic link, replace the link with
@ -165,7 +163,8 @@ a new file instead of following it. Good for editing files in
Enable mouse support, if available for your system. When enabled, mouse
clicks can be used to place the cursor, set the mark (with a double
click), and execute shortcuts. The mouse will work in the X Window
System, and on the console when gpm is running.
System, and on the console when gpm is running. Text can still be
selected through dragging by holding down the Shift key.
.TP
.B \-n (\-\-noread)
Treat any name given on the command line as a new file. This allows
@ -186,13 +185,15 @@ by the terminal.
Do not report errors in the \fInanorc\fP file nor ask them to be
acknowledged by pressing Enter at startup.
.TP
.B \-r \fIcols\fP (\-\-fill=\fIcols\fP)
Hard-wrap lines at column \fIcols\fP. If this value is 0 or less, wrapping
will occur at the width of the screen less \fIcols\fP columns, allowing
.B \-r \fInumber\fP (\-\-fill=\fInumber\fP)
Hard-wrap lines at column \fInumber\fP. If this value is 0 or less, wrapping
will occur at the width of the screen less \fInumber\fP columns, allowing
the wrap point to vary along with the width of the screen if the screen
is resized. The default value is \-8.
is resized. The default value is \-8. This option conflicts with
.B \-w
-- the last one given takes effect.
.TP
.B \-s \fIprog\fP (\-\-speller=\fIprog\fP)
.B \-s \fIprogram\fP (\-\-speller=\fIprogram\fP)
Enable alternative spell checker command.
.TP
.B \-t (\-\-tempfile)
@ -200,24 +201,27 @@ Always save changed buffer without prompting. Same as Pico's \fB\-t\fP
option.
.TP
.B \-u (\-\-undo)
Enable experimental generic-purpose undo code. By default, the undo and redo
shortcuts are Meta-U and Meta-E, respectively.
Enable the experimental generic-purpose undo/redo code. The default undo
and redo shortcuts are Meta-U and Meta-E, respectively.
.TP
.B \-v (\-\-view)
View file (read only) mode.
View-file (read-only) mode.
.TP
.B \-w (\-\-nowrap)
Disable the hard-wrapping of long lines.
Disable the hard-wrapping of long lines. This option conflicts with
.B \-r
-- the last one given takes effect.
.TP
.B \-x (\-\-nohelp)
Disable help screen at bottom of editor.
Don't show the two help lines at the bottom of the screen.
.TP
.B \-z (\-\-suspend)
Enable suspend ability.
Enable the suspend ability.
.TP
.B \-$ (\-\-softwrap)
Enable 'soft wrapping'. \fBnano\fP will attempt to display the entire
contents of a line, even if it is longer than the screen width. Since
Enable 'soft wrapping'. This will make \fBnano\fP attempt to display the
entire contents of any line, even if it is longer than the screen width, by
continuing it over multiple screen lines. Since
\&'$' normally refers to a variable in the Unix shell, you should specify
this option last when using other options (e.g. 'nano \-wS$') or pass it
separately (e.g. 'nano \-wS \-$').

26
doc/man/nanorc.5
View File

@ -62,7 +62,7 @@ Use auto-indentation.
Create backup files by adding a tilde (\fB~\fP) to each file's name.
.TP
.B set backupdir "\fIdirectory\fP"
Set the directory where \fBnano\fP puts unique backup files if file
Set the directory where \fBnano\fP puts unique backup files, if file
backups are enabled.
.TP
.B set/unset backwards
@ -75,9 +75,9 @@ the options \fBtitlecolor\fP, \fBstatuscolor\fP, and \fBkeycolor\fP.
.TP
.B set brackets "\fIstring\fP"
Set the characters treated as closing brackets when justifying
paragraphs. This cannot include blank characters. Only closing
punctuation, optionally followed by the specified closing brackets,
can end sentences. The default value is "\fB"')>]}\fP".
paragraphs. This may not include blank characters. Only closing
punctuation (see \fBpunct\fP), optionally followed by the specified
closing brackets, can end sentences. The default value is "\fB"')>]}\fP".
.TP
.B set/unset casesensitive
Do case-sensitive searches by default.
@ -86,7 +86,7 @@ Do case-sensitive searches by default.
Constantly display the cursor position in the status bar.
.TP
.B 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.
.TP
.B set fill \fIn\fP
Hard-wrap lines at column number \fIn\fP. If \fIn\fP is 0 or less, the
@ -112,9 +112,9 @@ Enable vim-style lock-files for when editing files.
.TP
.B set matchbrackets "\fIstring\fP"
Set the opening and closing brackets that can be found by bracket
searches. They cannot contain blank characters. The opening set must
come before the closing set, and both must be in the same order. The
default value is "\fB(<[{)>]}\fP".
searches. This may not include blank characters. The opening set must
come before the closing set, and the two sets must be in the same order.
The default value is "\fB(<[{)>]}\fP".
.TP
.B set/unset morespace
Use the blank line below the titlebar as extra editing space.
@ -124,7 +124,7 @@ Enable mouse support, if available for your system. When enabled, mouse
clicks can be used to place the cursor, set the mark (with a double
click), and execute shortcuts. The mouse will work in the X Window
System, and on the console when gpm is running. Text can still be
selected through dragging by holding the Shift key.
selected through dragging by holding down the Shift key.
.TP
.B set/unset multibuffer
Allow inserting files into their own buffers.
@ -158,9 +158,9 @@ Preserve the XON and XOFF keys (^Q and ^S).
.TP
.B set punct "\fIstring\fP"
Set the characters treated as closing punctuation when justifying
paragraphs. This cannot include blank characters. Only the specfified
closing punctuation, optionally followed by closing brackets, can end
sentences. The default value is "\fB!.?\fP".
paragraphs. This may not include blank characters. Only the
specfified closing punctuation, optionally followed by closing brackets
(see \fBbrackets\fP), can end sentences. The default value is "\fB!.?\fP".
.TP
.B set/unset quickblank
Do quick statusbar blanking. Statusbar messages will disappear after 1
@ -168,7 +168,7 @@ keystroke instead of 25.
.TP
.B set/unset quiet
\fBnano\fP will not report errors in the \fInanorc\fP file nor ask them
to be acknowledged by pressing enter at startup. If this is used it
to be acknowledged by pressing Enter at startup. If this is used it
should be placed at the top of the file to be fully effective.
.TP
.B set quotestr "\fIstring\fP"

91
doc/texinfo/nano.texi
View File

@ -23,7 +23,7 @@
@titlepage
@title GNU @code{nano}
@subtitle a small and friendly text editor.
@subtitle version 2.2.0
@subtitle version 2.3.3
@author Chris Allegretta
@page
@ -54,6 +54,7 @@ You may contact the author by
e-mail: @email{chrisa@@asty.org}@*
@end titlepage
@node Top
@top
@ -76,8 +77,8 @@ editor.
@chapter Introduction
GNU @code{nano} is a small and friendly text editor. Besides basic text
editing, @code{nano} offers many extra features like an interactive
search and replace, go to line and column number, auto-indentation,
editing, @code{nano} offers many extra features, like an interactive
search-and-replace, go-to-line-and-column-number, auto-indentation,
feature toggles, internationalization support, and filename tab
completion.
@ -121,8 +122,8 @@ Email bug reports to @email{nano@@nano-editor.org}.
@code{nano} takes the following options from the command line:
@table @code
@item +LINE,COLUMN
Start at line number LINE and column number COLUMN (at least one of
@item +<line>,<column>
Start at line number <line> and column number <column> (at least one of
which must be specified) instead of the default of line 1, column 1.
@item -A, --smarthome
@ -149,6 +150,9 @@ Convert typed tabs to spaces.
@item -F, --multibuffer
Enable multiple file buffers, if available.
@item -G, --locking
Enable vim-style file locking when editing files.
@item -H, --historylog
Log search and replace strings to ~/.nano_history, so they can be
retrieved in later sessions, if nanorc support is available.
@ -166,7 +170,7 @@ won't work properly with this option enabled.
Don't add newlines to the ends of files.
@item -N, --noconvert
Don't convert files from DOS/Mac format.
Disable automatic conversion of files from DOS/Mac format.
@item -O, --morespace
Use the blank line below the titlebar as extra editing space.
@ -187,18 +191,19 @@ 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
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").
command line; don't read any nanorc files; don't allow suspending; don't
allow a file to be appended to, prepended to, or saved under a different
name if it already has one; don't use backup files nor spell checking.
This restricted mode is also accessible by invoking @code{nano} with
any name beginning with 'r' (e.g. "rnano").
@item -S, --smooth
Enable smooth scrolling. Text will scroll line-by-line, instead of the
usual chunk-by-chunk behavior.
@item -T <#cols>, --tabsize=<#cols>
Set the displayed tab length to #cols columns. The value of #cols must
be greater than 0. The default value is 8.
@item -T <number>, --tabsize=<number>
Set the displayed tab length to <number> columns. The value of <number>
must be greater than 0. The default value is 8.
@item -U, --quickblank
Do quick statusbar blanking. Statusbar messages will disappear after 1
@ -232,7 +237,8 @@ Automatically indent new lines to the same number of spaces and tabs as
the previous line.
@item -k, --cut
Cut from the current cursor position to the end of the current line.
Make the 'Cut Text' command (normally ^K) cut from the current cursor
position to the end of the line, instead of cutting the entire line.
@item -l, --nofollow
When writing files, if the given file is a symbolic link, it is removed
@ -242,7 +248,8 @@ and a new file is created.
Enable mouse support, if available for your system. When enabled, mouse
clicks can be used to place the cursor, set the mark (with a double
click), and execute shortcuts. The mouse will work in the X Window
System, and on the console when gpm is running.
System, and on the console when gpm is running. Text can still be
selected through dragging by holding down the Shift key.
@item -n, --noread
Treat any name given on the command line as a new file. This allows
@ -263,14 +270,15 @@ editor can be can be stopped and started.
Do not report errors in the nanorc file and ask them to be acknowledged
by pressing Enter at startup.
@item -r <#cols>, --fill=<#cols>
Hard-wrap lines at column #cols (by inserting a newline character).
@item -r <number>, --fill=<number>
Hard-wrap lines at column <number> (by inserting a newline character).
If the given value is 0 or less, wrapping will occur at the width of
the screen minus the given amount, allowing the wrapping width to
vary along with the width of the screen if and when it is resized.
The default value is -8.
The default value is -8. This option conflicts with -w -- the last
one given takes effect.
@item -s <prog>, --speller=<prog>
@item -s <program>, --speller=<program>
Invoke the given program as the spell checker. By default, @code{nano}
uses the command specified in the SPELL environment variable, or, if
SPELL is not set, its own interactive spell checker that requires the
@ -291,8 +299,8 @@ option should NOT be used in place of correct file permissions to
implement a read-only file.
@item -w, --nowrap
Don't hard-wrap long lines at any length. This option overrides any value
for -r.
Don't hard-wrap long lines at any length. This option conflicts with
-r -- the last one given takes effect.
@anchor{Expert Mode}
@item -x, --nohelp
@ -301,10 +309,10 @@ 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.
disabled to display the help-system navigation keys.
@item -z, --suspend
Enable @code{nano}'s suspend ability using the system's suspend
Enable the ability to suspend @code{nano} using the system's suspend
keystroke (usually ^Z).
@item -$, --softwrap
@ -554,36 +562,39 @@ You should NOT enable this option unless you are sure you need it.
Use auto-indentation.
@item set/unset backup
Create backup files in "filename~".
When saving a file, back up the previous version of it to the current
filename suffixed with a tilde (@code{~}).
@item set backupdir "directory"
Set the directory where @code{nano} puts unique backup files if file
Set the directory where @code{nano} puts unique backup files, if file
backups are enabled.
@item set/unset backwards
Do backwards searches by default.
@item set/unset boldtext
Use bold text instead of reverse video text.
Use bold instead of reverse video for the titlebar, statusbar, key combos,
and selected text. This can be overridden for the first three by setting
the options "titlecolor", "statuscolor", and "keycolor".
@item set brackets "string"
Set the characters treated as closing brackets when justifying
paragraphs. They cannot contain blank characters. Only closing
punctuation, optionally followed by closing brackets, can end sentences.
The default value is
paragraphs. This may not include blank characters. Only closing
punctuation (see "punct"), optionally followed by the specified
closing brackets, can end sentences. The default value is
@quotation
@code{""')>]@}"}
@end quotation
@item set/unset casesensitive
Do case sensitive searches by default.
Do case-sensitive searches by default.
@item set/unset const
Constantly display the cursor position in the status bar.
@item set/unset cut
Use cut to end of line by default, instead of cutting the whole line.
Use cut-to-end-of-line by default, instead of cutting the whole line.
@item set fill "n"
Hard-wrap lines at column number "n". If "n" is 0 or less, the maximum line
@ -608,9 +619,9 @@ Enable vim-style lock-files for when editing files.
@item set matchbrackets "string"
Set the opening and closing brackets that can be found by bracket
searches. They cannot contain blank characters. The former set must
come before the latter set, and both must be in the same order. The
default value is
searches. This may not include blank characters. The opening set must
come before the closing set, and the two sets must be in the same order.
The default value is
@quotation
@code{"(<[@{)>]@}"}
@ -655,9 +666,9 @@ Preserve the XON and XOFF keys (^Q and ^S).
@item set punct "string"
Set the characters treated as closing punctuation when justifying
paragraphs. They cannot contain blank characters. Only closing
punctuation, optionally followed by closing brackets, can end sentences.
The default value is @code{"!.?"}.
paragraphs. This may not include blank characters. Only the
specified closing punctuation, optionally followed by closing brackets
(see "brackets"), can end sentences. The default value is @code{"!.?"}.
@item set/unset quickblank
Do quick statusbar blanking. Statusbar messages will disappear after 1
@ -677,7 +688,7 @@ otherwise a literal string. The default value is
@code{"^([ \\t]*[#:>\\|@}])+"}
@end quotation
if you have extended regular expression support, or "> " otherwise.
if you have extended regular expression support, and "> " otherwise.
Note that '\\t' stands for a literal Tab character.
@item set/unset rebinddelete
@ -734,13 +745,13 @@ white, black, red, blue, green, yellow, magenta, and cyan.
And either "fgcolor" or ",bgcolor" may be left out.
@item set/unset undo
Enable experimental generic-purpose undo code.
Enable the experimental generic-purpose undo/redo code.
@item set/unset view
Disallow file modification.
@item set whitespace "string"
Set the two characters used to display the first characters of tabs and
Set the two characters used to indicate the presence of tabs and
spaces. They must be single-column characters.
@item set/unset wordbounds