15 |
Source file position: <groff_source_top>/contrib/groffer/groffer.man |
Source file position: <groff_source_top>/contrib/groffer/groffer.man |
16 |
Installed position: $prefix/share/man/man1/groffer.1 |
Installed position: $prefix/share/man/man1/groffer.1 |
17 |
|
|
18 |
Last update: 22 August 2005 |
Last update: 07 Sep 2005 |
19 |
|
|
20 |
Source file position: <groff-source>/contrib/groffer/groffer.man |
Source file position: <groff-source>/contrib/groffer/groffer.man |
21 |
.. |
.. |
808 |
.Opt_[alt] -- default\-modes mode1,mode2,\*[Ellipsis] |
.Opt_[alt] -- default\-modes mode1,mode2,\*[Ellipsis] |
809 |
.Opt_[alt] -- dvi |
.Opt_[alt] -- dvi |
810 |
.Opt_[alt] -- dvi\-viewer prog |
.Opt_[alt] -- dvi\-viewer prog |
|
.Opt_[alt] -- dvi\-viewer\-tty prog |
|
811 |
.Opt_[alt] -- groff |
.Opt_[alt] -- groff |
812 |
.Opt_[alt] -- html |
.Opt_[alt] -- html |
813 |
.Opt_[alt] -- html\-viewer prog |
.Opt_[alt] -- html\-viewer prog |
|
.Opt_[alt] -- html\-viewer\-tty prog |
|
814 |
.Opt_[alt] -- mode display_mode |
.Opt_[alt] -- mode display_mode |
815 |
.Opt_[alt] -- pdf |
.Opt_[alt] -- pdf |
816 |
.Opt_[alt] -- pdf\-viewer prog |
.Opt_[alt] -- pdf\-viewer prog |
|
.Opt_[alt] -- pdf\-viewer\-tty prog |
|
817 |
.Opt_[alt] -- ps |
.Opt_[alt] -- ps |
818 |
.Opt_[alt] -- ps\-viewer prog |
.Opt_[alt] -- ps\-viewer prog |
|
.Opt_[alt] -- ps\-viewer\-tty prog |
|
819 |
.Opt_[alt] -- text |
.Opt_[alt] -- text |
820 |
.Opt_[alt] -- tty |
.Opt_[alt] -- tty |
821 |
.Opt_[alt] -- tty\-viewer prog |
.Opt_[alt] -- tty\-viewer prog |
|
.Opt_[alt] -- tty\-viewer\-tty prog |
|
822 |
.Opt_[alt] -- www |
.Opt_[alt] -- www |
823 |
.Opt_[alt] -- www\-viewer prog |
.Opt_[alt] -- www\-viewer prog |
|
.Opt_[alt] -- www\-viewer\- prog |
|
824 |
.Opt_[alt] -- x -- X |
.Opt_[alt] -- x -- X |
825 |
.Opt_[alt] -- x\-viewer -- X\-viewer prog |
.Opt_[alt] -- x\-viewer -- X\-viewer prog |
|
.Opt_[alt] -- x\-viewer\-tty -- X\-viewer\-tty prog |
|
|
.RE |
|
|
. |
|
|
. |
|
|
.TP |
|
|
.I development options |
|
|
.RS |
|
|
.P |
|
|
.Opt_[alt] -- debug |
|
|
.Opt_[alt] -- do\-nothing |
|
|
.Opt_[alt] -- shell prog |
|
|
.Opt_[alt] - Q -- source |
|
|
.Opt_[alt] - V |
|
826 |
.RE |
.RE |
827 |
. |
. |
828 |
. |
. |
892 |
. |
. |
893 |
. |
. |
894 |
.TP |
.TP |
895 |
|
.I options for development |
896 |
|
.RS |
897 |
|
.P |
898 |
|
.Opt_[alt] -- debug |
899 |
|
.Opt_[alt] -- debug\-all |
900 |
|
.Opt_[alt] -- debug\-filenames |
901 |
|
.Opt_[alt] -- debug\-func |
902 |
|
.Opt_[alt] -- debug\-keep |
903 |
|
.Opt_[alt] -- debug\-lm |
904 |
|
.Opt_[alt] -- debug\-params |
905 |
|
.Opt_[alt] -- debug\-shell |
906 |
|
.Opt_[alt] -- debug\-stacks |
907 |
|
.Opt_[alt] -- debug\-tmpdir |
908 |
|
.Opt_[alt] -- debug\-user |
909 |
|
.Opt_[alt] -- do\-nothing |
910 |
|
.Opt_[alt] -- shell prog |
911 |
|
.Opt_[alt] - Q -- source |
912 |
|
.Opt_[alt] - V |
913 |
|
.RE |
914 |
|
. |
915 |
|
. |
916 |
|
.TP |
917 |
.I \%filespec arguments |
.I \%filespec arguments |
918 |
.RS |
.RS |
919 |
.P |
.P |
1052 |
.I latin1 |
.I latin1 |
1053 |
under |
under |
1054 |
.B less |
.B less |
1055 |
on a terminal. |
on a terminal; a series of other modes are tested if the programs for |
1056 |
|
the main default mode do not exist. |
1057 |
. |
. |
1058 |
. |
. |
1059 |
.P |
.P |
1060 |
There are two kinds of options for viewers. |
In \%\f[CR]X\~Window\f[], |
1061 |
.Opt_long \fImode\fP-viewer |
.B groffer |
1062 |
chooses the normal viewer programs that run on their own in |
can run the viewer as an independent program in the background. |
|
\%\f[CR]X\~Window\f[], while |
|
|
.Opt_long \fImode\fP-viewer-tty |
|
|
chooses programs that run on the terminal (on tty). |
|
1063 |
. |
. |
1064 |
Most graphical viewers are programs running in \%\f[CR]X\~Window\f[], |
As this does not work in text mode on a terminal there must be a |
1065 |
so there aren't many opportunities to call the tty viewers. |
way to know which viewers are \%\f[CR]X\~Window\f[] graphical |
1066 |
|
programs. |
1067 |
. |
. |
1068 |
But they give the chance to view the output source; for example, |
The |
1069 |
.Opt_long ps\-viewer\-tty=less |
.B groffer |
1070 |
shows the content of the |
script has a small set of information on some viewer names. |
1071 |
.I Postscript |
. |
1072 |
output with the pager |
If a viewer argument of the command\-line chooses an element that is |
1073 |
.BR less . |
kept as \%\f[CR]X\~Window\f[] program in this list it is treated as a |
1074 |
|
viewer that can run in the background. |
1075 |
|
. |
1076 |
|
All other, unknown viewer calls are not run in the background. |
1077 |
. |
. |
1078 |
. |
. |
1079 |
.P |
.P |
1080 |
The \%\f[CR]X\~Window\f[] viewers are not critical, you can use both |
For each mode, you are free to choose whatever viewer you want. |
1081 |
.Opt_long *\-viewer |
. |
1082 |
|
That need not be some graphical viewer suitable for this mode. |
1083 |
|
. |
1084 |
|
There is a chance to view the output source; for example, the |
1085 |
|
combination of the options |
1086 |
|
.Opt_long mode=ps |
1087 |
and |
and |
1088 |
.Opt_long *\-viewer\-tty |
.Opt_long ps\-viewer=less |
1089 |
for them; with |
show the content of the |
1090 |
.Opt_long *\-viewer\-tty |
.I Postscript |
1091 |
the viewer program will not become independently, it just stays |
output with the pager |
1092 |
coupled with |
.BR less . |
|
.BR groffer . |
|
|
But the program will not run if you specify a terminal program with |
|
|
.Opt_long *\-viewer |
|
|
because this viewer will stay in background without a chance to reach |
|
|
it. |
|
|
. |
|
|
So you really need |
|
|
.Opt_long *\-viewer\-tty |
|
|
for viewers that run on tty. |
|
1093 |
. |
. |
1094 |
. |
. |
1095 |
.Opt_def -- auto |
.Opt_def -- auto |
1145 |
In each case, arguments can be provided additionally. |
In each case, arguments can be provided additionally. |
1146 |
. |
. |
1147 |
. |
. |
|
.Opt_def -- dvi\-viewer\-tty prog |
|
|
Choose a program running on the terminal for viewing the output of |
|
|
.IR \%dvi\~mode . |
|
|
. |
|
|
This can be a file name or a program to be searched in |
|
|
.Env_var $PATH ; |
|
|
arguments can be provided additionally. |
|
|
. |
|
|
. |
|
1148 |
.Opt_def -- groff |
.Opt_def -- groff |
1149 |
Equivalent to |
Equivalent to |
1150 |
.Opt_long_arg mode groff . |
.Opt_long_arg mode groff . |
1165 |
In each case, arguments can be provided additionally. |
In each case, arguments can be provided additionally. |
1166 |
. |
. |
1167 |
. |
. |
|
.Opt_def -- html\-viewer\-tty |
|
|
Choose a terminal program for viewing the output of |
|
|
.I \%html\~mode . |
|
|
. |
|
|
It can be the path name of an executable file or a program in |
|
|
.Env_var $PATH ; |
|
|
arguments can be provided additionally. |
|
|
. |
|
|
. |
|
1168 |
.Opt_def -- mode value |
.Opt_def -- mode value |
1169 |
. |
. |
1170 |
Set the display mode. |
Set the display mode. |
1381 |
arguments can be provided additionally. |
arguments can be provided additionally. |
1382 |
. |
. |
1383 |
. |
. |
|
.Opt_def -- pdf\-viewer\-tty prog |
|
|
Choose a terminal viewer program for |
|
|
.IR \%pdf\~mode . |
|
|
. |
|
|
This can be a file name or a program to be searched in |
|
|
.Env_var $PATH ; |
|
|
arguments can be provided additionally. |
|
|
. |
|
|
. |
|
1384 |
.Opt_def -- ps |
.Opt_def -- ps |
1385 |
Equivalent to |
Equivalent to |
1386 |
.Opt_long_arg mode ps . |
.Opt_long_arg mode ps . |
1402 |
In each case, arguments can be provided additionally. |
In each case, arguments can be provided additionally. |
1403 |
. |
. |
1404 |
. |
. |
|
.Opt_def -- ps\-viewer\-tty prog |
|
|
Choose a terminal viewer program for |
|
|
.IR \%ps\~mode . |
|
|
. |
|
|
This can be a file name or a program to be searched in |
|
|
.Env_var $PATH ; |
|
|
arguments can be provided additionally. |
|
|
. |
|
|
. |
|
1405 |
.Opt_def -- text |
.Opt_def -- text |
1406 |
Equivalent to |
Equivalent to |
1407 |
.Opt_long_arg mode text . |
.Opt_long_arg mode text . |
1426 |
arguments can be provided additionally. |
arguments can be provided additionally. |
1427 |
. |
. |
1428 |
. |
. |
|
.Opt_def -- tty\-viewer\-tty prog |
|
|
This is equivalent to |
|
|
.Opt_long tty\-viewer |
|
|
because the programs for |
|
|
.I tty |
|
|
mode run on a terminal anyway. |
|
|
. |
|
|
. |
|
1429 |
.Opt_def -- www |
.Opt_def -- www |
1430 |
Equivalent to |
Equivalent to |
1431 |
.Opt_long_arg mode html . |
.Opt_long_arg mode html . |
1436 |
.Opt_long html\-viewer . |
.Opt_long html\-viewer . |
1437 |
. |
. |
1438 |
. |
. |
|
.Opt_def -- www\-viewer\-tty prog |
|
|
Equivalent to |
|
|
.Opt_long html\-viewer\-tty . |
|
|
. |
|
|
. |
|
1439 |
.Opt_def -- X -- x |
.Opt_def -- X -- x |
1440 |
Equivalent to |
Equivalent to |
1441 |
.Opt_long_arg mode x . |
.Opt_long_arg mode x . |
1453 |
arguments can be provided additionally. |
arguments can be provided additionally. |
1454 |
. |
. |
1455 |
. |
. |
|
.Opt_def -- X\-viewer\-tty -- x\-viewer\-tty prog |
|
|
Choose a terminal viewer program for |
|
|
.IR \%x\~mode . |
|
|
The argument can be any executable file or a program in |
|
|
.Env_var $PATH ; |
|
|
arguments can be provided additionally. |
|
|
. |
|
|
. |
|
1456 |
.TP |
.TP |
1457 |
.Opt_-- |
.Opt_-- |
1458 |
Signals the end of option processing; all remaining arguments are |
Signals the end of option processing; all remaining arguments are |
1482 |
. |
. |
1483 |
. |
. |
1484 |
.\" -------------------------------------------------------------------- |
.\" -------------------------------------------------------------------- |
|
.SH "Options for Development" |
|
|
.\" -------------------------------------------------------------------- |
|
|
. |
|
|
.Opt_def -- debug |
|
|
Enable five debugging informations. |
|
|
. |
|
|
The temporary files are kept and not deleted, the name of the |
|
|
temporary directory and the shell name for |
|
|
.File_name groffer2.sh |
|
|
are printed, the parameters are printed at several steps of |
|
|
development, and a function stack is output with function |
|
|
\f[CR]error_user()\f[] as well. |
|
|
. |
|
|
Neither the function call stack that is printed at each opening and |
|
|
closing of a function call nor the landmark information that is |
|
|
printed to determine how far the program is running are used. |
|
|
. |
|
|
This seems to be the most useful among all debugging options. |
|
|
. |
|
|
. |
|
|
.Opt_def -- debug\-all |
|
|
Enable all seven debugging informations including the function call |
|
|
stack and the landmark information. |
|
|
. |
|
|
. |
|
|
.Opt_def -- debug\-keep |
|
|
Enable two debugging information, the printing of the name of the |
|
|
temporary directory and the keeping of the temporary files. |
|
|
. |
|
|
. |
|
|
.Opt_def -- debug\-lm |
|
|
Enable one debugging information, the landmark information. |
|
|
. |
|
|
. |
|
|
.Opt_def -- debug\-params |
|
|
Enable one debugging information, the parameters at several steps. |
|
|
. |
|
|
. |
|
|
.Opt_def -- debug\-shell |
|
|
Enable one debugging information, the shell name for |
|
|
.File_name groffer2.sh . |
|
|
. |
|
|
. |
|
|
.Opt_def -- debug\-stacks |
|
|
Enable one debugging information, the function call stack. |
|
|
. |
|
|
. |
|
|
.Opt_def -- debug\-tmpdir |
|
|
Enable one debugging information, the name of the temporary directory. |
|
|
. |
|
|
. |
|
|
.Opt_def -- debug\-user |
|
|
Enable one debugging information, the function stack with |
|
|
\f[CR]error_user()\f[]. |
|
|
. |
|
|
. |
|
|
.Opt_def -- do-nothing |
|
|
This is like |
|
|
.Opt_long version , |
|
|
but without the output; no viewer is started. |
|
|
. |
|
|
This makes only sense in development. |
|
|
. |
|
|
. |
|
|
.Opt_def -- print=text |
|
|
Just print the argument to standard error. |
|
|
. |
|
|
This is good for parameter check. |
|
|
. |
|
|
. |
|
|
.Opt_def -- shell "shell_program" |
|
|
Specify the shell under which the |
|
|
.File_name \%groffer2.sh |
|
|
script should be run. |
|
|
. |
|
|
This option overwrites the automatic shell determination of the |
|
|
program. |
|
|
. |
|
|
If the argument |
|
|
.I shell_program |
|
|
is empty a former shell option and the automatic shell determination |
|
|
is cancelled and the default shell is restored. |
|
|
. |
|
|
Some shells run considerably faster than the standard shell. |
|
|
. |
|
|
. |
|
|
.Opt_def - Q -- source |
|
|
Output the roff source code of the input files without further |
|
|
processing. |
|
|
. |
|
|
This is the equivalent |
|
|
.Opt_long_arg mode source . |
|
|
. |
|
|
. |
|
|
.Opt_def - V |
|
|
This is an advanced option for debugging only. |
|
|
. |
|
|
Instead of displaying the formatted input, a lot of |
|
|
.I \%groffer |
|
|
specific information is printed to standard output: |
|
|
. |
|
|
.RS |
|
|
.Topic |
|
|
the output file name in the temporary directory, |
|
|
. |
|
|
.Topic |
|
|
the display mode of the actual |
|
|
.B \%groffer |
|
|
run, |
|
|
. |
|
|
.Topic |
|
|
the display program for viewing the output with its arguments, |
|
|
. |
|
|
.Topic |
|
|
the active parameters from the config files, the arguments in |
|
|
.Env_var $GROFFER_OPT , |
|
|
and the arguments of the command line, |
|
|
. |
|
|
.Topic |
|
|
the pipeline that would be run by the |
|
|
.B \%groff |
|
|
program, but without executing it. |
|
|
.RE |
|
|
. |
|
|
. |
|
|
.P |
|
|
Other useful debugging options are the |
|
|
.B \%groff |
|
|
option |
|
|
.Opt_short Z |
|
|
and |
|
|
.Opt_long_arg mode groff . |
|
|
. |
|
|
. |
|
|
.\" -------------------------------------------------------------------- |
|
1485 |
.SH "Options related to groff" |
.SH "Options related to groff" |
1486 |
.\" -------------------------------------------------------------------- |
.\" -------------------------------------------------------------------- |
1487 |
. |
. |
2042 |
. |
. |
2043 |
. |
. |
2044 |
.\" -------------------------------------------------------------------- |
.\" -------------------------------------------------------------------- |
2045 |
|
.SH "Options for Development" |
2046 |
|
.\" -------------------------------------------------------------------- |
2047 |
|
. |
2048 |
|
.Opt_def -- debug |
2049 |
|
Enable seven debugging informations. |
2050 |
|
. |
2051 |
|
The temporary files are kept and not deleted, the name of the |
2052 |
|
temporary directory and the shell name for |
2053 |
|
.File_name groffer2.sh |
2054 |
|
are printed, the displayed file names are printed, the parameters are |
2055 |
|
printed at several steps of development, and a function stack is |
2056 |
|
output with function \f[CR]error_user()\f[] as well. |
2057 |
|
. |
2058 |
|
Neither the function call stack at the opening and closing of each |
2059 |
|
function call nor the landmark information to determine how far the |
2060 |
|
program is running are printed. |
2061 |
|
. |
2062 |
|
These seem to be the most useful parts among all debugging options. |
2063 |
|
. |
2064 |
|
. |
2065 |
|
.Opt_def -- debug\-all |
2066 |
|
Enable all nine debugging informations including the function call |
2067 |
|
stack and the landmark information. |
2068 |
|
. |
2069 |
|
. |
2070 |
|
.Opt_def -- debug\-filenames |
2071 |
|
Print the names of the files and |
2072 |
|
.I \%man\~pages |
2073 |
|
that are displayed by |
2074 |
|
.BR \&groffer . |
2075 |
|
. |
2076 |
|
. |
2077 |
|
.Opt_def -- debug\-func |
2078 |
|
Enable the basic debugging information for checking the functions on |
2079 |
|
the beginning and end of each call. |
2080 |
|
. |
2081 |
|
The options |
2082 |
|
.Opt_long debug\-stacks |
2083 |
|
and |
2084 |
|
.Opt_long debug\-user |
2085 |
|
enable this option automatically. |
2086 |
|
. |
2087 |
|
This option is important for the development, but it decreases the |
2088 |
|
speed of |
2089 |
|
.B groffer |
2090 |
|
by large amounts. |
2091 |
|
. |
2092 |
|
. |
2093 |
|
.Opt_def -- debug\-keep |
2094 |
|
Enable two debugging information, the printing of the name of the |
2095 |
|
temporary directory and the keeping of the temporary files. |
2096 |
|
. |
2097 |
|
. |
2098 |
|
.Opt_def -- debug\-lm |
2099 |
|
Enable one debugging information, the landmark information. |
2100 |
|
. |
2101 |
|
. |
2102 |
|
.Opt_def -- debug\-params |
2103 |
|
Enable one debugging information, the parameters at several steps. |
2104 |
|
. |
2105 |
|
. |
2106 |
|
.Opt_def -- debug\-shell |
2107 |
|
Enable one debugging information, the shell name for |
2108 |
|
.File_name groffer2.sh . |
2109 |
|
. |
2110 |
|
. |
2111 |
|
.Opt_def -- debug\-stacks |
2112 |
|
Enable one debugging information, the function call stack. |
2113 |
|
. |
2114 |
|
. |
2115 |
|
.Opt_def -- debug\-tmpdir |
2116 |
|
Enable one debugging information, the name of the temporary directory. |
2117 |
|
. |
2118 |
|
. |
2119 |
|
.Opt_def -- debug\-user |
2120 |
|
Enable one debugging information, the function stack with |
2121 |
|
\f[CR]error_user()\f[]. |
2122 |
|
. |
2123 |
|
. |
2124 |
|
.Opt_def -- do-nothing |
2125 |
|
This is like |
2126 |
|
.Opt_long version , |
2127 |
|
but without the output; no viewer is started. |
2128 |
|
. |
2129 |
|
This makes only sense in development. |
2130 |
|
. |
2131 |
|
. |
2132 |
|
.Opt_def -- print=text |
2133 |
|
Just print the argument to standard error. |
2134 |
|
. |
2135 |
|
This is good for parameter check. |
2136 |
|
. |
2137 |
|
. |
2138 |
|
.Opt_def -- shell "shell_program" |
2139 |
|
Specify the shell under which the |
2140 |
|
.File_name \%groffer2.sh |
2141 |
|
script should be run. |
2142 |
|
. |
2143 |
|
This option overwrites the automatic shell determination of the |
2144 |
|
program. |
2145 |
|
. |
2146 |
|
If the argument |
2147 |
|
.I shell_program |
2148 |
|
is empty a former shell option and the automatic shell determination |
2149 |
|
is cancelled and the default shell is restored. |
2150 |
|
. |
2151 |
|
Some shells run considerably faster than the standard shell. |
2152 |
|
. |
2153 |
|
. |
2154 |
|
.Opt_def - Q -- source |
2155 |
|
Output the roff source code of the input files without further |
2156 |
|
processing. |
2157 |
|
. |
2158 |
|
This is the equivalent |
2159 |
|
.Opt_long_arg mode source . |
2160 |
|
. |
2161 |
|
. |
2162 |
|
.Opt_def - V |
2163 |
|
This is an advanced option for debugging only. |
2164 |
|
. |
2165 |
|
Instead of displaying the formatted input, a lot of |
2166 |
|
.I \%groffer |
2167 |
|
specific information is printed to standard output: |
2168 |
|
. |
2169 |
|
.RS |
2170 |
|
.Topic |
2171 |
|
the output file name in the temporary directory, |
2172 |
|
. |
2173 |
|
.Topic |
2174 |
|
the display mode of the actual |
2175 |
|
.B \%groffer |
2176 |
|
run, |
2177 |
|
. |
2178 |
|
.Topic |
2179 |
|
the display program for viewing the output with its arguments, |
2180 |
|
. |
2181 |
|
.Topic |
2182 |
|
the active parameters from the config files, the arguments in |
2183 |
|
.Env_var $GROFFER_OPT , |
2184 |
|
and the arguments of the command line, |
2185 |
|
. |
2186 |
|
.Topic |
2187 |
|
the pipeline that would be run by the |
2188 |
|
.B \%groff |
2189 |
|
program, but without executing it. |
2190 |
|
.RE |
2191 |
|
. |
2192 |
|
. |
2193 |
|
.P |
2194 |
|
Other useful debugging options are the |
2195 |
|
.B \%groff |
2196 |
|
option |
2197 |
|
.Opt_short Z |
2198 |
|
and |
2199 |
|
.Opt_long_arg mode groff . |
2200 |
|
. |
2201 |
|
. |
2202 |
|
.\" -------------------------------------------------------------------- |
2203 |
.SS "Filespec Arguments" |
.SS "Filespec Arguments" |
2204 |
.\" -------------------------------------------------------------------- |
.\" -------------------------------------------------------------------- |
2205 |
. |
. |