[ новости /+++ | форум | теги | ]

NAME

groffer - display groff files and man~pages on X and tty
 

SYNOPSIS

DESCRIPTION

OPTION OVERVIEW

breaking options

[t_[alt] -- apropos name] [t_[alt] -- apropos-data name] [t_[alt] -- apropos-devel name] [t_[alt] -- apropos-progs name] [t_[alt] - h -- help] [t_[alt] - v -- version]

groffer mode options

[t_[alt] -- auto] [t_[alt] -- default] [t_[alt] -- default-modes mode1,mode2,Ellipsis]] [t_[alt] -- dvi] [t_[alt] -- dvi-viewer prog] [t_[alt] -- groff] [t_[alt] -- html] [t_[alt] -- html-viewer prog] [t_[alt] -- man] [t_[alt] -- mode display_mode] [t_[alt] -- no-man] [t_[alt] -- pdf] [t_[alt] -- pdf-viewer prog] [t_[alt] -- ps] [t_[alt] -- ps-viewer prog] [t_[alt] -- text] [t_[alt] -- tty] [t_[alt] -- tty-viewer prog] [t_[alt] -- www] [t_[alt] -- www-viewer prog] [t_[alt] -- x -- X] [t_[alt] -- x-viewer -- X-viewer prog]

development options

[t_[alt] -- debug] [t_[alt] -- shell]

options related to groff

[t_[alt] - P -- postproc-arg opt_or_arg] [t_[alt] - Q -- source] [t_[alt] - T -- device device] [t_[alt] - Z -- intermediate-output -- ditroff] All further groff short options are accepted.

X Window toolkit options

[t_[alt] -- bd pixels] [t_[alt] -- bg -- background color] [t_[alt] -- bw pixels] [t_[alt] -- display X-display] [t_[alt] -- fg -- foreground color] [t_[alt] -- ft -- font font_name] [t_[alt] -- geometry size_pos] [t_[alt] -- resolution value] [t_[alt] -- rv] [t_[alt] -- title string] [t_[alt] -- xrm X_resource]

options from man

[t_[alt] -- all] [t_[alt] -- ascii] [t_[alt] -- ditroff] [t_[alt] -- extension suffix] [t_[alt] -- locale language] [t_[alt] -- local-file] [t_[alt] -- manpath dir1:dir2:Ellipsis]] [t_[alt] -- pager program] [t_[alt] -- sections sec1:sec2:Ellipsis]] [t_[alt] -- systems sys1,sys2,Ellipsis]] [t_[alt] -- troff-device device] [t_[alt] -- whatis] Further long options of GNU man are accepted as well.

filespec argument

No filespec parameters means standard input.

[t_short ]

stands for standard input (can occur several times).

filename

the path name of an existing file.

man:name(section)

name(section)

search the man~page name in man~section~section.

man:name.s

name.s

if s is a character in [1-9on], search for a man~page name in man~section s.

man:name

man~page in the lowest man~section that has name.

s name

if s is a character in [1-9on], search for a man~page name in man~section s.

name

if name is not an existing file search for the man~page name in the lowest man~section.

OPTION DETAILS

groffer breaking Options

groffer Mode Options

Select the automatic determination of the display mode. The sequence of modes that are tried can be set with the [t_long default-modes] option. Useful for restoring the default mode when a different mode was specified before.

Display formatted input in a dvi viewer program. By default, the formatted input is displayed with the xdvi(1) program. [t_long dvi]

After the file determination, switch groffer to process the input like groff(1) would do . This disables the groffer viewing features.

Translate the input into html format and display the result in a web browser program. By default, the existence of a sequence of standard web browsers is tested, starting with konqueror(1) and mozilla(1). The text html viewer is lynx(1).

Display formatted input in a PDF (Portable Document Format) viewer program. By default, the input is formatted by groff using the Postscript device, then it is transformed into the PDF file format using gs(1), and finally displayed either with the xpdf(1) or the acroread(1) program. PDF has a big advantage because the text is displayed graphically and is searchable as well. But as the transformation takes a considerable amount of time, this mode is not suitable as a default device for the auto mode.

Display formatted input in a Postscript viewer program. By default, the formatted input is displayed with the ghostview(1) program.

Format in a groff text mode and write the result to standard output without a pager or viewer program. The text device, latin1 by default, can be chosen with option [t_short T]

Format in a groff text mode and write the result to standard output using a text pager program, even when in X Window.

Equivalent to [t_long www]

Display formatted input in a native roff viewer. By default, the formatted input is displayed with the gxditview(1) program, being distributed together with groff, or with xditview(1), which is distributed as a standard X tool.

Equivalent to [t_long_arg mode X] The following modes do not use the groffer viewing features. They are only interesting for advanced applications.

Generate device output with plain groff without using the special viewing features of groffer. If no device was specified by option [t_short T] the groff default ps is assumed.

Display the source code of the input without formatting; equivalent to [t_short Q]

[t_--]

Signals the end of option processing; all remaining arguments are interpreted as filespec parameters. Besides these, groffer accepts all arguments that are valid for the groff(1) program. All non-groffer options are sent unmodified via grog to groff. Postprocessors, macro packages, compatibility with classical troff, and much more can be manually specified.

Options for Development

Options related to groff

X Window toolkit Options

Options from man

Filespec Arguments

OUTPUT MODES

Graphical Display Modes

Text mode

Special Modes for Debugging and Development

MAN~PAGE~SEARCHING

[t_long man]

forces to interpret all file parameters as filespecs for searching man~pages.

[t_long no-man]

[t_long local-file]

disable the man searching; so only local files are displayed. If neither a local file nor a man~page was retrieved for some file parameter a warning is issued on standard error, but processing is continued. The groffer program provides a search facility for man~pages. All long options, all environment variables, and most of the functionality of the GNU man(1) program were implemented. This inludes the extended file names of man~pages, for example, the man~page of groff in man~section 7 may be stored under where is part of the man~path, the subdirectory man7 and the file extension .7 refer to the man~section 7; .gz shows the compression of the file. The cat~pages (preformatted man~pages) are intentionally excluded from the search because groffer is a roff program that wants to format by its own. With the excellent performance of the actual computers, the preformatted man~pages aren't necessary any longer. The algorithm for retrieving man~pages uses five search methods. They are successively tried until a method works. The search path can be manually specified by using the option [t_long manpath] An empty argument disables the man~page searching. This overwrites the other methods. If this is not available the environment variable is searched. If this is empty, the program tries to read it from the environment variable If this does not work a reasonable default path from is searched for man~pages. If this does not work, the manpath(1) program for determining a path of man directories is tried. After this, the path elements for the language (locale) and operating system specific man~pages are added to the man~path; their sequence is determined automatically. For example, both /usr/share/man/linux/fr and /usr/share/man/fr/linux for french linux man~pages are found. The language and operating system names are determined from both environment variables and command line options. The locale (language) is determined like in GNU man, that is from highest to lowest precedence: [t_long locale] The language locale is usually specified in the POSIX 1003.1 based format: I]<language>][CB]_]I]<territory>][CB].]I]<character-set>][CB],]I]<version>]]]], but the two-letter code in <language> is sufficient for most purposes. If no man~pages for a complicated locale are found the country part consisting of the first two characters (without the `CB]_]', `CB].]', and `CB],]', parts) of the locale is searched as well. If still not found the corresponding man~page in the default language is used instead. As usual, this default can be specified by one of CR]C] or CR]POSIX]. The man~pages in the default language are usually in English. Several operating systems can be given by appending their names, separated by a comma. This is then specified by the environment variable or by the command line option [t_long systems] The precedence is similar to the locale case above from highest to lowest precedence: Topic [t_long systems] When searching for man~pages this man~path with the additional language and system specific directories is used. The search can further be restricted by limiting it to certain sections. A single section can be specified within each filespec argument, several sections as a colon-separated list in command line option [t_long sections] or environment variable When no section was specified a set of standard sections is searched until a suitable man~page was found. Finally, the search can be restricted to a so-called extension. This is a postfix that acts like a subsection. It can be specified by [t_long extension] or environment variable For further details on man~page searching, see man(1).

DECOMPRESSION

ENVIRONMENT

Native groffer Variables

Store options for a run of groffer. The options specified in this variable are overridden by the options given on the command line. The content of this variable is run through the shell builtin `eval'; so arguments containing white-space or special shell characters should be quoted.

System Variables

If this variable is set this indicates that the X Window system is running. Testing this variable decides on whether graphical or text output is generated. This variable should not be changed by the user carelessly, but it can be used to start the graphical groffer on a remote X terminal. For example, depending on your system, groffer can be started on the second monitor by the command

ell_cmd DISPLAY=:0.1~groffer~ what.ever

If one of these variables is set (in the above sequence), its content is interpreted as the locale, the language to be used, especially when retrieving man~pages. A locale name is typically of the form language[_territory[.codeset[@modifier]]], where language is an ISO 639 language code, territory is an ISO 3166 country code, and codeset is a character set or encoding identifier like ISO-8859-1 or UTF-8; see setlocale(3). The locale values~C and POSIX stand for the default, i.e. the man~page directories without a language prefix. This is the same behavior as when all 3~variables are unset.

This variable can be used to set the pager for the tty output. For example, to disable the use of a pager completely set this variable to the cat(1) program

ell_cmd PAGER=cat~groffer~ anything

All programs within the groffer shell script are called without a fixed path. Thus this environment variable determines the set of programs used within the run of groffer.

If set to a non-empty value this chooses the POSIX mode. This is done internally by some shells. 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 filespec arguments is used in any case. Usually, you do not want to set this environment variable externally.

Groff Variables

If the value of this variable is an existing, writable directory, groffer uses it for storing its temporary files, just as groff does.

Man Variables

Restrict the search for man~pages to files having this extension. This is overridden by option [t_long extension] see there for details.

This variable contains options as a preset for man(1). As not all of these are relevant for groffer only the essential parts of its value are extracted. The options specified in this variable overwrite the values of the other environment variables taht are specific to man. All options specified in this variable are overridden by the options given on the command line.

If set, this variable contains the directories in which the man~page trees are stored. This is overridden by option [t_longSegmentation fault (core dumped)

Поиск по тексту MAN-ов: 

Партнёры:

Хостинг:

Закладки на сайте Проследить за страницей

Created 1996-2024 by Maxim Chirkov Добавить, Поддержать, Вебмастеру