commit e77ebfa3faad9826b513b15b0b33d3db28792ea3
parent 3fe5acebea2114f847790b3c695ffca6bb0707c0
Author: David Lawrence Ramsey <pooka109@gmail.com>
Date: Sun, 14 May 2006 15:19:38 +0000
more documentation updates from Benno Schulenberg, with a few tweaks and
additions by me
git-svn-id: svn://svn.savannah.gnu.org/nano/trunk/nano@3513 35c25a1d-7b9e-4130-9fde-d3aeb78583b8
Diffstat:
5 files changed, 81 insertions(+), 50 deletions(-)
diff --git a/ChangeLog b/ChangeLog
@@ -171,6 +171,9 @@ CVS code -
- Rename to print_opt_full(), for consistency. (DLR)
usage()
- Fix inaccuracies in the usage example. (DLR)
+ - Put command line arguments in <>'s instead of []'s, as the
+ latter imply that the arguments are optional when they aren't.
+ (DLR, found by Benno Schulenberg)
renumber()
- Remove invalid assert. (DLR, found by Filipe Moreira)
do_input()
@@ -232,6 +235,8 @@ CVS code -
well as single-line ones. This avoids a segfault when trying
to color e.g. "start="$" end="$"". (DLR, found by Trevor
Caira)
+ do_credits()
+ - Update the last copyright notice to include 2006. (DLR)
- configure.ac:
- Remove old warnings about color support. (DLR)
- doc/faq.html:
@@ -249,20 +254,36 @@ CVS code -
require that the bracket matching key change to Ctrl-], which
is used as the telnet escape key. (DLR, found by Chris)
- Make the link to the nano CVS page a bit more readable. (DLR)
-- doc/nano.1, doc/nanorc.5, doc/rnano.1, doc/nano.texi:
+- doc/nano.1:
- Update the copyright years to include 2006. (DLR)
- 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)
+ - Put command line arguments in <>'s instead of []'s, as the
+ latter imply that the arguments are optional when they aren't.
+ (Benno Schulenberg)
- doc/nanorc.5:
+ - Update the copyright years to include 2006. (DLR)
+ - 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)
- Mention that the nanorc file should not be in DOS or Mac
format. (DLR)
- - Add various wording fixes. (DLR)
- doc/rnano.1:
+ - Update the copyright years to include 2006. (DLR)
+ - 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)
- Add description of the +LINE[,COLUMN] option. (DLR)
- doc/nano.texi:
+ - Update the copyright years to include 2006. (DLR)
+ - 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)
- Change license to GPL, in order to match the rest of the
documentation, and because the current license is incompatible
with everything else in any case. (DLR)
@@ -272,7 +293,12 @@ 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)
+ - Put command line arguments in <>'s instead of []'s, as the
+ latter imply that the arguments are optional when they aren't.
+ (Benno Schulenberg)
+ - Add missing description of -H/--historylog, and move
+ -x/--nohelp down so that all the command line options are in
+ alphabetical order. (Benno Schulenberg)
- 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:
@@ -295,6 +321,7 @@ CVS code -
- Simplify the "nanorc" regex for commands. (DLR)
- Mention that the nanorc file should not be in DOS or Mac
format. (DLR)
+ - Add various wording fixes. (Benno Schulenberg and DLR)
- UPGRADE:
- Miscellaneous minor fixes. (DLR)
diff --git a/doc/man/nano.1 b/doc/man/nano.1
@@ -7,7 +7,7 @@
.\" warranty.
.\"
.\" $Id$
-.TH NANO 1 "version 1.3.12" "May 1, 2006"
+.TH NANO 1 "version 1.3.12" "May 14, 2006"
.\" Please adjust this date whenever revising the manpage.
.\"
@@ -65,8 +65,8 @@ Convert typed tabs to spaces.
Enable multiple file buffers, if available.
.TP
.B \-H (\-\-historylog)
-Log search and replace strings to \fI~/.nano_history\fP so they can be
-stored for later editing, if nanorc support is configured.
+Log search and replace strings to \fI~/.nano_history\fP, so they can be
+retrieved in later sessions, if nanorc support is available.
.TP
.B \-I (\-\-ignorercfiles)
Don't look at \fISYSCONFDIR/nanorc\fP or \fI~/.nanorc\fP, if nanorc
@@ -89,7 +89,8 @@ Use the blank line below the titlebar as extra editing space.
.B \-Q \fIstr\fP (\-\-quotestr=\fIstr\fP)
Set the quoting string for justifying. The default is
"\fI^([\ \\t]*[#:>\\|}])+\fP" if extended regular expression support is
-available, or "\fI>\ \fP" otherwise.
+available, or "\fI>\ \fP" otherwise. Note that \fI\\t\fP stands for a
+Tab.
.TP
.B \-R (\-\-restricted)
Restricted mode: don't read or write to any file not specified on the
@@ -108,7 +109,7 @@ Set the size (width) of a tab to \fIcols\fP columns. The value of
.TP
.B \-U (\-\-quickblank)
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 overrules this.
.TP
.B \-V (\-\-version)
Show the current version number and exit.
@@ -122,8 +123,7 @@ Specify a specific syntax highlighting from the \fInanorc\fP to use, if
available.
.TP
.B \-c (\-\-const)
-Constantly show the cursor position. Note that this cancels out
-\fB-U\fP.
+Constantly show the cursor position. Note that this overrules \fB-U\fP.
.TP
.B \-d (\-\-rebinddelete)
Interpret the Delete key differently so that both Backspace and Delete
@@ -195,14 +195,14 @@ If no alternative spell checker command is specified on the command
line or in one of the nanorc files, \fBnano\fP will check the
\fBSPELL\fP environment variable for one.
-\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
+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
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
+that name already exists in the current directory, it will add ".save"
+plus a number (e.g. ".save.1") 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
diff --git a/doc/nanorc.sample b/doc/nanorc.sample
@@ -40,7 +40,7 @@
# set casesensitive
## Constantly display the cursor position in the statusbar. Note that
-## this cancels out "quickblank".
+## this overrules "quickblank".
# set const
## Use cut to end of line by default.
@@ -106,7 +106,7 @@
# set punct "!.?"
## Do quick statusbar blanking. Statusbar messages will disappear after
-## 1 keystroke instead of 25. Note that "const" cancels this out.
+## 1 keystroke instead of 25. Note that "const" overrules this.
##
# set quickblank
diff --git 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 01 May 2006
+@set UPDATED 14 May 2006
@dircategory Editors
@direntry
@@ -92,9 +92,9 @@ with a plus sign before any file name, and even in a desired column
by adding it with a comma. So the complete synopsis is:
@quotation
-@code{nano [OPTION]@dots{} [[+LINE] [FILE]]@dots{}}
+@code{nano [OPTION]@dots{} [[+LINE] FILE]@dots{}}
-@code{nano [OPTION]@dots{} [[+LINE,COLUMN] [FILE]]@dots{}}
+@code{nano [OPTION]@dots{} [[+LINE,COLUMN] FILE]@dots{}}
@end quotation
Email bug reports to @email{nano@@nano-editor.org}.
@@ -123,7 +123,7 @@ line.
When saving a file, back up the previous version of it to the current
filename suffixed with a ~.
-@item -C, --backupdir=[dir]
+@item -C <dir>, --backupdir=<dir>
Set the directory where @code{nano} puts unique backup files if file
backups are enabled.
@@ -136,6 +136,10 @@ Convert typed tabs to spaces.
@item -F, --multibuffer
Enable multiple file buffers, if available.
+@item -H, --historylog
+Log search and replace strings to ~/.nano_history, so they can be
+retrieved in later sessions, if nanorc support is available.
+
@item -I, --ignorercfiles
Don't look at SYSCONFDIR/nanorc or ~/.nanorc, if nanorc support is
available.
@@ -151,7 +155,7 @@ Don't add newlines to the ends of files.
@item -N, --noconvert
Don't convert files from DOS/Mac format.
-@item -Q [str], --quotestr [str]
+@item -Q <str>, --quotestr=<str>
Set the quoting string for justifying. The default value is
@quotation
@@ -172,13 +176,13 @@ by invoking @code{nano} with any name beginning with 'r' (e.g. "rnano").
Enable smooth scrolling. Text will scroll line-by-line, instead of the
usual chunk-by-chunk behavior.
-@item -T [num], --tabsize=[#cols]
+@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 -U, --quickblank
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 overules this.
@item -V, --version
Show the current version number and exit.
@@ -187,13 +191,13 @@ Show the current version number and exit.
Detect word boundaries more accurately by treating punctuation
characters as part of a word.
-@item -Y, --syntax=[str]
+@item -Y <str>, --syntax=<str>
Specify a specific syntax highlighting from the nanorc to use, if
available. See @xref{Nanorc Files}, for more info.
@item -c, --const
Constantly display the cursor position and line number on the statusbar.
-Note that this cancels out -U.
+Note that this overrules -U.
@item -d, --rebinddelete
Interpret the Delete key differently so that both Backspace and Delete
@@ -218,7 +222,7 @@ and a new file is created.
Enables the use of the mouse to select text (currently only useful for
running under the X Window System).
-@item -o [dir], --operatingdir=[dir]
+@item -o <dir>, --operatingdir=<dir>
Set operating directory. Makes @code{nano} set up something similar to
a chroot.
@@ -226,32 +230,23 @@ a chroot.
Preserve the ^Q (XON) and ^S (XOFF) sequences so data being sent to the
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
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.
-@item -s [prog], --speller=[prog]
-Invoke [prog] 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 @code{spell}
-program to be installed on your system.
+@item -s <prog>, --speller=<prog>
+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
+@code{spell} program to be installed on your system.
@item -t, --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 @code{nano} as the
composer of a mailer program.
-@anchor{Expert Mode}
-@item -x, --nohelp
-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.
-
@item -v, --view
Don't allow the contents of the file to be altered. Note that this
option should NOT be used in place of correct file permissions to
@@ -261,6 +256,15 @@ implement a read-only file.
Don't wrap long lines at any length. This option overrides any value
for -r.
+@anchor{Expert Mode}
+@item -x, --nohelp
+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.
+
@item -z, --suspend
Enable @code{nano}'s suspend ability using the system's suspend
keystroke (usually ^Z).
diff --git a/src/nano.c b/src/nano.c
@@ -726,7 +726,7 @@ void usage(void)
#ifndef NANO_TINY
print_opt("-A", "--smarthome", N_("Enable smart home key"));
print_opt("-B", "--backup", N_("Save backups of existing files"));
- print_opt(_("-C [dir]"), _("--backupdir=[dir]"),
+ print_opt(_("-C <dir>"), _("--backupdir=<dir>"),
N_("Directory for saving unique backup files"));
#endif
print_opt("-D", "--boldtext",
@@ -756,14 +756,14 @@ void usage(void)
#endif
print_opt("-O", "--morespace", N_("Use more space for editing"));
#ifndef DISABLE_JUSTIFY
- print_opt(_("-Q [str]"), _("--quotestr=[str]"),
+ print_opt(_("-Q <str>"), _("--quotestr=<str>"),
N_("Quoting string"));
#endif
print_opt("-R", "--restricted", N_("Restricted mode"));
#ifndef NANO_TINY
print_opt("-S", "--smooth", N_("Smooth scrolling"));
#endif
- print_opt(_("-T [#cols]"), _("--tabsize=[#cols]"),
+ print_opt(_("-T <#cols>"), _("--tabsize=<#cols>"),
N_("Set width of a tab in cols to #cols"));
#ifndef NANO_TINY
print_opt("-U", "--quickblank", N_("Do quick statusbar blanking"));
@@ -775,7 +775,7 @@ void usage(void)
N_("Detect word boundaries more accurately"));
#endif
#ifdef ENABLE_COLOR
- print_opt(_("-Y [str]"), _("--syntax=[str]"),
+ print_opt(_("-Y <str>"), _("--syntax=<str>"),
N_("Syntax definition to use"));
#endif
print_opt("-c", "--const", N_("Constantly show cursor position"));
@@ -792,17 +792,17 @@ void usage(void)
print_opt("-m", "--mouse", N_("Enable mouse"));
#endif
#ifndef DISABLE_OPERATINGDIR
- print_opt(_("-o [dir]"), _("--operatingdir=[dir]"),
+ print_opt(_("-o <dir>"), _("--operatingdir=<dir>"),
N_("Set operating directory"));
#endif
print_opt("-p", "--preserve",
N_("Preserve XON (^Q) and XOFF (^S) keys"));
#ifndef DISABLE_WRAPJUSTIFY
- print_opt(_("-r [#cols]"), _("--fill=[#cols]"),
+ print_opt(_("-r <#cols>"), _("--fill=<#cols>"),
N_("Set fill cols to (wrap lines at) #cols"));
#endif
#ifndef DISABLE_SPELLER
- print_opt(_("-s [prog]"), _("--speller=[prog]"),
+ print_opt(_("-s <prog>"), _("--speller=<prog>"),
N_("Enable alternate speller"));
#endif
print_opt("-t", "--tempfile",
