diff options
author | wl <wl> | 2012-08-10 05:15:03 +0000 |
---|---|---|
committer | wl <wl> | 2012-08-10 05:15:03 +0000 |
commit | db1c0a9667d0e8a43be5dabffec43f6279942ebd (patch) | |
tree | e8c7d586ea63a7b5d9e9b0a5f4d84a0ba3b1823f /contrib/groffer/shell | |
parent | 2812117791cf0710b27a4a3524f337de010d33a3 (diff) | |
download | groff-db1c0a9667d0e8a43be5dabffec43f6279942ebd.tar.gz |
Synchronize man pages.
* perl/groffer.man, shell/groffer.man: Fix many minor issues.
Diffstat (limited to 'contrib/groffer/shell')
-rw-r--r-- | contrib/groffer/shell/groffer.man | 274 |
1 files changed, 136 insertions, 138 deletions
diff --git a/contrib/groffer/shell/groffer.man b/contrib/groffer/shell/groffer.man index 729a7512..4c6f5c0b 100644 --- a/contrib/groffer/shell/groffer.man +++ b/contrib/groffer/shell/groffer.man @@ -9,19 +9,11 @@ groffer \- display groff files and man\~pages on X and tty .\" Legalese .\" -------------------------------------------------------------------- . -.ig -groffer.1 - man page for groffer (section 1). - -Source file position: <groff_source_top>/contrib/groffer/shell/groffer.man -Installed position: $prefix/share/man/man1/groffer.1 - -Last update: 7 Feb 2011 -.. .de author This file was written by Bernd Warken. .. .de copyleft -Copyright (C) 2001, 2002, 2004-2011 +Copyright (C) 2001, 2002, 2004-2012 Free Software Foundation, Inc. . .P @@ -63,7 +55,7 @@ You can also visit .\" Setup .\" -------------------------------------------------------------------- . -.ds Ellipsis "\&.\|.\|.\"" +.ds Ellipsis "\&.\|.\|.\&\" . .\" -------------------------------------------------------------------- .\" Macro definitions @@ -158,8 +150,7 @@ You can also visit . ds @indent 2m\" . el \ . ds @indent \\$1\" -. TP \\*[@indent] -. Text \[bu] +. IP \[bu] \\*[@indent] . rm @indent .. @@ -308,8 +299,8 @@ Long options can be abbreviated in several ways. .RS .P .SY -.OP "-h~~\fR|\fB\~\~--help" -.OP "-v~~\fR|\fB\~\~--version" +.OP -h\~\fR|\fB\~--help +.OP -v\~\fR|\fB\~--version .YS .RE . @@ -339,8 +330,8 @@ Long options can be abbreviated in several ways. .OP --tty\-viewer prog .OP --www .OP --www\-viewer prog -.OP --x --X -.OP --x\-viewer --X\-viewer prog +.OP --x\~\fR|\fB\~--X +.OP --x\-viewer\~\fR|\fB\~--X\-viewer prog .YS .RE . @@ -349,8 +340,10 @@ Long options can be abbreviated in several ways. .I options related to \%groff .RS .P -.OP -T~\fR|\fB\~--device device -.OP -Z~\fR|\fB\~--intermediate\-output~\fR|\fB\~--ditroff +.SY +.OP -T\~\fR|\fB\~--device device +.OP -Z\~\fR|\fB\~--intermediate\-output\~\fR|\fB\~--ditroff +.YS .P All further .B \%groff @@ -360,16 +353,19 @@ short options are accepted. . .TP .I options for man\~pages +.RS +.P .SY .OP --apropos .OP --apropos\-data .OP --apropos\-devel .OP --apropos\-progs .OP --man -.OP --no-man -.OP --no-special +.OP --no\-man +.OP --no\-special .OP --whatis .YS +.RE . . .TP @@ -382,14 +378,14 @@ short options are accepted. .OP --ditroff .OP --extension suffix .OP --locale language -.OP --local-file -.OP "--location~\fR|\fB\~--where" +.OP --local\-file +.OP --location\~\fR|\fB\~--where .OP --manpath dir1:dir2:\*[Ellipsis] -.OP --no-location +.OP --no\-location .OP --pager program .OP --sections sec1:sec2:\*[Ellipsis] .OP --systems sys1,sys2,\*[Ellipsis] -.OP --troff-device device +.OP --troff\-device device .YS .P Further long options of \f[CR]GNU\f[] @@ -403,17 +399,17 @@ are accepted as well. .RS .P .SY -.OP --bd~\fR|\fB\~--bordercolor pixels -.OP --bg~\fR|\fB\~--background color -.OP --bw~\fR|\fB\~--borderwidth pixels +.OP --bd\~\fR|\fB\~--bordercolor pixels +.OP --bg\~\fR|\fB\~--background color +.OP --bw\~\fR|\fB\~--borderwidth pixels .OP --display X-display -.OP --fg~\fR|\fB\~--foreground color -.OP --fn~\fR|\fB\~--ft~\fR|\fB\~--font font_name +.OP --fg\~\fR|\fB\~--foreground color +.OP --fn\~\fR|\fB\~--ft\~\fR|\fB\~--font font_name .OP --geometry size_pos .OP --resolution value .OP --rv .OP --title string -.OP --xrm X-resource +.OP --xrm X\-resource .YS .RE . @@ -579,6 +575,14 @@ If the abbreviation of the argument leads to several resulting options an error is raised. . . +.P +These abbreviations are only allowed in the environment variable +.Env_var \%$GROFFER_OPT , +but not in the configuration files. +. +In configuration, all long options must be exact. +. +. .\" -------------------------------------------------------------------- .SS "groffer breaking Options" .\" -------------------------------------------------------------------- @@ -592,13 +596,13 @@ All other arguments are ignored. . . .TP -.OP -h\fR|\fR--help +.B -h\~\fR|\fB\~--help Print help information with a short explanation of options to standard output. . . .TP -.OP -v~\fR|\fB\~--version +.B -v\~\fR|\fB\~--version Print version information to standard output. . . @@ -684,7 +688,7 @@ and restart option processing using only the rest of the command line. . . .TP -.B --default\-modes mode1,mode2,\*[Ellipsis] +.BI --default\-modes \ mode1,mode2,\*[Ellipsis] Set the sequence of modes for .I \%auto\~mode to the comma separated list given in the argument. @@ -708,7 +712,7 @@ Equivalent to . . .TP -.B --dvi\-viewer prog +.BI --dvi\-viewer \ prog Choose a viewer program for .IR \%dvi\~mode . . @@ -720,7 +724,7 @@ Known \%\f[CR]X\~Window\f[] viewers include .BR \%xdvi (1) and -.BR \%dvilx (1) +.BR \%dvilx (1). . In each case, arguments can be provided additionally. . @@ -749,7 +753,7 @@ In each case, arguments can be provided additionally. . . .TP -.BI --mode value +.BI --mode \ value . Set the display mode. . @@ -779,7 +783,6 @@ viewer program. By default, the formatted input is displayed with the .BR \%xdvi (1) program. -.BR --dvi . . . .TP @@ -884,20 +887,20 @@ But the standard \%\f[CR]X\~Window\f[] tool can also be chosen with the option .BR --x\-viewer . The default resolution is -.BR 75\~dpi , +.BR 75dpi , but -.B 100\~dpi +.B 100dpi are also possible. . The default .I groff device for the resolution of -.B 75\~dpi +.B 75dpi is .BR X75\-12 , for -.B 100\~dpi +.B 100dpi it is .BR X100 . . @@ -906,9 +909,9 @@ The corresponding for the actual device is generated and the result is displayed. . For a resolution of -.BR 100\~dpi , +.BR 100dpi , the default width of the geometry of the display program is chosen to -.BR 850\~dpi . +.BR 850dpi . . . .TP @@ -956,7 +959,7 @@ Equivalent to . . .TP -.B --pdf\-viewer prog +.BI --pdf\-viewer \ prog Choose a viewer program for .IR \%pdf\~mode . . @@ -972,7 +975,7 @@ Equivalent to . . .TP -.B --ps\-viewer prog +.BI --ps\-viewer \ prog Choose a viewer program for .IR \%ps\~mode . . @@ -990,7 +993,7 @@ In each case, arguments can be provided additionally. . .TP .B --source -Equivalent +Equivalent to .BR --mode=source . . . @@ -1015,7 +1018,7 @@ Equivalent to . . .TP -.B --tty\-viewer prog +.BI --tty\-viewer \ prog Choose a text pager for mode .IR tty . The standard pager is @@ -1023,7 +1026,7 @@ The standard pager is This option is equivalent to .I man option -.BR --pager=prog . +.BR --pager=\fIprog\fP . The option argument can be a file name or a program to be searched in .Env_var $PATH ; arguments can be provided additionally. @@ -1036,19 +1039,19 @@ Equivalent to . . .TP -.B --www\-viewer prog +.BI --www\-viewer \ prog Equivalent to -.B --html\-viewer . +.BR --html\-viewer . . . .TP -.B --X~\fR|\fB\~--x +.B --X\~\fR|\fB\~--x Equivalent to .BR --mode=x . . . .TP -.B --X\-viewer -- x\-viewer prog +.BI --X\-viewer\~\fR|\fB\~--x\-viewer \ prog Choose a viewer program for .IR \%x\~mode . Suitable viewer programs are @@ -1111,7 +1114,7 @@ option .B -Z .B \%groffer was designed to be switched into -.I \%groff\~mode ; +.IR \%groff\~mode ; the .I \%groffer viewing features are disabled there. @@ -1133,7 +1136,7 @@ sequences in . . .TP -.BI --m file +.BI --m \ file Add .I \%file as a @@ -1144,7 +1147,7 @@ This is useful in case it cannot be recognized automatically. . . .TP -.BI --P opt_or_arg +.BI --P \ opt_or_arg Send the argument .I \%opt_or_arg as an option or option argument to the actual @@ -1153,7 +1156,7 @@ postprocessor. . . .TP -.B --T \fIdevname\fR ~\fR|\fB\~ --device \fIdevname\fR +.B --T \fIdevname\fR\~\fR|\fB\~--device \fIdevname\fR . This option determines .BR \%groff 's @@ -1214,7 +1217,7 @@ device for a better display. . . .TP -.B -Z~\fR|\fB\~--intermediate-output~\fR|\fB\~--ditroff +.B -Z\~\fR|\fB\~--intermediate-output\~\fR|\fB\~--ditroff Switch into .I \%groff\~mode and format the input with the @@ -1409,7 +1412,7 @@ is first tested whether it is an existing file. . . .TP -.B --no-man~\fR|\fB\~--local-file +.B --no-man\~\fR|\fB\~--local-file Do not check for .IR \%man\~pages . . @@ -1422,10 +1425,10 @@ option. .TP .B --no-special Disable former calls of -.B --all , -.B --apropos* , +.BR --all , +.BR --apropos* , and -.B --whatis . +.BR --whatis . . . .\" -------------------------------------------------------------------- @@ -1446,10 +1449,10 @@ so most of them are just ignored. These ignored .B man options are -.B --catman , -.B --troff , +.BR --catman , +.BR --troff , and -.B --update . +.BR --update . . . .P @@ -1479,13 +1482,13 @@ retrieve all suitable documents instead of only one. . . .TP -.B -7\fR\fB--ascii +.B -7\~\fR|\fB\~--ascii In .IR \%text\~modes , display ASCII translation of special characters for critical environment. . This is equivalent to -.BR "groff -mtty_char" ; +.BR "groff \%-mtty_char" ; see .BR groff_tmac (@MAN5EXT@). . @@ -1496,11 +1499,11 @@ Produce .IR "groff intermediate output" . This is equivalent to .B \%groffer -.B -Z . +.BR -Z . . . .TP -.BI --extension suffix +.BI --extension \ suffix Restrict .I \%man\~page search to file names that have @@ -1516,13 +1519,13 @@ extension is . . .TP -.BI --locale language +.BI --locale \ language . Set the language for .IR \%man\~pages . . This has the same effect, but overwrites -.Env_var $LANG +.Env_var $LANG . . . .TP @@ -1534,14 +1537,14 @@ Print the location of the retrieved files to standard error. .B --no-location Do not display the location of retrieved files; this resets a former call to -.B --location . +.BR --location . . This was added by .BR \%groffer . . . .TP -.BI --manpath "'dir1:dir2:\*[Ellipsis]'" +.BI --manpath \ 'dir1:dir2:\*[Ellipsis]' Use the specified search path for retrieving .I \%man\~pages instead of the program defaults. @@ -1558,11 +1561,11 @@ Set the pager program in default is .BR \%less . This is equivalent to -.B --tty\-viewer . +.BR --tty\-viewer . . . .TP -.BI --sections "'sec1:sec2:\*[Ellipsis]'" +.BI --sections \ sec1:sec2:\*[Ellipsis] Restrict searching for .I \%man\~pages to the given @@ -1571,7 +1574,7 @@ a colon-separated list. . . .TP -.BI --systems "'sys1,sys2,\*[Ellipsis]'" +.BI --systems \ sys1,sys2,\*[Ellipsis] Search for .I \%man\~pages for the given operating systems; the argument @@ -1582,7 +1585,7 @@ is a comma-separated list. .TP .B --where Equivalent to -.B --location . +.BR --location . . . .\" -------------------------------------------------------------------- @@ -1611,7 +1614,7 @@ options, for example, uses the option .B --font for the \%\f[CR]X\~Window\f[] option -.B -font . +.BR -font . . . .P @@ -1622,78 +1625,78 @@ for more details on these options and their arguments. . . .TP -.BI --background color +.BI --background \ color Set the background color of the viewer window. . . .TP -.BI --bd pixels +.BI --bd \ pixels This is equivalent to -.B --bordercolor . +.BR --bordercolor . . . .TP -.BI --bg color +.BI --bg \ color This is equivalent to -.B --background . +.BR --background . . . .TP -.B --bw pixels +.BI --bw \ pixels This is equivalent to -.B --borderwidth . +.BR --borderwidth . . . .TP -.BI --bordercolor pixels +.BI --bordercolor \ pixels Specifies the color of the border surrounding the viewer window. . . .TP -.BI --borderwidth pixels +.BI --borderwidth \ pixels Specifies the width in pixels of the border surrounding the viewer window. . . .TP -.BI --display X-display +.BI --display \ X-display Set the \%\f[CR]X\~Window\f[] display on which the viewer program shall be started, see the \%\f[CR]X\~Window\f[] documentation for the syntax of the argument. . . .TP -.BI --foreground color +.BI --foreground \ color Set the foreground color of the viewer window. . . .TP -.BI --fg color +.BI --fg \ color This is equivalent to -.B -foreground . +.BR -foreground . . . .TP -.B --fn font_name +.BI --fn \ font_name This is equivalent to -.B --font . +.BR --font . . . .TP -.BI --font font_name +.BI --font \ font_name Set the font used by the viewer window. . The argument is an \%\f[CR]X\~Window\f[] font name. . . .TP -.BI --ft font_name +.BI --ft \ font_name This is equivalent to -.B --font . +.BR --font . . . .TP -.BI --geometry size_pos +.BI --geometry \ size_pos Set the geometry of the display window, that means its size and its starting position. . @@ -1703,7 +1706,7 @@ for the syntax of the argument. . . .TP -.BI --resolution value +.BI --resolution \ value Set \%\f[CR]X\~Window\f[] resolution in dpi (dots per inch) in some viewer programs. . @@ -1715,7 +1718,7 @@ and Actually, the default resolution for .B \%groffer is set to -.BR 75\~dpi . +.BR 75dpi . The resolution also sets the default device in .IR "mode x" . . @@ -1726,12 +1729,12 @@ Reverse foreground and background color of the viewer window. . . .TP -.BI --title "'some text'" +.BI --title "\ 'some text'" Set the title for the viewer window. . . .TP -.BI --xrm "'resource'" +.BI --xrm \ 'resource' Set \f[CR]\%X\~Window\f[] resource. . . @@ -1740,7 +1743,7 @@ Set \f[CR]\%X\~Window\f[] resource. .\" -------------------------------------------------------------------- . .TP -.B -- debug +.B --debug Enable eight debugging informations. . The temporary files are kept and not deleted, the name of the @@ -1793,7 +1796,7 @@ by large amounts. .TP .B --debug\-grog Print the output of all -.B \&grog +.B grog commands. . . @@ -1869,7 +1872,7 @@ Some shells run considerably faster than the standard shell. . . .TP -.B --V +.B -V This is an advanced option for debugging only. . Instead of displaying the formatted input, a lot of @@ -2051,7 +2054,7 @@ If you want to look up a called .B - use the argument -.BR "man:\-" . +.BR man:\- . . . .Topic @@ -2226,7 +2229,7 @@ Known viewers for the graphical display modes and their standard .Topic in a PDF viewer .nh -.RI ( \%pdf\~mode ), +.RI ( \%pdf\~mode ) .hy . .Topic @@ -2234,14 +2237,14 @@ in a web browser .nh .RI ( html or -.IR \%www\~mode ). +.IR \%www\~mode ) .hy .RE . .Topic in a Postscript viewer .nh -.RI ( \%ps\~mode ), +.RI ( \%ps\~mode ) .hy . .Topic @@ -2252,12 +2255,12 @@ viewers such as or .BR \%xditview (1) (in -.IR \%x\~mode ), +.IR \%x\~mode ) . .Topic in a dvi viewer program .nh -.RI ( \%dvi\~mode ), +.RI ( \%dvi\~mode ) .hy . . @@ -2313,7 +2316,7 @@ is chosen for This can be changed by specifying option .B -T or -.BR --device . +.BR \%--device . . . .P @@ -2402,7 +2405,7 @@ short options are supported by . . .\" -------------------------------------------------------------------- -.SH "MAN\~PAGE\~SEARCHING" +.SH "MAN PAGE SEARCHING" .\" -------------------------------------------------------------------- . The default behavior of @@ -2440,7 +2443,7 @@ error, but processing is continued. . . .\" -------------------------------------------------------------------- -.SS "Search Algoritm" +.SS "Search Algorithm" .\" -------------------------------------------------------------------- . Let us now assume that a @@ -3120,7 +3123,7 @@ For example, depending on your system, can be started on the second monitor by the command .sp .EX -\fIsh#\fR DISPLAY=:0.1\~groffer\~ what.ever & +\fIsh#\fR DISPLAY=:0.1\~groffer\~what.ever & .EE . . @@ -3173,7 +3176,7 @@ variable to the program .sp .EX -\fIsh#\fR PAGER=cat\~groffer\~ anything +\fIsh#\fR PAGER=cat\~groffer\~anything .EE .sp . @@ -3276,7 +3279,7 @@ If set, this variable contains the directories in which the trees are stored. . This is overridden by option -.BR --manpath . +.BR \%--manpath . . . .TP @@ -3427,10 +3430,11 @@ Some shells run much faster than the standard shell. . .P As an example, consider the following configuration file that can be --used either in --.File_name \%/etc/groff/groffer.conf --or --.File_name \%~/.groff/groffer.conf . +used either in +.File_name \%/etc/groff/groffer.conf +or +.File_name \%~/.groff/groffer.conf . +. . .P .ft CR @@ -3457,7 +3461,7 @@ date >>~/mygroffer.log .P The lines starting with .B # -are command lines. +are just ignored, so they act as command lines. . This configuration sets four .B \%groffer @@ -3485,7 +3489,7 @@ in all viewers that support this, such as . .Topic Use a resolution of -.B 100\~dpi +.B 100dpi in all viewers that support this, such as .BR \%gxditview . . @@ -3501,11 +3505,11 @@ Force as the .I \%x-mode viewer using the geometry option for setting the width to -.B 900\~dpi +.B 900px and the height to -.BR 1200\~dpi . +.BR 1200px . This geometry is suitable for a resolution of -.BR 100\~dpi . +.BR 100dpi . . . .Topic @@ -3543,10 +3547,11 @@ The following examples, however, show that .B \%groffer has much more fancy capabilities. . -. +.sp .EX \fIsh#\fR\~groffer\~/usr/local/share/doc/groff/meintro.ms.gz .EE +.sp Decompress, format and display the compressed file .File_name meintro.ms.gz in the directory @@ -3651,7 +3656,7 @@ The formatted files are concatenated and displayed in one piece. . .sp .EX -\fIsh#\fR\~LANG=de\~groffer\~--man\~--www\~--www-viever=galeon\~ls +\fIsh#\fR\~LANG=de\~groffer\~--man\~--www\~--www-viewer=galeon\~ls .EE .sp Retrieve the German @@ -3705,7 +3710,7 @@ This is a set of abbreviated arguments, it is determined as . .sp .EX -\fIsh#\fR\~cat\~file.gz\~|\~groffer\~-Z\~-mfoo" +\fIsh#\fR\~cat\~file.gz\~|\~groffer\~-Z\~-mfoo .EE .sp . @@ -3717,12 +3722,12 @@ transported to the without post-processing .RB ( groff option -.B -Z ), +.BR -Z ), using macro package .I \%foo .RB ( groff option -.B -m ) . +.BR -m ). . . .sp @@ -3848,7 +3853,7 @@ option or a combination thereof; for example, the short option combination .B -Qmfoo is equivalent to -.B -Q\~\-m\~foo . +.BR -Q\~\-m\~foo . . . .Topic @@ -3971,13 +3976,6 @@ command line options from the input using this program. . . .TP -.BR \%@g@chem (@MAN1EXT@) -Preprocessor of -.I groff -that is run automatically. -. -. -.TP .BR groff_out (@MAN5EXT@) Documentation on the .I \%groff intermediate output @@ -4093,7 +4091,7 @@ or .TP .BR \%less (1) Standard pager program for the -.I \%tty\~mode . +.IR \%tty\~mode . . . .P |