{ "content": [ { "type": "text", "text": "# troff(1) (man)\n\n**Summary:** troff - the troff processor of the groff text formatting system\n\n**Synopsis:** troff [-abcivzCERU] [-d cs] [-f fam] [-F dir] [-I dir] [-m name] [-M dir] [-n num] [-o list]\n[-r cn] [-T name] [-w name] [-W name] [file ...]\n\n## Flags\n\n| Flag | Long | Arg | Description |\n|------|------|-----|-------------|\n| -a | — | — | |\n| -b | — | — | track down the cause of the error. The line numbers given in the backtrace may not always be correct, for troff's idea o |\n| -c | — | — | |\n| -C | — | — | |\n| -d | — | — | |\n| -d | — | — | Define c or name to be a string s; c must be a one letter name. |\n| -E | — | — | standard error by macro packages using the tm or tm1 requests. |\n| -f | — | — | |\n| -F | — | — | name of the device) and there for the DESC file and font files. dir is scanned before all other font directories. |\n| -i | — | — | |\n| -I | — | — | the command line and those named in .psbb requests). The search path is initialized with the current directory. This opt |\n| -m | — | — | first searched for in directories given with the -M command-line option, then in di‐ rectories given in the GROFFTMACPAT |\n| -M | — | — | other macro directories. |\n| -n | — | — | |\n| -o | — | — | print page n, m-n means print every page between m and n, -n means print every page up to n, n- means print every page f |\n| -r | — | — | |\n| -r | — | — | Set number register c or name to n; c must be a one character name; n can be any troff numeric expression. |\n| -R | — | — | |\n| -T | — | — | detailed description. |\n| -U | — | — | For security reasons, these potentially dangerous requests are disabled otherwise. It will also add the current director |\n| -v | — | — | |\n| -w | — | — | To enable most useful warnings use -w all. To enable absolutely all warnings use -w w instead. Multiple -w options are a |\n| -W | — | — | |\n| -z | — | — | |\n\n## See Also\n\n- groff(1)\n- groff(7)\n- groffdiff(7)\n- roff(7)\n\n## Section Outline\n\n- **NAME** (2 lines)\n- **SYNOPSIS** (3 lines)\n- **DESCRIPTION** (5 lines)\n- **OPTIONS** (2 lines) — 24 subsections\n - -a (1 lines)\n - -b (4 lines)\n - -c (1 lines)\n - -C (1 lines)\n - -d (1 lines)\n - -d (2 lines)\n - -E (2 lines)\n - -f (1 lines)\n - -F (3 lines)\n - -i (1 lines)\n - -I (8 lines)\n - -m (5 lines)\n - -M (2 lines)\n - -n (1 lines)\n - -o (4 lines)\n - -r (1 lines)\n - -r (3 lines)\n - -R (1 lines)\n - -T (2 lines)\n - -U (3 lines)\n - -v (1 lines)\n - -w (3 lines)\n - -W -W (1 lines)\n - -z (1 lines)\n- **WARNINGS** (84 lines)\n- **ENVIRONMENT** (15 lines)\n- **FILES** (21 lines)\n- **AUTHORS** (4 lines)\n- **SEE ALSO** (24 lines)\n\n## Full Content\n\n### NAME\n\ntroff - the troff processor of the groff text formatting system\n\n### SYNOPSIS\n\ntroff [-abcivzCERU] [-d cs] [-f fam] [-F dir] [-I dir] [-m name] [-M dir] [-n num] [-o list]\n[-r cn] [-T name] [-w name] [-W name] [file ...]\n\n### DESCRIPTION\n\nThis manual page describes the GNU version of troff. It is part of the groff document for‐\nmatting system. It is functionally compatible with Unix troff, but has many extensions, see\ngroffdiff(7). Usually it should be invoked using the groff(1) command which will also run\npreprocessors and postprocessors in the appropriate order and with the appropriate options.\n\n### OPTIONS\n\nWhitespace is permitted between a command-line option and its argument.\n\n#### -a\n\n#### -b\n\ntrack down the cause of the error. The line numbers given in the backtrace may not\nalways be correct, for troff's idea of line numbers gets confused by as or am re‐\nquests.\n\n#### -c\n\n#### -C\n\n#### -d\n\n#### -d\n\nDefine c or name to be a string s; c must be a one letter name.\n\n#### -E\n\nstandard error by macro packages using the tm or tm1 requests.\n\n#### -f\n\n#### -F\n\nname of the device) and there for the DESC file and font files. dir is scanned before\nall other font directories.\n\n#### -i\n\n#### -I\n\nthe command line and those named in .psbb requests). The search path is initialized\nwith the current directory. This option may be specified more than once; the directo‐\nries are then searched in the order specified (but before the current directory). If\nyou want to make the current directory be read before other directories, add -I. at\nthe appropriate place.\n\nNo directory search is performed for files with an absolute file name.\n\n#### -m\n\nfirst searched for in directories given with the -M command-line option, then in di‐\nrectories given in the GROFFTMACPATH environment variable, then in the current di‐\nrectory (only if in unsafe mode), the home directory, /usr/lib/groff/site-tmac, /usr/\nshare/groff/site-tmac, and /usr/share/groff/1.22.4/tmac.\n\n#### -M\n\nother macro directories.\n\n#### -n\n\n#### -o\n\nprint page n, m-n means print every page between m and n, -n means print every page up\nto n, n- means print every page from n. troff will exit after printing the last page\nin the list.\n\n#### -r\n\n#### -r\n\nSet number register c or name to n; c must be a one character name; n can be any troff\nnumeric expression.\n\n#### -R\n\n#### -T\n\ndetailed description.\n\n#### -U\n\nFor security reasons, these potentially dangerous requests are disabled otherwise. It\nwill also add the current directory to the macro search path.\n\n#### -v\n\n#### -w\n\nTo enable most useful warnings use -w all. To enable absolutely all warnings use -w w\ninstead. Multiple -w options are allowed.\n\n#### -W -W\n\n#### -z\n\n### WARNINGS\n\nThe warnings that can be given by troff are divided into the following categories. The name\nassociated with each warning is used by the -w and -W options; the number is used by the warn\nrequest, and by the .warn register; it is always a power of 2 to allow bitwise composition.\n\n┌─────────────────────┬─────────────────────────────┐\n│Bit Code Warning │ Bit Code Warning │\n├─────────────────────┼─────────────────────────────┤\n│ 0 1 char │ 10 1024 reg │\n│ 1 2 number │ 11 2048 tab │\n│ 2 4 break │ 12 4096 right-brace │\n│ 3 8 delim │ 13 8192 missing │\n│ 4 16 el │ 14 16384 input │\n│ 5 32 scale │ 15 32768 escape │\n│ 6 64 range │ 16 65536 space │\n│ 7 128 syntax │ 17 131072 font │\n│ 8 256 di │ 18 262144 ig │\n│ 9 512 mac │ 19 524288 color │\n│ │ 20 1048576 file │\n└─────────────────────┴─────────────────────────────┘\nbreak 4 In fill mode, lines which could not be broken so that their length was\nless than the line length. This is enabled by default.\n\nchar 1 Non-existent characters. This is enabled by default.\n\ncolor 524288 Color-related warnings.\n\ndelim 8 Missing or mismatched closing delimiters.\n\ndi 256 Use of di or da without an argument when there is no current diversion.\n\nel 16 Use of the el request with no matching ie request.\n\nescape 32768 Unrecognized escape sequences. When an unrecognized escape sequence is\nencountered, the escape character is ignored.\n\nfile 1048576 Indicates a missing file for the mso request. Enabled by default.\n\nfont 131072 Non-existent fonts. This is enabled by default.\n\nig 262144 Invalid escapes in text ignored with the ig request. These are condi‐\ntions that are errors when they do not occur in ignored text.\n\ninput 16384 Invalid input characters.\n\nmac 512 Use of undefined strings, macros and diversions. When an undefined\nstring, macro or diversion is used, that string is automatically defined\nas empty. So, in most cases, at most one warning will be given for each\nname.\n\nmissing 8192 Requests that are missing non-optional arguments.\n\nnumber 2 Invalid numeric expressions. This is enabled by default.\n\nrange 64 Out of range arguments.\n\nreg 1024 Use of undefined number registers. When an undefined number register is\nused, that register is automatically defined to have a value of 0. So,\nin most cases, at most one warning will be given for use of a particular\nname.\n\nright-brace 4096 Use of \\} where a number was expected.\n\nscale 32 Meaningless scaling indicators.\n\nspace 65536 Missing space between a request or macro and its argument. This warning\nwill be given when an undefined name longer than two characters is en‐\ncountered, and the first two characters of the name make a defined name.\nThe request or macro will not be invoked. When this warning is given, no\nmacro is automatically defined. This is enabled by default. This warn‐\ning will never occur in compatibility mode.\n\nsyntax 128 Dubious syntax in numeric expressions.\n\ntab 2048 Inappropriate use of a tab character. Either use of a tab character\nwhere a number was expected, or use of tab character in an unquoted macro\nargument.\n\nThere are also names that can be used to refer to groups of warnings:\n\nall All warnings except di, mac, and reg. It is intended that this covers all warnings\nthat are useful with traditional macro packages.\n\nw All warnings.\n\n### ENVIRONMENT\n\nGROFFTMACPATH\nA colon separated list of directories in which to search for macro files. troff will\nscan directories given in the -M option before these, and in standard directories\n(current directory if in unsafe mode, home directory, /usr/lib/groff/site-tmac, /usr/\nshare/groff/site-tmac, /usr/share/groff/1.22.4/tmac) after these.\n\nGROFFTYPESETTER\nDefault device.\n\nGROFFFONTPATH\nA colon separated list of directories in which to search for the devname directory.\ntroff will scan directories given in the -F option before these, and in standard di‐\nrectories (/usr/share/groff/site-font, /usr/share/groff/1.22.4/font, /usr/lib/font)\nafter these.\n\n### FILES\n\n/usr/share/groff/1.22.4/tmac/troffrc\nInitialization file (called before any other macro package).\n\n/usr/share/groff/1.22.4/tmac/troffrc-end\nInitialization file (called after any other macro package).\n\n/usr/share/groff/1.22.4/tmac/name.tmac\n/usr/share/groff/1.22.4/tmac/tmac.name\nMacro files\n\n/usr/share/groff/1.22.4/font/devname/DESC\nDevice description file for device name.\n\n/usr/share/groff/1.22.4/font/devname/F\nFont file for font F of device name.\n\nNote that troffrc and troffrc-end are searched for neither in the current nor the home direc‐\ntory by default for security reasons (even if the -U option is given). Use the -M command-\nline option or the GROFFTMACPATH environment variable to add these directories to the\nsearch path if necessary.\n\n### AUTHORS\n\nThe GNU version of troff was originally written by James Clark; he also wrote the original\nversion of this document, which was modified by Werner Lemberg ⟨wl@gnu.org⟩ and Bernd Warken\n⟨groff-bernd.warken-72@web.de⟩.\n\n### SEE ALSO\n\ngroff(1)\nThe main program of the groff system, a wrapper around troff.\n\ngroff(7)\nA description of the groff language, including a short but complete reference of all\npredefined requests, registers, and escapes of plain groff. From the command line,\nthis is called by\n\nman 7 groff\n\ngroffdiff(7)\nThe differences of the groff language and the classical troff language. Currently,\nthis is the most actual document of the groff system.\n\nroff(7)\nAn overview over groff and other roff systems, including pointers to further related\ndocumentation.\n\nGroff: The GNU Implementation of troff, by Trent A. Fisher and Werner Lemberg, is the primary\ngroff manual. You can browse it interactively with “info groff”.\n\n\n\ngroff 1.22.4 23 March 2022 TROFF(1)\n\n" } ], "structuredContent": { "command": "troff", "section": "1", "mode": "man", "summary": "troff - the troff processor of the groff text formatting system", "synopsis": "troff [-abcivzCERU] [-d cs] [-f fam] [-F dir] [-I dir] [-m name] [-M dir] [-n num] [-o list]\n[-r cn] [-T name] [-w name] [-W name] [file ...]", "flags": [ { "flag": "-a", "long": null, "arg": null, "description": "" }, { "flag": "-b", "long": null, "arg": null, "description": "track down the cause of the error. The line numbers given in the backtrace may not always be correct, for troff's idea of line numbers gets confused by as or am re‐ quests." }, { "flag": "-c", "long": null, "arg": null, "description": "" }, { "flag": "-C", "long": null, "arg": null, "description": "" }, { "flag": "-d", "long": null, "arg": null, "description": "" }, { "flag": "-d", "long": null, "arg": null, "description": "Define c or name to be a string s; c must be a one letter name." }, { "flag": "-E", "long": null, "arg": null, "description": "standard error by macro packages using the tm or tm1 requests." }, { "flag": "-f", "long": null, "arg": null, "description": "" }, { "flag": "-F", "long": null, "arg": null, "description": "name of the device) and there for the DESC file and font files. dir is scanned before all other font directories." }, { "flag": "-i", "long": null, "arg": null, "description": "" }, { "flag": "-I", "long": null, "arg": null, "description": "the command line and those named in .psbb requests). The search path is initialized with the current directory. This option may be specified more than once; the directo‐ ries are then searched in the order specified (but before the current directory). If you want to make the current directory be read before other directories, add -I. at the appropriate place. No directory search is performed for files with an absolute file name." }, { "flag": "-m", "long": null, "arg": null, "description": "first searched for in directories given with the -M command-line option, then in di‐ rectories given in the GROFFTMACPATH environment variable, then in the current di‐ rectory (only if in unsafe mode), the home directory, /usr/lib/groff/site-tmac, /usr/ share/groff/site-tmac, and /usr/share/groff/1.22.4/tmac." }, { "flag": "-M", "long": null, "arg": null, "description": "other macro directories." }, { "flag": "-n", "long": null, "arg": null, "description": "" }, { "flag": "-o", "long": null, "arg": null, "description": "print page n, m-n means print every page between m and n, -n means print every page up to n, n- means print every page from n. troff will exit after printing the last page in the list." }, { "flag": "-r", "long": null, "arg": null, "description": "" }, { "flag": "-r", "long": null, "arg": null, "description": "Set number register c or name to n; c must be a one character name; n can be any troff numeric expression." }, { "flag": "-R", "long": null, "arg": null, "description": "" }, { "flag": "-T", "long": null, "arg": null, "description": "detailed description." }, { "flag": "-U", "long": null, "arg": null, "description": "For security reasons, these potentially dangerous requests are disabled otherwise. It will also add the current directory to the macro search path." }, { "flag": "-v", "long": null, "arg": null, "description": "" }, { "flag": "-w", "long": null, "arg": null, "description": "To enable most useful warnings use -w all. To enable absolutely all warnings use -w w instead. Multiple -w options are allowed." }, { "flag": "-W", "long": null, "arg": null, "description": "" }, { "flag": "-z", "long": null, "arg": null, "description": "" } ], "examples": [], "see_also": [ { "name": "groff", "section": "1", "url": "https://www.chedong.com/phpMan.php/man/groff/1/json" }, { "name": "groff", "section": "7", "url": "https://www.chedong.com/phpMan.php/man/groff/7/json" }, { "name": "groffdiff", "section": "7", "url": "https://www.chedong.com/phpMan.php/man/groffdiff/7/json" }, { "name": "roff", "section": "7", "url": "https://www.chedong.com/phpMan.php/man/roff/7/json" } ], "section_outline": [ { "name": "NAME", "lines": 2, "subsections": [] }, { "name": "SYNOPSIS", "lines": 3, "subsections": [] }, { "name": "DESCRIPTION", "lines": 5, "subsections": [] }, { "name": "OPTIONS", "lines": 2, "subsections": [ { "name": "-a", "lines": 1, "flag": "-a" }, { "name": "-b", "lines": 4, "flag": "-b" }, { "name": "-c", "lines": 1, "flag": "-c" }, { "name": "-C", "lines": 1, "flag": "-C" }, { "name": "-d", "lines": 1, "flag": "-d" }, { "name": "-d", "lines": 2, "flag": "-d" }, { "name": "-E", "lines": 2, "flag": "-E" }, { "name": "-f", "lines": 1, "flag": "-f" }, { "name": "-F", "lines": 3, "flag": "-F" }, { "name": "-i", "lines": 1, "flag": "-i" }, { "name": "-I", "lines": 8, "flag": "-I" }, { "name": "-m", "lines": 5, "flag": "-m" }, { "name": "-M", "lines": 2, "flag": "-M" }, { "name": "-n", "lines": 1, "flag": "-n" }, { "name": "-o", "lines": 4, "flag": "-o" }, { "name": "-r", "lines": 1, "flag": "-r" }, { "name": "-r", "lines": 3, "flag": "-r" }, { "name": "-R", "lines": 1, "flag": "-R" }, { "name": "-T", "lines": 2, "flag": "-T" }, { "name": "-U", "lines": 3, "flag": "-U" }, { "name": "-v", "lines": 1, "flag": "-v" }, { "name": "-w", "lines": 3, "flag": "-w" }, { "name": "-W -W", "lines": 1, "flag": "-W" }, { "name": "-z", "lines": 1, "flag": "-z" } ] }, { "name": "WARNINGS", "lines": 84, "subsections": [] }, { "name": "ENVIRONMENT", "lines": 15, "subsections": [] }, { "name": "FILES", "lines": 21, "subsections": [] }, { "name": "AUTHORS", "lines": 4, "subsections": [] }, { "name": "SEE ALSO", "lines": 24, "subsections": [] } ] } }