From 6cacd1e32045cc6e9b07644edde8cd8a8e733bf1 Mon Sep 17 00:00:00 2001 From: Benno Schulenberg Date: Sat, 22 Oct 2016 22:07:02 +0200 Subject: [PATCH] tweaks: make several small adjustments to the documentation --- doc/man/nano.1 | 40 +++++++++++++------------------ doc/man/nanorc.5 | 14 ++++++----- doc/man/rnano.1 | 56 +++++++++++++++++-------------------------- doc/texinfo/nano.texi | 4 ++-- 4 files changed, 49 insertions(+), 65 deletions(-) diff --git a/doc/man/nano.1 b/doc/man/nano.1 index ffeb1853..68274ec2 100644 --- a/doc/man/nano.1 +++ b/doc/man/nano.1 @@ -26,7 +26,7 @@ nano \- Nano's ANOther editor, an enhanced free Pico clone .SH SYNOPSIS .B nano -.RI [ options "] [[+" line , column "]\ " file "]..." +.RI [ options "] [[+" line [, column "]]\ " file "]..." .SH DESCRIPTION \fBnano\fP is a small, free and friendly editor which aims to replace @@ -38,7 +38,7 @@ replace" and "go to line and column number". .SH EDITING Entering text and moving around in a file is straightforward: typing the letters and using the normal cursor movement keys. Commands are entered -by using the Control (^) and the Alt or Meta (M-) keys. +by using the Control (^) and the Alt or Meta (M\-) keys. Typing \fB^K\fR deletes the current line and puts it in the cutbuffer. Consecutive \fB^K\fRs will put all deleted lines together in the cutbuffer. Any cursor movement or executing any other command will cause the next @@ -47,7 +47,7 @@ contents of the cutbuffer at the current cursor position. .PP When a more precise piece of text needs to be cut or copied, one can mark its start with \fB^6\fR, move the cursor to its end (the marked text will be -highlighted), and then use \fB^K\fR to cut it, or \fBM-6\fR to copy it to the +highlighted), and then use \fB^K\fR to cut it, or \fBM\-6\fR to copy it to the cutbuffer. One can also save the marked text to a file with \fB^O\fR, or spell check it with \fB^T\fR. .PP @@ -180,7 +180,7 @@ Indent new lines to the previous line's indentation. Useful when editing source code. .TP .BR \-k ", " \-\-cut -Make the 'Cut Text' command (normally ^K) cut from the current cursor +Make the 'Cut Text' command (normally \fB^K\fR) cut from the current cursor position to the end of the line, instead of cutting the entire line. .TP .BR \-l ", " \-\-linenumbers @@ -217,15 +217,13 @@ 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. This option conflicts with -.B \-w --- the last one given takes effect. +\fB\-w\fR -- the last one given takes effect. .TP .BR \-s\ \fIprogram\fR ", " \-\-speller= \fIprogram Use this alternative spell checker command. .TP .BR \-t ", " \-\-tempfile -Always save a changed buffer without prompting. Same as Pico's \fB\-t\fP -option. +Save a changed buffer without prompting (when exiting with \fB^X\fR). .TP .BR \-u ", " \-\-unix Save a file by default in Unix format. This overrides nano's @@ -233,12 +231,11 @@ default behavior of saving a file in the format that it had. (This option has no effect when you also use \fB\-\-noconvert\fR.) .TP .BR \-v ", " \-\-view -View-file (read-only) mode. +Just view the file and disallow editing: read-only mode. .TP .BR \-w ", " \-\-nowrap Disable the hard-wrapping of long lines. This option conflicts with -.B \-r --- the last one given takes effect. +\fB\-r\fR -- the last one given takes effect. .TP .BR \-x ", " \-\-nohelp Don't show the two help lines at the bottom of the screen. @@ -258,11 +255,11 @@ separately (e.g.\& 'nano \-wS \-$'). Ignored, for compatibility with Pico. .SH TOGGLES -Many of the above options can be switched on and off also while +Several of the above options can be switched on and off also while \fBnano\fR is running. For example, \fBM\-L\fR toggles the hard-wrapping of long lines, \fBM\-$\fR toggles soft-wrapping, -\fBM\-#\fR toggles line numbers, \fBM\-P\fR the visibility of -whitespace, \fBM\-M\fR the mouse, and \fBM\-X\fR the help lines. +\fBM\-#\fR toggles line numbers, \fBM\-M\fR toggles the mouse, +\fBM\-I\fR auto-indentation, and \fBM\-X\fR the help lines. See at the end of the \fB^G\fR help text for a complete list. .SH INITIALIZATION FILE @@ -276,7 +273,7 @@ for more information on the possible contents of those files. If no alternative spell checker command is specified on the command line nor in one of the \fInanorc\fP files, \fBnano\fP will check the \fBSPELL\fP environment variable for one. - +.sp In some cases \fBnano\fP will try to dump the buffer into an emergency file. This will happen mainly if \fBnano\fP receives a SIGHUP or SIGTERM or runs out of memory. It will write the buffer into a file @@ -288,27 +285,24 @@ it unique. In multibuffer mode, \fBnano\fP will write all the open buffers to their respective emergency files. .SH BUGS -Justifications (\fB^J\fR) and reindentations (\fBM-{\fR and \fBM-}\fR) +Justifications (\fB^J\fR) and reindentations (\fBM\-{\fR and \fBM\-}\fR) are not yet covered by the general undo system. So after a justification that is not immediately undone, or after any reindentation, earlier edits cannot be undone any more. The workaround is, of course, to exit without saving. .sp Please report any other bugs that you encounter via -https://savannah.gnu.org/bugs/?group=nano. +\fIhttps://savannah.gnu.org/bugs/?group=nano\fR. .SH HOMEPAGE https://nano-editor.org/ .SH SEE ALSO -.PD 0 -.TP -\fBnanorc\fP(5) +.BR nanorc (5) .PP \fI/usr/share/doc/nano/\fP (or equivalent on your system) .SH AUTHOR -Chris Allegretta , et al (see the files \fIAUTHORS\fP and +Chris Allegretta and others (see the files \fIAUTHORS\fR and \fITHANKS\fP for details). This manual page was originally written by -Jordi Mallach , for the Debian system (but may be used by -others). +Jordi Mallach for the Debian system (but may be used by others). diff --git a/doc/man/nanorc.5 b/doc/man/nanorc.5 index 86978198..763bda68 100644 --- a/doc/man/nanorc.5 +++ b/doc/man/nanorc.5 @@ -20,8 +20,10 @@ .TH NANORC 5 "version 2.7.0" "September 2016" .\" Please adjust this date whenever revising the manpage. .\" + .SH NAME -nanorc \- GNU nano's rcfile +nanorc \- GNU nano's configuration file + .SH DESCRIPTION The \fInanorc\fP file contains the default settings for \fBnano\fP, a small and friendly editor. The file should be in Unix format, not in @@ -762,14 +764,14 @@ System-wide configuration file. .TP .B ~/.nanorc Per-user configuration file. + .SH SEE ALSO -.TP -\fBnano\fP(1) +.BR nano (1) .PP \fI/usr/share/doc/nano/examples/nanorc.sample\fP (or equivalent on your system) + .SH AUTHOR -Chris Allegretta , et al (see \fIAUTHORS\fP and +Chris Allegretta and others (see the files \fIAUTHORS\fP and \fITHANKS\fP for details). This manual page was originally written by -Jordi Mallach , for the Debian system (but may be used by -others). +Jordi Mallach for the Debian system (but may be used by others). diff --git a/doc/man/rnano.1 b/doc/man/rnano.1 index ed58d5b9..4e916b62 100644 --- a/doc/man/rnano.1 +++ b/doc/man/rnano.1 @@ -20,60 +20,48 @@ .\" Please adjust this date whenever revising the manpage. .\" .SH NAME -rnano \- Restricted mode for Nano's ANOther editor, an enhanced free -Pico clone +rnano \- a restricted nano .SH SYNOPSIS .B rnano -.RI [ options "] [[+" line , column "]\ " file "]..." +.RI [ options "] [[+" line [, column "]]\ " file "]..." .SH DESCRIPTION -\fBnano\fP is a small, free and friendly editor which aims to replace -Pico, the default editor included in the non-free Pine package. On -top of copying Pico's look and feel, \fBnano\fP also implements some -missing (or disabled by default) features in Pico, such as "search and -replace" and "go to line and column number". +\fBrnano\fR runs the \fBnano\fR editor in restricted mode. This allows +editing only the specified file or files, and doesn't allow the user +access to the filesystem nor to a command shell. .PP -\fBrnano\fP is a restricted version of \fBnano\fP, which only edits -specific files and doesn't allow the user access to the filesystem or a -command shell. -.PP -In restricted mode, \fBnano\fP will \fInot\/\fP: +In restricted mode, \fBnano\fR will: .IP \[bu] 2 -read or write to any file not specified on the command line; +not read any nanorc files; .IP \[bu] -read any nanorc files; +not allow suspending; .IP \[bu] -allow suspending; +not read nor write any file not specified on the command line; .IP \[bu] -allow a file to be appended to, prepended to, or saved under a different -name; +not allow saving a file under a different name; .IP \[bu] -use backup files or spell checking. +not allow appending or prepending to any file; +.IP \[bu] +not make backup files nor do spell checking. .SH OPTIONS .TP .BR \-h ", " \-\-help Show a summary of command-line options and exit. -.TP -.BR \-V ", " \-\-version -Show the current version number and exit. .PP -See the \fBnano\fP(1) manpage for all of the possible options. +See the \fBnano\fP(1) manpage for all available options. .SH BUGS -Please send any comments or bug reports to \fBnano@nano-editor.org\fP. - -The \fBnano\fP mailing list is available from \fBnano-devel@gnu.org\fP. - -To subscribe, email to \fBnano-devel-request@gnu.org\fP with a subject -of "subscribe". +Please report bugs via \fIhttps://savannah.gnu.org/bugs/?group=nano\fR. .SH HOMEPAGE -http://www.nano-editor.org/ +https://nano-editor.org/ + +.SH SEE ALSO +.BR nano (1) .SH AUTHOR -Chris Allegretta , et al (see the file AUTHORS for details). -This manual page was originally written by Thijs Kinkhorst -, for the Debian system (but may be used by -others). +Chris Allegretta and others (see the files \fIAUTHORS\fR and \fITHANKS\fR +for details). This manual page was originally written by Thijs Kinkhorst +for the Debian system (but may be used by others). diff --git a/doc/texinfo/nano.texi b/doc/texinfo/nano.texi index f721485d..d87d0778 100644 --- a/doc/texinfo/nano.texi +++ b/doc/texinfo/nano.texi @@ -323,8 +323,8 @@ the @command{spell} program to be installed on your system. @item -t @itemx --tempfile -Don't ask whether or not to save the current contents of the file when -exiting, assume yes. This is most useful when using @command{nano} as the +Don't ask whether to save a modified buffer when exiting with ^X, but +assume yes. This option is useful when @command{nano} is used as the composer of a mailer program. @item -u