ariadne
/
smol
2
1
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

docs: add some more mark-up to the Info document 

And rewrap the feature toggles, so that a title does not start
a sentence.
master
Benno Schulenberg 2017-07-13 22:17:29 +02:00
parent 46cec27b26
commit 961294f533
1 changed files with 80 additions and 78 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

158
doc/nano.texi
View File

@ -279,7 +279,7 @@ the previous line.
@item -k @item -k
@itemx --cut @itemx --cut
Make the 'Cut Text' command (normally ^K) cut from the current cursor Make the 'Cut Text' command (normally @kbd{^K}) cut from the current cursor
position to the end of the line, instead of cutting the entire line. position to the end of the line, instead of cutting the entire line.
@item -l @item -l
@ -309,8 +309,8 @@ similar to a chroot.
@item -p @item -p
@itemx --preserve @itemx --preserve
Preserve the ^Q (XON) and ^S (XOFF) sequences so data being sent to the Preserve the @kbd{^Q} (XON) and @kbd{^S} (XOFF) sequences so data being
editor can be stopped and started. sent to the editor can be stopped and started.
@item -q @item -q
@itemx --quiet @itemx --quiet
@ -337,7 +337,7 @@ corrector, which requires the GNU @command{spell} program to be installed.
@item -t @item -t
@itemx --tempfile @itemx --tempfile
Don't ask whether to save a modified buffer when exiting with ^X, but Don't ask whether to save a modified buffer when exiting with @kbd{^X}, but
assume yes. This option is useful when @command{nano} is used as the assume yes. This option is useful when @command{nano} is used as the
composer of a mailer program. composer of a mailer program.
@ -371,7 +371,7 @@ disabled to display the help-system navigation keys.
@item -z @item -z
@itemx --suspend @itemx --suspend
Enable the ability to suspend @command{nano} using the system's suspend Enable the ability to suspend @command{nano} using the system's suspend
keystroke (usually ^Z). keystroke (usually @kbd{^Z}).
@item -$ @item -$
@itemx --softwrap @itemx --softwrap
@ -422,13 +422,13 @@ pressing the Esc key twice and then typing a three-digit decimal number
with that value. with that value.
@item @item
For any possible character, pressing M-V (Alt+V) and then typing a For any possible character, pressing @kbd{M-V} (Alt+V) and then typing a
six-digit hexadecimal number (starting with 0 or 1) will enter the six-digit hexadecimal number (starting with 0 or 1) will enter the
corresponding Unicode character into the buffer. corresponding Unicode character into the buffer.
@end itemize @end itemize
For example, typing "Esc Esc 2 3 4" will enter the character "ê" --- For example, typing @kbd{Esc Esc 2 3 4} will enter the character "ê" ---
useful when writing about a French party. Typing "M-V 0 0 2 2 c 4" useful when writing about a French party. Typing @kbd{M-V 0 0 2 2 c 4}
will enter the symbol "⋄", a little diamond. will enter the symbol "⋄", a little diamond.
@node Commands @node Commands
@ -457,29 +457,30 @@ and then pressing the desired key.
@section The Cutbuffer @section The Cutbuffer
Text can be cut from a file, a whole line at a time, by using the 'Cut Text' Text can be cut from a file, a whole line at a time, by using the 'Cut Text'
command (default key binding: ^K). The cut line is stored in the cutbuffer. command (default key binding: @kbd{^K}). The cut line is stored in
Consecutive strokes of ^K will add each cut line to this buffer, but a ^K 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. after any other keystroke will overwrite the entire cutbuffer.
The contents of the cutbuffer can be pasted back into the file with the The contents of the cutbuffer can be pasted back into the file with the
'Uncut Text' command (default key binding: ^U). 'Uncut Text' command (default key binding: @kbd{^U}).
A line of text can be copied into the cutbuffer (without cutting it) with A line of text can be copied into the cutbuffer (without cutting it) with
the 'Copy Text' command (default key binding: M-6). the 'Copy Text' command (default key binding: @kbd{M-6}).
@node The Mark @node The Mark
@section The Mark @section The Mark
Text can be selected by first 'setting the Mark' (default key bindings: Text can be selected by first 'setting the Mark' (default key bindings:
^6 and M-A) and then moving the cursor to the other end of the portion @kbd{^6} and @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 in to be selected. The selected portion of text will be highlighted in
reverse video (or in bold if you set the boldtext option). reverse video (or in bold if you set the boldtext option).
This selection can now be cut or copied in its entirety with a single This selection can now be cut or copied in its entirety with a single
^K or M-6. Or the selection can be used to limit the scope of a @kbd{^K} or @kbd{M-6}. Or the selection can be used to limit the scope of
search-and-replace (^\) or spell-checking session (^T). a search-and-replace (@kbd{^\}) or spell-checking session (@kbd{^T}).
Cutting or copying selected text will toggle the mark off automatically. Cutting or copying selected text will toggle the mark off automatically.
If necessary, it can be toggled off manually with another ^6 or M-A. If necessary, it can be toggled off manually with another @kbd{^6} or @kbd{M-A}.
@node Screen Layout @node Screen Layout
@section Screen Layout @section Screen Layout
@ -509,13 +510,13 @@ Shortcut List.
@section Search and Replace @section Search and Replace
One can search the current buffer for the occurrence of any string One can search the current buffer for the occurrence of any string
with the Search command (default key binding: ^W). The default search with the Search command (default key binding: @kbd{^W}). The default search
mode is forward, case-insensitive, and for literal strings. But one mode is forward, case-insensitive, and for literal strings. But one
can search backwards by pressing M-B, search case sensitively with M-C, can search backwards by pressing @kbd{M-B}, search case sensitively with @kbd{M-C},
and interpret regular expressions in the search string with M-R. and interpret regular expressions in the search string with @kbd{M-R}.
A regular expression in a search string always covers just one line; A regular expression in a search string always covers just one line;
it cannot span multiple lines. And when replacing (with ^\ or M-R) it cannot span multiple lines. And when replacing (with @kbd{^\} or @kbd{M-R})
the replacement string cannot contain a newline (LF). the replacement string cannot contain a newline (LF).
@node Using the Mouse @node Using the Mouse
@ -534,7 +535,7 @@ is running.
@node Limitation @node Limitation
@section Limitation @section Limitation
Justifications (@code{^J}) and reindentations (@code{M-@{} and @code{M-@}}) Justifications (@kbd{^J}) and reindentations (@kbd{M-@{} and @kbd{M-@}})
are not yet covered by the general undo system. So after a justification are not yet covered by the general undo system. So after a justification
that is not immediately undone, or after any reindentation, earlier edits that is not immediately undone, or after any reindentation, earlier edits
cannot be undone any more. The workaround is, of course, to exit without cannot be undone any more. The workaround is, of course, to exit without
@ -544,10 +545,10 @@ saving.
@node Built-in Help @node Built-in Help
@chapter Built-in Help @chapter Built-in Help
The built-in help system in @code{nano} is available by pressing ^G@. The built-in help system in @code{nano} is available by pressing @kbd{^G}.
It is fairly self-explanatory. It documents the various parts of the It is fairly self-explanatory. It documents the various parts of the
editor and the available keystrokes. Navigation is via the ^Y (Page Up) editor and the available keystrokes. Navigation is via the @kbd{^Y} (Page Up)
and ^V (Page Down) keys. ^X exits the help system. and @kbd{^V} (Page Down) keys. @kbd{^X} exits from the help system.
@node Feature Toggles @node Feature Toggles
@ -560,60 +561,60 @@ The following global toggles are available:
@table @code @table @code
@item Backup Files Toggle (Meta-B) @item Backup Files toggle
toggles the @code{-B} (@code{--backup}) command-line option. @kbd{Meta-B} toggles the @code{-B} (@code{--backup}) command-line option.
@item Constant Cursor Position Display Toggle (Meta-C) @item Constant Cursor Position Display toggle
toggles the @code{-c} (@code{--constantshow}) command-line option. @kbd{Meta-C} toggles the @code{-c} (@code{--constantshow}) command-line option.
@item Multiple File Buffers Toggle (Meta-F) @item Multiple File Buffers toggle
toggles the @code{-F} (@code{--multibuffer}) command-line option. @kbd{Meta-F} toggles the @code{-F} (@code{--multibuffer}) command-line option.
@item Smart Home Key Toggle (Meta-H) @item Smart Home Key toggle
toggles the @code{-A} (@code{--smarthome}) command-line option. @kbd{Meta-H} toggles the @code{-A} (@code{--smarthome}) command-line option.
@item Auto Indent Toggle (Meta-I) @item Auto Indent toggle
toggles the @code{-i} (@code{--autoindent}) command-line option. @kbd{Meta-I} toggles the @code{-i} (@code{--autoindent}) command-line option.
@item Cut To End Toggle (Meta-K) @item Cut From Cursor To End-of-Line toggle
toggles the @code{-k} (@code{--cut}) command-line option. @kbd{Meta-K} toggles the @code{-k} (@code{--cut}) command-line option.
@item Long Line Wrapping Toggle (Meta-L) @item Long-Line Wrapping toggle
toggles the @code{-w} (@code{--nowrap}) command-line option. @kbd{Meta-L} toggles the @code{-w} (@code{--nowrap}) command-line option.
@item Mouse Support Toggle (Meta-M) @item Mouse Support toggle
toggles the @code{-m} (@code{--mouse}) command-line option. @kbd{Meta-M} toggles the @code{-m} (@code{--mouse}) command-line option.
@item No Conversion From DOS/Mac Format Toggle (Meta-N) @item No Conversion From DOS/Mac Format toggle
toggles the @code{-N} (@code{--noconvert}) command-line option. @kbd{Meta-N} toggles the @code{-N} (@code{--noconvert}) command-line option.
@item More Space For Editing Toggle (Meta-O) @item More Space For Editing toggle
toggles the @code{-O} (@code{--morespace}) command-line option. @kbd{Meta-O} toggles the @code{-O} (@code{--morespace}) command-line option.
@item Whitespace Display Toggle (Meta-P) @item Whitespace Display toggle
toggles the whitespace-display mode (@pxref{Whitespace}). @kbd{Meta-P} toggles the whitespace-display mode (@pxref{Whitespace}).
@item Tabs to Spaces Toggle (Meta-Q) @item Tabs To Spaces toggle
toggles the @code{-E} (@code{--tabstospaces}) command-line option. @kbd{Meta-Q} toggles the @code{-E} (@code{--tabstospaces}) command-line option.
@item Smooth Scrolling Toggle (Meta-S) @item Smooth Scrolling toggle
toggles the @code{-S} (@code{--smooth}) command-line option. @kbd{Meta-S} toggles the @code{-S} (@code{--smooth}) command-line option.
@item Expert/No Help Toggle (Meta-X) @item Expert/No Help toggle
toggles the @code{-x} (@code{--nohelp}) command-line option. @kbd{Meta-X} toggles the @code{-x} (@code{--nohelp}) command-line option.
@item Color Syntax Highlighting Toggle (Meta-Y) @item Color Syntax Highlighting toggle
toggles color syntax highlighting (if your nanorc defines syntaxes @kbd{Meta-Y} toggles color syntax highlighting (if your nanorc defines syntaxes
--- @pxref{Syntax Highlighting}). --- @pxref{Syntax Highlighting}).
@item Suspension Toggle (Meta-Z) @item Suspension toggle
toggles the @code{-z} (@code{--suspend}) command-line option. @kbd{Meta-Z} toggles the @code{-z} (@code{--suspend}) command-line option.
@item Line Numbers Toggle (Meta-#) @item Line Numbers toggle
toggles the @code{-l} (@code{--linenumbers}) command-line option. @kbd{Meta-#} toggles the @code{-l} (@code{--linenumbers}) command-line option.
@item Soft Wrapping Toggle (Meta-$) @item Soft Wrapping toggle
toggles the @code{-$} (@code{--softwrap}) command-line option. @kbd{Meta-$} toggles the @code{-$} (@code{--softwrap}) command-line option.
@end table @end table
@ -755,7 +756,7 @@ 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 a double click), or execute shortcuts.
@item set multibuffer @item set multibuffer
When reading in a file with ^R, insert it into a new buffer by default. When reading in a file with @kbd{^R}, insert it into a new buffer by default.
@item set noconvert @item set noconvert
Don't convert files from DOS/Mac format. Don't convert files from DOS/Mac format.
@ -790,7 +791,7 @@ The cursor position is remembered for the 200 most-recently edited files.
(The old form of this option, @code{set poslog}, is deprecated.) (The old form of this option, @code{set poslog}, is deprecated.)
@item set preserve @item set preserve
Preserve the XON and XOFF keys (^Q and ^S). Preserve the XON and XOFF keys (@kbd{^Q} and @kbd{^S}).
@item set punct "@var{string}" @item set punct "@var{string}"
Set the characters treated as closing punctuation when justifying Set the characters treated as closing punctuation when justifying
@ -1334,7 +1335,7 @@ Toggles mouse support.
Toggles automatic conversion of files from DOS/Mac format. Toggles automatic conversion of files from DOS/Mac format.
@item suspendenable @item suspendenable
Toggles whether the suspend sequence (normally ^Z) will suspend the editor window. Toggles whether the suspend shortcut (normally @kbd{^Z}) will suspend the editor.
@end table @end table
@ -1396,14 +1397,15 @@ it means all menus where the specified @code{key} exists.
@node The File Browser @node The File Browser
@chapter The File Browser @chapter The File Browser
When reading or writing files, pressing ^T will invoke the file browser. When reading or writing files, pressing @kbd{^T} will invoke the file browser.
Here, one can navigate directories in a graphical manner in order to Here, one can navigate directories in a graphical manner in order to
find the desired file. find the desired file.
Basic movement in the file browser is accomplished with the arrow keys, Basic movement in the file browser is accomplished with the arrow keys,
page up, and page down. More advanced movement is accomplished by page up, and page down. More advanced movement is accomplished by
searching via ^W (or 'w') and changing directories via ^_ (or 'g'). The searching via @kbd{^W} (or @kbd{w'} and changing directories via
behavior of the Enter (or 's') key varies by what is currently selected. @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 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 enter and display the contents of the directory. If the object is a
file, this filename and path are copied to the status bar, and the file file, this filename and path are copied to the status bar, and the file
@ -1439,7 +1441,7 @@ when you close a file, and will place the cursor in that position
again when you later reopen the file. again when you later reopen the file.
@item Current Cursor Position @item Current Cursor Position
The output of the "Display Cursor Position" command (^C) displays The output of the "Display Cursor Position" command (@kbd{^C}) displays
not only the current line and character position of the cursor, not only the current line and character position of the cursor,
but also (between the two) the current column position. but also (between the two) the current column position.
@ -1449,18 +1451,18 @@ and trimmed for uniqueness, such that the words 'apple' and 'Apple' will
be prompted for correction separately. be prompted for correction separately.
@item Writing Selected Text to Files @item Writing Selected Text to Files
When using the Write-Out key (^O), text that has been selected using the When using the Write-Out key (@kbd{^O}), text that has been selected using the
marking key (^^) can not just be written out to a new (or existing) file, marking key (@kbd{^^}) can not just be written out to a new (or existing) file,
it can also be appended or prepended to an existing file. it can also be appended or prepended to an existing file.
@item Reading Text from a Command @item Reading Text from a Command
When using the Read-File key (^R), @code{nano} can not just read a file, When using the Read-File key (@kbd{^R}), @code{nano} can not just read a file,
it can also read the output of a command to be run (^X). it can also read the output of a command to be run (@kbd{^X}).
@item Reading from Working Directory @item Reading from Working Directory
By default, Pico will read files from the user's home directory (when By default, Pico will read files from the user's home directory (when
using ^R), but it will write files to the current working directory using @kbd{^R}), but it will write files to the current working directory
(when using ^O). @code{nano} makes this symmetrical: always reading (when using @kbd{^O}). @code{nano} makes this symmetrical: always reading
from and writing to the current working directory --- the directory from and writing to the current working directory --- the directory
that @code{nano} was started in. that @code{nano} was started in.
@ -1474,7 +1476,7 @@ Many options which alter the functionality of the program can be
"toggled" on or off using Meta key sequences, meaning the program does "toggled" on or off using Meta key sequences, meaning the program does
not have to be restarted to turn a particular feature on or off. not have to be restarted to turn a particular feature on or off.
@xref{Feature Toggles} for a list of options that can be toggled. @xref{Feature Toggles} for a list of options that can be toggled.
Or see the list at the end the main internal help text (^G) instead. Or see the list at the end of the main internal help text (@kbd{^G}) instead.
@end table @end table
@ -1499,7 +1501,7 @@ The possible options to @code{./configure} are:
@table @code @table @code
@item --disable-browser @item --disable-browser
Disable the mini file browser that can be called with ^T when reading Disable the mini file browser that can be called with @kbd{^T} when reading
or writing files. or writing files.
@item --disable-color @item --disable-color
@ -1507,7 +1509,7 @@ Disable support for the syntax coloring of files. This also eliminates
the @code{-Y} command-line option, which chooses a specific syntax. the @code{-Y} command-line option, which chooses a specific syntax.
@item --disable-comment @item --disable-comment
Disable the single-keystroke comment/uncomment function (M-3). Disable the single-keystroke comment/uncomment function (@kbd{M-3}).
@item --disable-extra @item --disable-extra
Disable the Easter egg: a crawl of major contributors. Disable the Easter egg: a crawl of major contributors.
@ -1533,7 +1535,7 @@ the file type and thus which syntax to use for colouring --- often the
tests on filename extension and header line will be enough). tests on filename extension and header line will be enough).
@item --disable-linenumbers @item --disable-linenumbers
Disable the line-numbering function (M-#). This also eliminates the Disable the line-numbering function (@kbd{M-#}). This also eliminates the
@code{-l} command-line option, which turns line numbering on. @code{-l} command-line option, which turns line numbering on.
@item --disable-mouse @item --disable-mouse
@ -1566,7 +1568,7 @@ command-line option, which allows specifying an alternate spell checker.
Disable tab completion (when nano asks for a filename or a search string). Disable tab completion (when nano asks for a filename or a search string).
@item --disable-wordcomp @item --disable-wordcomp
Disable word completion (^]). Disable word completion (@kbd{^]}).
@item --disable-wrapping @item --disable-wrapping
Disable all hard-wrapping of overlong lines. This also eliminates the Disable all hard-wrapping of overlong lines. This also eliminates the