troffのヘルプ・マニュアル／リナックスコマンド

troffのヘルプ・マニュアル

help
man

troff --help

usage: troff -abcivzCERU -wname -Wname -dcs -ffam -mname -nnum -olist -rcn -Tname -Fdir -Mdir [files...]

man troff

TROFF(1) TROFF(1) 名称 troff - 文書をフォーマットする書式 troff [ -abivzCERU ] [ -wname ] [ -Wname ] [ -dcs ] [ -ffam ] [ -mname ] [ -nnum ] [ -olist ] [ -rcn ] [ -Tname ] [ -Fdir ] [ -Mdir ] [ files... ] コマンドラインオプションとパラメータの間に空白を含めることが可能です。解説本マニュアルでは、groff ドキュメントフォーマットシステムの一部である GNU バージョンの troff について記述します。本コマンドは UNIX troff と高い互換性を持ちます。通常 troff は groff コマンドから起動されます。 groff はまた、適切な前処理プログラムと後処理プログラムを適切なオプションで、適切な順序で起動します。オプション -a ASCII 文字のみの近似的な出力を行います。 -b 各警告とエラーメッセージに対するバックトレースを表示します。これは、警告やエラーの原因を調べるのに有用です。出力される行番号は必ずしも正しくはありません。 as や am リクエストにより、 troff が行番号を誤認する可能性があるからです。 -i 指定されたファイルをすべて処理したあとに、標準入力も読み込み、処理します。 -v バージョン番号を表示します。 -wname name で指定した分類の警告を行います。指定できる name は、後述の警告のサブセクションを参照してください。 -w オプションは複数指定できます。 -Wname name で指定した分類の警告を行いません。 -W オプションは複数指定することができます。 -E エラーメッセージを一切出力しません。 -z フォーマットした結果を出力しません。 -C 互換モードにします。 -dcs -dname=s マクロ c または name を文字列 s と定義します。 c は 1 文字のマクロ名です。 -ffam fam をデフォルトのフォントファミリとして使用します。 -mname マクロファイル name.tmac を読み込みます。見つからなければ、かわりに tmac.name を試みます。まず最初に -M コマンドラインオプションで指定されたディレクトリ、続いて GROFF_TMAC_PATH 環境変数で指定されたディレクトリ、そして現在のディレクトリ (安全でないモードの場合のみ)、ホームディレクトリ、/usr/share/tmac/ 、/usr/share/tmac/、 /usr/share/tmac の順に検索します。 -U 安全でないモード。これによって以下のリクエストが有効になります: .open, .opena, .pso, .sy, .pi. そうでなければ、セキュリティのためにこれらの危険性のあるリクエストは禁止されています。また現在のディレクトリをマクロ検索パスに加えます。 -R troffrc と troffrc-end を読みません。 -nnum 最初のページ番号を num とします。 -olist list で指定したページのみを出力します。 list は、コンマで区切られたページ範囲の列です。ページ範囲の指定方法は以下のとおりです: n は n ページの出力、 m-n は m ページから n ページまでの出力、 -n は n ページまでの出力、 n- は n ページ以降の出力を意味します。 troff はリストの最後のページを印刷し終えると終了します。 -rcn -rname=n 数値レジスタ c または name の値を n とします。 c は 1 文字の名前です。 n は troff で扱える数式です。 -Tname デバイス name 用の出力を生成します。デフォルトは ps です。 -Fdir フォントファイルと DESC ファイルを検索するのに、ディレクトリ (またはディレクトリパス) dir 以下の devname (name は出力デバイス名) を探します。他のすべてのフォントディレクトリより前に dir を調べます。 -Mdir 指定したディレクトリ (またはディレクトリパス) dir からマクロファイルを検索します。他のすべてのマクロディレクトリより前に調べます。使用法ここでは UNIX troff には無い機能のみを説明します。長い名前数値レジスタ、フォント、文字列/マクロ/転換、特殊文字のそれぞれの名前の長さは任意です。エスケープシーケンス中、すなわち 2 文字の名前 (xx を使用可能な場所で、任意の長さの名前 [xxx] を使用可能です。 \[xxx] xxx で呼ばれる特殊文字を表示します。 \f[xxx] フォント xxx を設定します。 \*[xxx] 文字列 xxx を挿入する。 \n[xxx] 数値レジスタ xxx を挿入する。分数のポイントサイズスケールドポイントは 1/sizescale ポイントです。ここで sizescale は DESC ファイルで指定されます (デフォルト値は 1 です)。また、新しいスケールインジケータ z があります。これは sizescale 倍する効果があります。 troff におけるリクエストおよびエスケープシーケンスはポイントサイズを表す引数をスケールドポイント単位で表されているとして解釈しますが、このような引数の評価はデフォルトのスケールインジケータ z にて行います。このように取り扱われる引数には、 ps リクエストの引数、 cs リクエストの 3 番目の引数、 tkf リクエストの 2 番目および 4 番目の引数、 \H エスケープシーケンスの引数、 \s エスケープシーケンスの変形で数値式を引数として取るものとがあります。例えば sizescale を 1000 とします; この場合スケールドポイントはミリポイントとなります; リクエスト .ps 10.25 は .ps 10.25z と同じですし、ポイントサイズは 10250 スケールドポイントに設定されます。これは 10.25 ポイントと等しい値です。数値レジスタ \n[.s] はポイントサイズを 10 進数分数のポイント単位で返します。新しい数値レジスタ \n[.ps] もあり、これはスケールドポイント単位でのポイントサイズを返します。デフォルトのスケールインジケータが u, z のどちらでもない数式中で z スケールインジケータを使用するのは無意味でしょう。 troff はこのようなことを禁止します。同様に、 z がデフォルトのスケールインジケータであった数式において z, u のどちらでもないスケールインジケータを使用するのは無意味でしょう。 troff はこのようなことを禁止します。また、新しいスケールインジケータ s があります。これはもとの値をスケールドポイントの単位数で逓倍します。例えば、 \n[.ps]s は 1m と同じです。 s, z スケールインジケータを混同しないようにして下さい。数値式括弧内の数式中に空白を含めることが許されます。 M は em の 1/100 を意味します。 e1>?e2 e1 と e2 とで小さくない方。 e1

TROFF(1) TROFF(1) NAME troff - the troff processor of the groff text formatting system SYNOPSIS troff [ -abcivzCERU ] [ -dcs ] [ -ffam ] [ -Fdir ] [ -mname ] [ -Mdir ] [ -nnum ] [ -olist ] [ -rcn ] [ -Tname ] [ -wname ] [ -Wname ] [ files... ] It is possible to have whitespace between a command line option and its parameter. DESCRIPTION This manual page describes the GNU version of troff. It is part of the groff document formatting system. It is functionally compatible with UNIX troff, but has many extensions, see groff_diff(7). Usually it should be invoked using the groff(1) command which will also run pre- processors and postprocessors in the appropriate order and with the appropriate options. OPTIONS -a Generate an ASCII approximation of the typeset output. -b Print a backtrace with each warning or error message. This backtrace should help track down the cause of the error. The line numbers given in the backtrace may not always be cor- rect, for troff’s idea of line numbers gets confused by as or am requests. -c Disable color output (always disabled in compatibility mode). -C Enable compatibility mode. -dcs -dname=s Define c or name to be a string s; c must be a one letter name. -E Inhibit all error messages of troff. Note that this doesn’t affect messages output to standard error by macro packages using the tm or tm1 requests. -ffam Use fam as the default font family. -Fdir Search in directory (or directory path) dir for subdirecto- ries devname (name is the name of the device) and there for the DESC file and font files. dir is scanned before all other font directories. -i Read the standard input after all the named input files have been processed. -mname Read in the file name.tmac. If it isn’t found, try tmac.name instead. It will be first searched for in directories given with the -M command line option, then in directories given in the GROFF_TMAC_PATH environment variable, then in the current directory (only if in unsafe mode), the home directory, /usr/lib64/groff/site-tmac, /usr/share/groff/site-tmac, and /usr/share/groff/1.18.1.4/tmac. -Mdir Search directory (or directory path) dir for macro files. This is scanned before all other macro directories. -nnum Number the first page num. -olist Output only pages in list, which is a comma-separated list of page ranges; n means 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. -rcn -rname=n Set number register c or name to n; c must be a one character name; n can be any troff numeric expression. -R Don’t load troffrc and troffrc-end. -Tname Prepare output for device name, rather than the default ps. -U Unsafe mode. This will enable the following requests: open, opena, pso, sy, and pi. For security reasons, these poten- tially dangerous requests are disabled otherwise. It will also add the current directory to the macro search path. -v Print the version number. -wname Enable warning name. Available warnings are described in the section WARNINGS below. For example, to enable all warnings, use -w all. Multiple -w options are allowed. -Wname Inhibit warning name. Multiple -W options are allowed. -z Suppress formatted output. WARNINGS The warnings that can be given by troff are divided into the following categories. The name associated with each warning is used by the -w and -W options; the number is used by the warn request, and by the .warn register; it is always a power of 2 to allow bitwise composition. +---------------------+----------------------------+ |Bit Code Warning | Bit Code Warning | +---------------------+----------------------------+ | 0 1 char | 10 1024 reg | | 1 2 number | 11 2048 tab | | 2 4 break | 12 4096 right-brace | | 3 8 delim | 13 8192 missing | | 4 16 el | 14 16384 input | | 5 32 scale | 15 32768 escape | | 6 64 range | 16 65536 space | | 7 128 syntax | 17 131072 font | | 8 256 di | 18 262144 ig | | 9 512 mac | 19 524288 color | +---------------------+----------------------------+ break 4 In fill mode, lines which could not be broken so that their length was less than the line length. This is enabled by default. char 1 Non-existent characters. This is enabled by default. color 524288 Color related warnings. delim 8 Missing or mismatched closing delimiters. di 256 Use of di or da without an argument when there is no current diversion. el 16 Use of the el request with no matching ie request. escape 32768 Unrecognized escape sequences. When an unrecog- nized escape sequence is encountered, the escape character is ignored. font 131072 Non-existent fonts. This is enabled by default. ig 262144 Invalid escapes in text ignored with the ig request. These are conditions that are errors when they do not occur in ignored text. input 16384 Invalid input characters. mac 512 Use of undefined strings, macros and diversions. When an undefined string, macro or diversion is used, that string is automatically defined as empty. So, in most cases, at most one warning will be given for each name. missing 8192 Requests that are missing non-optional arguments. number 2 Invalid numeric expressions. This is enabled by default. range 64 Out of range arguments. reg 1024 Use of undefined number registers. When an unde- fined number register is used, that register is automatically defined to have a value of 0. So, in most cases, at most one warning will be given for use of a particular name. right-brace 4096 Use of \} where a number was expected. scale 32 Meaningless scaling indicators. space 65536 Missing space between a request or macro and its argument. This warning will be given when an unde- fined name longer than two characters is encoun- tered, and the first two characters of the name make a defined name. The request or macro will not be invoked. When this warning is given, no macro is automatically defined. This is enabled by default. This warning will never occur in compati- bility mode. syntax 128 Dubious syntax in numeric expressions. tab 2048 Inappropriate use of a tab character. Either use of a tab character where a number was expected, or use of tab character in an unquoted macro argument. There are also names that can be used to refer to groups of warnings: all All warnings except di, mac, and reg. It is intended that this covers all warnings that are useful with traditional macro pack- ages. w All warnings. ENVIRONMENT GROFF_TMAC_PATH A colon separated list of directories in which to search for macro files. troff will scan directories given in the -M option before these, and in standard directories (current directory if in unsafe mode, home directory, /usr/lib64/groff/site-tmac, /usr/share/groff/site-tmac, /usr/share/groff/1.18.1.4/tmac) after these. GROFF_TYPESETTER Default device. GROFF_FONT_PATH A colon separated list of directories in which to search for the devname directory. troff will scan directories given in the -F option before these, and in standard directories (/usr/share/groff/site-font, /usr/share/groff/1.18.1.4/font, /usr/lib/font) after these. FILES /usr/share/groff/1.18.1.4/tmac/troffrc Initialization file (called before any other macro package). /usr/share/groff/1.18.1.4/tmac/troffrc-end Initialization file (called after any other macro package). /usr/share/groff/1.18.1.4/tmac/name.tmac /usr/share/groff/1.18.1.4/tmac/tmac.name Macro files /usr/share/groff/1.18.1.4/font/devname/DESC Device description file for device name. /usr/share/groff/1.18.1.4/font/devname/F Font file for font F of device name. Note that troffrc and troffrc-end are neither searched in the current nor in the home directory by default for security reasons (even if the -U option is given). Use the -M command line option or the GROFF_TMAC_PATH environment variable to add these directories to the search path if necessary. AUTHOR Copyright (C) 1989, 2001, 2002 Free Software Foundation, Inc. This document is distributed under the terms of the FDL (GNU Free Docu- mentation License) version 1.1 or later. You should have received a copy of the FDL on your system, it is also available on-line at the GNU copyleft site 〈http://www.gnu.org/copyleft/fdl.html〉. This document was written by James Clark, with modifications from Werner Lemberg 〈wl@gnu.org〉 and Bernd Warken 〈bwarken@mayn.de〉 This document is part of groff, the GNU roff distribution. SEE ALSO groff(1) The main program of the groff system, a wrapper around troff. groff(7) A description of the groff language, including a short but com- plete reference of all predefined requests, registers, and escapes of plain groff. From the command line, this is called by man 7 groff groff_diff(7) The differences of the groff language and the classical troff language. Currently, this is the most actual document of the groff system. roff(7) An overview over groff and other roff systems, including point- ers to further related documentation. The groff info file, cf. info(1), presents all groff documentation within a single document. Groff Version 1.18.1.4 16 September 2002 TROFF(1)

リナックスコマンド