From 12a0c0f69046340f4a6e1c7eef6073c013b81840 Mon Sep 17 00:00:00 2001 From: Benno Schulenberg Date: Tue, 18 Jun 2024 10:53:28 +0200 Subject: [PATCH] tweaks: rewrap some lines, for more even lengths Also, slightly improve a few descriptions. --- doc/nano.1 | 33 ++++++++++++++++----------------- doc/nano.texi | 18 +++++++++--------- doc/nanorc.5 | 31 +++++++++++++++---------------- doc/sample.nanorc.in | 4 ++-- 4 files changed, 42 insertions(+), 44 deletions(-) diff --git a/doc/nano.1 b/doc/nano.1 index 0ccbc20f..3ac554d7 100644 --- a/doc/nano.1 +++ b/doc/nano.1 @@ -84,9 +84,9 @@ contents of the cutbuffer at the current cursor position. .sp When a more precise piece of text needs to be cut or copied, you can mark its start with \fB^6\fR, move the cursor to its end (the marked text is -highlighted), and then use \fB^K\fR to cut it, or \fBM\-6\fR to copy it to the -cutbuffer. You can also save the marked text to a file with \fB^O\fR, or -spell check it with \fB^T^T\fR. +highlighted), and then use \fB^K\fR to cut it, or \fBM\-6\fR to copy it to +the cutbuffer. You can also save the marked text to a file with \fB^O\fR, +or spell check it with \fB^T^T\fR. .sp On some terminals, text can be selected also by holding down Shift while using the arrow keys. Holding down the Ctrl or Alt key too increases @@ -157,9 +157,9 @@ in your \fInanorc\fR file.) .BR \-K ", " \-\-rawsequences Interpret escape sequences directly, instead of asking \fBncurses\fR to translate them. (If you need this option to get some keys to work -properly, it means that the \fBterminfo\fR terminal description that is used -does not fully match the actual behavior of your terminal. This can -happen when you ssh into a BSD machine, for example.) +properly, it means that the \fBterminfo\fR terminal description that +is used does not fully match the actual behavior of your terminal. +This can happen when you ssh into a BSD machine, for example.) Using this option disables \fBnano\fR's mouse support. .TP .BR \-L ", " \-\-nonewlines @@ -423,8 +423,8 @@ the main menu only. .SH FILES When \fB\-\-rcfile\fR is given, \fBnano\fR reads just the specified file -for setting its options and syntaxes and key bindings. Without that option, -\fBnano\fR reads two configuration files: first the system's +for setting its options and syntaxes and key bindings. Without that +option, \fBnano\fR reads two configuration files: first the system's \fInanorc\fR (if it exists), and then the user's \fInanorc\fR (if it exists), either \fI~/.nanorc\fR or \fI$XDG_CONFIG_HOME/nano/nanorc\fR or \fI~/.config/nano/nanorc\fR, whichever is encountered first. See @@ -446,15 +446,14 @@ If no alternative spell checker command is specified on the command line nor in one of the \fInanorc\fP files, \fBnano\fP checks the \fBSPELL\fP environment variable for one. .sp -In some cases \fBnano\fP tries to dump the buffer into an emergency -file. This happens mainly if \fBnano\fP receives a SIGHUP or -SIGTERM or runs out of memory. It writes the buffer into a file -named \fInano.save\fP if the buffer didn't have a name already, or -adds a ".save" suffix to the current filename. If an emergency file with -that name already exists in the current directory, it adds ".save" -plus a number (e.g.\& ".save.1") to the current filename in order to make -it unique. In multibuffer mode, \fBnano\fP writes all the open -buffers to their respective emergency files. +In some cases \fBnano\fP tries to dump the buffer into an emergency file. +This happens mainly if \fBnano\fP receives a SIGHUP or SIGTERM or runs out +of memory. It writes the buffer into a file named \fInano.save\fP if the +buffer didn't have a name already, or adds a ".save" suffix to the current +filename. If an emergency file with that name already exists in the +current directory, it adds ".save" plus a number (e.g.\& ".save.1") to +the current filename in order to make it unique. In multibuffer mode, +\fBnano\fP writes all open buffers to their respective emergency files. .sp If you have any question about how to use \fBnano\fR in some specific situation, you can ask on \fIhelp-nano@gnu.org\fR. diff --git a/doc/nano.texi b/doc/nano.texi index a253a160..b3754354 100644 --- a/doc/nano.texi +++ b/doc/nano.texi @@ -622,10 +622,10 @@ Display line numbers to the left of the text area. @item -m @itemx --mouse 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 works in the X Window -System, and on the console when gpm is running. Text can still be -selected through dragging by holding down the Shift key. +clicks can be used to place the cursor, set the mark (with two clicks), +and execute shortcuts. The mouse works in the X Window System, and on +the console when gpm is running. Text can still be selected through +dragging by holding down the Shift key. @item -n @itemx --noread @@ -1072,7 +1072,7 @@ Use this color combination for the mini bar. @item set mouse Enable mouse support, so that mouse clicks can be used to place the -cursor, set the mark (with a double click), or execute shortcuts. +cursor, set the mark (with two clicks), or execute shortcuts. @item set multibuffer When reading in a file with @kbd{^R}, insert it into a new buffer by default. @@ -1323,8 +1323,8 @@ If no @var{fileregex} matched and no @code{header} regex matched either, then compare this @var{regex} (or regexes) against the result of querying the @code{magic} database about the current file, to determine whether this syntax should be used for it. -(This functionality only works when @code{libmagic} is installed -on the system and is silently ignored otherwise.) +(This querying is done only when @code{libmagic} is actually installed +on the system and @option{--magic} or @code{set magic} was given.) @item formatter @var{program} [@var{argument} @dots{}] Run the given @var{program} on the full contents of the current buffer. @@ -1988,8 +1988,8 @@ but also (between the two) the current column position. @item Spell Checking In the internal spell checker misspelled words are sorted alphabetically -and trimmed for uniqueness, such that the words 'apple' and 'Apple' will -be prompted for correction separately. +and trimmed for uniqueness, such that the strings 'Aplpe' and 'aplpe' +will be offered for correction separately. @item Writing Selected Text to Files When using the Write-Out key (@kbd{^O}), text that has been selected using the diff --git a/doc/nanorc.5 b/doc/nanorc.5 index 13df8397..38ff487d 100644 --- a/doc/nanorc.5 +++ b/doc/nanorc.5 @@ -24,13 +24,12 @@ nanorc \- GNU nano's configuration file .SH DESCRIPTION The \fInanorc\fP files contain the default settings for \fBnano\fP, a small and friendly text editor. During startup, if \fB\-\-rcfile\fR -is not given, \fBnano\fR reads two files: first the -system-wide settings, from \fI/etc/nanorc\fP (the exact path might be -different on your system), and then the user-specific settings, either -from \fI~/.nanorc\fR or from \fI$XDG_CONFIG_HOME/nano/nanorc\fR -or from \fI~/.config/nano/nanorc\fR, whichever is encountered first. -If \fB\-\-rcfile\fR is given, \fBnano\fR reads just the specified -settings file. +is not given, \fBnano\fR reads two files: first the system-wide settings, +from \fI/etc/nanorc\fP (the exact path might be different on your system), +and then the user-specific settings, either from \fI~/.nanorc\fR or from +\fI$XDG_CONFIG_HOME/nano/nanorc\fR or from \fI~/.config/nano/nanorc\fR, +whichever is encountered first. If \fB\-\-rcfile\fR is given, +\fBnano\fR reads just the specified settings file. .SH NOTICE Since version 8.0, to be newcomer friendly, \fB^F\fR starts a forward search, @@ -102,8 +101,8 @@ The uniquely numbered files are stored in the specified \fIdirectory\fR. .TP .B set boldtext Use bold instead of reverse video for the title bar, status bar, -prompt bar, mini bar, key combos, line numbers, -and selected text. This can be overridden by setting the options +prompt bar, mini bar, key combos, line numbers, and selected text. +This can be overridden by setting the options \fBtitlecolor\fP, \fBstatuscolor\fP, \fBpromptcolor\fP, \fBminicolor\fP, \fBkeycolor\fP, \fBnumbercolor\fP, and/or \fBselectedcolor\fP. .TP @@ -223,9 +222,9 @@ Use this color combination for the mini bar. See \fBset titlecolor\fR for more details. .TP .B set mouse -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 works in the X Window +Enable mouse support, if available for your system. When enabled, +mouse clicks can be used to place the cursor, set the mark (with two +clicks), and execute shortcuts. The mouse works in the X Window System, and on the console when gpm is running. Text can still be selected through dragging by holding down the Shift key. .TP @@ -492,8 +491,8 @@ If no \fIfileregex\fR matched and no \fBheader\fR regex matched either, then compare this \fIregex\fR (or regexes) against the result of querying the \fBmagic\fP database about the current file, to determine whether this syntax should be used for it. -(This functionality only works when \fBlibmagic\fP is installed on the -system and is silently ignored otherwise.) +(This querying is done only when \fBlibmagic\fR is actually installed +on the system and \fB\-\-magic\fR or \fBset magic\fR was given.) .TP .BI formatter " program " \fR[ "argument " \fR...] Run the given \fIprogram\fR on the full contents of the current buffer. @@ -638,8 +637,8 @@ Example: F10. Rebinding \fB^M\fR (Enter) or \fB^I\fR (Tab) is probably not a good idea. Rebinding \fB^[\fR (Esc) is not possible, because its keycode is the starter byte of Meta keystrokes and escape sequences. -Rebinding any of the dedicated cursor-moving keys (the arrows, Home, End, -PageUp and PageDown) is not possible. +Rebinding any of the dedicated cursor-moving keys (the arrows, +Home, End, PageUp and PageDown) is not possible. On some terminals it's not possible to rebind \fB^H\fR (unless \fB\-\-raw\fR is used) because its keycode is identical to that of the Backspace key. diff --git a/doc/sample.nanorc.in b/doc/sample.nanorc.in index 99c4be23..ec049c73 100644 --- a/doc/sample.nanorc.in +++ b/doc/sample.nanorc.in @@ -98,8 +98,8 @@ # set minibar ## 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 +## mouse clicks can be used to place the cursor, set the mark (with +## two clicks), and execute shortcuts. The mouse will work in the ## X Window System, and on the console when gpm is running. # set mouse