title: groff_out(5)

summary: groff intermediate output format

text:
# groff_out(5)

## NAME
groff_out - groff intermediate output format

## DESCRIPTION
This manual page describes the intermediate output format of the GNU roff(7) text processing system groff(1). This output is produced by a run of the GNU troff(1) program. It contains already all device-specific information, but it is not yet fed into a device postprocessor program.

As the GNU roff processor groff(1) is a wrapper program around troff that automatically calls a postprocessor, this output does not show up normally. This is why it is called intermediate within the groff system. The groff program provides the option -Z to inhibit postprocessing, such that the produced intermediate output is sent to standard output just like calling troff manually.

In this document, the term troff output describes what is output by the GNU troff program, while intermediate output refers to the language that is accepted by the parser that prepares this output for the postprocessors. This parser is smarter on whitespace and implements obsolete elements for compatibility, otherwise both formats are the same. Both formats can be viewed directly with gxditview(1).

The main purpose of the intermediate output concept is to facilitate the development of postprocessors by providing a common programming interface for all devices. It has a language of its own that is completely different from the groff(7) language. While the groff language is a high-level programming language for text processing, the intermediate output language is a kind of low-level assembler language by specifying all positions on the page for writing and drawing.

The pre-groff roff versions are denoted as classical troff. The intermediate output produced by groff is fairly readable, while classical troff output was hard to understand because of strange habits that are still supported, but not used any longer by GNU troff.

## LANGUAGE CONCEPTS
During the run of troff, the roff input is cracked down to the information on what has to be printed at what position on the intended device. So the language of the intermediate output format can be quite small. Its only elements are commands with or without arguments. In this document, the term “command” always refers to the intermediate output language, never to the roff language used for document formatting. There are commands for positioning and text writing, for drawing, and for device controlling.

### Separation
Classical troff output had strange requirements on whitespace. The groff output parser, however, is smart about whitespace by making it maximally optional. The whitespace characters, i.e., the tab, space, and newline characters, always have a syntactical meaning. They are never printable because spacing within the output is always done by positioning commands.

Any sequence of space or tab characters is treated as a single syntactical space. It separates commands and arguments, but is only required when there would occur a clashing between the command code and the arguments without the space. Most often, this happens when variable length command names, arguments, argument lists, or command clusters meet. Commands and arguments with a known, fixed length need not be separated by syntactical space.

A line break is a syntactical element, too. Every command argument can be followed by whitespace, a comment, or a newline character. Thus a syntactical line break is defined to consist of optional syntactical space that is optionally followed by a comment, and a newline character.

The normal commands, those for positioning and text, consist of a single letter taking a fixed number of arguments. For historical reasons, the parser allows to stack such commands on the same line, but fortunately, in groff intermediate output, every command with at least one argument is followed by a line break, thus providing excellent readability.

The other commands — those for drawing and device controlling — have a more complicated structure; some recognize long command names, and some take a variable number of arguments. So all D and x commands were designed to request a syntactical line break after their last argument. Only one command, ‘x X’ has an argument that can stretch over several lines, all other commands must have all of their arguments on the same line as the command, i.e., the arguments may not be split by a line break.

Empty lines, i.e., lines containing only space and/or a comment, can occur everywhere. They are just ignored.

### Argument Units
Some commands take integer arguments that are assumed to represent values in a measurement unit, but the letter for the corresponding scale indicator is not written with the output command arguments; see groff(7) and the groff info file for more on this topic. Most commands assume the scale indicator u, the basic unit of the device, some use z, the scaled point unit of the device, while others, such as the color commands expect plain integers. Note that these scale indicators are relative to the chosen device. They are defined by the parameters specified in the device's DESC file; see groff_font(5).

Note that single characters can have the eighth bit set, as can the names of fonts and special characters (this is, glyphs). The names of glyphs and fonts can be of arbitrary length. A glyph that is to be printed will always be in the current font.

A string argument is always terminated by the next whitespace character (space, tab, or newline); an embedded # character is regarded as part of the argument, not as the beginning of a comment command. An integer argument is already terminated by the next non-digit character, which then is regarded as the first character of the next argument or command.

### Document Parts
A correct intermediate output document consists of two parts, the prologue and the body.

The task of the prologue is to set the general device parameters using three exactly specified commands. The groff prologue is guaranteed to consist of the following three lines (in that order):

x T device

x res n h v

x init

with the arguments set as outlined in the section Device Control Commands. However, the parser for the intermediate output format is able to swallow additional whitespace and comments as well.

The body is the main section for processing the document data. Syntactically, it is a sequence of any commands different from the ones used in the prologue. Processing is terminated as soon as the first x stop command is encountered; the last line of any groff intermediate output always contains such a command.

Semantically, the body is page oriented. A new page is started by a p command. Positioning, writing, and drawing commands are always done within the current page, so they cannot occur before the first p command. Absolute positioning (by the H and V commands) is done relative to the current page, all other positioning is done relative to the current location within this page.

## COMMAND REFERENCE
This section describes all intermediate output commands, the classical commands as well as the groff extensions.

### Comment Command
\#anything⟨end-of-line⟩

A comment. Ignore any characters from the # character up to the next newline character.

This command is the only possibility for commenting in the intermediate output. Each comment can be preceded by arbitrary syntactical space; every command can be terminated by a comment.

### Simple Commands
The commands in this subsection have a command code consisting of a single character, taking a fixed number of arguments. Most of them are commands for positioning and text writing. These commands are smart about whitespace. Optionally, syntactical space can be inserted before, after, and between the command letter and its arguments. All of these commands are stackable, i.e., they can be preceded by other simple commands or followed by arbitrary other commands on the same line. A separating syntactical space is only necessary when two integer arguments would clash or if the preceding argument ends with a string argument.

C xxx⟨white-space⟩

Print a glyph (special character) named xxx. The trailing syntactical space or line break is necessary to allow glyph names of arbitrary length. The glyph is printed at the current print position; the glyph's size is read from the font file. The print position is not changed.

c c

Print glyph with single-letter name c at the current print position; the glyph's size is read from the font file. The print position is not changed.

f n

Set font to font number n (a non-negative integer).

H n

Move right to the absolute vertical position n (a non-negative integer in basic units u) relative to left edge of current page.

h n

Move n (a non-negative integer) basic units u horizontally to the right. [CSTR #54] allows negative values for n also, but groff doesn't use this.

m color-scheme [component ...]

Set the color for text (glyphs), line drawing, and the outline of graphic objects using different color schemes; the analogous command for the filling color of graphic objects is DF. The color components are specified as integer arguments between 0 and 65536. The number of color components and their meaning vary for the different color schemes. These commands are generated by the groff escape sequence \m. No position changing. These commands are a groff extension.

mc cyan magenta yellow

Set color using the CMY color scheme, having the 3 color components cyan, magenta, and yellow.

md

Set color to the default color value (black in most cases). No component arguments.

mg gray

Set color to the shade of gray given by the argument, an integer between 0 (black) and 65536 (white).

mk cyan magenta yellow black

Set color using the CMYK color scheme, having the 4 color components cyan, magenta, yellow, and black.

mr red green blue

Set color using the RGB color scheme, having the 3 color components red, green, and blue.

N n

Print glyph with index n (an integer, normally non-negative) of the current font. The print position is not changed. If -T html or -T xhtml is used, negative values are emitted also to indicate an unbreakable space with given width. For example, N -193 represents an unbreakable space which has a width of 193u. This command is a groff extension.

n b a

Inform the device about a line break, but no positioning is done by this command. In classical troff, the integer arguments b and a informed about the space before and after the current line to make the intermediate output more human readable without performing any action. In groff, they are just ignored, but they must be provided for compatibility reasons.

p n

Begin a new page in the outprint. The page number is set to n. This page is completely independent of pages formerly processed even if those have the same page number. The vertical position on the outprint is automatically set to 0. All positioning, writing, and drawing is always done relative to a page, so a p command must be issued before any of these commands.

s n

Set point size to n scaled points (this is unit z in GNU troff). Classical troff used the unit points (p) instead; see section COMPATIBILITY.

t xyz...⟨white-space⟩

t xyz... dummy-arg⟨white-space⟩

Print a word, i.e., a sequence of glyphs with single-letter names x, y, z, etc., terminated by a space character or a line break; an optional second integer argument is ignored (this allows the formatter to generate an even number of arguments). The first glyph should be printed at the current position, the current horizontal position should then be increased by the width of the first glyph, and so on for each glyph. The widths of the glyph are read from the font file, scaled for the current point size, and rounded to a multiple of the horizontal resolution. Special characters (glyphs with names longer than a single letter) cannot be printed using this command; use the C command for those glyphs. This command is a groff extension; it is only used for devices whose DESC file contains the tcommand keyword; see groff_font(5).

u n xyz...⟨white-space⟩

Print word with track kerning. This is the same as the t command except that after printing each glyph, the current horizontal position is increased by the sum of the width of that glyph and n (an integer in basic units u). This command is a groff extension; it is only used for devices whose DESC file contains the tcommand keyword; see groff_font(5).

V n

Move down to the absolute vertical position n (a non-negative integer in basic units u) relative to upper edge of current page.

v n

Move n basic units u down (n is a non-negative integer). [CSTR #54] allows negative values for n also, but groff doesn't use this.

w

Informs about a paddable whitespace to increase readability. The spacing itself must be performed explicitly by a move command.

### Graphics Commands
Each graphics or drawing command in the intermediate output starts with the letter D followed by one or two characters that specify a subcommand; this is followed by a fixed or variable number of integer arguments that are separated by a single space character. A D command may not be followed by another command on the same line (apart from a comment), so each D command is terminated by a syntactical line break.

troff output follows the classical spacing rules (no space between command and subcommand, all arguments are preceded by a single space character), but the parser allows optional space between the command letters and makes the space before the first argument optional. As usual, each space can be any sequence of tab and space characters.

Some graphics commands can take a variable number of arguments. In this case, they are integers representing a size measured in basic units u. The h arguments stand for horizontal distances where positive means right, negative left. The v arguments stand for vertical distances where positive means down, negative up. All these distances are offsets relative to the current location.

Unless indicated otherwise, each graphics command directly corresponds to a similar groff \D escape sequence; see groff(7).

Unknown D commands are assumed to be device-specific. Its arguments are parsed as strings; the whole information is then sent to the postprocessor.

In the following command reference, the syntax element ⟨line-break⟩ means a syntactical line break as defined in section Separation.

D~ h1 v1 h2 v2 ... hn vn⟨line-break⟩

Draw B-spline from current position to offset (h1, v1), then to offset (h2, v2) if given, etc., up to (hn, vn). This command takes a variable number of argument pairs; the current position is moved to the terminal point of the drawn curve.

Da h1 v1 h2 v2⟨line-break⟩

Draw arc from current position to (h1, v1)+ (h2, v2) with center at (h1, v1); then move the current position to the final point of the arc.

DC d⟨line-break⟩

DC d dummy-arg⟨line-break⟩

Draw a solid circle using the current fill color with diameter d (integer in basic units u) with leftmost point at the current position; then move the current position to the rightmost point of the circle. An optional second integer argument is ignored (this allows to the formatter to generate an even number of arguments). This command is a groff extension.

Dc d⟨line-break⟩

Draw circle line with diameter d (integer in basic units u) with leftmost point at the current position; then move the current position to the rightmost point of the circle.

DE h v⟨line-break⟩

Draw a solid ellipse in the current fill color with a horizontal diameter of h and a vertical diameter of v (both integers in basic units u) with the leftmost point at the current position; then move to the rightmost point of the ellipse. This command is a groff extension.

De h v⟨line-break⟩

Draw an outlined ellipse with a horizontal diameter of h and a vertical diameter of v (both integers in basic units u) with the leftmost point at current position; then move to the rightmost point of the ellipse.

DF color-scheme [component ...]⟨line-break⟩

Set fill color for solid drawing objects using different color schemes; the analogous command for setting the color of text, line graphics, and the outline of graphic objects is m. The color components are specified as integer arguments between 0 and 65536. The number of color components and their meaning vary for the different color schemes. These commands are generated by the groff escape sequences \D'F ...' and \M (with no other corresponding graphics commands). No position changing. This command is a groff extension.

DFc cyan magenta yellow⟨line-break⟩

Set fill color for solid drawing objects using the CMY color scheme, having the 3 color components cyan, magenta, and yellow.

DFd ⟨line-break⟩

Set fill color for solid drawing objects to the default fill color value (black in most cases). No component arguments.

DFg gray⟨line-break⟩

Set fill color for solid drawing objects to the shade of gray given by the argument, an integer between 0 (black) and 65536 (white).

DFk cyan magenta yellow black⟨line-break⟩

Set fill color for solid drawing objects using the CMYK color scheme, having the 4 color components cyan, magenta, yellow, and black.

DFr red green blue⟨line-break⟩

Set fill color for solid drawing objects using the RGB color scheme, having the 3 color components red, green, and blue.

Df n⟨line-break⟩

The argument n must be an integer in the range -32767 to 32767.

0≤n≤1000

Set the color for filling solid drawing objects to a shade of gray, where 0 corresponds to solid white, 1000 (the default) to solid black, and values in between to intermediate shades of gray; this is obsoleted by command DFg.

n<0 or n>1000

Set the filling color to the color that is currently being used for the text and the outline, see command m. For example, the command sequence

```
mg 0 0 65536
Df -1

```

sets all colors to blue.

No position changing. This command is a groff extension.

Dl h v⟨line-break⟩

Draw line from current position to offset (h, v) (integers in basic units u); then set current position to the end of the drawn line.

Dp h1 v1 h2 v2 ... hn vn⟨line-break⟩

Draw a polygon line from current position to offset (h1, v1), from there to offset (h2, v2), etc., up to offset (hn, vn), and from there back to the starting position. For historical reasons, the position is changed by adding the sum of all arguments with odd index to the actual horizontal position and the even ones to the vertical position. Although this doesn't make sense it is kept for compatibility. This command is a groff extension.

DP h1 v1 h2 v2 ... hn vn⟨line-break⟩

The same macro as the corresponding Dp command with the same arguments, but draws a solid polygon in the current fill color rather than an outlined polygon. The position is changed in the same way as with Dp. This command is a groff extension.

Dt n⟨line-break⟩

Set the current line thickness to n (an integer in basic units u) if n>0; if n=0 select the smallest available line thickness; if n<0 set the line thickness proportional to the point size (this is the default before the first Dt command was specified). For historical reasons, the horizontal position is changed by adding the argument to the actual horizontal position, while the vertical position is not changed. Although this doesn't make sense it is kept for compatibility. This command is a groff extension.

### Device Control Commands
Each device control command starts with the letter x followed by a space character (optional or arbitrary space/tab in groff) and a subcommand letter or word; each argument (if any) must be preceded by a syntactical space. All x commands are terminated by a syntactical line break; no device control command can be followed by another command on the same line (except a comment).

The subcommand is basically a single letter, but to increase readability, it can be written as a word, i.e., an arbitrary sequence of characters terminated by the next tab, space, or newline character. All characters of the subcommand word but the first are simply ignored. For example, troff outputs the initialization command x i as x init and the resolution command x r as x res. But writings like x i_like_groff and x roff_is_groff are accepted as well to mean the same commands.

In the following, the syntax element ⟨line-break⟩ means a syntactical line break as defined in section Separation.

xF name⟨line-break⟩

(Filename control command)

Use name as the intended name for the current file in error reports. This is useful for remembering the original file name when groff uses an internal piping mechanism. The input file is not changed by this command. This command is a groff extension.

xf n s⟨line-break⟩

(font control command)

Mount font position n (a non-negative integer) with font named s (a text word), cf. groff_font(5).

xH n⟨line-break⟩

(Height control command)

Set character height to n (a positive integer in scaled points z). Classical troff used the unit points (p) instead; see section COMPATIBILITY.

xi ⟨line-break⟩

(init control command)

Initialize device. This is the third command of the prologue.

xp ⟨line-break⟩

(pause control command)

Parsed but ignored. The classical documentation reads pause device, can be restarted.

xr n h v⟨line-break⟩

(resolution control command)

Resolution is n, while h is the minimal horizontal motion, and v the minimal vertical motion possible with this device; all arguments are positive integers in basic units u per inch. This is the second command of the prologue.

xS n⟨line-break⟩

(Slant control command)

Set slant to n degrees (an integer in basic units u).

xs ⟨line-break⟩

(stop control command)

Terminates the processing of the current file; issued as the last command of any intermediate troff output.

xt ⟨line-break⟩

(trailer control command)

Generate trailer information, if any. In groff, this is actually just ignored.

xT xxx⟨line-break⟩

(Typesetter control command)

Set name of device to word xxx, a sequence of characters ended by the next whitespace character. The possible device names coincide with those from the groff -T option. This is the first command of the prologue.

xu n⟨line-break⟩

(underline control command)

Configure underlining of spaces. If n is 1, start underlining of spaces; if n is 0, stop underlining of spaces. This is needed for the cu request in nroff mode and is ignored otherwise. This command is a groff extension.

xX anything⟨line-break⟩

(X-escape control command)

Send string anything uninterpreted to the device. If the line following this command starts with a + character this line is interpreted as a continuation line in the following sense. The + is ignored, but a newline character is sent instead to the device, the rest of the line is sent uninterpreted. The same applies to all following lines until the first character of a line is not a + character. This command is generated by the groff escape sequence \X. The line-continuing feature is a groff extension.

### Obsolete Command
In classical troff output, emitting a single glyph was mostly done by a very strange command that combined a horizontal move and the printing of a glyph. It didn't have a command code, but is represented by a 3-character argument consisting of exactly 2 digits and a character.

ddc

Move right dd (exactly two decimal digits) basic units u, then print glyph with single-letter name c.

In groff, arbitrary syntactical space around and within this command is allowed to be added. Only when a preceding command on the same line ends with an argument of variable length a separating space is obligatory. In classical troff, large clusters of these and other commands were used, mostly without spaces; this made such output almost unreadable.

For modern high-resolution devices, this command does not make sense because the width of the glyphs can become much larger than two decimal digits. In groff, this is only used for the devices X75, X75-12, X100, and X100-12. For other devices, the commands t and u provide a better functionality.

## POSTPROCESSING
The roff postprocessors are programs that have the task to translate the intermediate output into actions that are sent to a device. A device can be some piece of hardware such as a printer, or a software file format suitable for graphical or text processing. The groff system provides powerful means that make the programming of such postprocessors an easy task.

There is a library function that parses the intermediate output and sends the information obtained to the device via methods of a class with a common interface for each device. So a groff postprocessor must only redefine the methods of this class. For details, see the reference in section FILES.

## EXAMPLES
This section presents the intermediate output generated from the same input for three different devices. The input is the sentence hell world fed into groff on the command line.

•

High-resolution device ps

```
shell> echo "hell world" | groff -Z -T ps
```

```
x T ps
x res 72000 1 1
x init
p1
x font 5 TR
f5
s10000
V12000
H72000
thell
wh2500
tw
H96620
torld
n12000 0
x trailer
V792000
x stop
```

This output can be fed into the postprocessor grops(1) to get its representation as a PostScript file, or gropdf(1) to output directly to PDF.

•

Low-resolution device latin1

This is similar to the high-resolution device except that the positioning is done at a minor scale. Some comments (lines starting with #) were added for clarification; they were not generated by the formatter.

```
shell> "hell world" | groff -Z -T latin1
```

```
# prologue
x T latin1
x res 240 24 40
x init
# begin a new page
p1
# font setup
x font 1 R
f1
s10
# initial positioning on the page
V40
H0
# write text ‘hell’
thell
# inform about a space, and do it by a horizontal jump
wh24
# write text ‘world’
tworld
# announce line break, but do nothing because ...
n40 0
# ... the end of the document has been reached
x trailer
V2640
x stop
```

This output can be fed into the postprocessor grotty(1) to get a formatted text document.

•

Classical style output

As a computer monitor has a very low resolution compared to modern printers the intermediate output for the X devices can use the jump-and-write command with its 2-digit displacements.

```
shell> "hell world" | groff -Z -T X100
```

```
x T X100
x res 100 1 1
x init
p1
x font 5 TR
f5
s10
V16
H100
# write text with old-style jump-and-write command
ch07e07l03lw06w11o07r05l03dh7
n16 0
x trailer
V1100
x stop
```

This output can be fed into the postprocessor xditview(1x) or gxditview(1) for displaying in X.

Due to the obsolete jump-and-write command, the text clusters in the classical output are almost unreadable.

## COMPATIBILITY
The intermediate output language of the classical troff was first documented in [CSTR #97]. The groff intermediate output format is compatible with this specification except for the following features.

•

The classical quasi device independence is not yet implemented.

•

The old hardware was very different from what we use today. So the groff devices are also fundamentally different from the ones in classical troff. For example, the classical PostScript device was called post and had a resolution of 720 units per inch, while groff's ps device has a resolution of 72000 units per inch. Maybe, by implementing some rescaling mechanism similar to the classical quasi device independence, these could be integrated into modern groff.

•

The B-spline command D~ is correctly handled by the intermediate output parser, but the drawing routines aren't implemented in some of the postprocessor programs.

•

The argument of the commands s and x H has the implicit unit scaled point z in groff, while classical troff had point (p). This isn't an incompatibility, but a compatible extension, for both units coincide for all devices without a sizescale parameter, including all classical and the groff text devices. The few groff devices with a sizescale parameter either did not exist, had a different name, or seem to have had a different resolution. So conflicts with classical devices are very unlikely.

•

The position changing after the commands Dp, DP, and Dt is illogical, but as old versions of groff used this feature it is kept for compatibility reasons.

The differences between groff and classical troff are documented in groff_diff(7).

## FILES
/usr/share/groff/1.22.3/font/devname/DESC

Device description file for device name.

⟨groff-source-dir⟩/src/libs/libdriver/input.cpp

Defines the parser and postprocessor for the intermediate output. It is located relative to the top directory of the groff source tree. This parser is the definitive specification of the groff intermediate output format.

## SEE ALSO
A reference like groff(7) refers to a manual page; here groff in section 7 of the man-page documentation system. To read the example, look up section 7 in your desktop help system or call from the shell prompt

```
shell> man 7 groff
```

For more details, see man(1).

groff(1)

option -Z and further readings on groff.

groff(7)

for details of the groff language such as numerical units and escape sequences.

groff_font(5)

for details on the device scaling parameters of the DESC file.

troff(1)

generates the device-independent intermediate output.

roff(7)

for historical aspects and the general structure of roff systems.

groff_diff(7)

The differences between the intermediate output in groff and classical troff.

gxditview(1)

Viewer for the intermediate output.

grodvi(1), grohtml(1), grolbp(1), grolj4(1), grops(1), grotty(1)

the groff postprocessor programs.

For a treatment of all aspects of the groff system within a single document, see the groff info file. It can be read within the integrated help systems, within emacs(1) or from the shell prompt by

```
shell> info groff
```

The classical troff output language is described in two AT&T Bell Labs CSTR documents available on-line at Bell Labs CSTR site.

[CSTR #97]

A Typesetter-independent TROFF by Brian Kernighan is the original and most comprehensive documentation on the output language; see CSTR #97.

[CSTR #54]

The 1992 revision of the Nroff/Troff User's Manual by J. F. Ossanna and Brian Kernighan isn't as comprehensive as [CSTR #97] regarding the output language; see CSTR #54.

## COPYING
Copyright © 1989-2014 Free Software Foundation, Inc.

This file is part of groff, the GNU roff type-setting system, which is a free software project.

Permission is granted to copy, distribute and/or modify this document under the terms of the GNU Free Documentation License, Version 1.3 or any later version published by the Free Software Foundation; with no Invariant Sections, with no Front-Cover Texts, and with no Back-Cover Texts.

A copy of the Free Documentation License is included as a file called FDL in the main directory of the groff source package, it is also available in the internet at GNU FDL license.

## AUTHORS
In 2001, this document was rewritten from scrach by Bernd Warken.


package: groff-extra

title: groff_tmac(5)

text:
# groff_tmac(5)

## NAME
groff_tmac - macro files in the roff typesetting system

## DESCRIPTION
The roff(7) type-setting system provides a set of macro packages suitable for special kinds of documents. Each macro package stores its macros and definitions in a file called the package's tmac file. The name is deduced from ‘TroffMACros’.

The tmac files are normal roff source documents, except that they usually contain only definitions and setup commands, but no text. All tmac files are kept in a single or a small number of directories, the tmac directories.

## GROFF MACRO PACKAGES
groff provides all classical macro packages, some more full packages, and some secondary packages for special purposes. Note that it is not possible to use multiple primary macro packages at the same time; saying e.g.

```
sh# groff -m man -m ms foo

```

or

```
sh# groff -m man foo -m ms bar

```

fails. Exception to this is the use of man pages written with either the mdoc or the man macro package. See below the description of the andoc.tmac file.

### Man Pages
man

This is the classical macro package for UNIX manual pages (man pages); it is quite handy and easy to use; see groff_man(7).

doc

mdoc

An alternative macro package for man pages mainly used in BSD systems; it provides many new features, but it is not the standard for man pages; see groff_mdoc(7).

andoc

mandoc

Use this file in case you don't know whether the man macros or the mdoc package should be used. Multiple man pages (in either format) can be handled.

### Full Packages
The packages in this section provide a complete set of macros for writing documents of any kind, up to whole books. They are similar in functionality; it is a matter of taste which one to use.

me

The classical me macro package; see groff_me(7).

mm

The semi-classical mm macro package; see groff_mm(7).

mom

The new mom macro package, only available in groff. As this is not based on other packages, it can be freely designed. So it is expected to become quite a nice, modern macro package. See groff_mom(7).

ms

The classical ms macro package; see groff_ms(7).

### Language-specific Packages
cs

This file adds support for Czech localization, including the main macro packages (me, mom, mm, and ms).

Note that cs.tmac sets the input encoding to latin-2.

de

den

German localization support, including the main macro packages (me, mom, mm, and ms).

de.tmac selects hyphenation patterns for traditional orthography, and den.tmac does the same for the new orthography (‘Rechtschreibreform’). It should be used as the last macro package on the command line.

fr

This file adds support for French localization, including the main macro packages (me, mom, mm, and ms). Example:

```
sh# groff -ms -mfr foo.ms > foo.ps

```

Note that fr.tmac sets the input encoding to latin-9 to get proper support of the ‘oe’ ligature.

sv

Swedish localization support, including the me, mom, and ms macro packages. Note that Swedish for the mm macros is handled separately; see groff_mmse(7). It should be used as the last macro package on the command line.

### Input Encodings
latin1

latin2

latin5

latin9

Various input encodings supported directly by groff. Normally, this macro is loaded at the very beginning of a document or specified as the first macro argument on the command line. roff loads latin1 by default at start-up. Note that these macro packages don't work on EBCDIC hosts.

cp1047

Encoding support for EBCDIC. On those platforms it is loaded automatically at start-up. Due to different character ranges used in roff it doesn't work on architectures which are based on ASCII.

Note that it can happen that some input encoding characters are not available for a particular output device. For example, saying

```
groff -Tlatin1 -mlatin9 ...
```

fails if you use the Euro character in the input. Usually, this limitation is present only for devices which have a limited set of output glyphs (-Tascii, -Tlatin1); for other devices it is usually sufficient to install proper fonts which contain the necessary glyphs.

### Special Packages
The macro packages in this section are not intended for stand-alone usage, but can be used to add special functionality to any other macro package or to plain groff.

62bit

Provide some macros for addition, multiplication, and division of 60bit integers (allowing safe multiplication of 31bit integers, for example).

ec

Switch to the EC and TC font families. To be used with grodvi(1) – this man page also gives more details of how to use it.

papersize

This macro file is already loaded at start-up by troff so it isn't necessary to call it explicitly. It provides an interface to set the paper size on the command line with the option -dpaper=size. Possible values for size are the same as the predefined papersize values in the DESC file (only lowercase; see groff_font(5) for more) except a7–d7. An appended l (ell) character denotes landscape orientation. Examples: a4, c3l, letterl.

Most output drivers need additional command line switches -p and -l to override the default paper length and orientation as set in the driver specific DESC file. For example, use the following for PS output on A4 paper in landscape orientation:

```
sh# groff -Tps -dpaper=a4l -P-pa4 -P-l -ms foo.ms > foo.ps

```

pic

This file provides proper definitions for the macros PS and PE, needed for the pic(1) preprocessor. They center each picture. Use it only if your macro package doesn't provide proper definitions for those two macros (actually, most of them already do).

pspic

A single macro is provided in this file, PSPIC, to include a PostScript graphic in a document. The following output devices support inclusion of PS images: -Tps, -Tdvi, -Thtml, and -Txhtml; for all other devices the image is replaced with a hollow rectangle of the same size. This macro file is already loaded at start-up by troff so it isn't necessary to call it explicitly.

Syntax:

.PSPIC [-L|-R|-C|-I n] file [width [height]]

file is the name of the PostScript file; width and height give the desired width and height of the image. If neither a width nor a height argument is specified, the image's natural width (as given in the file's bounding box) or the current line length is used as the width, whatever is smaller. The width and height arguments may have scaling indicators attached; the default scaling indicator is i. This macro scales the graphic uniformly in the x and y directions so that it is no more than width wide and height high. Option -C centers the graphic horizontally, which is the default. The -L and -R options cause the graphic to be left-aligned and right-aligned, respectively. The -I option causes the graphic to be indented by n (default scaling indicator is m).

For use of .PSPIC within a diversion it is recommended to extend it with the following code, assuring that the diversion's width completely covers the image's width.

```
.am PSPIC
.  vpt 0
\h'(\\n[ps-offset]u + \\n[ps-deswid]u)'
.  sp -1
.  vpt 1
..

```

ptx

A single macro is provided in this file, xx, for formatting permuted index entries as produced by the GNU ptx(1) program. In case you need a different formatting, copy the macro into your document and adapt it to your needs.

trace

Use this for tracing macro calls. It is only useful for debugging. See groff_trace(7).

tty-char

Overrides the definition of standard troff characters and some groff characters for TTY devices. The optical appearance is intentionally inferior compared to that of normal TTY formatting to allow processing with critical equipment.

www

Additions of elements known from the HTML format, as used in the internet (World Wide Web) pages; this includes URL links and mail addresses; see groff_www(7).

## NAMING
Classical roff systems were designed before the conventions of the modern C getopt(3) call evolved, and used a naming scheme for macro packages that looks odd to modern eyes. Macro packages were always included with the option -m; when this option was directly followed by its argument without an intervening space, this looked like a long option preceded by a single minus — a sensation in the computer stone age. To make this invocation form work, classical troff macro packages used names that started with the letter ‘m’, which was omitted in the naming of the macro file.

For example, the macro package for the man pages was called man, while its macro file tmac.an. So it could be activated by the argument an to option -m, or -man for short.

For similar reasons, macro packages that did not start with an ‘m’ had a leading ‘m’ added in the documentation and in speech; for example, the package corresponding to tmac.doc was called mdoc in the documentation, although a more suitable name would be doc. For, when omitting the space between the option and its argument, the command line option for activating this package reads -mdoc.

To cope with all situations, actual versions of groff(1) are smart about both naming schemes by providing two macro files for the inflicted macro packages; one with a leading ‘m’ the other one without it. So in groff, the man macro package may be specified as on of the following four methods:

```
sh# groff -m man
sh# groff -man
sh# groff -mman
sh# groff -m an

```

Recent packages that do not start with ‘m’ do not use an additional ‘m’ in the documentation. For example, the www macro package may be specified only as one of the two methods:

```
sh# groff -m www
sh# groff -mwww

```

Obviously, variants like -mmwww would not make much sense.

A second strange feature of classical troff was to name macro files in the form tmac.name. In modern operating systems, the type of a file is specified as a postfix, the file name extension. Again, groff copes with this situation by searching both anything.tmac and tmac.anything if only anything is specified.

The easiest way to find out which macro packages are available on a system is to check the man page groff(1), or the contents of the tmac directories.

In groff, most macro packages are described in man pages called groff_name(7), with a leading ‘m’ for the classical packages.

## INCLUSION
There are several ways to use a macro package in a document. The classical way is to specify the troff/groff option -m name at run-time; this makes the contents of the macro package name available. In groff, the file name.tmac is searched within the tmac path; if not found, tmac.name is searched for instead.

Alternatively, it is also possible to include a macro file by adding the request .so filename into the document; the argument must be the full file name of an existing file, possibly with the directory where it is kept. In groff, this was improved by the similar request .mso package, which added searching in the tmac path, just like option -m does.

Note that in order to resolve the .so and .mso requests, the roff preprocessor soelim(1) must be called if the files to be included need preprocessing. This can be done either directly by a pipeline on the command line or by using the troff/groff option -s. man calls soelim automatically.

For example, suppose a macro file is stored as

/usr/share/groff/1.22.3/tmac/macros.tmac

and is used in some document called docu.roff.

At run-time, the formatter call for this is

```
sh# groff -m macros docu.roff

```

To include the macro file directly in the document either

```
.mso macros.tmac

```

is used or

```
.so /usr/share/groff/1.22.3/tmac/macros.tmac

```

In both cases, the formatter should be called with option -s to invoke soelim.

```
sh# groff -s docu.roff

```

If you want to write your own groff macro file, call it whatever.tmac and put it in some directory of the tmac path, see section FILES. Then documents can include it with the .mso request or the option -m.

## WRITING MACROS
A roff(7) document is a text file that is enriched by predefined formatting constructs, such as requests, escape sequences, strings, numeric registers, and macros from a macro package. These elements are described in roff(7).

To give a document a personal style, it is most useful to extend the existing elements by defining some macros for repeating tasks; the best place for this is near the beginning of the document or in a separate file.

Macros without arguments are just like strings. But the full power of macros reveals when arguments are passed with a macro call. Within the macro definition, the arguments are available as the escape sequences \$1, ..., \$9, \$[...], \$*, and \$@, the name under which the macro was called is in \$0, and the number of arguments is in register \n[.$]; see groff(7).

### Copy-in Mode
The phase when groff reads a macro is called copy-in mode or copy mode in roff-talk. This is comparable to the C preprocessing phase during the development of a program written in the C language.

In this phase, groff interprets all backslashes; that means that all escape sequences in the macro body are interpreted and replaced by their value. For constant expressions, this is wanted, but strings and registers that might change between calls of the macro must be protected from being evaluated. This is most easily done by doubling the backslash that introduces the escape sequence. This doubling is most important for the positional parameters. For example, to print information on the arguments that were passed to the macro to the terminal, define a macro named ‘.print_args’, say.

```
.ds midpart was called with
.de print_args
.  tm \f[I]\\$0\f[] \*[midpart] \\n[.$] arguments:
.  tm \\$*
..

```

When calling this macro by

```
.print_args arg1 arg2

```

the following text is printed to the terminal:

```
print_args was called with the following 2 arguments:
arg1 arg2

```

Let's analyze each backslash in the macro definition. As the positional parameters and the number of arguments change with each call of the macro their leading backslash must be doubled, which results in \\$* and \\[.$]. The same applies to the macro name because it could be called with an alias name, so \\$0.

On the other hand, midpart is a constant string, it does not change, so no doubling for \*[midpart]. The \f escape sequences are predefined groff elements for setting the font within the text. Of course, this behavior does not change, so no doubling with \f[I] and \f[].

### Draft Mode
Writing groff macros is easy when the escaping mechanism is temporarily disabled. In groff, this is done by enclosing the macro definition(s) into a pair of .eo and .ec requests. Then the body in the macro definition is just like a normal part of the document — text enhanced by calls of requests, macros, strings, registers, etc. For example, the code above can be written in a simpler way by

```
.eo
.ds midpart was called with
.de print_args
.  tm \f[I]\$0\f[] \*[midpart] \n[.$] arguments:
.  tm \$*
..
.ec

```

Unfortunately, draft mode cannot be used universally. Although it is good enough for defining normal macros, draft mode fails with advanced applications, such as indirectly defined strings, registers, etc. An optimal way is to define and test all macros in draft mode and then do the backslash doubling as a final step; do not forget to remove the .eo request.

### Tips for Macro Definitions
•

Start every line with a dot, for example, by using the groff request .nop for text lines, or write your own macro that handles also text lines with a leading dot.

```
.de Text
.  if (\\n[.$] == 0) \
.    return
.  nop \)\\$*\)
..

```

•

Write a comment macro that works both for copy-in and draft mode; for as escaping is off in draft mode, trouble might occur when normal comments are used. For example, the following macro just ignores its arguments, so it acts like a comment line:

```
.de c
..
.c This is like a comment line.

```

- In long macro definitions, make ample use of comment lines or almost-empty lines (this is, lines which have a leading dot and nothing else) for a better structuring.

- To increase readability, use groff's indentation facility for requests and macro calls (arbitrary whitespace after the leading dot).

### Diversions
Diversions can be used to implement quite advanced programming constructs. They are comparable to pointers to large data structures in the C programming language, but their usage is quite different.

In their simplest form, diversions are multi-line strings, but they get their power when diversions are used dynamically within macros. The (formatted) information stored in a diversion can be retrieved by calling the diversion just like a macro.

Most of the problems arising with diversions can be avoided if you remain aware of the fact that diversions always store complete lines. If diversions are used when the line buffer has not been flushed, strange results are produced; not knowing this, many people get desperate about diversions. To ensure that a diversion works, line breaks should be added at the right places. To be on the secure side, enclose everything that has to do with diversions into a pair of line breaks; for example, by explicitly using .br requests. This rule should be applied to diversion definition, both inside and outside, and to all calls of diversions. This is a bit of overkill, but it works nicely.

[If you really need diversions which should ignore the current partial line, use environments to save the current partial line and/or use the .box request.]

The most powerful feature using diversions is to start a diversion within a macro definition and end it within another macro. Then everything between each call of this macro pair is stored within the diversion and can be manipulated from within the macros.

## FILES
All macro names must be named name.tmac to fully use the tmac mechanism. tmac.name as with classical packages is possible as well, but deprecated.

The macro files are kept in the tmac directories; a colon separated list of these constitutes the tmac path.

The search sequence for macro files is (in that order):

- the directories specified with troff/groff's -M command line option

- the directories given in the $GROFF_TMAC_PATH environment variable

- the current directory (only if in unsafe mode, which is enabled by the -U command line switch)

- the home directory

- a platform-specific directory, being

/usr/lib64/groff/site-tmac

in this installation

•

a site-specific (platform-independent) directory, being

/usr/share/groff/site-tmac

in this installation

•

the main tmac directory, being

/usr/share/groff/1.22.3/tmac

in this installation

## ENVIRONMENT
$GROFF_TMAC_PATH

A colon separated list of additional tmac directories in which to search for macro files. See the previous section for a detailed description.

## SEE ALSO
A complete reference for all parts of the groff system is found in the groff info(1) file.

groff(1)

an overview of the groff system.

groff_man(7),

groff_mdoc(7),

groff_me(7),

groff_mm(7),

groff_mom(7),

groff_ms(7),

groff_trace(7),

groff_www(7).

the groff tmac macro packages.

groff(7)

the groff language.

The Filesystem Hierarchy Standard is available at the FHS web site.

## COPYING
Copyright © 2000-2014 Free Software Foundation, Inc.

This file is part of groff, the GNU roff type-setting system.

Permission is granted to copy, distribute and/or modify this document under the terms of the GNU Free Documentation License, Version 1.3 or any later version published by the Free Software Foundation; with no Front-Cover Texts, and with no Back-Cover Texts.

A copy of the Free Documentation License is included as a file called FDL in the main directory of the groff source package, it is also available on-line at the GNU copyleft site.

## AUTHOR
This file was written by Bernd Warken and Werner Lemberg.


title: lj4_font(5)

summary: groff fonts for use with devlj4

text:
# lj4_font(5)

## NAME
lj4_font - groff fonts for use with devlj4

## DESCRIPTION
Nominally, all Hewlett-Packard LaserJet 4–series and newer printers have the same internal fonts: 45 scalable fonts and one bitmapped Lineprinter font. The scalable fonts are available in sizes between 0.25 point and 999.75 points, in 0.25-point increments; the Lineprinter font is available only in 8.5-point size.

The LaserJet font files included with groff assume that all printers since the LaserJet 4 are identical. There are some differences between fonts in the earlier and more recent printers, however. The LaserJet 4 printer used Agfa Intellifont technology for 35 of the internal scalable fonts; the remaining 10 scalable fonts were TrueType. Beginning with the LaserJet 4000–series printers introduced in 1997, all scalable internal fonts have been TrueType. The number of printable glyphs differs slightly between Intellifont and TrueType fonts (generally, the TrueType fonts include more glyphs), and there are some minor differences in glyph metrics. Differences among printer models are described in the PCL 5 Comparison Guide and the PCL 5 Comparison Guide Addendum (for printers introduced since approximately 2001).

LaserJet printers reference a glyph by a combination of a 256-glyph symbol set and an index within that symbol set. Many glyphs appear in more than one symbol set; all combinations of symbol set and index that reference the same glyph are equivalent. For each glyph, hpftodit(1) searches a list of symbol sets, and selects the first set that contains the glyph. The printing code generated by hpftodit(1) is an integer that encodes a numerical value for the symbol set in the high byte(s), and the index in the low byte. See groff_font(5) for a complete description of the font file format; symbol sets are described in greater detail in the PCL 5 Printer Language Technical Reference Manual.

Two of the scalable fonts, Symbol and Wingdings, are bound to 256-glyph symbol sets; the remaining scalable fonts, as well as the Lineprinter font, support numerous symbol sets, sufficient to enable printing of more than 600 glyphs.

The metrics generated by hpftodit(1) assume that the DESC file contains values of 1200 for res and 6350 for unitwidth (or any combination (e.g., 2400 and 3175) for which res × unitwidth = 7620000). Although HP PCL 5 LaserJet printers support an internal resolution of 7200 units per inch, they use a 16-bit signed integer for cursor positioning; if devlj4 is to support U.S. ledger paper (11" × 17"), the maximum usable resolution is 32767 / 17, or 1927, units per inch, which rounds down to 1200 units per inch. If the largest required paper size is less (e.g., 8.5" × 11" or A5), a greater resolution (and lesser unitwidth) can be specified.

## LIMITATIONS
Font metrics for Intellifont fonts were provided by Tagged Font Metric (TFM) files originally developed by Agfa/Compugraphic. The TFM files provided for these fonts supported 600+ glyphs and contained extensive lists of kern pairs.

To accommodate developers who had become accustomed to TFM files, HP also provided TFM files for the 10 TrueType fonts included in the LaserJet 4. The TFM files for TrueType fonts generally included less information than the Intellifont TFMs, supporting fewer glyphs, and in most cases, providing no kerning information. By the time the LaserJet 4000 printer was introduced, most developers had migrated to other means of obtaining font metrics, and support for new TFM files was very limited. The TFM files provided for the TrueType fonts in the LaserJet 4000 support only the Latin 2 (ISO 8859-2) symbol set, and include no kerning information; consequently, they are of little value for any but the most rudimentary documents.

Because the Intellifont TFM files contain considerably more information, they generally are preferable to the TrueType TFM files even for use with the TrueType fonts in the newer printers. The metrics for the TrueType fonts are very close, though not identical, to those for the earlier Intellifont fonts of the same names. Although most output using the Intellifont metrics with the newer printers is quite acceptable, a few glyphs may fail to print as expected. The differences in glyph metrics may be particularly noticeable with composite parentheses, brackets, and braces used by eqn(1). A script, located in /usr/share/groff/1.22.3/font/devlj4/generate, can be used to adjust the metrics for these glyphs in the special font S for use with printers that have all TrueType fonts.

At the time HP last supported TFM files, only Version 1 of the Unicode standard was available. Consequently, many glyphs lacking assigned code points were assigned by HP to the Private Use Area (PUA). Later versions of the Unicode standard included code points outside the PUA for many of these glyphs. The HP-supplied TrueType TFM files use the PUA assignments; TFM files generated from more recent TrueType font files require the later Unicode values to access the same glyphs. Consequently, two different mapping files may be required: one for the HP-supplied TFM files, and one for more recent TFM files.

## FILES
/usr/share/groff/1.22.3/font/devlj4/DESC

Device description file.

/usr/share/groff/1.22.3/font/devlj4/F

Font description file for font F.

## SEE ALSO
groff(1), groff_diff(1), hpftodit(1), grolj4(1), groff_font(5)

## COPYING
Copyright © 2004-2014 Free Software Foundation, Inc.

Permission is granted to make and distribute verbatim copies of this manual provided the copyright notice and this permission notice are preserved on all copies.

Permission is granted to copy and distribute modified versions of this manual under the conditions for verbatim copying, provided that the entire resulting derived work is distributed under the terms of a permission notice identical to this one.

Permission is granted to copy and distribute translations of this manual into another language, under the above conditions for modified versions, except that this permission notice may be included in translations approved by the Free Software Foundation instead of in the original English.


gssproxy.conf

package: gssproxy

title: gssproxy.conf(5)

summary: GssProxy Daemon Configuration file

text:
# gssproxy.conf(5)

## NAME
gssproxy.conf - GssProxy Daemon Configuration file

## DESCRIPTION
Optional configuration directives for the gssproxy daemon.

GSS-Proxy conf files are classic ini-style configuration files. Each option consist of a key = value pair. Any characters behind '#' will be treated as comments and will be ignored. Boolean parameters accept "1", "true", "yes" and "on" as positive values. All other values will be considered as negative values.

GSS-Proxy conf files must either be named "gssproxy.conf", or be of the form "##-foo.conf" (that is, start with two numbers followed by a dash, and end in ".conf"). Files not conforming to this will be ignored unless specifically requested through command line parameters. Within a single file, any duplicate values or sections will be merged. Across multiple files, duplicates will generate a warning, and the first value encountered will take precedence (i.e., there is no merging).

## SECTIONS
A section in a GSS-Proxy conf file is identified by the sectionname in square brackets ([sectionname]).

There is one special section for global gssproxy settings, called [gssproxy].

Services such as nfs, apache, ssh, etc. are represented by sections like [service/nfs], [service/apache], etc. and are identified by the "euid" setting (see below).

## VARIABLE SUBSTITUTIONS
String parameters may contain substitution patterns. This allows gssproxy to deal with patterns for the storage location of keytabs or credential caches easier.

The supported patterns are:

%U

substitutes to the user's numeric uid (e.g. 123)

%u

substitutes to the user's username (e.g. john).

## OPTIONS
gssproxy supports the following options:

allow_any_uid (boolean)

Allow any process of any user to use this service. Note that absent a custom socket option this option may cause a service definition to mask access to following services. To avoid issues change the order of services in your configuation file so that services with allow_any_uid enabled are listed last, or define a custom socket for other services.

Default: false

allow_protocol_transition (boolean)

Allow clients to request a ticket to self for an arbitrary user. This option controls whether s4u2self requests are allowed for the requesting client. The configured keytab is used as the service identity for which a ticket is requested. The KDC still needs to allow the operation for it to succeed.

Default: false

allow_constrained_delegation (boolean)

Allow clients to request a ticket to another service using an evidence ticket. This option controls whether s4u2proxy requests are allowed for the requesting client. The KDC still needs to allow the operation for it to succeed.

Default: false

allow_client_ccache_sync (boolean)

Allow clients to request credentials to be sent back for better caching. This option allows the proxy, in certain circumstances, to send back an additional option in the response structure of certain calls when it determines that a new ticket may have been added to the internal ccache. Clients can then replace their (encrypted) copy with the updated ccache.

Default: false

cred_store (string)

This parameter allows to control in which way gssproxy should use the cred_store interface provided by GSSAPI. The parameter can be defined multiple times per service. The syntax of the cred_store parameter is as follows: cred_store = <cred_store_option>:<cred_store_value>

Currently this interface supports the following options:

keytab

Defines the keytab the service should use. Example: cred_store = keytab:/path/to/keytab

client_keytab

Defines a client keytab the service should use. Example: cred_store = client_keytab:/path/to/client_keytab.

ccache

Defines a credential cache the service should use. Example: cred_store = ccache:/path/to/ccache.

Notably the client_keytab and the ccache setting typically are used with variable substitution placeholders (see above). For example:

```
    cred_store = keytab:/etc/krb5.keytab

    cred_store = ccache:FILE:/var/lib/gssproxy/krb5cc_%U

    cred_store = client_keytab:/var/lib/gssproxy/%U.keytab
```

Default: cred_store =

cred_usage (string)

Allow to restrict the kind of operations permitted for this service. The allowed options are: initiate, accept, both

Default: cred_usage = both

debug (boolean)

Enable debugging to syslog. Setting to true is identical to setting debug_level to 1. Default: debug = false

debug_level (integer)

Detail level at which to log debugging messages. 0 corresponds to no logging, while 1 turns on basic debug logging. Level 2 increases verbosity, including more detailed credential verification. At level 3 and above, KRB5_TRACE output is logged. If KRB5_TRACE was already set in the execution environment, trace output is sent to its value instead. Refer to docs/KRB5_TRACE.md for more information.

Default: 1 if debug is true, otherwise 0

enforce_flags (string)

A list of GSS Request Flags that are added unconditionally to every context initialization call. Flags can only be added to the list or removed from the list by prepending a +/- sign to the flag name or value. Recognized flag names: DELEGATE, MUTUAL_AUTH, REPLAY_DETECT, SEQUENCE, CONFIDENTIALITY, INTEGRITY, ANONYMOUS

Examples:

```
    enforce_flags = +REPLAY_DETECT

    enforce_flags = -0x0001
```

Default: enforce_flags =

euid (integer or string)

Either the numeric (e.g., 48) or symbolic (e.g., apache) effective uid of a running process, required to identify a service. The "euid" parameter is imperative, any section without it will be discarded.

Default: euid =

filter_flags (string)

A list of GSS Request Flags that are filtered unconditionally from every context initialization call. Flags can only be added to the list or removed from the list by prepending a +/- sign to the flag name or value. NOTE: Because often gssproxy is used to withold access to credentials the Delegate Flag is filtered by default. To allow a service to delegate credentials use the first example below.

Recognized flag names: DELEGATE, MUTUAL_AUTH, REPLAY_DETECT, SEQUENCE, CONFIDENTIALITY, INTEGRITY, ANONYMOUS

Examples:

```
    filter_flags = -DELEGATE

    filter_flags = -0x0001 +ANONYMOUS
```

Default: filter_flags = +DELEGATE

impersonate (boolean)

Use impersonation (s4u2self + s4u2proxy) to obtain credentials Default: impersonate = false

kernel_nfsd (boolean)

Boolean flag that allows the Linux kernel to check if gssproxy is running (via /proc/net/rpc/use-gss-proxy). Default: kernel_nfsd = false

krb5_principal (string)

The krb5 principal to be used preferred for this service, if one isn't requested by the application. Note that this does not enforce use of this specific name; it only sets a default. Default: krb5_principal =

mechs (string)

Currently only krb5 is supported. The "mechs" parameter is imperative, any section without it will be discarded.

Default: mechs =

min_lifetime (integer)

Minimum lifetime of a cached credential, in seconds. If non-zero, when gssproxy is deciding whether to use a cached credential, it will compare the lifetime of the cached credential to this value. If the lifetime of the cached credential is lower, gssproxy will treat the cached credential as expired and will attempt to obtain a new credential.

Default: min_lifetime = 15

program (string)

If specified, this service will only match when the program being run is the specified string. Programs are assumed to be specified as canonical paths (i.e., no relative paths, no symlinks). Additionally, the '|' character is reserved for future use and therefore forbidden.

run_as_user (string)

The name of the user gssproxy will drop privileges to. This option is only available in the global section.

Default: run_as_user =

selinux_context (string)

This option is deprecated. Use a custom socket or euid instead.

socket (string)

This parameter allows to create a per-service socket file over which gssproxy client and server components communicate. When this parameter is not set, gssproxy will use a compiled-in default.

syslog_status (boolean)

Enable per-call debugging output to the syslog. This may be useful for investigating problems in applications using gssproxy. Default: syslog_status = false

trusted (boolean)

Defines whether this service is considered trusted. Use with caution, this enables impersonation. Default: trusted = false

worker threads (integer)

Defines the amount of worker threads gssproxy will create at startup. Default: worker threads =

## SEE ALSO
gssproxy(8) and gssproxy-mech(8).

## AUTHORS
GSS-Proxy - http://fedorahosted.org/gss-proxy


gtkwaverc

package: gtkwave

title: gtkwaverc(5)

summary: GTKWave Configuration File

text:
# gtkwaverc(5)

## NAME
gtkwaverc - GTKWave Configuration File

## SYNTAX
option <value>

The configuration file is a series of option and value pairs. Comment lines marked with an initial '#' character are permissible. Blank lines are ignored.

## DESCRIPTION
Configuration file for gtkwave(1). The search path for the configuration file (if unspecified) is the current working directory followed by the user's home directory.

## OPTIONS
accel <"pathvalue" accelerator>

This allows replacement of menu accelerator keys. See the .gtkwaverc file in the source distribution for examples on pathvalue and accelerator syntax. The special accelerator value of (null) means that no accelerator is bound to the menu item.

alt_hier_delimeter <value>

This allows another character in addition to the hier_delimeter to be used to delimit levels in the hierarchy for VCD. Only the first character in the value is significant. Note that this is normally off. The intended use is to resolve the hierarchies of netlist based models that often contain slashes to delimit hierarchy inside of $var statements.

alt_wheel_mode <value>

Default is on. Scrollwheel alone pans along a quarter at a time rather than a full page, so you don't get lost. Ctrl+wheel zooms in/out around the mouse cursor position, not the marker position. Alt+wheel edges left/right based on the currently selected signal. This makes measuring deltas easier.

analog_redraw_skip_count <value>

Specifies how many overlapping analog segments can be drawn for a given X position onscreen. (Default: 20) If there are gaps in analog traces, this value is too low.

append_vcd_hier <value>

Allows the specification of a prefix hierarchy for VCD files. This can be done in "pieces," so that multiple layers of hierarchy are prepended to symbol names with the most significant addition occurring first (see .gtkwaverc in the examples/vcd directory). The intended use of this is to have the ability to add "project" prefixes which allow easier selection of everything from the tree hierarchy.

atomic_vectors <value>

Speeds up vcd loading and takes up less memory. This option is deprecated; it is currently the default.

autocoalesce <value>

A nonzero value enables autocoalescing of VCD vectors when applicable. This may be toggled dynamically during wave viewer usage.

autocoalesce_reversal <value>

causes split vectors to be reconstructed in reverse order (only if autocoalesce is also active).

autoname_bundles <value>

A nonzero value indicates that GTKWave will create its own bundle names rather than prompting the user for them.

clipboard_mouseover <value>

A nonzero value indicates that when mouseover is enabled, all values generated for the tooltips will be automatically copied into the clipboard so they may be pasted into other programs such as text editors, etc.

color_0 <value>

trace color when 0.

color_1 <value>

trace color when 1.

color_1fill <value>

trace color (inside of box) when 1.

color_back <value>

background color.

color_baseline <value>

middle mouse button marker color.

color_black <value>

color value for "black" in signal window.

color_brkred <value>

brick red color for comments.

color_dash <value>

trace color when don't care ("-").

color_dashfill <value>

trace color (inside of box) when don't care ("-").

color_dkblue <value>

color value for "dark blue" in signal window.

color_dkgray <value>

color value for "dark gray" in signal window.

color_gmstrd <value>

color value for trace groupings.

color_grid <value>

grid color (use Alt-G/Shift-Alt-G to show/hide grid). This is also the color used for highlight_wavewindow when enabled.

color_grid2 <value>

grid color for secondary pattern search.

color_high <value>

trace color when high ("H").

color_highfill <value>

trace color (inside of box) when high ("H").

color_low <value>

trace color when low ("L").

color_ltblue <value>

color for shadowed traces.

color_ltgray <value>

color value for "light gray" in signal window.

color_mark <value>

color of the named markers.

color_mdgray <value>

color value for "medium gray" in signal window.

color_mid <value>

trace color when floating ("Z").

color_normal <value>

color value for "normal" GTK state in signal window.

color_time <value>

text color for timebar.

color_timeb <value>

text color for timebar's background.

color_trans <value>

trace color when transitioning.

color_u <value>

trace color when undefined ("U").

color_ufill <value>

trace color (inside of box) when undefined ("U").

color_umark <value>

color of the unnamed (primary) marker.

color_value <value>

text color for vector values.

color_vbox <value>

vector color (horizontal).

color_vtrans <value>

vector color (verticals/transitions).

color_w <value>

trace color when weak ("W").

color_wfill <value>

trace color (inside of box) when weak ("W").

color_white <value>

color value for "white" in signal window.

color_x <value>

trace color when undefined ("X") (collision for VHDL).

color_xfill <value>

trace color (inside of box) when undefined ("X") (collision for VHDL).

constant_marker_update <value>

A nonzero value indicates that the values for traces listed in the signal window are to be updated constantly when the left mouse button is being held down rather than only when it is first pressed then when released (which is the default).

context_tabposition <value>

Use zero for tabbed viewing with named tabs at the top. Nonzero places numerically indexed tabs at the left.

convert_to_reals <value>

Converts all integer and parameter VCD declarations to real-valued ones when set to a nonzero/yes value. The positive aspect of this is that integers and parameters will take up less space in memory and will automatically display in decimal format. The negative aspect of this is that integers and parameters will only be displayable as decimals and can't be bit reversed, inverted, etc.

cursor_snap <value>

A nonzero value indicates the number of pixels the marker should snap to for the nearest signal transition.

disable_ae2_alias <value>

A nonzero value indicates that the AE2 loader is to ignore the aliasdb keyword and is not to construct facility aliases.

disable_auto_comphier <value>

A nonzero value indicates that the loaders that support compressed hierarchies should not automatically turn on compression if the threshold count of signals (500000) has been reached.

disable_empty_gui <value>

A nonzero value indicates that if gtkwave is invoked without a dumpfile name, then an empty gtkwave session is to be suppressed. Default is a zero value: to bring up an empty session which needs a file loaded or dragged into it.

disable_mouseover <value>

A nonzero value indicates that signal/value tooltip pop up bubbles on mouse button presses should be disabled in the value window. A zero value indicates that value tooltips should be active (default is disabled).

disable_tooltips <value>

A nonzero value indicates that tooltip pop up bubbles should be disabled. A zero value indicates that tooltips should be active (default).

do_initial_zoom_fit <value>

A nonzero value indicates that the trace should initially be crunched to fit the screen. A zero value indicates that the initial zoom should be zero (default).

dragzoom_threshold <value>

A nonzero value indicates the number of pixels in the x direction the marker must move in order for a dragzoom to be triggered. This is largely to handle noisy input devices.

dynamic_resizing <value>

A nonzero value indicates that dynamic resizing should be initially enabled (default). A zero value indicates that dynamic resizing should be initially disabled.

editor <"value">

This is used to specify a string (quotes mandatory) for when gtkwave invokes a text editor (e.g., Open Source Definition). Examples are: editor "vimx -g +%d %s", editor "gedit +%d %s", editor "emacs +%d %s", and for OSX, editor "mate -l %d %s". The %d may be combined with other characters in a string such as +, etc. The %s argument must stand by itself. Note that if this rc variable is not set, then the environment variable GTKWAVE_EDITOR will be consulted next, then finally gedit will be used (if found).

enable_fast_exit <value>

Allows exit without bringing up a confirmation requester. The default is nonzero/yes.

enable_ghost_marker <value>

lets the user turn on/off the ghost marker during primary marker dragging. Default is enabled.

enable_horiz_grid <value>

A nonzero value indicates that when grid drawing is enabled, horizontal lines are to be drawn. This is the default.

enable_vcd_autosave <value>

causes the vcd loader to automatically generate a .sav file (vcd_autosave.sav ) in the cwd if a save file is not specified on the command line. Note that this mirrors the VCD $var defs and no attempt is made to coalesce split bitvectors back together.

enable_vert_grid <value>

A nonzero value indicates that when grid drawing is enabled, vertical lines are to be drawn. This is the default. Note that all possible combinations of enable_horiz_grid and enable_vert_grid values are acceptable.

fill_waveform <value>

A zero value indicates that the waveform should not be filled for 1/H values. This is the default.

fontname_logfile <value>

When followed by an argument, this indicates the name of the X11 font that you wish to use for the logfile browser. You may generate appropriate fontnames using the xfontsel program.

fontname_signals <value>

When followed by an argument, this indicates the name of the X11 font that you wish to use for signals. You may generate appropriate fontnames using the xfontsel program.

fontname_waves <value>

When followed by an argument, this indicates the name of the X11 font that you wish to use for waves. You may generate appropriate fontnames using the xfontsel program. Note that the signal font must be taller than the wave font or the viewer will complain then terminate.

force_toolbars <value>

When enabled, this forces everything above the signal and wave windows to be rendered as toolbars. This allows for them to be detached which allows for more usable wave viewer space. By default this is off.

hide_sst <value>

Hides the Signal Search Tree widget for GTK2.4 and greater such that it is not embedded into the main viewer window. It is still reachable as an external widget through the menus.

hier_delimeter <value>

This allows characters other than '/' to be used to delimit levels in the hierarchy. Only the first character in the value is significant.

hier_grouping <value>

For the tree widgets, this allows the hierarchies to be grouped in a single place rather than spread among the netnames.

hier_ignore_escapes <value>

A nonzero value indicates that the signal pane ignores escapes in identifiers when determining the hierarchy maximum depth. Default is disabled so that escapes are examined.

hier_max_level <value>

Sets the maximum hierarchy depth (from the right side) to display for trace names. Note that a value of zero displays the full hierarchy name.

highlight_wavewindow <value>

When enabled, this causes traces highlighted in the signal window also to be highlighted in the wave window.

hpane_pack <value>

A nonzero value indicates that the horizontal pane should be constructed using the gtk_paned_pack functions (default and recommended). A zero value indicates that gtk_paned_add will be used instead.

ignore_savefile_pane_pos <value>

If nonzero, specifies that the pane position attributes (i.e., signal window width size, SST is expanded, etc.) are to be ignored during savefile loading and is to be skipped during saving. Default is that the attribute is used.

ignore_savefile_pos <value>

If nonzero, specifies that the window position attribute is to be ignored during savefile loading and is to be skipped during saving. Default is that the position attribute is used.

ignore_savefile_size <value>

If nonzero, specifies that the window size attribute is to be ignored during savefile loading and is to be skipped during saving. Default is that the size attribute is used.

initial_signal_window_width <value>

Sets the creation width for the signal pane on GUI initialization. Also sets another potential minimum value for dynamic resizing.

initial_window_x <value>

Sets the size of the initial width of the wave viewer window. Values less than or equal to zero will set the initial width equal to -1 which will let GTK determine the minimum size.

initial_window_xpos <value>

Sets the size of the initial x coordinate of the wave viewer window. -1 will let the window manager determine the position.

initial_window_y <value>

Sets the size of the initial height of the wave viewer window. Values less than or equal to zero will set the initial width equal to -1 which will let GTK determine the minimum size.

initial_window_ypos <value>

Sets the size of the initial y coordinate of the wave viewer window. -1 will let the window manager determine the position.

keep_xz_colors <value>

When nonzero, indicates that the original color scheme for non 0/1 signal values is to be used when Color Format overrides are in effect. Default is off.

left_justify_sigs <value>

When nonzero, indicates that the signal window signal name justification should default to left, else the justification is to the right (default).

lxt_clock_compress_to_z <value>

For LXT (not LXT2) allows clocks to compress to a 'z' value so that regular/periodic value changes may be noted.

lz_removal <value>

When nonzero, suppresses the display of leading zeros on non-filtered traces. This has no effect on filtered traces.

max_fsdb_trees <value>

sets the maximum number of hierarchy and signal trees to process for an FSDB file. Default = 0 = unlimited. The intent of this is to work around sim environments that accidentally call fsdbDumpVars multiple times.

page_divisor <value>

Sets the scroll amount for page left and right operations. (The buttons, not the hscrollbar.) Values over 1.0 are taken as 1/x and values equal to and less than 1.0 are taken literally. (i.e., 2 gives a half-page scroll and .67 gives 2/3). The default is 1.0.

ps_maxveclen <value>

sets the maximum number of characters that can be printed for a value in the signal window portion of a postscript file (not including the net name itself). Legal values are 4 through 66 (default).

ruler_origin <value>

sets the zero origin for alternate time tick marks.

ruler_step <value>

sets the left/right step value for the alternate time tick marks from the origin. When this value is zero, alternate time tick marks are disabled.

scale_to_time_dimension <value>

The value can be any of the characters m, u, n, f, p, or s, which indicates which time dimension to convert the time values to. The default for this is * which means that time dimension conversion is disabled.

show_base_symbols <value>

A nonzero value (default) indicates that the numeric base symbols for hexadecimal ('$'), binary ('%'), and octal ('#') should be rendered. Otherwise they will be omitted.

show_grid <value>

A nonzero value (default) indicates that a grid should be drawn behind the traces. A zero indicates that no grid should be drawn.

splash_disable <value>

Turning this off enables the splash screen with the GTKWave mascot when loading a trace. Default is on.

sst_dbl_action_type <value>

Allows double-clicking to be active in the SST signals pane with the following actions possible: insert (default), replace, append, prepend, none. The value specified for the action is case insensitive and only the first letter is required. Invalid action types default to none.

sst_dynamic_filter <value>

When true (default) allows the SST dialog signal filter to filter signals while keys are being pressed, otherwise enter must be pressed to cause the filter to go active.

sst_expanded <value>

When true allows the SST dialog (when not hidden) to come up already expanded.

strace_repeat_count <value>

Determines how many times that edge search and pattern search will iterate on a search. This allows, for example, skipping ahead 10 clock edges instead of 1.

use_big_fonts <value>

A nonzero value indicates that any text rendered into the wave window will use fonts that are four points larger in size than normal. This can enhance readability. A zero value indicates that normal font sizes should be used.

use_frequency_delta <value>

allows you to switch between the delta time and frequency display in the upper right corner of the main window when measuring distances between markers. Default behavior is that the delta time is displayed (off).

use_full_precision <value>

does not round time values when the number of ticks per pixel onscreen is greater than 10 when active. The default is that this feature is disabled.

use_maxtime_display <value>

A nonzero value indicates that the maximum time will be displayed in the upper right corner of the screen. Otherwise, the current primary (unnamed) marker time will be displayed. This can be toggled at any time with the Toggle Max-Marker menu option.

use_nonprop_fonts <value>

Allows accelerated redraws of the signalwindow that can be done because the font width is constant. Default is off.

use_pango_fonts <value>

Uses anti-aliased pango fonts (GTK2) rather than bitmapped X11 ones. Default is on.

use_roundcaps <value>

A nonzero value indicates that vector traces should be drawn with rounded caps rather than perpendicular ones. The default for this is zero.

use_scrollbar_only <value>

A nonzero value indicates that the page, shift, fetch, and discard buttons should not be drawn (i.e., time manipulations should be through the scrollbar only rather than front panel buttons). The default for this is zero.

use_scrollwheel_as_y <value>

A nonzero value indicates that the scroll wheel on the mouse should be used to scroll the signals up and down rather than scrolling the time value from left to right.

use_standard_clicking <value>

This option no longer has any effect in gtkwave: normal GTK click semantics are used in the signalwindow.

use_standard_trace_select <value>

A nonzero value keeps the currently selected traces from deselecting on mouse button press. This allows drag and drop to function more smoothly. As this behavior is not how GTK normally functions, it is by default disabled.

use_toolbutton_interface <value>

A nonzero value indicates that a toolbar with buttons should be at the top of the screen instead of the traditional style gtkwave button groups. Default is on.

vcd_explicit_zero_subscripts <value>

indicates that signal names should be stored internally as name.bitnumber when enabled. When disabled, a more "normal" ordering of name[bitnumber] is used. Note that when disabled, the Bundle Up and Bundle Down options are disabled in the Signal Search Regexp, Signal Search Hierarchy, and Signal Search Tree options. This is necessary as the internal data structures for signals are represented with one "less" level of hierarchy than when enabled and those functions would not work properly. This should not be an issue if atomic_vectors are enabled. Default for vcd_explicit_zero_subscripts is disabled.

vcd_preserve_glitches <value>

indicates that any repeat equal values for a net spanning different time values in the VCD/FST file are not to be compressed into a single value change but should remain in order to allow glitches to be present for this case. Default for vcd_preserve_glitches is disabled.

vcd_preserve_glitches_real <value>

indicates that any repeat equal values for a real net spanning different time values in the VCD/FST file are not to be compressed into a single value change but should remain for this case. Default for vcd_preserve_glitches is disabled. The intended use is for when viewing analog interpolated data such that removing duplicate values would incorrectly deform the interpolation.

vcd_warning_filesize <value>

produces a warning message if the VCD filesize is greater than the argument's size in MB. Set to zero to disable this.

vector_padding <value>

indicates the number of pixels of extra whitespace that should be added to any strings for the purpose of calculating text in vectors. Permissible values are 0 to 16 with the default being 4.

vlist_compression <value>

indicates the value to pass to zlib during vlist processing (which is used in the VCD recoder). -1 disables compression, 0-9 correspond to the value zlib expects. 4 is default.

vlist_prepack <value>

indicates that the VCD recoder should pre-compress data going into the value change vlists in order to reduce memory usage. This is done before potential zlib packing. Default is off.

vlist_spill <value>

indicates that the VCD recoder should spill all generated vlists to a tempfile on disk in order to reduce memory usage. Default is off.

wave_scrolling <value>

a nonzero value enables scrolling by dragging the marker off the left or right sides of the wave window. A zero value disables it.

zoom_base <value>

allows setting of the zoom base with a value between 1.5 and 10.0. Default is 2.0.

zoom_center <value>

a nonzero value enables center zooming, a zero value disables it.

zoom_dynamic <value>

a nonzero value enables dynamic full zooming when using the partial VCD (incremental) loader, a zero value disables it.

zoom_dynamic_end <value>

a nonzero value enables dynamic zoom to the end when using the partial VCD (incremental) loader, a zero value disables it.

zoom_pow10_snap <value>

corresponds to the Zoom Pow10 Snap menu option. Default for this is disabled (zero).

## AUTHORS
Anthony Bybell <bybell@rocketmail.com>

## SEE ALSO
gtkwave(1)


guacd.conf

package: guacd

title: guacd.conf(5)

summary: Configuration file for guacd

text:
# guacd.conf(5)

## NAME
/etc/guacamole/guacd.conf - Configuration file for guacd

## DESCRIPTION
/etc/guacamole/guacd.conf is the configuration file for the Guacamole proxy daemon used by the Guacamole web application and framework, guacd. Use of this file is entirely optional, and all of its options can be specified from the command line when running guacd. If you provide both the guacd.conf file and command line options, the command line options will take precedence.

## SYNTAX
guacd.conf is made up of sections, where each section contains a set of parameter/value pairs. The parameters available are dictated by the section in use, and parameters may only be specified within a section.

The beginning of each section is denoted with a section name in brackets, and each section ends implicitly with the beginning of a new section, or at the end of the file.

[server]

Contains parameters which control how guacd behaves as a server, from a network perspective.

[daemon]

Parameters which configure how guacd behaves as a daemon, such as what file should contain the PID, if any.

[ssl]

Parameters which control the SSL support of guacd, such as the certificate and private key used for encryption of the Guacamole protocol. This section and its parameters are only valid if guacd was built with SSL support.

Parameters within sections are written as a parameter name, followed by an equals sign, followed by the parameter value, all on one line. Comments may be placed anywhere, and consist of arbitrary text following a # symbol until end-of-line:

name = value # Some arbitrary comment text

Beware that it is the combination of the section name with the parameter name that makes up the fully qualified name of a parameter. Each parameter absolutely must be placed only within its proper section, or guacd.conf will fail to be parsed, and guacd will not start.

If special characters need to be placed within a parameter value, such as whitespace, #, ", or \, the entire value must be enclosed in double quotes, and each occurrence of " or \ within the value must be escaped with backslashes:

name = "quoted # value \\ with \" special characters"

## SERVER PARAMETERS
bind_host = HOSTNAME

Requires guacd to bind to a specific host when listening for connections. By default, guacd will bind to localhost only.

bind_port = PORT

Requires guacd to bind to a specific port when listening for connections. By default, guacd will bind to port 4822.

## DAEMON PARAMETERS
log_level = LEVEL

Sets the maximum level at which guacd will log messages to syslog and, if running in the foreground, the console. Legal values are trace, debug, info, warning, and error. The default value is info.

pid_file = FILE

Causes guacd to write its PID to the specified file upon startup. Note that guacd must have sufficient privileges to create or write this file, or it will fail to start. This parameter is typically needed for startup scripts, such that the script can report on the status of guacd and kill it if necessary.

## SSL PARAMETERS
If guacd was built with SSL support, then connections between the web application and guacd can be encrypted if an SSL certificate and key file are given.

When using a chain of certificates, you must append the additional certificates to your server certificate. This can be done easily with the standard cat command. Beware that the certificate for guacd must be the first certificate in the file.

server_certificate = CERTIFICATE FILE

Enables SSL/TLS using the given certificate file. Future connections to guacd will require SSL/TLS enabled in the client (the web application).

server_key = KEY FILE

Enables SSL/TLS using the given private key file. Future connections to guacd will require SSL/TLS enabled in the client (the web application).

## EXAMPLE

```
#
# guacd.conf example
#
[daemon]
pid_file = /var/run/guacd.pid
[server]
bind_host = localhost
bind_port = 4822
[ssl]
server_certificate = /etc/ssl/certs/guacd.crt
server_key = /etc/ssl/private/guacd.key
```

```

```