From 4f673d802c6eff34d9f2ee82d3c2c3ed1dfb88f5 Mon Sep 17 00:00:00 2001 From: David Lawrence Ramsey Date: Fri, 17 Jun 2005 22:11:43 +0000 Subject: [PATCH] add a description of -U/--quickblank to nano.texi, plus a few more miscellaneous documentation fixes git-svn-id: svn://svn.savannah.gnu.org/nano/trunk/nano@2714 35c25a1d-7b9e-4130-9fde-d3aeb78583b8 --- ChangeLog | 3 +- doc/man/nano.1 | 75 +++++++++++++++++-------------------------- doc/man/nanorc.5 | 25 ++++++--------- doc/nanorc.sample | 5 +-- doc/texinfo/nano.texi | 5 +++ 5 files changed, 48 insertions(+), 65 deletions(-) diff --git a/ChangeLog b/ChangeLog index 4d8e53cf..1bcd6543 100644 --- a/ChangeLog +++ b/ChangeLog @@ -112,7 +112,8 @@ CVS code - effect when constant cursor position display is turned on, and that this is disabled when NANO_SMALL is defined. Changes to toggle_init(), usage(), main(), statusbar(), nanorc.sample, - nano.1, and nanorc.5. (DLR, suggested by CHAO Wei-Lun) + nano.1, nanorc.5, and nano.texi. (DLR, suggested by CHAO + Wei-Lun) - chars.c: make_mbstring() - Change erroneous ENABLE_EXTRA #ifdef to NANO_EXTRA to fix a diff --git a/doc/man/nano.1 b/doc/man/nano.1 index 240f2316..b5cf2c72 100644 --- a/doc/man/nano.1 +++ b/doc/man/nano.1 @@ -61,17 +61,12 @@ Convert typed tabs to spaces. Enable multiple file buffers, if available. .TP .B \-H (\-\-historylog) -Log search and replace strings to -.I ~/.nano_history -so they may be stored for later editing, if nanorc support is -configured. +Log search and replace strings to \fI~/.nano_history\fP so they can be +stored for later editing, if nanorc support is configured. .TP .B \-I (\-\-ignorercfiles) -Don't look at -.I SYSCONFDIR/nanorc -or -.IR ~/.nanorc , -if nanorc support is available. +Don't look at \fISYSCONFDIR/nanorc\fP or \fI~/.nanorc\fP, if nanorc +support is available. .TP .B \-N (\-\-noconvert) Disable automatic conversion of files from DOS/Mac format. @@ -93,15 +88,14 @@ Set the size (width) of a tab to \fIcols\fP columns. .TP .B \-U (\-\-quickblank) Do quick statusbar blanking. Statusbar messages will disappear after 1 -keystroke instead of 25. +keystroke instead of 25. Note that \fB-c\fP cancels this out. .TP .B \-V (\-\-version) Show the current version number and author. .TP .B \-Y \fIstr\fP (\-\-syntax=\fIstr\fP) -Specify a specific syntax highlighting from the -.I nanorc -to use, if available. +Specify a specific syntax highlighting from the \fInanorc\fP to use, if +available. .TP .B \-Z (\-\-restricted) Restricted mode: Don't read or write to any file not specified on the @@ -111,7 +105,8 @@ already has one. Also accessible by invoking \fBnano\fP with any name beginning with 'r' (e.g. "rnano"). .TP .B \-c (\-\-const) -Constantly show the cursor position. +Constantly show the cursor position. Note that this cancels out +\fB-U\fP. .TP .B \-d (\-\-rebinddelete) Interpret the Delete key differently so that both Backspace and Delete @@ -131,8 +126,7 @@ Enable cut from cursor to end of line. .B \-l (\-\-nofollow) If the file being edited is a symbolic link, replace the link with a new file instead of following it. Good for editing files in -.IR /tmp , -perhaps? +\fI/tmp\fP, perhaps? .TP .B \-m (\-\-mouse) Enable mouse support (if available for your system). @@ -155,7 +149,8 @@ to vary along with the screen width if resized. Enable alternative spell checker command. .TP .B \-t (\-\-tempfile) -Always save changed buffer without prompting. Same as Pico's -t option. +Always save changed buffer without prompting. Same as Pico's \fB-t\fP +option. .TP .B \-v (\-\-view) View file (read only) mode. @@ -174,13 +169,9 @@ Ignored, for compatibility with Pico. .SH INITIALIZATION FILE \fBnano\fP will read initialization files in the following order: -.IR SYSCONFDIR/nanorc , -then -.IR ~/.nanorc . -Please see -.BR nanorc (5) -and the example file \fBnanorc.sample\fP which should be provided with -\fBnano\fP. +\fISYSCONFDIR/nanorc\fP, then \fI~/.nanorc\fP. Please see +\fBnanorc(5)\fP and the example file \fBnanorc.sample\fP, both of which +should be provided with \fBnano\fP. .SH NOTES If no alternative spell checker command is specified on the command @@ -190,25 +181,20 @@ line or in one of the nanorc files, \fBnano\fP will check the \fBnano\fP will try to dump the buffer into an emergency file in some cases. Mainly, this will happen if \fBnano\fP receives a SIGHUP or SIGTERM or runs out of memory, when it will write the buffer into a file -named -.I nano.save -if the buffer didn't have a name already, or will add a ".save" suffix -to the current filename. If an emergency file with that name already -exists in the current directory, ".save" and a number (e.g. ".save.1") -will be suffixed to the current filename in order to make it unique. In -multibuffer mode, \fBnano\fP will write all the open buffers to the -respective emergency files. +named \fInano.save\fP if the buffer didn't have a name already, or will +add a ".save" suffix to the current filename. If an emergency file with +that name already exists in the current directory, ".save" and a number +(e.g. ".save.1") will be suffixed to the current filename in order to +make it unique. In multibuffer mode, \fBnano\fP will write all the open +buffers to their respective emergency files. .SH BUGS -Please send any comments or bug reports to -.BR nano@nano-editor.org . +Please send any comments or bug reports to \fBnano@nano-editor.org\fP. -The \fBnano\fP mailing list is available from -.BR nano-devel@gnu.org . +The \fBnano\fP mailing list is available from \fBnano-devel@gnu.org\fP. -To subscribe, email to -.B nano-devel-request@gnu.org -with a subject of "subscribe". +To subscribe, email to \fBnano-devel-request@gnu.org\fP with a subject +of "subscribe". .SH HOMEPAGE http://www.nano-editor.org/ @@ -221,10 +207,7 @@ http://www.nano-editor.org/ \fI/usr/share/doc/nano/\fP (or equivalent on your system) .SH AUTHOR -Chris Allegretta , et al (see -.I AUTHORS -and -.I THANKS -for details). This manual page was originally written by Jordi Mallach -, for the Debian GNU system (but may be used by -others). +Chris Allegretta , et al (see \fIAUTHORS\fP and +\fITHANKS\fP for details). This manual page was originally written by +Jordi Mallach , for the Debian GNU system (but may +be used by others). diff --git a/doc/man/nanorc.5 b/doc/man/nanorc.5 index 6f20acff..5e7105de 100644 --- a/doc/man/nanorc.5 +++ b/doc/man/nanorc.5 @@ -6,7 +6,7 @@ .\" Public License for copying conditions. There is NO warranty. .\" .\" $Id$ -.TH NANORC 5 "version 1.3.8" "June 16, 2005" +.TH NANORC 5 "version 1.3.8" "June 17, 2005" .\" Please adjust this date whenever revising the manpage. .\" .SH NAME @@ -22,9 +22,8 @@ replace" and "go to line number". .PP The \fInanorc\fP file contains the default settings for \fBnano\fP. During startup, \fBnano\fP will first read its system-wide settings from -.IR SYSCONFDIR/nanorc , -and then user-specific settings from -.IR ~/.nanorc . +\fISYSCONFDIR/nanorc\fP, and then user-specific settings from +\fI~/.nanorc\fP. .SH OPTIONS The configuration file accepts a series of "set" and "unset" commands, @@ -45,8 +44,7 @@ The supported commands and arguments are: Use auto-indentation. .TP .B set/unset backup -Create backup files in -.IR filename~ . +Create backup files in \fIfilename~\fP. .TP .B set backupdir "\fIdirectory\fP" Set the directory where \fBnano\fP puts unique backup files if file @@ -74,9 +72,8 @@ Wrap lines at column number \fIn\fP. If \fIn\fP is 0 or less, the line length will be the screen width less \fIn\fP. The default value is -8. .TP .B set/unset historylog -Enable -.I ~/.nano_history -for saving and reading search/replace strings. +Enable \fI~/.nano_history\fP for saving and reading search/replace +strings. .TP .B set/unset morespace Allow use of the blank line below the titlebar as extra editing space. @@ -193,7 +190,6 @@ at least one of which must be specified. This allows syntax highlighting to span multiple lines. Note that all subsequent instances of \fIsr\fP after an initial \fIsr\fP is found will be highlighted until the first instance of \fIer\fP. -\fI .SH FILES .TP @@ -210,9 +206,6 @@ Per-user configuration file \fI/usr/share/doc/nano/examples/nanorc.sample\fP (or equivalent on your system) .SH AUTHOR -Chris Allegretta , et al (see -.I AUTHORS -and -.I THANKS -for details). -This manual page was written by Jordi Mallach . +Chris Allegretta , et al (see \fIAUTHORS\fP and +\fITHANKS\fP for details). This manual page was written by Jordi +Mallach . diff --git a/doc/nanorc.sample b/doc/nanorc.sample index 92fd9738..5c08db39 100644 --- a/doc/nanorc.sample +++ b/doc/nanorc.sample @@ -29,7 +29,8 @@ ## Do case sensitive searches by default. # set casesensitive -## Constantly display the cursor position in the status bar. +## Constantly display the cursor position in the statusbar. Note that +## this cancels out "quickblank". # set const ## Use cut to end of line by default. @@ -86,7 +87,7 @@ # set punct ".?!" ## Do quick statusbar blanking. Statusbar messages will disappear after -## 1 keystroke instead of 25. +## 1 keystroke instead of 25. Note that "const" cancels this out. ## # set quickblank diff --git a/doc/texinfo/nano.texi b/doc/texinfo/nano.texi index 167da6d0..bfbd203a 100644 --- a/doc/texinfo/nano.texi +++ b/doc/texinfo/nano.texi @@ -157,6 +157,10 @@ Enable smooth scrolling. @item -T [num], --tabsize=[#cols] Set the displayed tab length to [#cols] columns. +@item -U, --quickblank +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. @@ -173,6 +177,7 @@ beginning with 'r' (e.g. "rnano"). @item -c, --const Constantly display the cursor position and line number on the statusbar. +Note that this cancels out -U. @item -d, --rebinddelete Interpret the Delete key differently so that both Backspace and Delete