From 77a8841d254fb2283eef76c6204447185c965e6c Mon Sep 17 00:00:00 2001 From: Benno Schulenberg Date: Mon, 17 Jun 2024 16:31:17 +0200 Subject: [PATCH] tweaks: elide unhelpful occurrences of the word "will" In most cases, "will" is just a filler word and doesn't improve clarity. And in the bargain improve two descriptions. --- doc/faq.html | 8 ++-- doc/nano.1 | 53 ++++++++++++------------ doc/nano.texi | 109 +++++++++++++++++++++++++------------------------- doc/nanorc.5 | 44 ++++++++++---------- 4 files changed, 106 insertions(+), 108 deletions(-) diff --git a/doc/faq.html b/doc/faq.html index 49d36b31..da764a29 100644 --- a/doc/faq.html +++ b/doc/faq.html @@ -176,7 +176,7 @@

3.8. How do I make a .nanorc file that will be read when I start nano?

It's not hard at all! Simply copy the sample.nanorc from the doc/ directory in the nano source package (or from /usr/doc/nano on your system) to .nanorc in your home directory, and then edit it. If you didn't get a sample nanorc, the syntax of the file is simple: features are turned on and off by using the words set and unset followed by the long option name of the feature (see man nanorc for the full list of options). For example, "set quickblank" or "set smarthome". Of course, for this to work, your nano must not have been compiled with --disable-nanorc.

3.9. Why does my self-compiled nano not read /etc/nanorc?

-

By default (see 3.3), nano gets installed into /usr/local. This also means that, at startup, nano will read /usr/local/etc/nanorc instead of /etc/nanorc. You can make a symlink from the former to the latter if you want your self-compiled nano to read the same nanorc as the system-installed nano. Or you can configure your nano to overwrite the system nano (again, see 3.3).

+

By default (see 3.3), nano gets installed into /usr/local. This also means that, at startup, nano reads /usr/local/etc/nanorc instead of /etc/nanorc. You can make a symlink from the former to the latter if you want your self-compiled nano to read the same nanorc as the system-installed nano. Or you can configure your nano to overwrite the system nano (again, see 3.3).

4. Running

@@ -220,15 +220,15 @@

4.3. Ack! My numeric keypad's keys don't work properly when NumLock is off! What can I do?

You can use the -K or --rawsequences option on the command line, or add the line set rawsequences to your .nanorc. However, nano's mouse support will be disabled if you do any of these things.

4.4. With what keystroke can I paste text from the clipboard into nano?

-

In most desktop environments Shift+Insert will paste the contents of the clipboard.

+

In most desktop environments Shift+Insert pastes the contents of the clipboard.

4.5. How do I select text for or paste text from the clipboard when nano's mouse support is turned on?

Try holding down the Shift key and selecting or pasting the text as you normally would.

4.6. When I paste text into a document, each line gets indented further than the last. Why? And how can I stop this?

You have the autoindent feature turned on. Hit Meta-I to turn it off, paste your text, and then hit Meta-I again to turn it back on.

-

Update: Since version 4.8, nano will suppress auto-indentation during a paste (when your terminal understands bracketed pastes), so you no longer need to toggle it off and on manually.

+

Update: Since version 4.8, nano suppresses auto-indentation during a paste (when your terminal understands bracketed pastes), so you no longer need to toggle it off and on manually.

4.7. When I paste from Windows into a remote nano, nano rewraps the lines. What gives?

When pasting from Windows, in some situations linefeeds are sent instead of carriage returns (Enters). And linefeeds are ^Js, which make nano justify (rewrap) the current paragraph. To prevent these linefeeds from causing these unwanted justifications, add this line to your .nanorc on the remote Linux box: unbind ^J main or bind ^J enter main, depending on whether the paste contains CR + LF or only LF.

-

Update: Since version 4.8, nano will ignore linefeed characters in a paste (when your terminal understands bracketed pastes), so you no longer need the above workaround.

+

Update: Since version 4.8, nano ignores linefeed characters in a paste (when your terminal understands bracketed pastes), so you no longer need the above workaround.

4.8. I've compiled nano with color support, but I don't see any color when I run it!

If you want nano to actually use color, you have to specify the color configurations you want it to use in your .nanorc. Several example configurations are in the syntax/ subdirectory of the nano source, which are normally installed to /usr/local/share/nano/. To enable all of them, uncomment the line # include "/usr/local/share/nano/*.nanorc" in your nanorc. See also section 3.9.

4.9. How do I make nano my default editor (in Pine, mutt, etc.)?

diff --git a/doc/nano.1 b/doc/nano.1 index e07a43ad..0ccbc20f 100644 --- a/doc/nano.1 +++ b/doc/nano.1 @@ -77,21 +77,21 @@ Entering text and moving around in a file is straightforward: typing the letters and using the normal cursor movement keys. Commands are entered by using the Control (^) and the Alt or Meta (M\-) keys. Typing \fB^K\fR deletes the current line and puts it in the cutbuffer. -Consecutive \fB^K\fRs will put all deleted lines together in the cutbuffer. -Any cursor movement or executing any other command will cause the next -\fB^K\fR to overwrite the cutbuffer. A \fB^U\fR will paste the current +Consecutive \fB^K\fRs put all deleted lines together in the cutbuffer. +Any cursor movement or executing any other command causes the next +\fB^K\fR to overwrite the cutbuffer. A \fB^U\fR pastes the current 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 will be +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. .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 will increase +using the arrow keys. Holding down the Ctrl or Alt key too increases the stride. -Any cursor movement without Shift being held will cancel such a selection. +Any cursor movement without Shift being held cancels such a selection. .sp Any valid Unicode code point can be inserted into the buffer by typing \fBM\-V\fR followed by the hexadecimal digits of the code point (concluded @@ -111,10 +111,9 @@ The default key bindings can be changed via a \fInanorc\fR file -- see .TP .BR \-A ", " \-\-smarthome Make the Home key smarter. When Home is pressed anywhere but at the -very beginning of non-whitespace characters on a line, the cursor will -jump to that beginning (either forwards or backwards). If the cursor is -already at that position, it will jump to the true beginning of the -line. +very beginning of non-whitespace characters on a line, the cursor jumps +to that beginning (either forwards or backwards). If the cursor is +already at that position, it jumps to the true beginning of the line. .TP .BR \-B ", " \-\-backup When saving a file, back up the previous version of it, using the current @@ -287,14 +286,14 @@ Display line numbers to the left of the text area. .BR \-m ", " \-\-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 will work in the X Window +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. .TP .BR \-n ", " \-\-noread Treat any name given on the command line as a new file. This allows -\fBnano\fR to write to named pipes: it will start with a blank buffer, -and will write to the pipe when the user saves the "file". This way +\fBnano\fR to write to named pipes: it starts with a blank buffer, +and writes to the pipe when the user saves the "file". This way \fBnano\fR can be used as an editor in combination with for instance \fBgpg\fR without having to write sensitive data to disk first. .TP @@ -303,8 +302,8 @@ Set the operating directory. This makes \fBnano\fP set up something similar to a chroot. .TP .BR \-p ", " \-\-preserve -Preserve the XON and XOFF sequences (\fB^Q\fR and \fB^S\fR) so they -will be caught by the terminal. +Preserve the XOFF and XON sequences (\fB^S\fR and \fB^Q\fR) so that +they are caught by the terminal (stopping and resuming the output). Note that option \fB\-/\fR (\fB\-\-modernbindings\fR) overrides this. .TP .BR \-q ", " \-\-indicator @@ -314,7 +313,7 @@ and how much of the buffer is covered by the viewport. .TP .BR \-r\ \fInumber ", " \-\-fill= \fInumber Set the target width for justifying and automatic hard-wrapping at this -\fInumber\fR of columns. If the value is 0 or less, wrapping will occur +\fInumber\fR of columns. If the value is 0 or less, wrapping occurs at the width of the screen minus \fInumber\fR columns, allowing the wrap point to vary along with the width of the screen if the screen is resized. The default value is \fB\-8\fR. @@ -423,9 +422,9 @@ the help viewer and the linter. All other toggles work in the main menu only. .SH FILES -When \fB\-\-rcfile\fR is given, \fBnano\fR will read just the specified file +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 will read two configuration files: first the system's +\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 @@ -444,17 +443,17 @@ When you want to copy marked text from \fBnano\fR to the system's clipboard, see one of the examples in the \fBnanorc\fR(5) man page. .sp If no alternative spell checker command is specified on the command -line nor in one of the \fInanorc\fP files, \fBnano\fP will check the +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 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, it will add ".save" +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 will write all the open +it unique. In multibuffer mode, \fBnano\fP writes all the open buffers to their respective emergency files. .sp If you have any question about how to use \fBnano\fR in some specific @@ -469,7 +468,7 @@ Please report any other bugs that you encounter via: .br .IR https://savannah.gnu.org/bugs/?group=nano . .sp -When nano crashes, it will save any modified buffers to emergency .save files. +When nano crashes, it saves any modified buffers to emergency .save files. If you are able to reproduce the crash and you want to get a backtrace, define the environment variable \fBNANO_NOCATCH\fR. diff --git a/doc/nano.texi b/doc/nano.texi index 9ae60ed0..a253a160 100644 --- a/doc/nano.texi +++ b/doc/nano.texi @@ -213,9 +213,9 @@ file has been modified since it was last saved or opened. The status bar is the third line from the bottom of the screen. It shows important and informational messages. Any error messages that -occur from using the editor will appear on the status bar. Any questions -that are asked of the user will be asked on the status bar, and any user -input (search strings, filenames, etc.) will be input on the status bar. +occur from using the editor appear on the status bar. Any questions +that are asked of the user are asked on the status bar, and any user +input (search strings, filenames, etc.) is input on the status bar. The two help lines at the bottom of the screen show some of the most essential functions of the editor. @@ -233,21 +233,21 @@ Characters not present on the keyboard can be entered in two ways: @item For characters with a single-byte code, pressing the Esc key twice and then typing a three-digit decimal number -(from @kbd{000} to @kbd{255}) will make @command{nano} behave as if you +(from @kbd{000} to @kbd{255}) makes @command{nano} behave as if you typed the key with that value. @item For any possible character, pressing @kbd{M-V} (Alt+V) and then typing a series of hexadecimal digits (at most six, or concluded with @kbd{Enter} or -@kbd{Space}) will enter the corresponding Unicode character into the buffer. +@kbd{Space}) enters the corresponding Unicode character into the buffer. @end itemize -For example, typing @kbd{Esc Esc 2 3 4} will enter the character "ê" --- +For example, typing @kbd{Esc Esc 2 3 4} enters the character "ê" --- useful when writing about a French party. Typing @kbd{M-V 0 0 2 2 c 4} -will enter the symbol "⋄", a little diamond. +enters the symbol "⋄", a little diamond. Typing @kbd{M-V} followed by anything other than a hexadecimal digit -will enter this keystroke verbatim into the buffer, allowing the user +enters this keystroke verbatim into the buffer, allowing the user to insert literal control codes (except @code{^J}) or escape sequences. @node Commands @@ -277,8 +277,8 @@ and then pressing the desired key. Text can be cut from a file a whole line at a time with @kbd{^K}. The cut line is stored in the cutbuffer. Consecutive strokes of @kbd{^K} -will add each cut line to this buffer, but a @kbd{^K} -after any other keystroke will overwrite the entire cutbuffer. +add each cut line to this buffer, but a @kbd{^K} +after any other keystroke overwrites the entire cutbuffer. The contents of the cutbuffer can be pasted at the current cursor position with @kbd{^U}. @@ -291,14 +291,14 @@ with @kbd{M-6}. Text can be selected by first 'setting the Mark' with @kbd{^6} or @kbd{M-A} and then moving the cursor to the other end of the portion -to be selected. The selected portion of text will be highlighted. +to be selected. The selected portion of text is highlighted. This selection can now be cut or copied in its entirety with a single @kbd{^K} or @kbd{M-6}. Or the selection can be used to limit the scope of a search-and-replace (@kbd{^\}) or spell-checking session (@kbd{^T^T}). On some terminals, text can be selected also by holding down @kbd{Shift} while using the cursor keys. Holding down the @kbd{Ctrl} or @kbd{Alt} -key too will increase the stride. Such a selection is cancelled +key too increases the stride. Such a selection is cancelled upon any cursor movement where @kbd{Shift} isn't held. Cutting or copying selected text toggles off the mark automatically. @@ -320,7 +320,7 @@ When a regular expression contains fragments between parentheses, the replacement string can refer back to these fragments via @code{\1} to @code{\9}. -For each occurrence of the search string you will be asked whether to +For each occurrence of the search string you are asked whether to replace it. You can choose Yes (replace it), or No (skip this one), or All (replace all remaining occurrences without asking any more), or Cancel (stop with replacing, but replacements that have already @@ -344,7 +344,7 @@ executes the selected shortcut. To be able to select text with the left button, or paste text with the middle button, hold down the Shift key during those actions. -The mouse will work in the X Window System, and on the console when gpm +The mouse works in the X Window System, and on the console when gpm is running. @node Anchors @@ -384,7 +384,7 @@ and @kbd{^V} (Page Down) keys. @kbd{^X} exits from the help viewer. @chapter The File Browser When in the Read-File (@kbd{^R}) or Write-Out menu (@kbd{^O}), -pressing @kbd{^T} will invoke the file browser. +pressing @kbd{^T} invokes the file browser. Here, one can navigate directories in a graphical manner in order to find the desired file. @@ -393,8 +393,8 @@ other cursor-movement keys. More targeted movement is accomplished by searching, via @kbd{^W} or @kbd{w}, or by changing directory, via @kbd{^_} or @kbd{g}. The behavior of the @kbd{Enter} key (or @kbd{s}) varies by what is currently selected. -If the currently selected object is a directory, the file browser will -enter and display the contents of the directory. If the object is a +If the currently selected object is a directory, the file browser +enters and displays the contents of the directory. If the object is a file, this filename and path are copied to the status bar, and the file browser exits. @@ -409,10 +409,9 @@ browser exits. @item -A @itemx --smarthome Make the Home key smarter. When Home is pressed anywhere but at the -very beginning of non-whitespace characters on a line, the cursor will -jump to that beginning (either forwards or backwards). If the cursor is -already at that position, it will jump to the true beginning of the -line. +very beginning of non-whitespace characters on a line, the cursor jumps +to that beginning (either forwards or backwards). If the cursor is +already at that position, it jumps to the true beginning of the line. @item -B @itemx --backup @@ -624,15 +623,15 @@ Display line numbers to the left of the text area. @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 will work in the X Window +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. @item -n @itemx --noread Treat any name given on the command line as a new file. This allows -@command{nano} to write to named pipes: it will start with a blank buffer, -and will write to the pipe when the user saves the "file". This way +@command{nano} to write to named pipes: it starts with a blank buffer, +and writes to the pipe when the user saves the "file". This way @command{nano} can be used as an editor in combination with for instance @command{gpg} without having to write sensitive data to disk first. @@ -643,8 +642,8 @@ similar to a chroot. @item -p @itemx --preserve -Preserve the @kbd{^Q} (XON) and @kbd{^S} (XOFF) sequences so data being -sent to the editor can be stopped and started. +Preserve the @kbd{^S} (XOFF) and @kbd{^Q} (XON) sequences so that +data being sent to the terminal can be stopped and resumed. Note that option @option{-/} (@option{--modernbindings}) overrides this. @item -q @@ -656,7 +655,7 @@ and how much of the buffer is covered by the viewport. @item -r @var{number} @itemx --fill=@var{number} Set the target width for justifying and automatic hard-wrapping at this -@var{number} of columns. If the value is 0 or less, wrapping will occur +@var{number} of columns. If the value is 0 or less, wrapping occurs at the width of the screen minus @var{number} columns, allowing the wrap point to vary along with the width of the screen if the screen is resized. The default value is @t{-8}. @@ -852,13 +851,13 @@ not the help lines. The latter are toggled with @kbd{M-X}. @chapter Nanorc Files Nanorc files can be used to configure @command{nano} to your liking -without using command-line options. During startup @command{nano} will -normally read two files: first the system-wide file, @file{/etc/nanorc} +without using command-line options. During startup @command{nano} +normally reads two files: first the system-wide file, @file{/etc/nanorc} (the exact path may be different on your system), and then the user-specific file, either @file{~/.nanorc} or @file{$XDG_CONFIG_HOME/nano/nanorc} or @file{.config/nano/nanorc}, whichever exists first. -However, if @option{--rcfile} is given, @command{nano} will skip the -above files and will read just the specified settings file. +However, if @option{--rcfile} is given, @command{nano} skips the +above files and reads just the specified settings file. A nanorc file can contain @command{set} and @command{unset} commands for various options (@pxref{Settings}). It can also contain commands that @@ -968,7 +967,7 @@ The default value is @t{bold,white,red}. @item set fill @var{number} Set the target width for justifying and automatic hard-wrapping at this -@var{number} of columns. If the value is 0 or less, wrapping will occur +@var{number} of columns. If the value is 0 or less, wrapping occurs at the width of the screen minus @var{number} columns, allowing the wrap point to vary along with the width of the screen if the screen is resized. The default value is @t{-8}. @@ -1097,7 +1096,7 @@ Use this color combination for line numbers. @xref{@code{set keycolor}} for valid color names. @item set operatingdir "@var{directory}" -@command{nano} will only read and write files inside "directory" and its +@command{nano} only reads and writes files inside "directory" and its subdirectories. Also, the current directory is changed to here, so files are inserted from this directory. By default, the operating directory feature is turned off. @@ -1107,7 +1106,8 @@ Save the cursor position of files between editing sessions. The cursor position is remembered for the 200 most-recently edited files. @item set preserve -Preserve the XON and XOFF keys (@kbd{^Q} and @kbd{^S}). +Preserve the XOFF and XON sequences (@kbd{^S} and @kbd{^Q}) so that +they are caught by the terminal (stopping and resuming the output). @item set promptcolor [bold,][italic,]@var{fgcolor},@var{bgcolor} Use this color combination for the prompt bar. @@ -1170,10 +1170,9 @@ poor vision. @item set smarthome Make the Home key smarter. When Home is pressed anywhere but at the -very beginning of non-whitespace characters on a line, the cursor will -jump to that beginning (either forwards or backwards). If the cursor is -already at that position, it will jump to the true beginning of the -line. +very beginning of non-whitespace characters on a line, the cursor jumps +to that beginning (either forwards or backwards). If the cursor is +already at that position, it jumps to the true beginning of the line. @item set softwrap Display lines that exceed the screen's width over multiple screen lines. @@ -1299,10 +1298,10 @@ via the following commands in a nanorc file: @item syntax @var{name} ["@var{fileregex}" @dots{}] Start the definition of a syntax with this @var{name}. All subsequent @code{color} and other such commands -will be added to this syntax, until a new @code{syntax} +are added to this syntax, until a new @code{syntax} command is encountered. -When @command{nano} is run, this syntax will be automatically +When @command{nano} is run, this syntax is automatically activated (for the relevant buffer) if the absolute filename matches the extended regular expression @var{fileregex}. Or the syntax can be explicitly activated (for all buffers) @@ -1325,7 +1324,7 @@ 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 will be silently ignored otherwise.) +on the system and is silently ignored otherwise.) @item formatter @var{program} [@var{argument} @dots{}] Run the given @var{program} on the full contents of the current buffer. @@ -1393,7 +1392,7 @@ Paint all pieces of text whose start matches extended regular expression "fromrx" and whose end matches extended regular expression "torx" with the given foreground and background colors, at least one of which must be specified. This means that, after an initial instance of -"fromrx", all text until the first instance of "torx" will be colored. +"fromrx", all text until the first instance of "torx" is colored. This allows syntax highlighting to span multiple lines. @item icolor [bold,][italic,]@var{fgcolor},@var{bgcolor} start="@var{fromrx}" end="@var{torx}" @@ -1430,7 +1429,7 @@ Rebinds @code{key} to @code{function} in the context of @code{menu} Makes @code{key} produce @code{string} in the context of @code{menu} (or in all menus where the key exists when @code{all} is used). Besides literal text and/or control codes, the @code{string} may contain -function names between braces. These functions will be invoked when the +function names between braces. These functions are invoked when the key is typed. To include a literal opening brace, use @code{@{@{@}}. @item unbind key menu @@ -1441,10 +1440,10 @@ Unbinds @code{key} from @code{menu} Note that @code{bind key "@{function@}" menu} is equivalent to @code{bind key function menu}, except that for the latter form -@command{nano} will check the availability of the @code{function} +@command{nano} checks the availability of the @code{function} in the given @code{menu} at startup time (and report an error if it does not exist there), whereas for the first form @command{nano} -will check at execution time that the @code{function} exists but not +checks at execution time that the @code{function} exists but not whether it makes any sense in the current menu. The user has to take care that a function name between braces (or any sequence of them) is appropriate. Strange behavior can result when it is not. @@ -1589,7 +1588,7 @@ the contents of the buffer.) @item linter Invokes a syntax-checking program (if the active syntax defines one). If this program produces lines of the form "filename:linenum:charnum: -some message", then the cursor will be put at the indicated position +some message", then the cursor is put at the indicated position in the mentioned file while showing "some message" on the status bar. You can move from message to message with @kbd{PgUp} and @kbd{PgDn}, and leave linting mode with @kbd{^C} or @kbd{Enter}. @@ -1855,14 +1854,14 @@ whitespace as the preceding line --- or as the next line if the preceding line is the beginning of a paragraph. @item cutfromcursor -Toggles whether cutting text will cut the whole line or just from the current cursor +Toggles whether cutting text cuts the whole line or just from the current cursor position to the end of the line. @item breaklonglines -Toggles whether long lines will be hard-wrapped to the next line. +Toggles whether the overlong part of a line is hard-wrapped to the next line. @item tabstospaces -Toggles whether typed tabs will be converted to spaces. +Toggles whether typed tabs are converted to spaces. @item mouse Toggles mouse support. @@ -1947,7 +1946,7 @@ whereas Pico does it at screen width minus six columns. You can make @command{nano} do as Pico by using @option{--fill=-6}. @item Scrolling -By default, @command{nano} will scroll just one line (instead of half +By default, @command{nano} scrolls just one line (instead of half a screen) when the cursor is moved to a line that is just out of view. And when paging up or down, @command{nano} keeps the cursor in the same screen position as much as possible, instead of always placing it on the @@ -1963,8 +1962,8 @@ get it back with the @option{--emptyline} option. @item Interactive Replace Instead of allowing you to replace either just one occurrence of a search -string or all of them, @command{nano}'s replace function is interactive: it -will pause at each found search string and query whether to replace this +string or all of them, @command{nano}'s replace function is interactive: +it pauses at each found search string and asks whether to replace this instance. You can then choose Yes, or No (skip this one), or All (don't ask any more), or Cancel (stop with replacing). @@ -2002,8 +2001,8 @@ When using the Read-File key (@kbd{^R}), @command{nano} can not just read a file it can also read the output of a command to be run (@kbd{^X}). @item Reading from Working Directory -By default, Pico will read files from the user's home directory (when -using @kbd{^R}), but it will write files to the current working directory +By default, Pico reads files from the user's home directory (when +using @kbd{^R}), but it writes files to the current working directory (when using @kbd{^O}). @command{nano} makes this symmetrical: always reading from and writing to the current working directory --- the directory that @command{nano} was started in. @@ -2138,7 +2137,7 @@ Include some code for runtime debugging output. This can get messy, so chances are you only want this feature when you're working on the nano source. @item --disable-nls -Exclude Native Language support. This will disable the use of any +Exclude Native Language support. This disables the use of any available GNU @command{nano} translations. @item --enable-utf8 diff --git a/doc/nanorc.5 b/doc/nanorc.5 index 15c71c70..13df8397 100644 --- a/doc/nanorc.5 +++ b/doc/nanorc.5 @@ -24,12 +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 will read two files: first the +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 will read just the specified +If \fB\-\-rcfile\fR is given, \fBnano\fR reads just the specified settings file. .SH NOTICE @@ -150,7 +150,7 @@ See \fBset titlecolor\fR for valid color names. .TP .B set fill \fInumber\fR Set the target width for justifying and automatic hard-wrapping at this -\fInumber\fR of columns. If the value is 0 or less, wrapping will occur +\fInumber\fR of columns. If the value is 0 or less, wrapping occurs at the width of the screen minus \fInumber\fR columns, allowing the wrap point to vary along with the width of the screen if the screen is resized. The default value is \fB\-8\fR. @@ -225,7 +225,7 @@ See \fBset titlecolor\fR for more details. .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 will work in the X Window +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. .TP @@ -251,7 +251,7 @@ Use this color combination for line numbers. See \fBset titlecolor\fR for more details. .TP .B set operatingdir "\fIdirectory\fP" -\fBnano\fP will only read and write files inside \fIdirectory\fP and its +\fBnano\fP only reads and writes files inside \fIdirectory\fP and its subdirectories. Also, the current directory is changed to here, so files are inserted from this directory. By default, the operating directory feature is turned off. @@ -261,7 +261,8 @@ Save the cursor position of files between editing sessions. The cursor position is remembered for the 200 most-recently edited files. .TP .B set preserve -Preserve the XON and XOFF keys (\fB^Q\fR and \fB^S\fR). +Preserve the XOFF and XON sequences (\fB^S\fR and \fB^Q\fR) so that +they are caught by the terminal (stopping and resuming the output). .TP .B set promptcolor \fR[\fBbold,\fR][\fBitalic,\fR]\fIfgcolor\fB,\fIbgcolor\fR Use this color combination for the prompt bar. @@ -323,10 +324,9 @@ poor vision. .TP .B set smarthome Make the Home key smarter. When Home is pressed anywhere but at the -very beginning of non-whitespace characters on a line, the cursor will -jump to that beginning (either forwards or backwards). If the cursor is -already at that position, it will jump to the true beginning of the -line. +very beginning of non-whitespace characters on a line, the cursor jumps +to that beginning (either forwards or backwards). If the cursor is +already at that position, it jumps to the true beginning of the line. .TP .B set softwrap Display lines that exceed the screen's width over multiple screen lines. @@ -467,10 +467,10 @@ via the following commands: .BI syntax " name \fR[" """" fileregex """ " \fR...] Start the definition of a syntax with this \fIname\fR. All subsequent \fBcolor\fR and other such commands -will be added to this syntax, until a new \fBsyntax\fR +are added to this syntax, until a new \fBsyntax\fR command is encountered. .sp -When \fBnano\fR is run, this syntax will be automatically +When \fBnano\fR is run, this syntax is automatically activated (for the relevant buffer) if the absolute filename matches the extended regular expression \fIfileregex\fR. Or the syntax can be explicitly activated (for all buffers) @@ -493,7 +493,7 @@ 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 will be silently ignored otherwise.) +system and is silently ignored otherwise.) .TP .BI formatter " program " \fR[ "argument " \fR...] Run the given \fIprogram\fR on the full contents of the current buffer. @@ -558,7 +558,7 @@ Paint all pieces of text whose start matches extended regular expression with the given foreground and background colors, at least one of which must be specified. This means that, after an initial instance of \fIfromrx\fP, all text until the first instance of -\fItorx\fP will be colored. This allows syntax highlighting to span +\fItorx\fP is colored. This allows syntax highlighting to span multiple lines. .TP .BI "icolor \fR[\fBbold,\fR][\fBitalic,\fR]" fgcolor , bgcolor " start=""" fromrx """ end=""" torx """ @@ -590,7 +590,7 @@ Rebinds the given \fIkey\fP to the given \fIfunction\fP in the given \fImenu\fP Makes the given \fIkey\fR produce the given \fIstring\fR in the given \fImenu\fR (or in all menus where the key exists when \fBall\fR is used). Besides literal text and/or control codes, the \fIstring\fR may contain -function names between braces. These functions will be invoked when +function names between braces. These functions are invoked when the key is typed. To include a literal opening brace, use \fB{{}\fR. .TP .BI unbind " key menu" @@ -600,9 +600,9 @@ menus where the key exists when \fBall\fP is used). .sp Note that \fBbind \fIkey\fR \fB"{\fIfunction\fB}"\fR \fImenu\fR is equivalent to \fBbind \fIkey\fR \fIfunction\fR \fImenu\fR, except that for the latter form -\fBnano\fR will check the availability of the \fIfunction\fR in the given \fImenu\fR +\fBnano\fR checks the availability of the \fIfunction\fR in the given \fImenu\fR at startup time (and report an error if it does not exist there), whereas for the -first form \fBnano\fR will check at execution time that the \fIfunction\fR exists +first form \fBnano\fR checks at execution time that the \fIfunction\fR exists but not whether it makes any sense in the current menu. The user has to take care that a function name between braces (or any sequence of them) is appropriate. Strange behavior can result when it is not. @@ -723,7 +723,7 @@ Counts and reports on the status bar the number of lines, words, and characters in the current buffer (or in the marked region). .TP .B execute -Prompts for a program to execute. The program's output will be inserted +Prompts for a program to execute. The program's output is inserted into the current buffer (or into a new buffer when \fBM\-F\fR is toggled). .TP .B speller @@ -739,7 +739,7 @@ the contents of the buffer.) .B linter Invokes a syntax-checking program (if the active syntax defines one). If this program produces lines of the form "filename:linenum:charnum: -some message", then the cursor will be put at the indicated position +some message", then the cursor is put at the indicated position in the mentioned file while showing "some message" on the status bar. You can move from message to message with and , and leave linting mode with \fB^C\fR or . @@ -1006,14 +1006,14 @@ whitespace as the preceding line -- or as the next line if the preceding line is the beginning of a paragraph. .TP .B cutfromcursor -Toggles whether cutting text will cut the whole line or just from the current cursor +Toggles whether cutting text cuts the whole line or just from the current cursor position to the end of the line. .TP .B breaklonglines -Toggles whether long lines will be hard-wrapped to the next line. +Toggles whether the overlong part of a line is hard-wrapped to the next line. .TP .B tabstospaces -Toggles whether typed tabs will be converted to spaces. +Toggles whether typed tabs are converted to spaces. .TP .B mouse Toggles mouse support.