From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: X-Spam-Checker-Version: SpamAssassin 3.4.1 (2015-04-28) on sa.local.altlinux.org X-Spam-Level: X-Spam-Status: No, score=-3.3 required=5.0 tests=BAYES_00,RP_MATCHES_RCVD autolearn=ham autolearn_force=no version=3.4.1 DKIM-Filter: OpenDKIM Filter v2.11.0 inpost.hi.is 02INDFaE009063 Date: Wed, 18 Mar 2020 23:13:15 +0000 From: Bjarni Ingi Gislason To: kbd@lists.altlinux.org Message-ID: <20200318231315.GA3678@rhi.hi.is> MIME-Version: 1.0 Content-Type: text/plain; charset=us-ascii Content-Disposition: inline Sender: bjarniig@hi.is User-Agent: Mutt/1.5.20 (2009-12-10) X-Mailman-Approved-At: Thu, 19 Mar 2020 12:54:32 +0300 Subject: [kbd] [PATCH] docs/man/man1: Fix warnings from "groff" and some other formatting X-BeenThere: kbd@lists.altlinux.org X-Mailman-Version: 2.1.12 Precedence: list Reply-To: Linux console tools development discussion List-Id: Linux console tools development discussion List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , X-List-Received-Date: Wed, 18 Mar 2020 23:13:25 -0000 Archived-At: List-Archive: 1) Remove space at end of lines 2) Fix some wrong fonts 3) Fix warnings from test-groff. Output is from: test-groff -b -e -mandoc -T utf8 -rF0 -t -w w -z [ "test-groff" is a developmental version of "groff" ] Input file is ./dumpkeys.1.in :218 (macro BI): only 1 argument, but more are expected #### Input file is ./fgconsole.1 :8 (macro BI): only 1 argument, but more are expected :42 (macro IR): only 1 argument, but more are expected #### Input file is ./loadkeys.1.in :220 (macro BI): only 1 argument, but more are expected :224 (macro BI): only 1 argument, but more are expected #### Input file is ./openvt.1 :12 (macro BR): only 1 argument, but more are expected :67 (macro BR): only 0 argument, but more are expected :83 (macro BR): only 0 argument, but more are expected #### Input file is ./psfxtable.1 :34 (macro IR): only 1 argument, but more are expected #### Input file is ./setleds.1 troff: :63: warning: escape character ignored before '+' troff: :69: warning: escape character ignored before '+' troff: :75: warning: escape character ignored before '+' #### Input file is ./unicode_start.1 :38 (macro BR): only 1 argument, but more are expected #### Input file is ./unicode_stop.1 :19 (macro BR): only 1 argument, but more are expected Signed-off-by: Bjarni Ingi Gislason #### --- docs/man/man1/dumpkeys.1.in | 4 ++-- docs/man/man1/fgconsole.1 | 18 +++++++++--------- docs/man/man1/loadkeys.1.in | 10 +++++----- docs/man/man1/openvt.1 | 15 ++++++--------- docs/man/man1/psfxtable.1 | 4 ++-- docs/man/man1/setleds.1 | 8 ++++---- docs/man/man1/unicode_start.1 | 4 ++-- docs/man/man1/unicode_stop.1 | 4 ++-- 8 files changed, 32 insertions(+), 35 deletions(-) diff --git a/docs/man/man1/dumpkeys.1.in b/docs/man/man1/dumpkeys.1.in index d3e894f..7dcce71 100644 --- a/docs/man/man1/dumpkeys.1.in +++ b/docs/man/man1/dumpkeys.1.in @@ -16,7 +16,7 @@ dumpkeys \- dump keyboard translation tables .B \-v \-\-verbose \-V \-\-version ] .SH DESCRIPTION -.IX "dumpkeys command" "" "\fLdumpkeys\fR command" +.IX "dumpkeys command" "" "\fLdumpkeys\fR command" .LP .B dumpkeys writes, to the standard output, the current contents of the keyboard @@ -215,7 +215,7 @@ Prints version number and exits. .SH FILES .PD 0 .TP 20 -.BI @DATADIR@/keymaps +.I @DATADIR@/keymaps recommended directory for keytable files .PD .SH "SEE ALSO" diff --git a/docs/man/man1/fgconsole.1 b/docs/man/man1/fgconsole.1 index 3f63890..47ab841 100644 --- a/docs/man/man1/fgconsole.1 +++ b/docs/man/man1/fgconsole.1 @@ -5,12 +5,12 @@ fgconsole \- print the number of the active VT. .SH SYNOPSIS .B fgconsole -.BI [ -\-h \-\-help +[ +.B \-h \-\-help | -\-V \-\-version +.B \-V \-\-version | -\-n \-\-next-available +.B \-n \-\-next-available ] .SH DESCRIPTION If the active Virtual Terminal is @@ -19,8 +19,8 @@ then prints .I N on standard output. -If the console is a serial console, then -"serial" +If the console is a serial console, then +"serial" is printed instead. .TP .I \-h \-\-help @@ -35,11 +35,11 @@ terminals are allocated, with number 7 used for X; this will return "8" in this case. .SH NOTES -Under +Under .IR devfs , -the consoles are in +the consoles are in .IR /dev/vc/N . -.IR devfsd +.I devfsd may maintain symlinks for compatibility. .SH "SEE ALSO" .BR chvt (1). diff --git a/docs/man/man1/loadkeys.1.in b/docs/man/man1/loadkeys.1.in index 9c89f5b..b5bb7e5 100644 --- a/docs/man/man1/loadkeys.1.in +++ b/docs/man/man1/loadkeys.1.in @@ -37,7 +37,7 @@ loadkeys \- load keyboard translation tables ] .LP .SH DESCRIPTION -.IX "loadkeys command" "" "\fLloadkeys\fR command" +.IX "loadkeys command" "" "\fLloadkeys\fR command" .LP The program .B loadkeys @@ -45,7 +45,7 @@ reads the file or files specified by .IR filename... . Its main purpose is to load the kernel keymap for the console. You can specify console device by the -.I -C +.I -C (or .I --console ) option. @@ -131,7 +131,7 @@ in the keymap. The default bindings for the function keys are certain escape sequences mostly inspired by the VT100 terminal. .SH "CREATE KERNEL SOURCE TABLE" -If the +If the .I -m (or .I --mktable @@ -217,11 +217,11 @@ outlive your session. This means that even at the login prompt the key bindings may not be what the user expects. .SH FILES .TP -.BI @DATADIR@/keymaps +.I @DATADIR@/keymaps default directory for keymaps .LP .TP -.BI /usr/src/linux/drivers/char/defkeymap.map +.I /usr/src/linux/drivers/char/defkeymap.map default kernel keymap .SH "SEE ALSO" .BR dumpkeys (1), diff --git a/docs/man/man1/openvt.1 b/docs/man/man1/openvt.1 index 4712547..97f8bf4 100644 --- a/docs/man/man1/openvt.1 +++ b/docs/man/man1/openvt.1 @@ -4,14 +4,14 @@ .SH NAME openvt \- start a program on a new virtual terminal (VT). .SH SYNOPSIS -.B openvt +.B openvt [\-c vtnumber] [OPTIONS] [\-\-] command .SH DESCRIPTION .B openvt -will find the first available VT, and run on it the given -.BR command -with the given -.BR "command options", +will find the first available VT, and run on it the given +.B command +with the given +.B "command options", standard input, output and error are directed to that terminal. The current search path ($PATH) is used to find the requested command. If no command is specified then the environment variable $SHELL is used. @@ -55,7 +55,7 @@ print program version and exit; .I "\-h, \-\-help" show this text and exit. .TP -.I "\-\-" +.I "\-\-" end of options to .BR openvt . .SH NOTE @@ -64,7 +64,6 @@ If is compiled with a getopt_long() and you wish to set options to the command to be run, then you must supply the end of options \-\- flag before the command. -.BR .SH EXAMPLES .B openvt can be used to start a shell on the next free VT, by using the command: @@ -80,8 +79,6 @@ To start the shell as a login shell, use: To get a long listing you must supply the \-\- separator: .TP .I "openvt -- ls -l" -.BR - .SH HISTORY Earlier, .B openvt diff --git a/docs/man/man1/psfxtable.1 b/docs/man/man1/psfxtable.1 index adc3bc9..b65a88e 100644 --- a/docs/man/man1/psfxtable.1 +++ b/docs/man/man1/psfxtable.1 @@ -14,7 +14,7 @@ psfxtable \- handle Unicode character tables for console fonts .IR outtable ] .RB [ \-nt ] .SH DESCRIPTION -.IX "psfxtable command" "" "\fLpsfxtable\fR command" +.IX "psfxtable command" "" "\fLpsfxtable\fR command" .LP .B psfxtable handles the embedded Unicode character table for .psf format @@ -31,7 +31,7 @@ Each of the filenames .IR outfont , .IR intable , and -.IR outtable +.I outtable may be replaced by a single dash (\-), in which case standard input or standard output is used. If no \-i option is given, the font is read from standard input. diff --git a/docs/man/man1/setleds.1 b/docs/man/man1/setleds.1 index f484fa0..890fb65 100644 --- a/docs/man/man1/setleds.1 +++ b/docs/man/man1/setleds.1 @@ -7,7 +7,7 @@ setleds \- set the keyboard leds .RI [ "-v" "] [" "-L" "] [" "-D" "] [" "-F" ] .RI [ {+|-}num "] [" {+|-}caps "] [" {+|-}scroll ] .SH DESCRIPTION -.IX "setleds command" "" "\fLsetleds\fR command" +.IX "setleds command" "" "\fLsetleds\fR command" .LP .B Setleds reports and changes the led flag settings of a VT @@ -60,19 +60,19 @@ done .in -5m .SH OPTIONS .TP -\-num \+num +\-num +num Clear or set NumLock. (At present, the NumLock setting influences the interpretation of keypad keys. Pressing the NumLock key complements the NumLock setting.) .TP -\-caps \+caps +\-caps +caps Clear or set CapsLock. (At present, the CapsLock setting complements the Shift key when applied to letters. Pressing the CapsLock key complements the CapsLock setting.) .TP -\-scroll \+scroll +\-scroll +scroll Clear or set ScrollLock. (At present, pressing the ScrollLock key (or ^S/^Q) stops/starts console output.) diff --git a/docs/man/man1/unicode_start.1 b/docs/man/man1/unicode_start.1 index b76ccb3..45af288 100644 --- a/docs/man/man1/unicode_start.1 +++ b/docs/man/man1/unicode_start.1 @@ -6,7 +6,7 @@ unicode_start \- put keyboard and console in unicode mode .B unicode_start .RI [ font " [" umap ]] .SH DESCRIPTION -.IX "unicode_start command" "" "\fLunicode_start\fR command" +.IX "unicode_start command" "" "\fLunicode_start\fR command" .LP The .B unicode_start @@ -35,5 +35,5 @@ However, usually the font and keymap is common to all consoles. .BR kbd_mode (1), .BR loadkeys (1), .BR unicode_stop (1), -.BR utf-8(7), +.BR utf-8 (7), .BR setfont (8) diff --git a/docs/man/man1/unicode_stop.1 b/docs/man/man1/unicode_stop.1 index 2fa2015..2929e1d 100644 --- a/docs/man/man1/unicode_stop.1 +++ b/docs/man/man1/unicode_stop.1 @@ -5,7 +5,7 @@ unicode_stop \- revert keyboard and console from unicode mode .SH SYNOPSIS .B unicode_stop .SH DESCRIPTION -.IX "unicode_stop command" "" "\fLunicode_stop\fR command" +.IX "unicode_stop command" "" "\fLunicode_stop\fR command" .LP The .B unicode_stop @@ -16,5 +16,5 @@ the console UTF-8 mode. .SH "SEE ALSO" .BR kbd_mode (1), .BR unicode_start (1), -.BR utf-8(7), +.BR utf-8 (7), .BR setfont (8) -- 2.25.1