1 .TH GROFFER @MAN1EXT@ "@MDATE@" "Groff Version @VERSION@"
3 groffer \- display groff files and man\~pages on X and tty
6 .\" The .SH was moved to this place in order to appease `apropos'.
8 .\" --------------------------------------------------------------------
10 .\" --------------------------------------------------------------------
13 groffer.1 - man page for groffer (section 1).
15 Source file position: <groff_source_top>/contrib/groffer/groffer.man
16 Installed position: $prefix/share/man/man1/groffer.1
18 Version : groffer 0.9.1
19 Last update : 30 Sep 2002
21 This file is part of groff, the GNU roff type-setting system.
23 Copyright (C) 2001, 2002 Free Software Foundation, Inc.
24 Written by Bernd Warken <bwarken@mayn.de>
26 Permission is granted to copy, distribute and/or modify this document
27 under the terms of the GNU Free Documentation License, Version 1.1 or
28 any later version published by the Free Software Foundation; with the
29 Invariant Sections being this .ig-section and AUTHORS, with no
30 Front-Cover Texts, and with no Back-Cover Texts.
32 A copy of the Free Documentation License is included as a file called
33 FDL in the main directory of the groff source package.
36 .\" --------------------------------------------------------------------
38 .\" --------------------------------------------------------------------
56 .ds @b- "\f[CB]-\f[]\""
57 .ds @b-- "\f[CB]--\f[]\""
59 .ds @i- "\f[CI]-\f[]\""
60 .ds @i-- "\f[CI]--\f[]\""
62 .ds Ellipsis .\|.\|.\"
64 .\" --------------------------------------------------------------------
65 .\" setup for the macro definitions below
67 .\" naming: namespace:cathegory_macro.variable_name (experimental)
69 .\" --------------------------------------------------------------------
70 .\" configuration of prompt for `.Shell_cmd'* macros
71 .ds groffer:Shell_cmd.prompt_text sh#\" prompt for shell commands
72 .ds groffer:Shell_cmd+.prompt_text >\" prompt on continuation lines
73 .ds groffer:Shell_cmd_base.prompt_font I\" font for prompts
75 .\" automatically determine setup from the configuration above
76 .als @f groffer:Shell_cmd_base.prompt_font\"
77 .als @t groffer:Shell_cmd.prompt_text\"
78 .als @t+ groffer:Shell_cmd+.prompt_text\"
79 .ds groffer:Shell_cmd.prompt \f[\*[@f]]\*[@t]\f[]\" needed
80 .ds groffer:Shell_cmd+.prompt \f[\*[@f]]\*[@t+]\f[]\" needed
81 .nr @w \w'\*[groffer:Shell_cmd.prompt]'\"
82 .nr @w+ \w'\*[groffer:Shell_cmd+.prompt]'\"
84 .\" Full prompt width is maximum of texts plus 1m
85 .nr groffer:Shell_cmd_base.prompt_width (\n[@w]>?\n[@w+]+1m)\" needed
94 .\" --------------------------------------------------------------------
95 .\" static register for inter-macro communication in `.Synopsis'*
96 .nr groffer:Synopsis.level 0
98 .\" --------------------------------------------------------------------
99 .\" static registers for inter-macro communication in `.TP'*
100 .nr groffer:TP.level 0
101 .rr groffer:TP_header.flag
102 .rr groffer:TP_body.flag
103 .rr groffer:TP.indent
106 .\" --------------------------------------------------------------------
107 .\" Macro definitions
109 .\" Ignore all arguments like a comment, even after a .eo call.
112 .c --------------------------------------------------------------------
115 .c Print in constant-width bold font.
122 .c --------------------------------------------------------------------
125 .c Print in constant-width italic font.
132 .c --------------------------------------------------------------------
135 .c Print in constant-width roman font.
142 .c --------------------------------------------------------------------
143 .c .Error (<text>...)
145 .c Print error message to terminal and abort.
151 .c --------------------------------------------------------------------
152 .c .Env_var (<env_var_name> [<punct>])
154 .c Display an environment variable, with optional punctuation.
159 . Text \f[CB]\\$1\f[]\\$2
162 .c --------------------------------------------------------------------
163 .c .Opt_- ([<punct>])
165 .c Print `-' (minus sign); optional punctuation.
168 . ie (\\n[.$] == 0) \
171 . Opt_alt - "" "\\$1"
173 .c --------------------------------------------------------------------
174 .c .Opt_[-] ([<punct>])
176 .c Print `Opt_[-]' (minus sign in brackets); optional punctuation.
179 . ie (\\n[.$] == 0) \
182 . Opt_[alt] - "" "\\$1"
184 .c --------------------------------------------------------------------
185 .c .Opt_-- ([<punct>])
187 .c Print `--' (double minus); optional punctuation.
190 . ie (\\n[.$] == 0) \
193 . Opt_alt -- "" "\\$1"
195 .c --------------------------------------------------------------------
196 .c .Opt_[--] ([<punct>])
198 .c Print `Opt_[--]' (double minus in brackets); optional punctuation.
201 . ie (\\n[.$] == 0) \
204 . Opt_[alt] -- "" "\\$1"
206 .c --------------------------------------------------------------------
207 .c .Opt_alt ([<minus> <opt>]... [<arg> [<punct>]])
209 .c Alternate options separated by a vertical bar.
212 .c minus: either `-' or `--' (font CB).
213 .c opt: a name for an option, empty allowed (font CB).
214 .c arg: optionally, the argument to the option (font I).
215 .c punct: optional punctuation (in the starting font).
217 .c The minus/opt argument pairs, each
218 .c separated by a vertical bar `|', optionally add 'arg', separated
219 .c a space character ` '.
222 .c .Opt_alt - T -- device -- device-troff device .
224 .c -T|--device|--device-troff device.
227 . Opt_alt_base "" | "" \\$@
229 .c --------------------------------------------------------------------
230 .c .Opt_[alt] ([<minus> <opt>]... [<arg> [<punct>]])
232 .c Alternate options in brackets for section SYNOPSIS.
235 .c minus: either `-' or `--' (font CB).
236 .c opt: a name for an option, empty allowed (font CB).
237 .c arg: optionally, the argument to the option (font I).
238 .c punct: optional punctuation (in the starting font).
239 .c Global strings written to:
240 .c `@oa_prefix': left enclosing character (`[')
241 .c `@oa_sep': separator (`|')
242 .c `@oa_postfix': right enclosing character (`]')
244 .c The minus/opt argument pairs, each separated by a vertical
245 .c bar `|', optionally add 'arg', separated by a space character ` '.
248 .c .Opt_[alt] - T -- device -- device-troff device .
250 .c [-T|--device|--device-troff device].
253 . Opt_alt_base [ | ] \\$@
255 .c --------------------------------------------------------------------
256 .c .Opt_alt_base (<pre> <sep> <post> [<minus> <opt>]... [arg [punct]])
258 .c Alternating options; base macro for many others; do not use directly.
261 .c <pre>: prefix, resulted is preceded by this.
262 .c <sep>: separator between minux/opt pairs.
263 .c <post>: postfix, is appended to the result.
264 .c <minus>: either `-' or `--' (font CB).
265 .c <opt>: a name for an option, empty allowed (font CB).
266 .c <arg>: optionally, the argument to the option (font I).
267 .c <punct>: optional punctuation (in the starting font).
269 .c String `<pre>' followed by the <minus>/<opt> argument pairs, each
270 .c separated by string `<sep>', optionally add '<arg>', separated by
271 .c a single space ` ', followed by the string `<post>'.
276 . Error .\\0: not enough arguments.
277 . ds @pre \)\\$1\)\" prefix
278 . ds @sep \)\\$2\)\" separator
279 . ds @post \)\\$3\)\" postfix
282 . ds @res \f[CR]\\*[@pre]\"
283 . while (\\n[.$] >= 2) \{\
284 . c do the pairs, break on no `-'
290 . if (\\n[@count] > 0) \
291 . as @res \f[CR]\\*[@sep]\"
293 . as @res \f[CB]\\$1\\$2\:\" combine minus with option name
296 . if (\\n[.$] >= 3) \
297 . Error .\\0: wrong arguments: \\$@
298 . c all pairs are done
299 . ie (\\n[.$] == 0) \
300 . as @res \f[CR]\\*[@post]\"
302 . c optional option argument
304 . as @res \f[CR] \,\f[I]\\$1\"
306 . as @res \\f[CR]\\*[@post]\" postfix
307 . if (\\n[.$] >= 1) \{\
309 . as @res \f[\\n[@font]]\\$1\"
323 .c --------------------------------------------------------------------
324 .c .Opt_def ([<minus> <opt>]... [<arg> [<punct>]])
326 .c Definitions of options in section OPTIONS.
329 .c minus: either `-' or `--' (font CB).
330 .c opt: a name for an option, empty allowed (font CB).
331 .c arg: optionally, the argument to the option (font I).
332 .c punct: optional punctuation (in the starting font).
334 .c The header for an indented paragraph, consisting of
335 .c minus/opt argument pairs, each, separated by a space
336 .c character ` ', optionally add 'arg', separated a space
340 .c .Opt_def - T -- device -- device-troff device .
342 .c -T --device --device-troff device.
343 .c as the header of for indented paragraph.
347 . Opt_alt_base "" "\~|\~" "" \\$@
349 .c --------------------------------------------------------------------
350 .c .Opt_element ([<minus> <opt>]... [<arg> [<punct>]])
352 .c Definitions of options in section OPTIONS.
355 .c minus: either `-' or `--' (font CB).
356 .c opt: a name for an option, empty allowed (font CB).
357 .c arg: optionally, the argument to the option (font I).
358 .c punct: optional punctuation (in the starting font).
360 .c The minus/opt argument pairs, each, separated by a space
361 .c character ` ', optionally add 'arg', separated a space
365 .c .Opt_element - T -- device -- device-troff device .
367 .c -T --device --device-troff device.
370 . Opt_alt_base "" "\~" "" \\$@
372 .c --------------------------------------------------------------------
373 .als Opt_list Opt_element
375 .c --------------------------------------------------------------------
376 .c .Opt_long ([<name> [<punct>]])
378 .c Print `--name' somewhere in the text; optional punctuation.
381 . Opt_alt -- "\\$1" "" "\\$2"
383 .c --------------------------------------------------------------------
384 .c .Opt_[long] ([<name> [<punct>]])
386 .c Print `--name' somewhere in the text; optional punctuation.
389 . Opt_[alt] -- "\\$1" "" "\\$2"
391 .c --------------------------------------------------------------------
392 .c .Opt_short ([<name> [<punct>]])
394 .c Print `-name' somewhere in the Text; optional punctuation.
397 . Opt_alt - "\\$1" "" "\\$2"
399 .c --------------------------------------------------------------------
400 .c .Opt_[short] ([name [punct]])
402 .c Print `[-name]' somewhere in the Text; optional punctuation.
405 . Opt_[alt] - "\\$1" "" "\\$2"
407 .c --------------------------------------------------------------------
408 .c .Shell_cmd (<CR> [<CI>] ...)
410 .c A shell command line; display args alternating in fonts CR and CI.
413 .c .Shell_cmd "groffer --dpi 100 file"
414 .c result: `sh# groffer --dpi 100 file'
415 .c with 'sh#' in font I, the rest in CR
417 .c .Shell_cmd groffer\~--dpi\~100\~file
418 .c result: the same as above
420 .c .Shell_cmd "groffer --dpi=" value " file"
421 .c result: sh# groffer --dpi=value file
422 .c with `groffer --dpi=' and `file' in CR; `value' in CI
424 .c .Shell_cmd groffer\~--dpi= value \~file
425 .c result: the same as the previous example
428 . groffer:Shell_cmd_base "\*[groffer:Shell_cmd.prompt]" \\$@
430 .c --------------------------------------------------------------------
431 .c .Shell_cmd+ (<CR> [<CI>] ...)
433 .c A continuation line for .Shell_cmd.
436 . groffer:Shell_cmd_base "\*[groffer:Shell_cmd+.prompt]" \\$@
438 .c --------------------------------------------------------------------
439 .c .Shell_cmd_base (<prompt> [<CR> [<CI>] ...])
441 .c A shell command line; display args alternating in fonts CR and CI.
442 .c Internal, do not use directly.
444 .c Globals: read-only register @.Shell_cmd_width
446 .de groffer:Shell_cmd_base
447 . if (\\n[.$] <= 0) \
449 . nr @+font \\n[.f]\"
452 . c gap between prompt and command
453 . nr @+gap \\n[groffer:Shell_cmd_base.prompt_width]-\\w'\\*[@prompt]'\"
454 . ds @res \\*[@prompt]\h'\\n[@+gap]u'\"
457 . while (\\n[.$] > 0) \{\
458 . as @res \\f[\\*[@cf]]\\$1\"
480 .c --------------------------------------------------------------------
483 .c Begin a synopsis section, to be ended by a ./Synopsis macro.
486 . if (\\n[groffer:Synopsis.level] > 0) \
487 . Error .\\$0: previous .Synopsis was not closed by ./Synopsis.
490 . nr @old_indent \\n(.i
492 . in +\w'\fB\\*[@1]\0'u
493 . ti \\n[@old_indent]u
497 . nr groffer:Synopsis.level +1\" marker for ./Synopsis
499 .c --------------------------------------------------------------------
502 .c Close a synopsis section opened by the previous .Synopsis macro.
505 . if (\\n[groffer:Synopsis.level] <= 0) \
506 . Error .\\$0: no previous call of .Synopsis
511 . nr groffer:Synopsis.level -1
513 .c --------------------------------------------------------------------
516 .c Treat the arguments as text, no matter how they look.
519 . if (\\n[.$] == 0) \
523 .c --------------------------------------------------------------------
524 .c .Topic ([<indent>])
526 .c A bulleted paragraph
537 .c --------------------------------------------------------------------
540 .c Continuation line for .TP header.
547 .c --------------------------------------------------------------------
548 .c .TP_header ([<indent>])
550 .c Start a multi-line header for a .TP-like paragraph
553 . if (\\n[groffer:TP.level] < 0) \
554 . Error .\\$0: wrong level.
555 . nr groffer:TP.level +1
557 . ie (\\n[.$] == 0) \
558 . rr groffer:TP.indent
560 . nr groffer:TP.indent \\$1
561 . nr groffer:TP_header.flag 1
563 .c --------------------------------------------------------------------
564 .c .TP_body ([<indent>])
566 .c End a previous .TP-header and beging the body of the paragraph.
569 . if !rgroffer:TP_header.flag \
570 . Error .\\$0: no previous call of .TP_header
571 . if (\\n[groffer:TP.level] <= 0) \
572 . Error .\\$0: wrong level.
574 . ie (\\n[.$] == 0) \{\
575 . ie rgroffer:TP.indent \{\
576 . RS \\n[groffer:TP.indent]u
583 . rr groffer:TP.indent
584 . rr groffer:TP_header.flag
585 . nr groffer:TP_body.flag 1
587 .c --------------------------------------------------------------------
590 .c End of former .TP_body paragraph.
593 . if !rgroffer:TP_body.flag \
594 . Error .\\$0: no previous .TP_body.
595 . if (\\n[groffer:TP.level] <= 0) \
596 . Error TP_end: wrong level.
597 . nr groffer:TP.level -1
598 . rr grogger:TP.indent
599 . rr groffer:TP_header.flag
600 . rr groffer:TP_body.flag
605 .\" End of macro definitions
608 .\" --------------------------------------------------------------------
610 .\" --------------------------------------------------------------------
614 .RI [ viewing_options ]
616 .RI [ groff_options ]
618 .RI [ "filespec" "\*[Ellipsis]]"
626 .Opt_alt - v -- version
632 These options determine and configure the display mode.
634 They were synchronized with the options of both
635 .BR groff (@MAN1EXT@)
638 As groff uses almost any letter in its option set, only long option
639 names are available for most features.
641 If none of these options is used groffer tries to find a suitable
642 display mode automatically.
648 .Opt_[alt] - Q -- source
649 .Opt_[alt] - T -- device device
650 .Opt_[alt] -- auto-modes mode1,mode2,\*[Ellipsis]
652 .Opt_[alt] -- default
654 .Opt_[alt] -- dvi-viewer prog
656 .Opt_[alt] -- location
657 .Opt_[alt] -- mode display_mode
658 .Opt_[alt] -- pager program
660 .Opt_[alt] -- pdf-viewer prog
662 .Opt_[alt] -- ps-viewer prog
666 .Opt_[alt] -- www-viewer prog
668 .Opt_[alt] -- x-viewer prog
672 The following long options were adapted from the corresponding X
673 Toolkit options with a single leading minus; see
679 .Opt_[alt] -- bg -- background
681 .Opt_[alt] -- display
682 .Opt_[alt] -- fg -- foreground
683 .Opt_[alt] -- ft -- font
684 .Opt_[alt] -- geometry size_pos
685 .Opt_[alt] -- resolution value
687 .Opt_[alt] -- title string
688 .Opt_[alt] -- xrm X_resource
695 Any combination of (short) options from the
696 .BR groff (@MAN1EXT@)
697 program is accepted; the options that are not explicitly handled by
698 groffer are transparently passed to groff.
700 Due to the automatism in groffer, none of these groff options should
701 be necessary, except for advanced usage.
707 Because of the special outputting behavior of the groff options
712 groffer was designed to be switched into
714 mode by each of these options; in this mode, the groffer viewing
715 features are disabled.
718 The other groff options do not switch the mode, but allow to customize
719 the formatting process.
721 Useful groff formatting options include
723 (to add macro files that cannot be recognized by grog), and
725 (to specify an alternative device for the modes
735 These options regulate whether and how man pages are searched.
737 They are compatible with the long options of the
747 .Opt_[alt] -- apropos
748 .Opt_[alt] -- ditroff
749 .Opt_[alt] -- extension suffix
750 .Opt_[alt] -- locale language
751 .Opt_[alt] -- local-file
753 .Opt_[alt] -- manpath dir1:dir2:\*[Ellipsis]
754 .Opt_[alt] -- no-location
756 .Opt_[alt] -- sections sec1:sec2:\*[Ellipsis]
757 .Opt_[alt] -- systems sys1,sys2,\*[Ellipsis]
758 .Opt_[alt] -- troff-device device
765 long options that are not mentioned are recognized, but they are just
766 ignored because of alternative implementations.
768 The full set of long and short options of the GNU man program can be
769 passed via the environment variable
773 if your system has GNU man installed.
780 is a sequence of file names or templates for searching
785 can have one of the following forms.
792 the path name of an existing file.
797 stands for standard input (can occur several times).
801 .BI man: name ( section )
809 .BI man: name . section
820 in the lowest available section.
841 if this is `1', \*[Ellipsis], `9', `o', or `n' try to retrieve the
842 next argument as a man\~page in this section.
847 search for the man\~page
849 in the lowest available section.
855 parameters means standard input.
861 For details on the options, see section
865 .\" --------------------------------------------------------------------
867 .\" --------------------------------------------------------------------
872 .BR groff (@MAN7EXT@).
873 It can be used to display arbitrary documents written in the
875 formatting language in several different ways, in an X window viewer
876 program or in a text terminal.
878 The viewer programs can be chosen as the groff native viewer
879 .BR gxditview (@MAN1EXT@),
880 a Postcript or dvi display program, or a web browser.
884 A search facility for manual pages (
888 Almost the whole functionality of the
890 program was provided or suitably adapted.
892 This makes the groffer program a valuable tool on systems with a poor
898 The program always concatenates all input specified by the non-option
899 parameters of the calling command line or standard input.
901 Compressed standard input or files are decompressed on-the-fly.
905 Normally, the input is run through the
906 .BR groff (@MAN1EXT@)
907 text processor before being displayed.
911 the roff source code is displayed without formatting.
915 The formatting process can be regulated by all options that are
920 option, groffer can be switched to behave exactly like groff without
921 using its viewer facilities, but additionally with the search and
922 decompression features.
926 All necessary options can be determined automatically.
928 For example, the groffer program internally uses the
930 program to determine from the unformatted document which preprocessors
931 should be run and which macro files should be included.
933 But all parts of the program can be controlled manually by suitable
937 .\" --------------------------------------------------------------------
939 .\" --------------------------------------------------------------------
941 The groffer program provides its own parser for command line options
942 that is compatible to both POSIX
946 The command line behaves as usually.
948 For completeness, the details are provided here.
951 .\" --------------------------------------------------------------------
953 .\" --------------------------------------------------------------------
955 The following types of options are supported, equally on all systems
956 that are able to run the groffer program:
960 single character options are always preceded by a single minus
961 character, for example,
966 the argument for a single character option is the next command line
967 argument, for example,
969 or can be appended to the option character within the same argument
974 clusters of such single character options without an argument,
975 eventually terminated by a single character option with an argument;
986 Long options, that means option with names longer than one character
987 are always prededed by a double minus; an option argument can either
988 go to the next command line argument or be appended with an equal sign
989 to the argument; for example,
990 .Opt_alt -- long= arg
992 .Opt_alt -- long\~ arg .
998 ends option parsing; all further command line arguments are
999 interpreted as filespec arguments.
1003 By default, all command line arguments that are neither options nor
1004 option arguments are interpreted as filespec parameters and stored
1005 until option parsing has finished.
1007 For example, the command line
1008 .Shell_cmd "groffer file1 -a -o arg file 2"
1009 is, by default, equivalent to
1010 .Shell_cmd "groffer -a -o arg -- file1 file 2"
1014 This behavior can be changed by setting the environment variable
1015 .Env_var $POSIXLY_CORRECT
1016 to a non-empty value; in this case, option processing is stopped as
1017 soon as the first non-option argument is found.
1019 For example, in posixly correct mode, the command line
1020 .Shell_cmd "groffer file1 -a -o arg file 2"
1022 .Shell_cmd "groffer -- file1 -a -o arg file 2"
1023 As this leads to unwanted behavior in most cases, most people do not
1025 .Env_var $POSIXLY_CORRECT .
1028 .\" --------------------------------------------------------------------
1029 .SS "Compatibility with Options from other Programs"
1030 .\" --------------------------------------------------------------------
1032 All short options of
1034 are compatible with the short options of
1035 .BR groff (@MAN1EXT@).
1039 options were given a special meaning within
1044 options are supported by
1046 but they are just transparently transferred to
1048 without any intervention.
1050 Therefore these transparent options are not documented here, but in
1051 .BR groff (@MAN1EXT@).
1057 are compatible with the long options of
1062 long options were implemented as native options into
1065 These options are documented in the following; the other
1067 options are recognized, but ignored.
1070 .\" --------------------------------------------------------------------
1071 .SS "Native groffer Options"
1072 .\" --------------------------------------------------------------------
1075 Print usage message to standard error and exit.
1079 Output the roff source code of the input files unprocessed.
1081 This is the equivalent
1082 .Opt_long mode\~source .
1085 .Opt_def - T devname
1087 .Opt_long mode\~device ,
1093 Instead, the input is formatted and postprocessed using plain
1097 as the output device.
1099 The allowed device names are listed in
1100 .BR groff (@MAN1EXT@).
1102 Note that this forces all device names that begin with the letter
1104 to be displayed with
1105 .BR gxditview (@MAN1EXT@);
1106 all other device names generate output for the specified device; this
1107 is printed onto standard output without a pager.
1111 Print version information onto standard error.
1117 mode and format the input with groff option
1119 this produces the groff calling pipe without formatting the input.
1121 This an advanced option from
1122 .BR groff (@MAN1EXT@) ,
1123 only useful for debugging.
1129 mode and format the input with groff option
1131 actually, this formats the input and displays it with
1132 .BR gxditview (@MAN1EXT@) .
1134 This differs from groffer's mode
1136 because groffer's viewer options are not used, but the viewer is
1137 configured like in groff with the groff option
1139 This option is inhereted from
1140 .BR groff (@MAN1EXT@) .
1146 mode and format the input with groff option
1148 this produces the groff intermediate output without postprocessing; see
1149 .BR groff_out (@MAN1EXT@) .
1150 This an advanced option from
1151 .BR groff (@MAN1EXT@) ,
1152 useful for debugging.
1156 In searching man pages, retrieve all suitable ones instead of only one.
1160 Instead of displaying, start the `apropos' command for searching
1161 within man page descriptions; only kept for compatibility with `man'.
1164 .Opt_def -- auto-modes mode1,mode2,\*[Ellipsis]
1165 Set the sequence of modes for default mode to the comma separated list
1166 given in the argument.
1169 .Opt_def -- background color
1170 This is equivalent to
1174 .Opt_def -- bd pixels
1175 Specifies the color of the border surrounding the viewer
1178 This is an adaption of the X Toolkit option
1181 The argument is an X color name, see
1186 .Opt_def -- bg color
1187 Set the background color of the viewer window.
1189 This is an adaption of the X Toolkit option
1192 The argument is an X color name, see
1197 .Opt_def -- bw pixels
1198 Specifies the width in pixels of the border surrounding the viewer
1199 window (not available for all viewers).
1201 This is an adaption of the X Toolkit option
1206 Print debugging information.
1208 Actually, a function call stack is printed if an error occurs.
1212 Reset all configuration from previously processed command line options
1213 to the default values.
1215 This is useful to wipe out all effects of former options and restart
1216 option processing using only the rest of the command line.
1224 .Opt_def -- display X-display
1225 Set the X display on which the viewer program shall be started, see
1227 for the syntax of the argument.
1233 This is kept for compatibiliy with GNU
1238 Choose dvi mode; the formatted input is displayed with the
1239 by default, the formatted input is displayed with the
1244 .Opt_def -- dvi-viewer prog
1245 Set the viewer program for dvi mode.
1247 This can be a file name or a program to be searched in
1250 Known dvi viewers inlude
1255 In each case, arguments can be provided additionally.
1258 .Opt_def -- extension suffix
1259 Restrict man\~page search to file names that have
1261 appended to their section element.
1263 For example, in the file name
1264 .I /usr/share/man/man3/terminfo.3ncurses.gz
1265 the man\~page extension is
1272 .Opt_def -- foreground color
1273 This is equivalent to
1277 .Opt_def -- fg color
1278 Set the foreground color of the viewer window.
1280 This is an adaption of the X Toolkit option
1283 The argument is an X color name, see
1288 .Opt_def -- font font_name
1289 This is equivalent to
1293 .Opt_def -- ft font_name
1294 Set the font used by the viewer window.
1296 This is an adaption of the X Toolkit option
1299 The argument is an X font name, see
1304 .Opt_def -- geometry size_pos
1305 Set the geometry of the display window, that means its size and its
1310 for details on the syntax of the argument.
1312 If the actual display mode is not X then this option is ignored.
1320 Switch groffer to process the input like
1321 .BR groff (@MAN1EXT@).
1323 This disables the groffer viewing features, all groffer viewing
1324 options are ignored.
1332 .Opt_def -- location
1333 Print the location of the retrieved files to standard error.
1336 .Opt_def -- locale language
1338 Set the language for man pages.
1340 This option originates from GNU
1345 Check the non-option command line arguments (filespecs) first on being
1346 man\~pages, then whether they represent an existing file.
1348 By default, a filespec is first tested if it is an existing file.
1351 .Opt_def -- manpath "'dir1:dir2:\*[Ellipsis]'"
1352 Use the specified search path for retrieving man\~pages instead of the
1355 If the argument is set to the empty string "" the search for man\~page
1359 .Opt_def -- mode value
1361 Set the display mode.
1363 The following mode values are recognized:
1371 Display in the default manner; this actually means to try the modes
1378 Useful for restoring default mode when a different mode was specified
1380 .Env_var $GROFFER_OPT .
1385 Display formatted input in a dvi viewer program; equivalent to
1391 Display formatted input in a PDF (Portable Document Format) viewer
1392 program; equivalent to
1398 Display formatted input in a Postscript viewer program; equivalent to
1404 Display formatted input in a text terminal; equivalent to
1410 Display formatted input in a internet browser program; equivalent to
1416 Display formatted input in a native roff viewer such as
1417 .BR gxditview (@MAN1EXT@); equivalent to
1422 The following modes do not use the
1426 They are only interesting for advanced applications.
1431 Generate device output with plain
1433 without using the special viewing features of
1435 If no device was specified by option
1446 Display source code; same as
1453 .Opt_def -- no-location
1454 Do not display the location of retireved files; this resets a former
1456 .Opt_long location .
1460 Do not check for man\~pages.
1464 Set the pager program in tty mode; default is
1469 Choose pdf mode (Portable Document Format).
1471 By default, the input is formatted by groff using the Postscript
1472 device, then it is transformed into the PDF file format using
1474 (this is quite slow), and finally displayed either with the
1478 program; this can be configured with option
1479 .Opt_long viewer-pdf .
1481 PDF has a big advantage because the text is displayed graphically and
1482 is searchable nevertheless; but as thtransformation into pdf takes a
1483 considerable amount of time, the pdf mode is not suitable as a default
1484 device for the auto mode.
1486 The only device that is compatible to this mode is
1488 which is also the default when no device is specified.
1491 .Opt_def -- pdf-viewer prog
1492 Set the viewer program for
1496 This can be a file name or a program to be searched in
1499 In each case, arguments can be provided additionally.
1503 Choose ps mode (Postscript).
1505 By default, the formatted input is displayed with the
1506 .BR ghostview (@MAN1EXT@)
1507 program; this can be configured with option
1508 .Opt_long viewer-ps .
1510 The only device that is compatible to this mode is
1512 which is also the default when no device is specified.
1515 .Opt_def -- ps-viewer prog
1516 Set the viewer program for
1520 This can be a file name or a program to be searched in
1523 Common Postscript viewers inlude
1529 In each case, arguments can be provided additionally.
1532 .Opt_def -- resolution value
1533 Set X resolution in dpi (dots per inch) in some viewer programs.
1535 The only supported dpi values are
1539 This is an adaption of the X Toolkit option
1540 .Opt_short resolution .
1544 Reverse foreground and background color of the viewer window.
1546 This is an adaption of the X Toolkit option
1548 This feature is not available in all viewer programs.
1551 .Opt_def -- sections
1552 Restrict searching for man pages to the given
1554 a colon-separated list.
1557 .Opt_def -- shell "shell_program"
1558 Specify the shell under which the groffer script should be run.
1560 The script first tests whether this option is set (either within
1562 or as a command line option); if so, the script is rerun under the
1563 shell program specified with the option argument.
1572 Search for man pages for the given operating systems; the argument
1574 is a comma-separated list.
1577 .Opt_def -- title "'some text'"
1578 Set the title for the viewer window.
1580 This feature is not available in all viewer programs.
1583 .Opt_def -- to-postproc opt_or_arg
1588 .Opt_def -- troff-device
1591 This option is only kept for compatibility with GNU
1596 Choose tty display mode, that means displaying in a text pager even
1597 when in X; eqivalent to
1598 .Opt_long mode\~tty .
1607 Instead of displaying the content, get the one-liner description from
1608 the retrieved man page files \[em] or say that it is not a man page.
1613 .Opt_long location .
1617 Choose www mode (html), display in a web browser program, which can be
1618 specified with option
1619 .Opt_long www-viewer .
1620 By default, the existence of a sequence of standard web browsers is
1621 tested, starting with
1627 .Opt_def -- www-viewer prog
1628 Set the web browser program for viewing in
1632 Each program that accepts html input and allows the
1633 .BI file://localhost/ dir / file
1634 syntax on the command line is suitable; it can be the path name of an
1635 executable file or a program in
1638 In each case, arguments can be provided additionally.
1644 mode (view in X roff viewer).
1646 By default, the formatted input is displayed with the
1647 .BR gxditview (@MAN1EXT@)
1648 program, being distributed together with groff, or with
1650 which is distributed as a standard X tool.
1652 This can be configured with option
1653 .Opt_long x-viewer .
1655 The only devices (option
1657 that are compatible with this mode are
1664 (the default device).
1667 .Opt_def -- x-viewer prog
1668 Set the viewer program for
1672 Suitable viewer programs are
1673 .BR gxditview (@MAN1EXT@)
1677 But the argument can be any executable file or a program in
1680 In each case, arguments can be provided additionally.
1685 Signals the end of option processing; all remaining arguments are
1692 Besides these, groffer accepts all arguments that are valid for the
1693 .BR groff (@MAN1EXT@)
1696 All non-groffer options are sent unmodified via grog to groff.
1698 Postprocessors, macro packages, compatibility with classical troff,
1699 and much more can be manually specified.
1702 .\" --------------------------------------------------------------------
1704 .\" --------------------------------------------------------------------
1706 By default, the groffer program formats the input and then
1707 automatically chooses a suitable display mode, but the user can also
1708 choose between the following modes:
1711 graphically display the formatted input with an X window program,
1716 with X window roff viewers such as
1717 .BR gxditview (@MAN1EXT@)
1722 in a dvi viewer program
1727 in a Postscript viewer
1743 display formatted input in a pager on the text terminal
1748 run groffer like groff, but with decompression and man\~page searching
1750 mode); this includes things like generating the groff intermediate
1754 stream the unformatted source code of the input onto standard output
1765 mode is possible, then
1771 This mode testing sequence for
1773 mode can be changed by specifying a comma separated list of modes
1775 .Opt_long default-modes.
1779 The searching for man\~pages and the decompression of the input are
1780 active in every mode.
1783 .\" --------------------------------------------------------------------
1784 .SS "Graphical Display Modes"
1785 .\" --------------------------------------------------------------------
1787 The graphical display modes work only in the X window environment (or
1788 similar implementations within other windowing environments).
1790 The environment variable
1794 are used for specifying the X display to be used; if neither is
1795 specified, groffer assumes that no X is running.
1799 A certain graphical display mode can be selected by one of the options
1807 By default, some graphical modes are tried first. If none succeeds
1814 The graphical modes can be customized by options that were named
1815 according to the resource options in the
1817 Toolkit but using a leading double minus instead of the single minus
1821 .Opt_long background ,
1822 .Opt_long foreground ,
1823 .Opt_long geometry ,
1824 .Opt_long resolution ,
1833 mode has a major advantage \[em] it is the only graphical diplay mode
1834 that allows to search for text within the viewer; this can be a really
1837 Unfortunately, it takes a long time to transform the input into the
1838 PDF format, so it was not chosen as the major mode.
1840 You can change this by the options
1843 .Opt_long auto-modes .
1846 .\" --------------------------------------------------------------------
1847 .SS "Displaying on a tty"
1848 .\" --------------------------------------------------------------------
1852 is not set or empty, groffer assumes that it should produce output on
1855 This mode can also be forced by option
1860 In the actual implementation, the groff output device
1862 is chosen and the processed output is piped into a pager program.
1864 This can be changed by specifying option
1865 .Opt_long tty-device .
1869 The pager to be used can be specified by option
1871 by the environment variable
1873 If this is not set or empty the
1875 program is used as the default pager.
1878 .\" --------------------------------------------------------------------
1879 .SS "Non-displaying Modes"
1880 .\" --------------------------------------------------------------------
1882 There are some special modes that do not display the formatted output
1883 in a viewer program.
1885 These modes are regarded as advanced, they are useful for debugging
1891 Instead of displaying the formatted output, it is also possible to
1892 have the roff source code streamed onto the standard output.
1894 This mode must be requested by one of the options
1902 This mode disables the groffer viewing facilities.
1904 The input is handled as usual with decompression and man\~page
1905 searching, but then it is passed to groff using only the options
1908 This enables the user to save the generated output into a file or pipe
1909 it into another program.
1911 In this mode, the input is formatted, but not postprocessed; see
1912 .BR groff_out (@MAN5EXT@)
1915 This mode is activated automatically by the three groff options
1917 (print roff pipe, no formatting),
1919 (display with gxditview in groff's native way, using
1921 for customization), and
1923 (disable post-processing, thus producing the groff intermediate output).
1926 .\" --------------------------------------------------------------------
1927 .SH "FILE PARAMETERS"
1928 .\" --------------------------------------------------------------------
1930 The non-option command line parameters determine which files should be
1934 .\" --------------------------------------------------------------------
1936 .\" --------------------------------------------------------------------
1938 The default behavior of groffer is to first test whether the file
1939 parameter is represents a local file; if not, it is assumed to
1940 represent a filespec for searching one or more man\~page.
1942 This behavior can be modified by options.
1947 forces to interpret all file parameters as filespecs for searching
1953 .Opt_long local-file
1954 disable the man searching; so only local files are displayed.
1958 The following parameter formats are recognized to represent a wanted
1963 .BI man: name ( section )
1964 the quasi-URL notation used in many Desktop systems to
1965 represent the man\~page
1973 search the man\~page
1975 in the lowest section.
1976 The corresponding command with the man program would be
1977 .Shell_cmd man\~ name
1986 The corresponding command with the man program would be
1987 .Shell_cmd man\~ section\~name
1994 is not an existing file search for the man\~page
1996 in the lowest section just like
1997 .Shell_cmd man\~ name
2002 Even this curious construct known from the various
2004 programs is handled.
2007 .Shell_cmd "groffer 7 groff"
2008 was modelled according to
2009 .Shell_cmd "man 7 groff"
2010 retrieves the man\~page named
2014 Only a few standard section names are accepted, being actually the
2016 .I 1, 2, 3, 4, 5, 6, 7, 8,
2019 and the lower case letters
2026 If neither a local file nor a man\~page was retrieved for some file
2027 parameter a warning is issued on standard error, but processing is
2031 .\" --------------------------------------------------------------------
2032 .SS "Man\~Page Searching"
2033 .\" --------------------------------------------------------------------
2035 The groffer program provides a search facility for system manual pages
2038 All long options, all environment variables, and most of the
2039 functionality of the GNU
2041 program were implemented.
2045 Preformatted man\~pages (cat\~pages) are intentionally excluded from
2046 the search because groffer is a roff program that wants to format by
2047 its own, not spit out stuff that was digested previously by someone
2050 With the excellent performance of the actual computers, the
2051 preformatted man\~pages aren't necessary any longer.
2053 Due to their inflexible nature, they tend to provoke some trouble with
2054 changing line lengths and different environments in networks.
2058 The algorithm for retrieving man\~pages uses five search methods.
2060 They are successively tried until a method works.
2064 The search path can be manually specified by using the option
2066 An empty argument disables the man\~page searching.
2068 This overwrites the other methods.
2072 If this is not available the environment variable
2078 If this is empty, the program tries to read it from the environment
2083 If this does not work, the
2085 program for determining a path of man directories is tried.
2089 If this does not work a reasonable default path is searched for
2094 After this, the path elements for the language (locale) and operating
2095 system specific man\~pages are added to the man\~path; their sequence
2096 is determined automatically.
2099 .I /usr/share/man/linux/fr
2101 .I /usr/share/man/fr/linux
2102 for french linux man\~pages are found.
2104 The language and operating system names are determined from both
2105 environment variables and command line options.
2109 The locale (language) is determined like in GNU man, that is from
2110 highest to lowest precedence:
2115 .Env_var $GROFFER_OPT
2124 .Env_var $LC_MESSAGES
2131 The language locale is usually specified in the POSIX 1003.1 based
2134 \f[I]<language>\f[][\f[CB]_\f[]\f[I]<territory>\f[][\f[CB].\f[]\
2135 \f[I]<character-set>\f[][\f[CB],\f[]\f[I]<version>\f[]]]],
2137 but the two-letter code in
2139 is sufficient for most purposes.
2143 If no man\~pages for a complicated locale are found the country part
2144 consisting of the first two characters (without the `\f[CB]_\f[]',
2145 `\f[CB].\f[]', and `\f[CB],\f[]', parts) of the locale is searched as
2150 If still not found the corresponding man\~page in the default language
2153 As usual, this default can be specified by one of \f[CR]C\f[] or
2156 The man\~pages in the default language are usually in English.
2160 Several operating systems can be given by appending their names,
2161 separated by a comma.
2163 This is then specified by the environment variable
2165 or by the command line option
2167 The precedence is similar to the locale case above from highest to
2174 .Env_var $GROFFER_OPT
2184 When searching for man\~pages this man\~path with the additional
2185 language and system specific directories is used.
2189 The search can further be restricted by limiting it to certain
2192 A single section can be specified within a filespec, several sections
2193 as a colon-separated list in command line option
2195 or environment variable
2198 When no section was specified a set of standard sections is searched
2199 until a suitable man\~page was found.
2203 Finally, the search can be restricted to a so-called
2205 This is a postfix that acts like a subsection.
2207 It can be specified by
2209 or environment variable
2210 .Env_var $EXTENSION .
2214 For further details on man\~page searching, see
2218 .\" --------------------------------------------------------------------
2220 .\" --------------------------------------------------------------------
2222 The program has a decompression facility.
2224 If standard input or a file that was retrieved from the command line
2225 parameters is compressed with a format that is supported by either
2229 it is decompressed on-the-fly.
2231 This includes the GNU
2238 The program displays the concatenation of all decompressed input in
2239 the sequence that was specified on the command line.
2242 .\" --------------------------------------------------------------------
2244 .\" --------------------------------------------------------------------
2246 The groffer programs supports many system variables, most of them by
2247 courtesy of other programs.
2249 All environment variables of
2250 .BR groff (@MAN1EXT@)
2253 and some standard system variables are honored.
2256 .\" --------------------------------------------------------------------
2257 .SS "Native groffer Variables"
2258 .\" --------------------------------------------------------------------
2261 .Env_var $GROFFER_OPT
2262 Store options for a run of groffer.
2264 The options specified in this variable are overridden by the options
2265 given on the command line.
2267 The content of this variable is run through the shell builitin `eval';
2268 so arguments containing white-space or special shell characters should
2272 .\" --------------------------------------------------------------------
2273 .SS "System Variables"
2274 .\" --------------------------------------------------------------------
2276 The groffer program is a shell script that is run through
2278 which can be internally linked to programs like
2280 The corresponding system environment is automatically effective.
2282 The following variables have a special meaning for groffer.
2287 If this variable is set this indicates that the X window system is
2290 Testing this variable decides on whether graphical or text output is
2293 This variable should not be changed by the user carelessly, but it can
2294 be used to start the graphical groffer on a remote X terminal.
2296 For example, depending on your system, groffer can be started on the
2297 second monitor by the command
2298 .Shell_cmd DISPLAY=:0.1\~groffer\~ what.ever &
2304 .Env_var $LC_MESSAGES
2307 If one of these variables is set (in the above sequence), its content
2308 is interpreted as the locale, the language to be used, especially when
2309 retrieving man\~pages.
2311 A locale name is typically of the form
2321 is an ISO 639 language code,
2323 is an ISO 3166 country code, and
2325 is a character set or encoding identifier like ISO-8859-1 or UTF-8;
2329 The locale values\~\c
2333 stand for the default, i.e. the man\~page directories without a
2336 This is the same behavior as when all 3\~variables are unset.
2341 This variable can be used to set the pager for the tty output.
2343 For example, to disable the use of a pager completely set this
2347 .Shell_cmd PAGER=cat\~groffer\~ anything
2352 All programs within the groffer shell script are called without a
2355 Thus this environment variable determines the set of programs used
2356 within the run of groffer.
2360 .Env_var $POSIXLY_CORRECT
2361 If set to a non-empty value this chooses the POSIX mode for option
2362 processing, that means that option processing will be finished as soon
2363 as a non-option argument is found.
2365 Usually, you do not want to set this environment variable.
2368 .\" --------------------------------------------------------------------
2369 .SS "Groff Variables"
2370 .\" --------------------------------------------------------------------
2372 The groffer program internally calls groff, so all environment
2373 variables documented in
2374 .BR groff (@MAN1EXT@)
2375 are internally used within groffer as well; see there for details.
2377 The following variables have a direct meaning for the groffer program.
2380 .Env_var $GROFF_TMPDIR
2381 If the value of this variable is an existing, writable directory,
2382 groffer uses it for storing its temporary files, just as groff does.
2385 .\" --------------------------------------------------------------------
2387 .\" --------------------------------------------------------------------
2389 Parts of the functionality of the man program were implemented in
2390 groffer; support for all environment variables documented in
2392 was added to groffer, but the meaning was slightly modified due to the
2393 different approach in groffer; but the user interface is the same.
2395 The man environment variables can be overwritten by options provided
2398 which in turn is overwritten by the command line.
2403 Restrict the search for man\~pages to files having this extension.
2405 This is overridden by option
2406 .Opt_long extension ;
2407 see there for details.
2412 This variable contains options as a preset for
2414 As not all of these are relevant for groffer only the essential parts
2415 of its value are extracted.
2417 The options specified in this variable overwrite the values of the
2418 other environment variables taht are specific to man.
2420 All options specified in this variable are overridden by the options
2421 given on the command line.
2426 If set, this variable contains the directories in which the man\~page
2429 This is overridden by option
2435 If this is a colon separated list of section names, the search for
2436 man\~pages is restricted to those manual sections in that order.
2438 This is overridden by option
2439 .Opt_long sections .
2444 If this is set to a comma separated list of names these are interpreted
2445 as man\~page trees for different operating systems.
2447 This variable can be overwritten by option
2449 see there for details.
2453 The environment variable
2454 .Env_var $MANROFFSEQ
2455 is ignored by groffer because the necessary preprocessors are
2456 determined automatically.
2459 .\" --------------------------------------------------------------------
2461 .\" --------------------------------------------------------------------
2463 The groffer program can be preconfigured by two configuration files.
2465 Both of them are shell scripts that are called at the beginning of
2466 groffer using the `\c
2473 .CB /etc/groff/groffer.conf
2474 System-wide configuration file for groffer.
2478 .CB $HOME/.groff/groffer.conf
2479 User-specific configuration file for groffer, where
2481 denotes the user's home directory.
2483 This script is called after the system-wide configuration file to
2484 enable overriding by the user.
2488 It makes sense to use these configuration files for the following
2492 Preset environment variables recognized by groffer; preferably a
2493 variable should only be set when it is unset in order not to override
2494 a user-provided value.
2497 Preset command line options by prepending them to
2498 .Env_var $GROFFER_OPT ;
2499 prepending should be preferred to appending and setting in order not
2500 to delete the environment variable provided by the
2503 Write functions for calling viewer programs in a special way and feed
2505 .Opt_long \f[I]*\f[]-viewer
2508 Note that the name of such a function must coincide with some existing
2509 program in the system path
2511 in order to be recognized by groffer.
2515 As an example, consider the following configuration file.
2522 # ~/.groff/groffer.conf
2523 if test "$DISPLAY" = ""; then
2524 DISPLAY='localhost:0.0';
2526 GROFF_OPT="--resolution=100 $GROFF_OPT";
2529 /usr/local/bin/gxditview --fg DarkBlue "$@";
2537 This has the following effects:
2539 allows to start groffer in a graphical mode even from a text
2542 all graphical modes use a resolution of 100 dpi where applicable;
2545 .BR gxditview (@MAN1EXT@)
2546 program is told to use
2550 These configurations can be overridden by command line options and by
2551 environment variable
2552 .Env_var $GROFFER_OPT .
2555 .\" --------------------------------------------------------------------
2557 .\" --------------------------------------------------------------------
2559 The usage of groffer is very easy.
2561 Usually, it is just called with a file name or man\~page.
2563 The following examples, however, show that groffer has much more fancy
2568 .Shell_cmd "groffer\~/usr/local/share/doc/groff/meintro.ms.gz"
2569 Decompress, format and display the compressed file
2572 .IR /usr/local/share/doc/groff ,
2573 using a default graphical viewer when in X window, or the
2575 pager program when not in X.
2579 .Shell_cmd "groffer\~groff.7\~groff\~\[cq]troff(1)\[cq]\~man:roff"
2581 The arguments that are not existing files are looked-up as the
2582 following man\~pages:
2586 (automatic search, should be found in section\~1),
2591 (in the section with the lowest number, being\~7 in this case).
2594 .I \[cq]troff(1)\[cq]
2595 are necessary because the paranthesis are special shell characters;
2596 escaping them with a backslash character
2600 would be possible, too.
2602 The formatted files are concatenated and displayed in one piece.
2606 .Shell_cmd "LANG=de\~groffer\~--man\~--www\~--www-viever=netscape\~ls"
2608 Retrieve the German man\~page for the
2610 program (or the English one if there is a German version), decompress
2611 it, format it into the html format and view the result in the default
2616 guarantees that the man\~page is retrieved, even when a local file
2618 exists in the actual directory.
2622 .Shell_cmd "groffer\~-Q\~'man:roff(7)'"
2624 Print the unformatted content of the man\~page called
2626 in section 7 on standard output.
2630 .Shell_cmd "groffer\~-Z\~-mfoo"
2632 Decompress the standard input, switch to
2634 mode, format the input with groff using the macro package foo, but do
2635 not postprocess the result, thus producing the intermediate output.
2639 .Shell_cmd "echo\~'\[rs]f[CB]WOW!'\~|"
2641 .Shell_cmd+ "groffer --x --bg red --fg yellow --geometry 200x100"
2643 Display \f[CB]WOW!\f[] in a small window in constant-width bold font,
2644 using color yellow on red background.
2647 .\" --------------------------------------------------------------------
2649 .\" --------------------------------------------------------------------
2653 shell script is compatible to both POSIX and GNU.
2655 POSIX compatibility refers to
2656 .B IEEE P1003.2/D11.2
2657 of September 1991, a very early version of this standard.
2659 The script uses only a quite restricted set of shell language elements
2660 and shell builtins, common to all POSIX versions; the only external
2661 program used is `sed', again only the most basic POSIX features of
2664 The groffer script should work on most actual free and commercial
2669 The groffer program provides its own parser for command line options;
2670 it can handle option arguments and file names containing white space
2671 and a large set of special characters.
2675 The groffer shell script was tested with the following common
2676 implementations of the POSIX shell:
2684 Free POSIX compatible shells and shell utilities for most operating
2685 systems are available at the
2686 .URL http://\:www.gnu.org/software/ "GNU software archive" .
2690 The best performance was obtained with the
2692 shell; so groffer tries to run under
2696 The procedure to determine the shell to run groffer was programmed to
2701 the argument of the command line option
2706 the argument of the option
2708 in the environment variable
2709 .Env_var $GROFF_OPT ;
2718 continue with the shell under which the script was started in the
2722 .\" --------------------------------------------------------------------
2724 .\" --------------------------------------------------------------------
2727 .BR groff (@MAN1EXT@)
2729 .BR troff (@MAN1EXT@)
2730 Details on the options and environment variables available in groff;
2731 all of them can be used with groffer.
2735 .BR grog (@MAN1EXT@)
2736 Internally, groffer tries to guess the groff command line options from
2737 the input using this program.
2741 .BR groff_out (@MAN5EXT@)
2742 Documentation on the groff intermediate output (ditroff output).
2749 Viewers for groffer's
2758 Viewers for groffer's
2782 .BR gxditview (@MAN1EXT@)
2785 Viewers for groffer's
2794 The decompression programs supported by groffer.
2799 The standard program to diplay man\~pages.
2801 The information there is only useful if it is the man\~page for
2803 Then it documents the options and environment variables that are
2804 supported by groffer.
2807 .\" --------------------------------------------------------------------
2809 .\" --------------------------------------------------------------------
2811 Copyright (C) 2001, 2002 Free Software Foundation, Inc.
2814 This document is distributed under the terms of the FDL (GNU Free
2815 Documentation License) version 1.1 or later.
2817 You should have received a copy of the FDL on your system, it is also
2818 available on-line at the
2819 .URL http://\:www.gnu.org/\:copyleft/\:fdl.html "GNU copyleft site" .
2822 This document is part of
2824 the GNU roff distribution.
2827 .MTO bwarken@mayn.de "Bernd Warken" .
2830 \" --------------------------------------------------------------------
2832 .\" --------------------------------------------------------------------
2834 .\" Local Variables: