Commands

colcrt

[-] [-2] [file ]

This command is a hack to display underlines, tables, and other half-line intensive output on terminals that can't display underlines. It works by double-spacing the output and putting dashes on the empty line beneath the word that is to be underlined.

Example: Colcrt might be used to display the tbl.n table file as follows:

tbl tbl.n | nroff -ms | colcrt - | less

`-`	Do not underline. Typically used in displaying tables.
`-2`	Print all half-lines whether they're empty or not. (Leads to a uniform appearance, but eats up space.)

eqn

[ -rvCNR ] [ -dcc ] [ -Tname ] [ -Mdir ] [ -fF ] [ -sn] [ -pn ] [ -mn ] [ files ]

eqn is used in conjunction with troff to compile equation descriptions into troff format.

Example: To compile the file eqn.src, use

eqn eqn.src

`-C`	Enable enq to recognize .EQ and .EN even when followed by a character other than a space or newline.
`-N`	Do not allow newlines within delimiters.
`-v`	Display version information.
`-r`	Limit to one size reduction.
`-mn`	Specify minimum point size.
`-Tname`	Specify device name to which output will be sent.
`-Mdir`	Tell eqn to search dir for eqnrc before the default directories.
`-R`	Tell eqn not to load eqnrc.
`-fF`	Equivalent to a gfont F command.
`-sn`	Equivalent to a gsize n command.
`-pn`	Tell eqn to make superscripts and subscripts n points smaller than the surrounding text, rather than the default of 70% of the size of the surrounding text.

[ options ] [ files ]

gs stands for ghostscript. Ghostscript is the Linux version of the PostScript^TM typesetting language. This program can be used either for printing or display of documents to a monitor. Initial input is from source files as specified on the command line, but you may optionally enter further commands interactively.

Example: To print the ghostscript file example.gs to the printer hplj, use

gs -sDEVICE=hplj example.gs

`-- filenamearg1...`	Take the specified filename as an argument (as usual), but define all remaining arguments immediately as an array in userdict named ARGUMENTS.
`-Dname=token,-dname=token`	Add a name to systemdict with the given definition.
`-Dname, -dname`	Allow the user to define a name in systemdict with value = null.
`-Sname=string, -sname=string`	Allow the user to add a name to systemdict with the specified string as the value.
`-q`	Enable operation.
`-gnumber1xnumber2`	Specify a device width.
`-rnumber, -rnumber1xnumber2`	Specify a device resolution.
`-Idirectories`	Tell ghostscript that the specified directories are part of the search path for library files.
`-`	Specify to take standard input from a file or pipe.
`-dDISKFONTS`	Tell ghostscript to load individual character outlines from disk as they are encountered, rather then when the font is loaded. (Runs slower, but you can fit more fonts into RAM.)
`-dNOCACHE`	Disable caching of characters. (Used in debugging.)
`-dNOBIND`	Disable the "bind" operator. (Useful only for debugging.)
`-dNODISPLAY`	Disable initialization of output device.
`-dNOPAUSE`	Disable pause and prompt at page breaks.
`-dNOPLATFONTS`	Disable access to fonts provided by the platform (e.g., X-Windows).
`-dSAFER`	Disable deletefile and renamefile operators, make all files read only. Typically used when interacting with a spooler (Safe mode).
`-dWRITESYSTEMDICT`	Override default to leave systemdict writable.
`-sDEVICE=device`	Use the specified device as the initial output device.
`-sOutputFile=filename`	Send output to the specified file or pipe.

groff

[ -tpeszaivhblCENRSVXZ ] [ -wname ] [ -Wname ] [ -mname ] [ -Fdir ] [ -Tdev ] [ -ffam ] [ -Mdir ] [ -dcs ] [ -rcn ] [ -nnum ] [ -olist ] [ -Parg ] [ files ]

This command is the front end to the groff document formatting system. Typically, it invokes troff and some postprocessor. The particular postprocessor to be used should be specified in the device description file by the postpro command. The possible devices are as follows:

`ps`	PostScript (default device)
`dvi`	TeX dvi format
`X75`	75 dpi X11 previewer
`X100`	100 dpi X11 previewer
`ascii`	typewriter like device
`latin1`	typewriter like device using ISO Latin-1 character set
`lj4`	HP LaserJet4 or compatible device

Example: To display the groff example file example.man listed in the introduction to this chapter, type

groff -Tascii -man example.man

`-h`	Display help information.
`-e`	Preprocess with eqn.
`-t`	Preprocess with tbl.
`-p`	Preprocess with pic.
`-s`	Preprocess with soelim.
`-R`	Preprocess with refer.
`-v`	Force programs run by groff to display version number.
`-V`	Display the pipeline to stdout, rather than executing it.
`-z`	Suppress output from troff with the exception of error messages.
`-Z`	Suppress postprocessing of troff output.
`-Parg`	Pass the specified argument to the postprocessor.
`-l`	Send output to printer. (Note that the print command to be executed is found in the device description file.)
`-Larg`	Pass the specified argument to the spooler.
`-Tdev`	Tell groff to prepare output for the specified device.
`-X`	Enable previewing gxditview, rather than the usual postprocessor.
`-N`	Do not allow newlines with eqn delimiters.
`-S`	Run in safe(r) mode.
`-a`	Generate ASCII output.
`-b`	Display a backtrace with each warning or error.
`-i`	Tell troff to read from standard input when it is done processing files.
`-v`	Display version information.
`-wname`	Enable the specified warning.
`-W`	Disable the specified warning.
`-E`	Disable error messages.
`-z`	Suppress formatted output.
`-C`	Enable compatibility mode.
`-dcs,-dname=s`	Define c or name to be a string s; c must be a one-letter name.
`-ffam`	Specify fam is the default font family.
`-mname`	Read in the file tmac.name, rather than searching for it in /usr/lib/groff/tmac.
`-R`	Don't load troffrc.
`-nnum`	Specify a starting page number.
`-olist`	Output only the pages specified in list, a comma-separated list of page ranges.
`-rcn,-rname=n`	Set number register c or name to n.
`-Tdevice`	Tell troff to prepare output for the specified device, rather than ps.
`-Fdir`	Search the specified directory for subdirectories devname, the DESC file, and font files before searching the default (/usr/lib/groff/font).
`-Mdir`	Search the directory for macro files before the normal /usr/lib/groff/tmac.

grog

[ files ]

Guesses options for the groff command. grog will look at files and guess which of the options are needed to print a file.

Example: To get the system to make an educated guess as to which options are required to print the example.man file shown in the introduction, use

grog example.man

gxditview

[-toolkitoption ] [-option ] [filename]

This command is used to display groff output on an X display. It is somewhat interactive and graphical. The left mouse button brings up the following menu:

Next Page	Display the next page (also n, <space>, <Enter>).
Previous Page	Display the previous page (also p, <Backspace>, <Del>).
Select Page	Select a numbered page.
Print	Print the gtroff output.
Open	Open a new file.
Quit	Exit from gxditview.

Example: To display the foregoing sample file generated with gxditview, use

gxditview example

`-help`	Display help information.
`-page`	Display the specified page number of the document.
`-backingStorebacking-store-type`	Cache the window contents for quick display.
`-printCommandcommand`	Specify a default print command.
`-resolutionres`	Display at the specified resolution.
`-filenamestring`	Specify a default filename.

X Toolkit Options

`-bgcolor`	Specify a background color.
`-bdcolor`	Specify a border color.
`-bwnumber`	Specify border width.
`-fgcolor`	Specify a foreground (text) color.
`-fnfont`	Specify font.
`-rv`	Reverse videoswap foreground and background settings.
`-geometrygeometry`	Specify a preference for window size.
`-displayhost:display`	Specify host X server.
`-xrmresourcestring`	Use the specified resource string.

tbl

[ -Cv ] [ files ]

This command compiles descriptions of tables into troff commands.

Example: Typically invoked automatically by groff. To compile the file tbl.src, use

tbl tbl.src

`-C`	Recognize .TS and .TE even when followed by a character other than space or newline.
`-v`	Display version number.

tex

The tex command compiles (sort of) TeX source file into a displayable and printable.device independent (dvi) file.

Example: To compile the file example.tex into the device independent intermediate file example.dvi, use

tex example.tex

`-ipc, -ipc-start`	Write output to a socket as well as a .dvi file. With-ipc start, also open a server program to read the output.
`-mktex=FILETYPE, -no-mktex=FILETYPE`	Turn on or off the mktex, script associated with FILETYPE. (The only values that make sense for FILETYPE are tex and tfm.)
`-mltex`	If INITEX, enable MLTeX extensions such as \charsubdef. Implicitly set if the program name is mltex.
`-output-comment=STRING`	Use specified string as the DVI file comment.
`-shell-escap,`	Enable the \write18{SHELL-COMMAND} feature.

troff

[ -abivzCER ] [ -wname ] [ -Wname ] [ -dcs ] [ -ffam ] [ -mname ] [ -nnum ] [ -olist ] [ -rcn ] [ -Tname ] [ -Fdir ] [ -Mdir ] [ files ]

The troff command is used to format documents. Typically, it is invoked by groff.

`-a`	Generate ASCII output.
`-b`	Display a backtrace with each warning or error.
`-I`	Tell troff to read from standard input when it is done processing files.
`-v`	Display version information.
`-wname`	Enable the specified warning.
`-W`	Disable the specified warning.
`-E`	Disable error messages.
`-z`	Suppress formatted output.
`-C`	Enable compatibility mode.
`-dcs, -dname=s`	Define c or name to be a string s; c must be a one letter name.
`-ffam`	Specify fam is the default font family.
`-mname`	Read in the file tmac.name, rather than searching for it in /usr/lib/groff/tmac.
`-R`	Don't load troffrc.
`-nnum`	Specify a starting page number.
`-olist`	Output only the pages specified in list, a comma-separated list of page ranges.
`-rcn, -rname=n`	Set number register c or name to n.
`-Tdevice`	Tell troff to prepare output for the specified device, rather than ps.
`-Fdir`	Search the specified directory for subdirectories devname, the DESC file, and font files before searching the default (/usr/lib/groff/font).
`-Mdir`	Search the directory for macro files before the normal /usr/lib/groff/tmac.

xdvi

[+[page]] [-s shrink] [-S density] [-nogrey] [-gamma g] [-p pixels] [-margins dimen] [-sidemargin dimen] [-topmargin dimen] [-offsets dimen] [-xoffset dimen] [-yoffset dimen] [-paper papertype] [-altfont font] [-nomakepk] [-mfmode mode-def] [-l] [-rv] [-expert] [-mgs[n] size] [-hush] [-hushspecials] [-hushchars] [-hushchecksums] [-safer] [-fg color] [-bg color] [-hl color] [-bd color] [-cr color] [-bw width] [-grid1 color] [-grid2 color] [-grid3 color] [-bw width] [-display host:display] [-geometry geometry] [-icongeometry geometry] [-iconic] [-font font] [-keep] [-copy] [-thorough] [-nopostscript] [-noscan] [-allowshell] [-noghostscript] [-interpreter path] [-nogssafer] [-gspalette palette] [-underlink] [-browser WWWbrowser] [-base base URL] [-debug bitmask] [-version] [dvi_file]

This is the program used to display dvi files on the X-Window system. A .dvi file is an intermediate file that is used as a halfway point between the .tex source file and printed output. When displayed, the .dvi file is pretty much "what you see is what you get."

Example: To display the file example.dvi (see the tex entry for information on creating .dvi files), use

xdvi example.dvi

In my experience, the displayed .dvi files tend to be overlarge. Shrink them with the -s <factor> option.

`+page`	Specify the first page to show (+ = last page).
`-allowshell`	Enable the shell escape in PostScript specials.
`-altfontfont`	Specify a font to use when the normal font is missing.
`-backgroundcolor`	Specify background color.
`-basebase_URL`	Specify a base URL to which external URL links in the file are relative.
`-bdcolor,-bordercolor color`	Specify the color of the window border.
`-bgcolor`	Specify the color of the background.
`-borderwidthwidth, -bw`	Specify width of the border.
`-browserWWWbrowser`	Specify WWW browser used to handle external URLs.
`-copy (.copy)`	Always use the copy operation when writing characters to the display.
`-crcolor(.cursorColor)`	Specify the color of the cursor.
`-debugbitmask`	If nonzero, xdvi prints additional information on standard output.
`-densitydensity`	Specify the density used when shrinking bitmaps for fonts.
`-displayhost:display`	Specify host and screen used for displaying the .dvi file.
`-expert`	Prevent the buttons from appearing.
`-fgcolor`	Determine the color of the text (foreground).
`-foregroundcolor`	Determine the color of the text (foreground).(Same as -fg.)
`-fontfont`	Set the font for use in the buttons.
`-gammagamma`	Control the interpolation of colors in the greyscale anti-aliasing color palette.
`-grid1color`	Specify the color of level 1 grid.
`-grid2color`	Specify the color of level 2 grid.
`-grid3color`	Specify the color of level 3 grid.
`-geometrygeometry`	Specify initial geometry of the window.
`-gspalettepalette`	Specify the palette to be employed when using Ghostscript for rendering PostScript specials.
`-hlcolor`	Specify color of page border.
`-hush`	Suppress all suppressible warnings.
`-hushchars`	Suppress warnings about undefined characters.
`-hushchecksums`	Suppress warnings about checksum mismatches between the .dvi file and the font file.
`-hushspecials`	Suppress warnings about special strings that it cannot process.
`-icongeometry geometry`	Specify an initial position for the icon.
`-iconic`	Start the xdvi window in the iconic state.
`-interpreter filename`	Use filename as the ghostscript interpreter.
`-keep`	Do not move to home position when moving to a new page.
`-l`	List the names of the fonts to be used.
`-margins dimen`	Specify size of top margin & side margin.
`-mfmodemode-def`	Specify a mode-def string (used in searching for fonts).
`-mgssize`	Same as -mgs1, or specify a magnifying glass window of size 1.
`-mgs[n]size`	Specify the size of the magnifying glass window. Size is either an integer (from a square window) or in the form widthxheight.
`-noghostscript`	Inhibit the use of ghostscript for displaying.
`-nogrey`	Turn off greyscale anti-aliasing.
`-nogssafer`	Run ghostscript without -dSAFER. (-dSAFER is intended to cripple possibly malicious ghostscript programs by disabling such options as deletefile.)
`-nomakepk`	Turn off automatic generation of font files.
`-nopostscript`	Turn off rendering of PostScript^TM specials.
`-noscan`	Do not do a preliminary scan of the .dvi file.
`-offsetsdimen`	Specify size of horizontal and vertical offsets of the output on the page.
`-ppixels`	Define size of fonts to use (in pixels per inch).
`-paperpapertype`	Specify size of printed page.
`-rv`	Display page with white characters on a black background.
`-sshrink`	Specify initial shrink factor (default = 3).
`-Sdensity`	Same as -density, q.v.
`-safer`	Turn on all available security options.
`-sidemargindimen`	Specify the side margin.
`-thorough`	Display slower, but with a stronger guarantee of correctness.
`-topmargindimen`	Specify top and bottom margins.
`-underlink`	Underline http links (default).
`-version`	Display version information.
`-xoffsetdimen`	Specify size of horizontal offset of page output.
`-yoffsetdimen`	Specify size of vertical offset of the output on the page.