mandoc/roff.7 - diff

Return to roff.7 CVS log

Up to [cvsweb.bsd.lv] / mandoc

Diff for /mandoc/roff.7 between version 1.63 and 1.74

version 1.63, 2015/01/20 21:16:51

version 1.74, 2015/08/29 22:40:05

Line 1

.\" $Id$

.\"

.\" Permission to use, copy, modify, and distribute this software for any

.\" purpose with or without fee is hereby granted, provided that the above

Line 665 produces

.D1 \efI\e^XtFree\e^\efP.

.Pp

in the input stream, and thus in the output: \fI\^XtFree\^\fP.

Each occurrence of \e\e$* is replaced with all the arguments,

joined together with single blank characters.

.Pp

Since macros and user-defined strings share a common string table,

defining a macro

Line 1003 This is a groff extension and currently ignored.

Line 1005 This is a groff extension and currently ignored.

.Ss \&hypp

Define hyphenation penalties.

This is a Heirloom extension and currently ignored.

.Ss \&hys

Set hyphenation space.

This is a groff extension and currently ignored.

.Ss \&ie

Line 1057 If the first character of COND is

Line 1059 If the first character of COND is

.Pq string defined ,

.Sq e

.Pq even page ,

.Sq r

.Pq register accessed ,

.Sq t

.Pq troff mode ,

Line 1066 or

.Pq vroff mode ,

COND evaluates to false.

.It

If the first character of COND is

.Sq r ,

it evalutes to true if the rest of COND is the name of an existing

number register; otherwise, it evaluates to false.

.It

If COND starts with a parenthesis or with an optionally signed

integer number, it is evaluated according to the rules of

.Sx Numerical expressions

Line 1196 This is a Heirloom extension and currently unsupported

Line 1201 This is a Heirloom extension and currently unsupported

Set an input line trap.

Its syntax is as follows:

.Pp

.D1 Pf . Cm it Ar number macro

.D1 Pf . Cm it Ar expression macro

.Pp

The named

.Ar macro

will be invoked after processing the specified

will be invoked after processing the number of input text lines

.Ar number

specified by the numerical

of input text lines.

.Ar expression .

While evaluating the

.Ar expression ,

the unit suffixes described below

.Sx Scaling Widths

are ignored.

.Ss \&itc

Set an input line trap, not counting lines ending with \ec.

Currently unsupported.

Line 1318 Switch to no-fill mode.

Line 1328 Switch to no-fill mode.

See

.Xr man 7 .

Ignored by

.Xr mdoc 7.

.Xr mdoc 7 .

.Ss \&nh

Turn off automatic hyphenation mode.

Currently ignored.

Line 1439 Retrieve the bounding box of a PostScript file.

Line 1449 Retrieve the bounding box of a PostScript file.

Currently unsupported.

.Ss \&pshape

Set a special shape for the current paragraph.

This is a Heirloom extension and currently ignored.

This is a Heirloom extension and currently unsupported.

.Ss \&pso

Include output of a shell command.

Ignored because insecure.

Line 1552 Currently ignored.

Line 1562 Currently ignored.

.Ss \&ss

Set space character size.

Currently ignored.

.Ss \&sty

Associate style with a font position.

This is a groff extension and currently ignored.

.Ss \&substring

Line 1572 See

Line 1582 See

.Ss \&ta

Set tab stops.

Takes an arbitrary number of arguments.

Currently ignored.

Currently unsupported.

.Ss \&tc

Change tab repetion character.

Currently unsupported.

Line 1582 See

Line 1592 See

.Sx \&TS .

.Ss \&ti

Temporary indent.

Currently ignored.

Currently unsupported.

.Ss \&tkf

Enable track kerning for a font.

Currently ignored.

Line 1715 prefixed by an optional sign

Line 1725 prefixed by an optional sign

.Sq +

.Sq - .

Each number may be followed by one optional scaling unit described below

.Sx Scaling Widths .

The following equations hold:

.Bd -literal -offset indent

1i = 6v = 6P = 10m = 10n = 72p = 1000M = 240u = 240

254c = 100i = 24000u = 24000

1f = 65536u = 65536

.Ed

.Pp

The following binary operators are implemented.

Unless otherwise stated, they behave as in the C language:

Line 1821 For short names, there are variants

Line 1839 For short names, there are variants

.No \e* Ns Ar c

and

.No \e*( Ns Ar cc .

.Ss \e,

Left italic correction (groff extension); ignored by

.Xr mandoc 1 .

.Ss \e-

Special character

.Dq mathematical minus sign .

.Ss \e/

Right italic correction (groff extension); ignored by

.Xr mandoc 1 .

.Ss \e[ Ns Ar name ]

.Sx Special Characters

with names of arbitrary length, see

Line 1948 For short names, there are variants

Line 1972 For short names, there are variants

and

.No \en( Ns Ar cc .

.Ss \eo\(aq Ns Ar string Ns \(aq

Overstrike

Overstrike, writing all the characters contained in the

.Ar string ;

.Ar string

ignored by

to the same output position.

.Xr mandoc 1 .

In terminal and HTML output modes,

only the last one of the characters is visible.

.Ss \eR\(aq Ns Ar name Oo +|- Oc Ns Ar number Ns \(aq

Set number register; ignored by

.Xr mandoc 1 .

Line 2014 Print

Line 2039 Print

with zero width and height; ignored by

.Xr mandoc 1 .

.Ss \ez

Output the next character without advancing the cursor position;

Output the next character without advancing the cursor position.

approximated in

.Xr mandoc 1

by simply skipping the next character.

.Sh COMPATIBILITY

This section documents compatibility between mandoc and other

The

.Xr mandoc 1

implementation of the

.Nm

implementations, at this time limited to GNU troff

language is intentionally incomplete.

.Pq Qq groff .

Unimplemented features include:

The term

.Qq historic groff

refers to groff version 1.15.

.Pp

.Bl -dash -compact

.It

For security reasons,

.Xr mandoc 1

never reads or writes external files except via

.Sx \&so

requests with safe relative paths.

.It

There is no automatic hyphenation, no adjustment to the right margin,

and no centering; the output is always set flush-left.

.It

Support for setting tabulator positions

and tabulator and leader characters is missing,

and support for manually changing indentation is limited.

.It

The

.Sq u

scaling unit is the default terminal unit.

In traditional troff systems, this unit would change depending on the

In traditional troff systems, this unit changes depending on the

output media.

.It

In mandoc, the

Width measurements are implemented in a crude way

.Sx \&EQ ,

and often yield wrong results.

.Sx \&TE ,

Explicit movement requests and escapes are ignored.

.Sx \&TS ,

and

.Sx \&T& ,

macros are considered regular macros.

In all other

.Nm

implementations, these are special macros that must be specified without

spacing between the control character (which must be a period) and the

macro name.

.It

The

There is no concept of output pages, no support for floats,

.Cm nS

graphics drawing, and picture inclusion;

terminal output is always continuous.

.It

Historic groff did not accept white-space before a custom

Requests regarding color, font families, and glyph manipulation

.Ar end

are ignored.

macro for the

Font support is very limited.

.Sx \&ig

Kerning is not implemented, and no ligatures are produced.

request.

.It

The

.Sx \&if

.Qq \(aq

and family would print funny white-spaces with historic groff when

macro control character does not suppress output line breaks.

using the next-line syntax.

.It

Diversions are not implemented,

and support for traps is very incomplete.

.It

While recursion is supported,

.Sx \&while

loops are not.

.El

.Pp

The special semantics of the

.Cm nS

number register is an idiosyncracy of

.Ox

manuals and not supported by other

.Xr mdoc 7

implementations.

.Sh SEE ALSO

.Xr mandoc 1 ,

.Xr eqn 7 ,

CVSweb