From 2a56ce79c580801183b296afa5564c7b20569800 Mon Sep 17 00:00:00 2001
From: David Lawrence Ramsey <pooka109@gmail.com>
Date: Wed, 24 May 2006 20:55:44 +0000
Subject: [PATCH] per Benno Schulenberg's patch with some additions of mine,
 explain the mouse support in more detail, and sync the text of its
 description across all documentation

git-svn-id: svn://svn.savannah.gnu.org/nano/trunk/nano@3561 35c25a1d-7b9e-4130-9fde-d3aeb78583b8
---
 ChangeLog             |  4 ++++
 doc/man/nano.1        |  7 +++++--
 doc/man/nanorc.5      |  8 +++++---
 doc/nanorc.sample     |  7 +++++--
 doc/texinfo/nano.texi | 24 ++++++++++++++++++++----
 5 files changed, 39 insertions(+), 11 deletions(-)

diff --git a/ChangeLog b/ChangeLog
index 641f04b3..78ed58d4 100644
--- a/ChangeLog
+++ b/ChangeLog
@@ -105,6 +105,10 @@ CVS code -
 	  do_input(), do_statusbar_input(), get_prompt_string(), and
 	  parse_kbinput(). (DLR, suggested by Nick Warne and Benno
 	  Schulenberg)
+	- Explain the mouse support in more detail, and sync the text of
+	  its description across all documentation.  Changes to nano.1,
+	  nanorc.5, nanorc.sample, and nano.texi. (Benno Schulenberg and
+	  DLR)
 - browser.c:
   do_browser()
 	- Reference NANO_GOTODIR_(ALT|F)?KEY instead of
diff --git a/doc/man/nano.1 b/doc/man/nano.1
index 4d327fbd..bfe2756b 100644
--- a/doc/man/nano.1
+++ b/doc/man/nano.1
@@ -7,7 +7,7 @@
 .\" warranty.
 .\"
 .\" $Id$
-.TH NANO 1 "version 1.3.12" "May 14, 2006"
+.TH NANO 1 "version 1.3.12" "May 24, 2006"
 .\" Please adjust this date whenever revising the manpage.
 .\"
 
@@ -146,7 +146,10 @@ a new file instead of following it.  Good for editing files in
 \fI/tmp\fP, perhaps?
 .TP
 .B \-m (\-\-mouse)
-Enable mouse support (if available for your system).
+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.
 .TP
 .B \-o \fIdir\fP (\-\-operatingdir=\fIdir\fP)
 Set operating directory.  Makes \fBnano\fP set up something similar to a
diff --git a/doc/man/nanorc.5 b/doc/man/nanorc.5
index 9f5d5e88..b4c478d6 100644
--- a/doc/man/nanorc.5
+++ b/doc/man/nanorc.5
@@ -7,7 +7,7 @@
 .\" warranty.
 .\"
 .\" $Id$
-.TH NANORC 5 "version 1.3.12" "May 23, 2006"
+.TH NANORC 5 "version 1.3.12" "May 24, 2006"
 .\" Please adjust this date whenever revising the manpage.
 .\"
 .SH NAME
@@ -95,8 +95,10 @@ default value is "\fI(<[{)>]}\fP".
 Allow use of the blank line below the titlebar as extra editing space.
 .TP
 .B set/unset mouse
-Enable mouse support, so that mouse clicks can be used to set the mark
-and run shortcuts.
+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.
 .TP
 .B set/unset multibuffer
 Allow inserting files into their own buffers.
diff --git a/doc/nanorc.sample b/doc/nanorc.sample
index 30e6b8ad..f4d1d448 100644
--- a/doc/nanorc.sample
+++ b/doc/nanorc.sample
@@ -65,8 +65,11 @@
 ## Use the blank line below the titlebar as extra editing space.
 # set morespace
 
-## Enable mouse support, so that mouse clicks can be used to set the
-## mark and run shortcuts.
+## 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.
+##
 # set mouse
 
 ## Allow multiple file buffers (inserting a file will put it into a
diff --git a/doc/texinfo/nano.texi b/doc/texinfo/nano.texi
index cbe8c4df..2bd43731 100644
--- 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 23 May 2006
+@set UPDATED 24 May 2006
 
 @dircategory Editors
 @direntry
@@ -219,8 +219,10 @@ When writing files, if the given file is a symbolic link, it is removed
 and a new file is created.
 
 @item -m, --mouse
-Enables the use of the mouse to select text (currently only useful for
-running under the X Window System).
+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.
 
 @item -o <dir>, --operatingdir=<dir>
 Set operating directory.  Makes @code{nano} set up something similar to
@@ -273,6 +275,7 @@ keystroke (usually ^Z).
 Ignored, for compatibility with Pico.
 @end table
 
+
 @node Editor Basics, Online Help, Introduction, Top
 @chapter Editor Basics
 @menu
@@ -281,6 +284,7 @@ Ignored, for compatibility with Pico.
 * The Titlebar::
 * The Statusbar::
 * Shortcut Lists::
+* Using the Mouse::
 @end menu
 
 @node Entering Text, Special Functions, Editor Basics, Editor Basics
@@ -339,12 +343,24 @@ occur from using the editor will appear on the statusbar.  Any questions
 that are asked of the user will be asked on the statusbar, and any user
 input (search strings, filenames, etc.) will be input on the statusbar.
 
-@node Shortcut Lists, , The Statusbar, Editor Basics
+@node Shortcut Lists, Using the Mouse, The Statusbar, Editor Basics
 @section Shortcut Lists
 
 The Shortcut Lists are the two lines at the bottom of the screen which
 show some of the more commonly used functions in the editor.
 
+@node Using the Mouse, , Shortcut Lists, Editor Basics
+@section Using the Mouse
+
+When mouse support has been configured and enabled, a single mouse click
+places the cursor at the indicated position.  Clicking a second time in
+the same position toggles the mark.  Clicking in the shortcut list
+executes the selected shortcut.
+
+The mouse will work in the X Window System, and on the console when gpm
+is running.
+
+
 @node Online Help, Feature Toggles, Editor Basics, Top
 @chapter Online Help
 
-- 
GitLab