From 3f4389b968258f68b525d47df7bf6853dc43999a Mon Sep 17 00:00:00 2001 From: Benno Schulenberg Date: Sun, 3 Aug 2014 20:25:16 +0000 Subject: [PATCH] Tweaking the formatting of the man pages a bit so that po4a will create a nicer POT file. git-svn-id: svn://svn.savannah.gnu.org/nano/trunk/nano@5089 35c25a1d-7b9e-4130-9fde-d3aeb78583b8 --- ChangeLog | 4 +++ doc/man/nano.1 | 84 ++++++++++++++++++++++++------------------------- doc/man/rnano.1 | 4 +-- 3 files changed, 48 insertions(+), 44 deletions(-) diff --git a/ChangeLog b/ChangeLog index b993e438..ec859d9d 100644 --- a/ChangeLog +++ b/ChangeLog @@ -1,3 +1,7 @@ +2014-08-03 Benno Schulenberg + * doc/man/nano.1, doc/man/rnano.1: Tweak the formatting a bit so that + po4a will create a nicer POT file. + 2014-08-02 Benno Schulenberg * doc/texinfo/nano.texi: Standardize the formatting of command-line options -- each one separately. Also add some more markup. diff --git a/doc/man/nano.1 b/doc/man/nano.1 index fb4b2fdb..d4746f19 100644 --- a/doc/man/nano.1 +++ b/doc/man/nano.1 @@ -45,65 +45,65 @@ Places the cursor on line number \fIline\fP and at column number \fIcolumn\fP (at least one of which must be specified) on startup, instead of the default line 1, column 1. .TP -.BR \-A , " \-\-smarthome" +.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. .TP -.BR \-B , " \-\-backup" +.BR \-B ", " \-\-backup When saving a file, back up the previous version of it to the current filename suffixed with a tilde (\fB~\fP). .TP -.BR \-C\ \fIdirectory\fR , " \-\-backupdir=" \fIdirectory +.BR \-C\ \fIdirectory\fR ", " \-\-backupdir= \fIdirectory Set the directory where \fBnano\fP puts unique backup files, if file backups are enabled. .TP -.BR \-D , " \-\-boldtext" +.BR \-D ", " \-\-boldtext Use bold text instead of reverse video text. .TP -.BR \-E , " \-\-tabstospaces" +.BR \-E ", " \-\-tabstospaces Convert typed tabs to spaces. .TP -.BR \-F , " \-\-multibuffer" +.BR \-F ", " \-\-multibuffer Enable multiple file buffers (if support for them has been compiled in). .TP -.BR \-G , " \-\-locking" +.BR \-G ", " \-\-locking Enable vim-style file locking when editing files. .TP -.BR \-H , " \-\-historylog" +.BR \-H ", " \-\-historylog Log search and replace strings to \fI~/.nano/search_history\fP, so they can be retrieved in later sessions. .TP -.BR \-I , " \-\-ignorercfiles" +.BR \-I ", " \-\-ignorercfiles Don't look at the system's \fBnanorc\fP nor at \fB~/.nanorc\fP. .TP -.BR \-K , " \-\-rebindkeypad" +.BR \-K ", " \-\-rebindkeypad Interpret the numeric keypad keys so that they all work properly. You should only need to use this option if they don't, as mouse support won't work properly with this option enabled. .TP -.BR \-L , " \-\-nonewlines" +.BR \-L ", " \-\-nonewlines Don't add newlines to the ends of files. .TP -.BR \-N , " \-\-noconvert" +.BR \-N ", " \-\-noconvert Disable automatic conversion of files from DOS/Mac format. .TP -.BR \-O , " \-\-morespace" +.BR \-O ", " \-\-morespace Use the blank line below the titlebar as extra editing space. .TP -.BR \-P , " \-\-poslog" +.BR \-P ", " \-\-poslog Log and later read back the location of the cursor and place it there again. .TP -.BR "\-Q ""\fIcharacters\fB""" , " \-\-quotestr=""" \fIcharacters\fR """ +.BR "\-Q ""\fIcharacters\fB""" ", " "\-\-quotestr=""" \fIcharacters\fR """ Set the quoting string for justifying. The default is \fB"^([\ \\t]*[#:>\\|}])+"\fP if extended regular expression support is available, or \fB">\ "\fP otherwise. Note that \fB\\t\fP stands for a Tab. .TP -.BR \-R , " \-\-restricted" +.BR \-R ", " \-\-restricted Restricted mode: don't read or write to any file not specified on the command line; don't read any \fInanorc\fP files nor history files; don't allow suspending nor spell checking; @@ -112,80 +112,80 @@ different name if it already has one; and don't use backup files. This restricted mode is also accessible by invoking \fBnano\fP with any name beginning with 'r' (e.g. "rnano"). .TP -.BR \-S , " \-\-smooth" +.BR \-S ", " \-\-smooth Enable smooth scrolling. Text will scroll line-by-line, instead of the usual chunk-by-chunk behavior. .TP -.BR \-T\ \fInumber\fR , " \-\-tabsize=" \fInumber +.BR \-T\ \fInumber\fR ", " \-\-tabsize= \fInumber Set the size (width) of a tab to \fInumber\fP columns. The value of \fInumber\fP must be greater than 0. The default value is 8. .TP -.BR \-U , " \-\-quickblank" +.BR \-U ", " \-\-quickblank Do quick statusbar blanking. Statusbar messages will disappear after 1 keystroke instead of 25. Note that \fB\-c\fP overrides this. .TP -.BR \-V , " \-\-version" +.BR \-V ", " \-\-version Show the current version number and exit. .TP -.BR \-W , " \-\-wordbounds" +.BR \-W ", " \-\-wordbounds Detect word boundaries more accurately by treating punctuation characters as part of a word. .TP -.BR \-Y\ \fIname\fR , " \-\-syntax=" \fIname +.BR \-Y\ \fIname\fR ", " \-\-syntax= \fIname Specify the name of the syntax highlighting to use from among the ones defined in the \fInanorc\fP files. .TP -.BR \-c , " \-\-const" +.BR \-c ", " \-\-const Constantly show the cursor position. Note that this overrides \fB\-U\fP. .TP -.BR \-d , " \-\-rebinddelete" +.BR \-d ", " \-\-rebinddelete Interpret the Delete key differently so that both Backspace and Delete work properly. You should only need to use this option if Backspace acts like Delete on your system. .TP -.BR \-h , " \-\-help" +.BR \-h ", " \-\-help Show a summary of the available command-line options and exit. .TP -.BR \-i , " \-\-autoindent" +.BR \-i ", " \-\-autoindent Indent new lines to the previous line's indentation. Useful when editing source code. .TP -.BR \-k , " \-\-cut" +.BR \-k ", " \-\-cut Make the 'Cut Text' command (normally ^K) cut from the current cursor position to the end of the line, instead of cutting the entire line. .TP -.BR \-l , " \-\-nofollow" +.BR \-l ", " \-\-nofollow If the file being edited is a symbolic link, replace the link with a new file instead of following it. Good for editing files in \fI/tmp\fP, perhaps? .TP -.BR \-m , " \-\-mouse" +.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 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" +.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 can be used as an editor in combination with for instance \fBgpg\fR without having to write sensitive data to disk first. .TP -.BR \-o\ \fIdirectory\fR , " \-\-operatingdir=" \fIdirectory +.BR \-o\ \fIdirectory\fR ", " \-\-operatingdir= \fIdirectory Set the operating directory. This makes \fBnano\fP set up something similar to a chroot. .TP -.BR \-p, " \-\-preserve" +.BR \-p ", " \-\-preserve Preserve the XON and XOFF sequences (^Q and ^S) so they will be caught by the terminal. .TP -.BR \-q , " \-\-quiet" +.BR \-q ", " \-\-quiet Do not report errors in the \fInanorc\fP files nor ask them to be acknowledged by pressing Enter at startup. .TP -.BR \-r\ \fInumber\fR , " \-\-fill=" \fInumber +.BR \-r\ \fInumber\fR ", " \-\-fill= \fInumber Hard-wrap lines at column \fInumber\fP. If this value is 0 or less, wrapping will occur at the width of the screen less \fInumber\fP columns, allowing the wrap point to vary along with the width of the screen if the screen @@ -193,28 +193,28 @@ is resized. The default value is \-8. This option conflicts with .B \-w -- the last one given takes effect. .TP -.BR \-s\ \fIprogram\fR , " \-\-speller=" \fIprogram +.BR \-s\ \fIprogram\fR ", " \-\-speller= \fIprogram Use this alternative spell checker command. .TP -.BR \-t , " \-\-tempfile" +.BR \-t ", " \-\-tempfile Always save a changed buffer without prompting. Same as Pico's \fB\-t\fP option. .TP -.BR \-v , " \-\-view" +.BR \-v ", " \-\-view View-file (read-only) mode. .TP -.BR \-w , " \-\-nowrap" +.BR \-w ", " \-\-nowrap Disable the hard-wrapping of long lines. This option conflicts with .B \-r -- the last one given takes effect. .TP -.BR \-x , " \-\-nohelp" +.BR \-x ", " \-\-nohelp Don't show the two help lines at the bottom of the screen. .TP -.BR \-z , " \-\-suspend" +.BR \-z ", " \-\-suspend Enable the suspend ability. .TP -.BR \-$ , " \-\-softwrap" +.BR \-$ ", " \-\-softwrap Enable 'soft wrapping'. This will make \fBnano\fP attempt to display the entire contents of any line, even if it is longer than the screen width, by continuing it over multiple screen lines. Since @@ -222,7 +222,7 @@ continuing it over multiple screen lines. Since this option last when using other options (e.g.\& 'nano \-wS$') or pass it separately (e.g.\& 'nano \-wS \-$'). .TP -.BR \-a , " \-b" , " \-e" , " \-f" , " \-g" , " \-j" +.BR \-a ", " \-b ", " \-e ", " \-f ", " \-g ", " \-j Ignored, for compatibility with Pico. .SH INITIALIZATION FILE diff --git a/doc/man/rnano.1 b/doc/man/rnano.1 index 1a972e31..49764201 100644 --- a/doc/man/rnano.1 +++ b/doc/man/rnano.1 @@ -56,10 +56,10 @@ use backup files or spell checking. .SH OPTIONS .TP -.BR \-h , " \-\-help" +.BR \-h ", " \-\-help Show a summary of command-line options and exit. .TP -.BR \-V , " \-\-version" +.BR \-V ", " \-\-version Show the current version number and exit. .PP See the \fBnano\fP(1) manpage for all of the possible options. -- 2.39.5