diff options
author | wlemb <wlemb> | 2004-06-12 13:26:57 +0000 |
---|---|---|
committer | wlemb <wlemb> | 2004-06-12 13:26:57 +0000 |
commit | c6cfec629eafd295e6923556fc1118756f6054f8 (patch) | |
tree | af6c0cf9e2d29ccc77660b9bb8e079be5243d508 | |
parent | 2c29a6b555d393f8beaa589181190c58714b4ce4 (diff) | |
download | groff-c6cfec629eafd295e6923556fc1118756f6054f8.tar.gz |
*** empty log message ***
-rw-r--r-- | contrib/groffer/groffer.man | 102 |
1 files changed, 72 insertions, 30 deletions
diff --git a/contrib/groffer/groffer.man b/contrib/groffer/groffer.man index 4f786f9c..9e7a0b70 100644 --- a/contrib/groffer/groffer.man +++ b/contrib/groffer/groffer.man @@ -15,7 +15,7 @@ groffer.1 - man page for groffer (section 1). Source file position: <groff_source_top>/contrib/groffer/groffer.man Installed position: $prefix/share/man/man1/groffer.1 -Last update : 1 June 2004 +Last update : 3 June 2004 Source file position: <groff-source>/contrib/groffer/groffer.man .. @@ -1712,10 +1712,14 @@ The default is looking up for local files. . . .Opt_def -- man -Check the non-option command line arguments (filespecs) first on being -man\~pages, then whether they represent an existing file. +Check the non-option command line arguments +.RI ( filespecs ) +first on being man\~pages, then whether they represent an existing +file. . -By default, a filespec is first tested whether it is an existing file. +By default, a +.I filespec +is first tested whether it is an existing file. . . .Opt_def -- no-man -- local-file @@ -1847,9 +1851,29 @@ parameter is an argument meaning an input source, such as a file name or template for searching man\~pages. . These input sources are collected and composed into a single output -file. +file such as +.I groff +does. +. +. +.P +The strange POSIX behavior that maps all arguments behind the first +non-option argument into +.I filespec +arguments is ignored. . -Each of these +The GNU behavior to recognize options even when mixed with +.I filespec +arguments is used througout. +. +But, as usual, the double minus argument +.Opt_long +still takes all following arguments as +.IR filespecs . +. +. +.P +Each .I filespec parameters can have one of the following forms. . @@ -2095,7 +2119,8 @@ X Window roff viewers such as .BR \%gxditview (@MAN1EXT@) or .BR \%xditview (1) -.RI (in x +(in +.I x or .I X mode), @@ -2614,11 +2639,20 @@ within the run of groffer. . .TP .Env_var $POSIXLY_CORRECT -If set to a non-empty value this chooses the POSIX mode for option -processing, that means that option processing will be finished as soon -as a non-option argument is found. +If set to a non-empty value this chooses the POSIX mode. . -Usually, you do not want to set this environment variable. +This is done internally by some shells. +. +.I groffer +ignores the bad POSIX behavior for option processing, that means that +option processing will be finished as soon as a non-option argument is +found. +. +Instead the GNU behavior of freely mixing options and +.I filespec +arguments is used in any case. +. +Usually, you do not want to set this environment variable externally. . . .\" -------------------------------------------------------------------- @@ -2765,6 +2799,13 @@ syntax. . . .P +The only option that needs a minus line in the configuration files is +.Opt_long shell . +The reason is that its argument must be called at a very early stage +before the whole syntax of the configuration can be transformed. +. +. +.P It makes sense to use these configuration files for the following tasks: . @@ -2799,9 +2840,10 @@ As an example, consider the following configuration file in # groffer configuration file # # groffer options that are used in each call of groffer +--shell=/bin/bash --resolution=100 --foreground=DarkBlue ---x-viewer 'gxditview -geometry 850x800' +--x-viewer='gxditview -geometry 850x800' # # some shell commands if test "$DISPLAY" = ""; then @@ -2814,7 +2856,7 @@ date >>~/mygroffer.log . . .P -This configuration sets three +This configuration sets four .I groffer options and runs two shell commands. . @@ -2829,7 +2871,15 @@ are . . .Topic -Use a resolution of +Use +.B /bin/bash +as the shell to run the +.I groffer +script. +. +. +.Topic +Take a resolution of .B 100 dpi and a text color of .B DarkBlue @@ -3037,8 +3087,7 @@ Most GNU shells are compatible with this interpretation of POSIX, but provide much more facilities. . Nevertheless this script uses only a restricted set of shell language -elements and shell builtins, such that it can be run on `ash', a GNU -shell that is quite fast, but has a slightly limited shell language. +elements and shell builtins. . The groffer script should work on most actual free and commercial operating systems. @@ -3053,7 +3102,6 @@ and a large set of special characters. .P The groffer shell script was tested with the following common implementations of the GNU shells: -.BR ash (1), POSIX .BR sh (1), .BR bash (1), @@ -3065,20 +3113,14 @@ systems are available at the . . .P -The best performance was obtained with the -.I ash -shell; so +The shell can be chosen by the option +.Opt_long shell . +This option can also be given to the environment variable +.Env_var $GROFF_OPT . +If you want to write it to one of the .I groffer -tries to run under -.I ash -whenever possible. -. -If -.I ash -is not available the shell under which the script was started in the -first place is used instead. -. -This can be modified by the option +configuration files you must use the single option style, a line +starting with .Opt_long shell . . . |