Documentation updates for nano 1.1.2 (texi and manpage).

git-svn-id: svn://svn.savannah.gnu.org/nano/trunk/nano@827 35c25a1d-7b9e-4130-9fde-d3aeb78583b8
2001-10-03 12:45:22 +00:00 · 2001-10-03 12:45:22 +00:00 · f57b886bed
--- a/11
+++ b/11
@ -36,6 +36,9 @@ CVS code -
 	  (discovered by DLR, fixed by DLR & Chris, fixes BUG #66).
  do_cut_text()
 	- Don't recenter the line when cutting one line (DLR) (Bug #65).
+- faq.html:
+	- Notes about the Free Translation Project.
+	- Debian additions.
 - files.c:
  do_writeout()
 	- Expanded strings to not use %s and ?: to determine
@ -62,8 +65,12 @@ CVS code -
  global_init()
 	- New arg save_cutbuffer, allows cutbuffer to not be lost when
 	  using multibuffer.
+- nano.1:
+	- Added new features, fixed some typos (Jordi).
 - nano.texi:
-	- corrected the Mouse Toggle section, noticed by Daniel Bonniot.
+	- Corrected the Mouse Toggle section, noticed by Daniel Bonniot.
+	- Added many command line options, toggles and other additions
+	  (Jordi).
 - rcfile.c:
 	- NUM_RCOPTS fix (DLR).
 	- Add tabsize support to rc file (Nathan Heagy).
@ -232,8 +239,6 @@ nano-1.1.0 - 07/15/2001
 - faq.html:
 	- Brought the FAQ up to date, many little changes (Jordi).
 	- Added sections 3.7 and 3.8 for the multibuffer and nanorc support.
-	- Notes about the Free Translation Project.
-	- Debian additions.
 - files.c:
  do_browser()
 	- Minor fixes to the processing of SELECT function (Rocco)
--- a/nano.1
+++ b/nano.1
@ -5,10 +5,8 @@
 .\" This is free documentation, see the latest version of the GNU General
 .\" Public License for copying conditions. There is NO warranty.
 .\"
-.\" First parameter, NAME, should be all caps
-.\" Second parameter, SECTION, should be 1-8, maybe w/ subsection
-.\" other parameters are allowed: see man(7), man(1)
-.TH NANO 1 "April 30, 2001"
+.\" $Id$
+.TH NANO 1 "October 3, 2001"
 .\" Please adjust this date whenever revising the manpage.
 .\"
 .SH NAME
@ -33,25 +31,35 @@ also implements some missing (or disabled by default) features in Pico,
 such as "search and replace" and "goto line number".
 .SH OPTIONS
 .TP
+.B \-D (\-\-dos)
+Write file in DOS format.
+.TP
 .B \-F (\-\-multibuffer)
 Enable multiple file buffers (if available).
 .TP
-.B \-T (\-\-tabsize)
-Set the size (width) of a tab.
+.B \-M (\-\-mac)
+Write file in Mac format.
 .TP
 .B \-R (\-\-regexp)
 Enable regular expression matching for search strings, as well as
 \\n subexpression replacement for replace strings, if available.
 .TP
+.B \-S (\-\-smooth)
+Enable smooth scrolling. Text will scroll line-by-line, instead of the
+usual chunk-by-chunk behaviour.
+.TP
+.B \-T [num] (\-\-tabsize=[num])
+Set the size (width) of a tab.
+.TP
 .B \-V (\-\-version)
 Show the current version number and author.
 .TP
-.B \-h (\-\-help)
-Display a summary of command line options.
-.TP
 .B \-c (\-\-const)
 Constantly show the cursor position.
 .TP
+.B \-h (\-\-help)
+Display a summary of command line options.
+.TP
 .B \-i (\-\-autoindent)
 Indent new lines to the previous line's indentation. Useful when editing
 source code.
@ -66,18 +74,21 @@ a new file, do not follow it.  Good for editing files in /tmp, perhaps?
 .B \-m (\-\-mouse)
 Enable mouse support (if available for your system).
 .TP
+.B \-o [dir] (\-\-operatingdir=[dir])
+Set operating directory. Makes nano set up something similar to a chroot.
+.TP
 .B \-p (\-\-pico)
 Emulate Pico as closely as possible.  This affects both the "shortcut list"
 at the bottom of the screen, as well as the display and entry of previous
 search and replace strings.
 .TP
-.B \-r (\-\-fill)
+.B \-r [#cols] (\-\-fill=[#cols])
 Wrap lines at column #cols.  By default, this is the width of the screen,
 less eight.  If this value is negative, wrapping will occur at #cols from
 the right of the screen, allowing it to vary along with the screen width
 if the screen is resized.
 .TP
-.B \-s (\-\-speller)
+.B \-s [prog] (\-\-speller=[prog])
 Enable alternative spell checker command.
 .TP
 .B \-t (\-\-tempfile)
@ -120,7 +131,8 @@ subject of "subscribe".
 .SH HOMEPAGE
 http://www.nano-editor.org
 .SH AUTHOR
-Chris Allegretta <chrisa@asty.org>, et al (see AUTHORS for details).
+Chris Allegretta <chrisa@asty.org>, et al (see AUTHORS and THANKS for
+details).
 This manual page was originally written by Jordi Mallach
 <jordi@sindominio.net>, for the Debian GNU/Linux system (but may be
 used by others).
--- a/nano.info
+++ b/nano.info
@ -59,12 +59,24 @@ Command Line Options
 ====================

   `nano' takes the following options from the command line:
-`-T [num, --tabsize=[num]'
-     Set the displayed tab length to [num] columns.
+`-D, --dos'
+     Write file in DOS format.
+
+`-F, --multibuffer'
+     Enable multiple file buffers.
+
+`-M, --mac'
+     Write file in Mac format.

 `-R, --regexp'
     Turns on regular expression search and search/replace.

+`-S, --smooth'
+     Enables smooth scrolling.
+
+`-T [num], --tabsize=[num]'
+     Set the displayed tab length to [num] columns.
+
 `-V, --version'
     Print the version number and copyright and quit.

@ -91,6 +103,10 @@ Command Line Options
     Enables the use of the mouse to select text (currently only useful
     for running under the X window system).

+`-o [dir], --operatingdir=[dir]'
+     Set operating directory. Makes nano set up something similar to a
+     chroot.
+
 `-p, --pico'
     Emulate Pico as closely as possible, sacrificing consistency for
     correct emulation.  *Note Pico Compatibility::, for more info.
@ -133,6 +149,9 @@ Command Line Options
     Enable suspend ability of `nano' using the system's suspend
     keystroke (usually ^Z).

+`-b, -e, -f'
+     Ignored, for compatibility with Pico.
+
 `+LINE'
     Start at line number LINE instead of the default of line 1.

@ -246,12 +265,24 @@ normally be done via command line flags. They are invoked via certain
 Meta key sequenced. *Note Special Functions::, for more info.  The
 following toggles are available:

+`Case Sensitive Search Toggle (Meta-A)'
+     toggles case sensistive searching functionality on/off.
+
+`Backwards Search Toggle (Meta-B)'
+     toggles backwards searching fuctionality on/off.
+
 `Constant Update Toggle (Meta-C)'
     toggles the -c (-const) command line flag.

+`DOS Format Toggle (Meta-D)'
+     toggles the -D (-dos) command line flag.
+
 `Regular Expressions Toggle (Meta-E)'
     toggles the -R (-regexp) command line flag.

+`Multiple Files Toggle (Meta-F)'
+     toggles the  -F (-multibuffer) command line flag.
+
 `AutoIndent Toggle (Meta-I)'
     toggles the -i (-autoindent) command line flag.

@ -261,10 +292,16 @@ following toggles are available:
 `Mouse Toggle (Meta-M)'
     toggles the -m (-mouse) command line flag.

+`Mac Format Toggle (Meta-O)'
+     toggles the -M (-mac) command line flag.
+
 `Pico Mode Toggle (Meta-P)'
     toggles the -p (-pico) command line flag.  *Note Pico
     Compatibility::, for more info.

+`Smooth Scrolling Toggle (Meta-S)'
+     toggles the -s (-smooth) command line flag.
+
 `AutoWrap Toggle (Meta-W)'
     toggles the -w (-nowrap) command line flag.

@ -274,6 +311,12 @@ following toggles are available:
 `Suspend Toggle (Meta-Z)'
     toggles the -z (-suspend) command line flag.

+`Open Previous File Toggle (Meta-<)'
+     changes buffer to previously loaded file.
+
+`Open Next File Toggle (Meta->)'
+     changes buffer to next loaded file.
+

 File: nano.info,  Node: The File Browser,  Next: Pico Compatibility,  Prev: Feature Toggles,  Up: Top

@ -388,6 +431,19 @@ consider the following command line options:
     Disables all mouse functionality.  This also disables the -m
     commands line flag which enables the mouse functions.

+`--disable-operatingdir'
+     Disables setting of operating directory. This also disables the -o
+     command line flag.
+
+`--disable-nls'
+     Disables Native Language support. This will make the available GNU
+     nano translations unusable.
+
+`--with-slang'
+     Compiling GNU nano with Slang is supported, and will make the
+     binary notably smaller than if compiled with ncurses or other
+     curses libraries.
+


 Tag Table:
@ -395,17 +451,17 @@ Node: Top200
 Node: Introduction508
 Node: Overview934
 Node: Command Line Options1514
-Ref: Expert Mode3406
-Node: Editor Basics4249
-Node: Entering Text4474
-Node: Special Functions4814
-Node: The Titlebar5669
-Node: The Statusbar6367
-Node: Shortcut Lists6948
-Node: Online Help7341
-Node: Feature Toggles7717
-Node: The File Browser8855
-Node: Pico Compatibility9564
-Node: Building and Configure Options11606
+Ref: Expert Mode3716
+Node: Editor Basics4616
+Node: Entering Text4841
+Node: Special Functions5181
+Node: The Titlebar6036
+Node: The Statusbar6734
+Node: Shortcut Lists7315
+Node: Online Help7708
+Node: Feature Toggles8084
+Node: The File Browser9900
+Node: Pico Compatibility10609
+Node: Building and Configure Options12651

 End Tag Table
--- a/nano.texi
+++ b/nano.texi
@ -8,8 +8,8 @@
@c Run `makeinfo' rather than `texinfo-format-buffer'.
@smallbook
@set EDITION 0.1
-@set VERSION 1.1.1
-@set UPDATED 12 Feb 2001
+@set VERSION 1.1.2
+@set UPDATED 3 Oct 2001

@dircategory Editors
@direntry
@ -23,7 +23,7 @@
@titlepage
@title GNU @code{nano}
@subtitle a small and friendly text editor.
-@subtitle version 1.1.1
+@subtitle version 1.1.2

@author Chris Allegretta
@page
@ -108,12 +108,24 @@ Email bug reports to @email{nano@@nano-editor.org}.
@code{nano} takes the following options from the command line:
@table @code

-@item -T [num, --tabsize=[num]
-Set the displayed tab length to [num] columns.
+@item -D, --dos
+Write file in DOS format.
+
+@item -F, --multibuffer
+Enable multiple file buffers.
+
+@item -M, --mac
+Write file in Mac format.

@item -R, --regexp
 Turns on regular expression search and search/replace.

+@item -S, --smooth
+Enables smooth scrolling.
+
+@item -T [num], --tabsize=[num]
+Set the displayed tab length to [num] columns.
+
@item -V, --version 
 Print the version number and copyright and quit.

@ -139,6 +151,9 @@ 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]
+Set operating directory. Makes nano set up something similar to a chroot. 
+
@item -p, --pico
 Emulate Pico as closely as possible, sacrificing consistency for correct
 emulation.  @xref{Pico Compatibility}, for more info.
@ -181,6 +196,9 @@ Do not wrap long lines at any length. This option overrides any value for
 Enable suspend ability of @code{nano} using the system's suspend
 keystroke (usually ^Z).

+@item -b, -e, -f
+Ignored, for compatibility with Pico.
+
@item +LINE
 Start at line number LINE instead of the default of line 1.
@end table
@ -277,12 +295,24 @@ The following toggles are available:

@table @code

+@item Case Sensitive Search Toggle (Meta-A)
+toggles case sensistive searching functionality on/off.
+
+@item Backwards Search Toggle (Meta-B)
+toggles backwards searching fuctionality on/off.
+
@item Constant Update Toggle (Meta-C)
 toggles the -c (--const) command line flag.

+@item DOS Format Toggle (Meta-D)
+toggles the -D (--dos) command line flag.
+
@item Regular Expressions Toggle (Meta-E)
 toggles the -R (--regexp) command line flag.

+@item Multiple Files Toggle (Meta-F)
+toggles the  -F (--multibuffer) command line flag.
+
@item AutoIndent Toggle (Meta-I)
 toggles the -i (--autoindent) command line flag.

@ -292,10 +322,16 @@ toggles the -k (--cut) command line flag.
@item Mouse Toggle (Meta-M)
 toggles the -m (--mouse) command line flag.

+@item Mac Format Toggle (Meta-O)
+toggles the -M (--mac) command line flag.
+
@item Pico Mode Toggle (Meta-P)
 toggles the -p (--pico) command line flag.
@xref{Pico Compatibility}, for more info.

+@item Smooth Scrolling Toggle (Meta-S)
+toggles the -s (--smooth) command line flag.
+
@item AutoWrap Toggle (Meta-W)
 toggles the -w (--nowrap) command line flag.

@ -305,6 +341,13 @@ toggles the -x (--nohelp) command line flag.
@item Suspend Toggle (Meta-Z)
 toggles the -z (--suspend) command line flag.

+@item Open Previous File Toggle (Meta-<)
+changes buffer to previously loaded file.
+
+@item Open Next File Toggle (Meta->)
+changes buffer to next loaded file.
+
+
@end table

@node The File Browser, Pico Compatibility, Feature Toggles, Top
@ -415,6 +458,18 @@ Disables all word wrapping in the editor.  This also eliminates the
 Disables all mouse functionality.  This also disables the -m commands line 
 flag which enables the mouse functions.

+@item --disable-operatingdir
+Disables setting of operating directory. This also disables the -o command
+line flag.
+
+@item --disable-nls
+Disables Native Language support. This will make the available GNU nano
+translations unusable.
+
+@item --with-slang
+Compiling GNU nano with Slang is supported, and will make the binary notably
+smaller than if compiled with ncurses or other curses libraries.
+
@end table

@contents