1 '\" t -- preprocess: tbl(1)
5 Copyright (c) 2014 - 2017 Steffen (Daode) Nurpmeso <steffen@sdaoden.eu>.
7 Copyright (C) 1989, 2000 - 2003, 2007, 2008
8 Free Software Foundation, Inc.
10 modified by Werner Lemberg <wl@gnu.org>
11 Bernd Warken <bwarken@mayn.de>
13 Permission is granted to copy, distribute and/or modify this document
14 under the terms of the GNU Free Documentation License, Version 1.1 or
15 any later version published by the Free Software Foundation; with the
16 Invariant Sections being this .ig-section and AUTHOR, with no
17 Front-Cover Texts, and with no Back-Cover Texts.
19 You should have received a copy of the Free Documentation License
20 as part of the file COPYING; also located in the main directory of the
21 source package of this program.
24 .TH @U_TROFF@ @MAN1EXT@ "@MDATE@" "@T_ROFF@ v@VERSION@"
28 @L_TROFF@ \- the troff processor of the @T_ROFF@ text formatting system
53 @T_TROFF@ is the main workhorse of the @T_ROFF@ text processing system
54 and translates roff text input into an intermediate output language that
55 can be and usually is furtherly used by @T_ROFF@ output devices.
56 It is functionally compatible with UNIX troff, but has many
58 .BR \%@L_ROFF@-diff (@MAN7EXT@).
59 Usually it is invoked by using the
60 .BR @L_ROFF@ (@MAN1EXT@)
61 command which will also run preprocessors and postprocessors in the
62 appropriate order and with the appropriate options.
67 It is possible to have whitespace between a command line option and
74 approximation of the typeset output.
78 Print a backtrace with each warning or error message.
79 This backtrace should help track down the cause of the error.
80 The line numbers given in the backtrace may not always be correct, for
82 idea of line numbers gets confused by
90 Disable color output (always disabled in compatibility mode).
94 Enable compatibility mode.
107 must be a one letter name.
111 Inhibit all error messages of
113 Note that this doesn't affect messages output to standard error by macro
124 as the default font family.
128 Search in directory (or directory path)
133 is the name of the device) and there for the
137 is scanned before all other font directories.
141 Read the standard input after all the named input files have been
146 This option may be used to add a directory to the search path for files
147 (both those on the command line and those named in
150 The search path is initialized with the current directory.
151 This option may be specified more than once; the directories are then
152 searched in the order specified (but before the current directory).
153 If you want to make the current directory be read before other directories,
156 at the appropriate place.
158 No directory search is performed for files with an absolute file name.
164 If it isn't found, try
167 It will be first searched for in directories given with the
169 command line option, then in directories given in the
170 .B @U_ROFF@_TMAC_PATH
171 environment variable, then in the current directory (only if in unsafe
172 mode), the home directory, @SYSTEMMACRODIR@, @LOCALMACRODIR@, and
177 Search directory (or directory path)
180 This is scanned before all other macro directories.
184 Number the first page
191 which is a comma-separated list of page ranges;
196 means print every page between
201 means print every page up to
204 means print every page from
207 will exit after printing the last page in the list.
220 must be a one character name;
222 can be any troff numeric expression.
233 Prepare output for device
235 rather than the default
238 .BR @L_ROFF@ (@MAN1EXT@)
239 for a more detailed description.
244 This will enable the following requests:
251 For security reasons, these potentially dangerous requests are disabled
253 It will also add the current directory to the macro search path.
257 Print the version number.
263 Available warnings are described in the section
266 For example, to enable all warnings, use
283 Suppress formatted output.
288 The warnings that can be given by
290 are divided into the following categories.
291 The name associated with each warning is used by the
295 options; the number is used by the
299 register; it is always a power of 2 to allow bitwise composition.
306 Bit@Code@Warning@Bit@Code@Warning
309 1@2@number@11@2048@tab
310 2@4@break@12@4096@right-brace
311 3@8@delim@13@8192@missing
312 4@16@el@14@16384@input
313 5@32@scale@15@32768@escape
314 6@64@range@16@65536@space
315 7@128@syntax@17@131072@font
316 8@256@di@18@262144@ig
317 9@512@mac@19@524288@color
322 .nr x \w'\fBright-brace'+1n+\w'00000'u
327 In fill mode, lines which could not be broken so that their length was
328 less than the line length.
329 This is enabled by default.
333 Non-existent characters.
334 This is enabled by default.
338 Color related warnings.
342 Missing or mismatched closing delimiters.
350 without an argument when there is no current diversion.
356 request with no matching
362 Unrecognized escape sequences.
363 When an unrecognized escape sequence is encountered, the escape
364 character is ignored.
368 Indicates a missing file for the
376 This is enabled by default.
380 Invalid escapes in text ignored with the
383 These are conditions that are errors when they do not occur in ignored
388 Invalid input characters.
392 Use of undefined strings, macros and diversions.
393 When an undefined string, macro or diversion is used, that string is
394 automatically defined as empty.
395 So, in most cases, at most one warning will be given for each name.
399 Requests that are missing non-optional arguments.
403 Invalid numeric expressions.
404 This is enabled by default.
408 Out of range arguments.
412 Use of undefined number registers.
413 When an undefined number register is used, that register is
414 automatically defined to have a value of\~0.
415 So, in most cases, at most one warning will be given for use of a
419 .BR right-brace "\t4096"
422 where a number was expected.
426 Meaningless scaling indicators.
430 Missing space between a request or macro and its argument.
431 This warning will be given when an undefined name longer than two
432 characters is encountered, and the first two characters of the name
434 The request or macro will not be invoked.
435 When this warning is given, no macro is automatically defined.
436 This is enabled by default.
437 This warning will never occur in compatibility mode.
441 Dubious syntax in numeric expressions.
445 Inappropriate use of a tab character.
446 Either use of a tab character where a number was expected, or use of tab
447 character in an unquoted macro argument.
450 There are also names that can be used to refer to groups of warnings:
459 It is intended that this covers all warnings that are useful with
460 traditional macro packages.
471 .B @U_ROFF@_TMAC_PATH
472 A colon separated list of directories in which to search for
475 will scan directories given in the
477 option before these, and in standard directories (current directory if
478 in unsafe mode, home directory,
479 .BR @SYSTEMMACRODIR@ ,
480 .BR @LOCALMACRODIR@ ,
486 .B @U_ROFF@_TYPESETTER
491 .B @U_ROFF@_FONT_PATH
492 A colon separated list of directories in which to search for the
496 will scan directories given in the
498 option before these, and in standard directories
499 .RB ( @LOCALFONTDIR@ ,
507 .B @MACRODIR@/troffrc
508 Initialization file (called before any other macro package).
511 .B @MACRODIR@/troffrc-end
512 Initialization file (called after any other macro package).
515 .BI @MACRODIR@/ name .tmac
517 .BI @MACRODIR@/tmac. name
521 .BI @FONTDIR@/dev name /DESC
522 Device description file for device
526 .BI @FONTDIR@/dev name / F
537 are neither searched in the current nor in the home directory by
538 default for security reasons (even if the
543 command line option or the
544 .B @U_ROFF@_TMAC_PATH
545 environment variable to add these directories to the search path if
551 Copyright (C) 1989, 2001 - 2003, 2007, 2008
552 Free Software Foundation, Inc.
555 This document is distributed under the terms of the FDL (GNU Free
556 Documentation License) version 1.1 or later.
558 You should have received a copy of the FDL on your system, it is also
559 available on-line at the
560 .UR http://\:www.gnu.org/\:copyleft/\:fdl.html
563 This document was written by James Clark, with modifications from
576 .BR @L_ROFF@ (@MAN1EXT@)
577 The main program of the
579 system, a wrapper around
583 .BR @L_ROFF@ (@MAN7EXT@)
584 A description of the roff language, including a short but complete
585 reference of all predefined requests, registers, and escapes.
588 .BR \%@L_ROFF@-diff (@MAN7EXT@)
589 The differences of the
591 language, GNU troff and the
596 .BR @L_ROFF@ (@MAN7EXT@)
597 An overview over roff.