diff --git a/ja_JP.eucJP/man/man1/as.1 b/ja_JP.eucJP/man/man1/as.1 index a14a2e7f49..fa332ee2c5 100644 --- a/ja_JP.eucJP/man/man1/as.1 +++ b/ja_JP.eucJP/man/man1/as.1 @@ -1,913 +1,913 @@ .\" $FreeBSD$ .\" .\" .\" Automatically generated by Pod::Man v1.3, Pod::Parser v1.13 .\" .\" Standard preamble: .\" ======================================================================== .de Sh \" Subsection heading .br .if t .Sp .ne 5 .PP \fB\\$1\fR .PP .. .de Sp \" Vertical space (when we can't use .PP) .if t .sp .5v .if n .sp .. .de Vb \" Begin verbatim text .ft CW .nf .ne \\$1 .. .de Ve \" End verbatim text .ft R .fi .. .\" Set up some character translations and predefined strings. \*(-- will .\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left .\" double quote, and \*(R" will give a right double quote. | will give a .\" real vertical bar. \*(C+ will give a nicer C++. Capital omega is used to .\" do unbreakable dashes and therefore won't be available. \*(C` and \*(C' .\" expand to `' in nroff, nothing in troff, for use with C<>. .tr \(*W-|\(bv\*(Tr .ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p' .ie n \{\ . ds -- \(*W- . ds PI pi . if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch . if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\" diablo 12 pitch . ds L" "" . ds R" "" . ds C` "" . ds C' "" 'br\} .el\{\ . ds -- \|\(em\| . ds PI \(*p . ds L" `` . ds R" '' 'br\} .\" .\" If the F register is turned on, we'll generate index entries on stderr for .\" titles (.TH), headers (.SH), subsections (.Sh), items (.Ip), and index .\" entries marked with X<> in POD. Of course, you'll have to process the .\" output yourself in some meaningful fashion. .if \nF \{\ . de IX . tm Index:\\$1\t\\n%\t"\\$2" .. . nr % 0 . rr F .\} .\" .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .hy 0 .\" .\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2). .\" Fear. Run. Save yourself. No user-serviceable parts. . \" fudge factors for nroff and troff .if n \{\ . ds #H 0 . ds #V .8m . ds #F .3m . ds #[ \f1 . ds #] \fP .\} .if t \{\ . ds #H ((1u-(\\\\n(.fu%2u))*.13m) . ds #V .6m . ds #F 0 . ds #[ \& . ds #] \& .\} . \" simple accents for nroff and troff .if n \{\ . ds ' \& . ds ` \& . ds ^ \& . ds , \& . ds ~ ~ . ds / .\} .if t \{\ . ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u" . ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u' . ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u' . ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u' . ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u' . ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u' .\} . \" troff and (daisy-wheel) nroff accents .ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V' .ds 8 \h'\*(#H'\(*b\h'-\*(#H' .ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#] .ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H' .ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u' .ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#] .ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#] .ds ae a\h'-(\w'a'u*4/10)'e .ds Ae A\h'-(\w'A'u*4/10)'E . \" corrections for vroff .if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u' .if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u' . \" for low resolution devices (crt and lpr) .if \n(.H>23 .if \n(.V>19 \ \{\ . ds : e . ds 8 ss . ds o a . ds d- d\h'-1'\(ga . ds D- D\h'-1'\(hy . ds th \o'bp' . ds Th \o'LP' . ds ae ae . ds Ae AE .\} .rm #[ #] #H #V #F C .\" ======================================================================== .\" .IX Title "AS 1" .TH AS 1 "2002-08-05" "binutils-2.12.91" "GNU Development Tools" .UC .SH "名称" \&\s-1AS\s0 \- ポータブル \s-1GNU\s0 アセンブラ .SH "書式" .IX Header "書式" as [\fB\-a\fR[\fBcdhlns\fR][=\fIfile\fR]] [\fB\-D\fR] [\fB\-\-defsym\fR \fIsym\fR=\fIval\fR] [\fB\-f\fR] [\fB\-\-gstabs\fR] [\fB\-\-gdwarf2\fR] [\fB\-\-help\fR] [\fB\-I\fR \fIdir\fR] [\fB\-J\fR] [\fB\-K\fR] [\fB\-L\fR] [\fB\-\-listing\-lhs\-width\fR=\fI\s-1NUM\s0\fR] [\fB\-\-listing\-lhs\-width2\fR=\fI\s-1NUM\s0\fR] [\fB\-\-listing\-rhs\-width\fR=\fI\s-1NUM\s0\fR] [\fB\-\-listing\-cont\-lines\fR=\fI\s-1NUM\s0\fR] [\fB\-\-keep\-locals\fR] [\fB\-o\fR \fIobjfile\fR] [\fB\-R\fR] [\fB\-\-statistics\fR] [\fB\-v\fR] [\fB\-version\fR] [\fB\-\-version\fR] [\fB\-W\fR] [\fB\-\-warn\fR] [\fB\-\-fatal\-warnings\fR] [\fB\-w\fR] [\fB\-x\fR] [\fB\-Z\fR] [\fB\-\-target\-help\fR] [\fItarget-options\fR] [\fB\-\-\fR|\fIfiles\fR ...] .PP \&\fIターゲット Alpha オプション:\fR [\fB\-m\fR\fIcpu\fR] [\fB\-mdebug\fR | \fB\-no\-mdebug\fR] [\fB\-relax\fR] [\fB\-g\fR] [\fB\-G\fR\fIsize\fR] [\fB\-F\fR] [\fB\-32addr\fR] .PP \&\fIターゲット \s-1ARC\s0 オプション:\fR [\fB\-marc[5|6|7|8]\fR] [\fB\-EB\fR|\fB\-EL\fR] .PP \&\fIターゲット \s-1ARM\s0 オプション:\fR [\fB\-mcpu\fR=\fIprocessor\fR[+\fIextension\fR...]] [\fB\-march\fR=\fIarchitecture\fR[+\fIextension\fR...]] [\fB\-mfpu\fR=\fIfloating-point-fromat\fR] [\fB\-mthumb\fR] [\fB\-EB\fR|\fB\-EL\fR] [\fB\-mapcs\-32\fR|\fB\-mapcs\-26\fR|\fB\-mapcs\-float\fR| \fB\-mapcs\-reentrant\fR] [\fB\-mthumb\-interwork\fR] [\fB\-moabi\fR] [\fB\-k\fR] .PP \&\fIターゲット \s-1CRIS\s0 オプション:\fR [\fB\-\-underscore\fR | \fB\-\-no\-underscore\fR] [\fB\-\-pic\fR] [\fB\-N\fR] [\fB\-\-emulation=criself\fR | \fB\-\-emulation=crisaout\fR] .PP \&\fIターゲット D10V オプション:\fR [\fB\-O\fR] .PP \&\fIターゲット D30V オプション:\fR [\fB\-O\fR|\fB\-n\fR|\fB\-N\fR] .PP \&\fIターゲット i386 オプション:\fR [\fB\-\-32\fR|\fB\-\-64\fR] .PP \&\fIターゲット i960 オプション:\fR [\fB\-ACA\fR|\fB\-ACA_A\fR|\fB\-ACB\fR|\fB\-ACC\fR|\fB\-AKA\fR|\fB\-AKB\fR| \fB\-AKC\fR|\fB\-AMC\fR] [\fB\-b\fR] [\fB\-no\-relax\fR] .PP \&\fIターゲット M32R オプション:\fR [\fB\-\-m32rx\fR|\fB\-\-[no\-]warn\-explicit\-parallel\-conflicts\fR| \fB\-\-W[n]p\fR] .PP \&\fIターゲット M680X0 オプション:\fR [\fB\-l\fR] [\fB\-m68000\fR|\fB\-m68010\fR|\fB\-m68020\fR|...] .PP \&\fIターゲット M68HC11 オプション:\fR [\fB\-m68hc11\fR|\fB\-m68hc12\fR] [\fB\-\-force\-long\-branchs\fR] [\fB\-\-short\-branchs\fR] [\fB\-\-strict\-direct\-mode\fR] [\fB\-\-print\-insn\-syntax\fR] [\fB\-\-print\-opcodes\fR] [\fB\-\-generate\-example\fR] .PP \&\fIターゲット \s-1MCORE\s0 オプション:\fR [\fB\-jsri2bsr\fR] [\fB\-sifilter\fR] [\fB\-relax\fR] [\fB\-mcpu=[210|340]\fR] .PP \&\fIターゲット \s-1MIPS\s0 オプション:\fR [\fB\-nocpp\fR] [\fB\-EL\fR] [\fB\-EB\fR] [\fB\-n\fR] [\fB\-O\fR[\fIoptimization level\fR]] [\fB\-g\fR[\fIdebug level\fR]] [\fB\-G\fR \fInum\fR] [\fB\-KPIC\fR] [\fB\-call_shared\fR] [\fB\-non_shared\fR] [\fB\-xgot\fR] [\fB\-\-membedded\-pic\fR] [\fB\-mabi\fR=\fI\s-1ABI\s0\fR] [\fB\-32\fR] [\fB\-n32\fR] [\fB\-64\fR] [\fB\-mfp32\fR] [\fB\-mgp32\fR] [\fB\-march\fR=\fI\s-1CPU\s0\fR] [\fB\-mtune\fR=\fI\s-1CPU\s0\fR] [\fB\-mips1\fR] [\fB\-mips2\fR] [\fB\-mips3\fR] [\fB\-mips4\fR] [\fB\-mips5\fR] [\fB\-mips32\fR] [\fB\-mips64\fR] [\fB\-construct\-floats\fR] [\fB\-no\-construct\-floats\fR] [\fB\-trap\fR] [\fB\-no\-break\fR] [\fB\-break\fR] [\fB\-no\-trap\fR] [\fB\-mfix7000\fR] [\fB\-mno\-fix7000\fR] [\fB\-mips16\fR] [\fB\-no\-mips16\fR] [\fB\-mips3d\fR] [\fB\-no\-mips3d\fR] [\fB\-mdmx\fR] [\fB\-no\-mdmx\fR] [\fB\-mdebug\fR] [\fB\-no\-mdebug\fR] .PP \&\fIターゲット \s-1MMIX\s0 オプション:\fR [\fB\-\-fixed\-special\-register\-names\fR] [\fB\-\-globalize\-symbols\fR] [\fB\-\-gnu\-syntax\fR] [\fB\-\-relax\fR] [\fB\-\-no\-predefined\-symbols\fR] [\fB\-\-no\-expand\fR] [\fB\-\-no\-merge\-gregs\fR] [\fB\-x\fR] [\fB\-\-linker\-allocated\-gregs\fR] .PP \&\fIターゲット \s-1PDP11\s0 オプション:\fR [\fB\-mpic\fR|\fB\-mno\-pic\fR] [\fB\-mall\fR] [\fB\-mno\-extensions\fR] [\fB\-m\fR\fIextension\fR|\fB\-mno\-\fR\fIextension\fR] [\fB\-m\fR\fIcpu\fR] [\fB\-m\fR\fImachine\fR] .PP \&\fIターゲット picoJava オプション:\fR [\fB\-mb\fR|\fB\-me\fR] .PP \&\fIターゲット PowerPC オプション:\fR [\fB\-mpwrx\fR|\fB\-mpwr2\fR|\fB\-mpwr\fR|\fB\-m601\fR|\fB\-mppc\fR|\fB\-mppc32\fR|\fB\-m603\fR|\fB\-m604\fR| \fB\-m403\fR|\fB\-m405\fR|\fB\-mppc64\fR|\fB\-m620\fR|\fB\-mppc64bridge\fR|\fB\-mbooke\fR| \fB\-mbooke32\fR|\fB\-mbooke64\fR] [\fB\-mcom\fR|\fB\-many\fR|\fB\-maltivec\fR] [\fB\-memb\fR] [\fB\-mregnames\fR|\fB\-mno\-regnames\fR] [\fB\-mrelocatable\fR|\fB\-mrelocatable\-lib\fR] [\fB\-mlittle\fR|\fB\-mlittle\-endian\fR|\fB\-mbig\fR|\fB\-mbig\-endian\fR] [\fB\-msolaris\fR|\fB\-mno\-solaris\fR] .PP \&\fIターゲット \s-1SPARC\s0 オプション:\fR [\fB\-Av6\fR|\fB\-Av7\fR|\fB\-Av8\fR|\fB\-Asparclet\fR|\fB\-Asparclite\fR \fB\-Av8plus\fR|\fB\-Av8plusa\fR|\fB\-Av9\fR|\fB\-Av9a\fR] [\fB\-xarch=v8plus\fR|\fB\-xarch=v8plusa\fR] [\fB\-bump\fR] [\fB\-32\fR|\fB\-64\fR] .SH "解説" .IX Header "解説" \s-1GNU\s0 \fBas\fR とは、実は一連のアセンブラのことです。 もしあるアーキテクチャで \s-1GNU\s0 アセンブラを使う (もしくは、使った ことがある) ならば、他のアーキテクチャで使う時もかなり似た環境となり ます。それぞれのバージョンは他のバージョンと共通の部分が多くあります。 例えば、オブジェクトファイルフォーマットや ほとんどのアセンブラディレクティブ (\fI疑似命令(pseudo-ops)\fRとも呼ばれます)、アセンブラシンタクスなどです。 .PP \fBas\fR が作られた第一の目的は、\s-1GNU\s0 C コンパイラ の出力をリンカで使用できるようアセンブルすることです。 確かに、\fBas\fR が、 ネイティブアセンブラがアセンブルできるものはすべて 正しくアセンブルできるようにしようとしてきました。 例外は明確に文書化されています。 このことは、\fBas\fR の用いるシンタクスが、 同一アーキテクチャの他のアセンブラと同じである、 ということを意味するものではありません。 たとえば、680x0 のアセンブラ言語 のシンタクスには互換性のないバージョンが存在することが知られてい ます。 .PP \fBas\fR の起動 1 回ごとに、 ちょうどひとつのソースプログラムだけをアセンブルします。 ソースプログラムはひとつ以上のファイルから構成されます。 (標準入力もファイルひとつとみなします。) .PP \fBas\fR に与えるコマンドラインには、 0 個以上の入力ファイル名が含まれます。 入力ファイルは (左のファイル名から開始して右へ向って) 読み込まれます。 特別な意味が無いコマンドライン引数は (どんな位置であっても) 入力ファイル名であるとみなされます。 .PP もし \fBas\fR にファイル名が指定されなければ、ひとつの入力ファイルが \fBas\fR の標準入力 (ふつうは端末) から読み出されます。 \fBctl-D\fR をタイプすることで、これ以上アセンブルするプログラムが存在しないこと を \fBas\fR に通知します。 .PP コマンドライン上で明示的に標準入力を指定する必要のある時は、 \fB\-\-\fR を使ってください。 .PP ソースが空の場合、\fBas\fR は小さな空のオブジェクトファイルを作成します。 .PP \fBas\fR は、警告およびエラーメッセージを標準エラー出力 (通常は端末) へ出力します。 \fBas\fR が コンパイラによって自動起動された場合は、この限りではありません。 警告とは、欠陥のあるプログラムのアセンブルを続行するために \fBas\fR が仮定した内容を報告したものです。 エラーは、アセンブルを続行できない重大な問題を表します。 .PP \fBas\fR を \s-1GNU\s0 C コンパイラ (バージョン 2) から起動している場合、 \fB\-Wa\fR オプションを使用してアセンブラへの引数を渡せます。 それぞれのアセンブラ引数 (と \fB\-Wa\fR) は、コンマで区切られます。 例えば次のようになります。 .PP .Vb 1 \& gcc -c -g -O -Wa,-alh,-L file.c .Ve これは 2 個のオプションをアセンブラに渡します: すなわち \fB\-alh\fR (高級言語とアセンブラソースのリストを標準出力へ出力) と \fB\-L\fR (ローカルシンボルをシンボルテーブルに残す) です。 .PP 通常はこの \fB\-Wa\fR の機構を使用する必要はありません。 なぜならば、コンパイラがアセンブラに対し、 多くのコンパイラコマンドラインオプションを渡すからです。 (\s-1GNU\s0 コンパイラドライバを \fB\-v\fR オプション付きで起動することで、 アセンブラを含む各コンパイルのパスに対してどのようなオプションを渡すのか、 正確に調べることができます。) .SH "オプション" .IX Header "オプション" .IP "\fB\-a[cdhlmns]\fR" 4 .IX Item "-a[cdhlmns]" リスト出力を行います。 次の種類があります。 .RS 4 .IP "\fB\-ac\fR" 4 .IX Item "-ac" 偽の条件を削除します .IP "\fB\-ad\fR" 4 .IX Item "-ad" デバッグ用ディレクティブを削除します .IP "\fB\-ah\fR" 4 .IX Item "-ah" 高級言語ソースを含みます .IP "\fB\-al\fR" 4 .IX Item "-al" アセンブリを含みます .IP "\fB\-am\fR" 4 .IX Item "-am" マクロ拡張を含みます .IP "\fB\-an\fR" 4 .IX Item "-an" フォーム処理 (forms processing) を削除します .IP "\fB\-as\fR" 4 .IX Item "-as" シンボルを含みます .IP "\fB=file\fR" 4 .IX Item "=file" リスト出力を行うファイル名を設定します。 .RE .RS 4 .Sp これらのオプションを組み合わせ可能です。 例えば、\fB\-aln\fR はアセンブリリストをフォーム処理無しで出力します。 \fB=file\fR オプションは、使用された場合、 最後のサブオプションである必要があります。 デフォルトのサブオプションは \fB\-a\fR だけ指定すると \fB\-ahls\fR になります。 .RE .IP "\fB\-D\fR" 4 .IX Item "-D" 無視されます。 このオプションは、他のアセンブラ呼び出しとの互換のために 受け付けられるものです。 .IP "\fB\-\-defsym\fR \fIsym\fR\fB=\fR\fIvalue\fR" 4 .IX Item "--defsym sym=value" 入力ファイルをアセンブルする前に、 シンボル \fIsym\fR を \fBvalue\fR であると定義します。 \fBvalue\fR は定数の整数である必要があります。 C と同様、先行する \fB0x\fR は 16 進数値を示し、 先行する \fB0\fR は 8 進数値を示します。 .IP "\fB\-f\fR" 4 .IX Item "-f" ``高速 (fast)''オプションです\-\-\- プリプロセシングを行ないません (ソースはコンパイラの出力したものとみなします)。 .IP "\fB\-\-gstabs\fR" 4 .IX Item "--gstabs" 各アセンブリの行に対し、スタブデバッグ情報 (stabs debugging information) を生成します。 デバッガが扱える場合、アセンブリコードのデバッグに役立つかもしれません。 .IP "\fB\-\-gdwarf2\fR" 4 .IX Item "--gdwarf2" 各アセンブリの行に対し、\s-1DAWRF2\s0 デバッグ情報を生成します。 デバッガが扱える場合、アセンブリコードのデバッグに役立つかもしれません。 注 \- 本オプションはすべてのターゲットでサポートされているわけではなく、 一部のみでサポートされています。 .IP "\fB\-\-help\fR" 4 .IX Item "--help" コマンドラインオプションのまとめを表示し、終了します。 .IP "\fB\-\-target\-help\fR" 4 .IX Item "--target-help" ターゲット固有のすべてのオプションのまとめを表示し、終了します。 .IP "\fB\-I\fR \fIdir\fR" 4 .IX Item "-I dir" \fBdir\fR を \f(CW\*(C`.include\*(C'\fR ディレクティブの検索リストに追加します。 .IP "\fB\-J\fR" 4 .IX Item "-J" 符号付き整数の桁溢れを警告しません。 .IP "\fB\-K\fR" 4 .IX Item "-K" 本オプションは受け付けられますが、\s-1TARGET\s0 ファミリでは効果がありません。 .IP "\fB\-L\fR" 4 .IX Item "-L" .PD 0 .IP "\fB\-\-keep\-locals\fR" 4 .IX Item "--keep-locals" .PD ローカルシンボルを (シンボル表) に保存します。 伝統的な a.out システムでは、これらは \fBL\fR で開始しますが、 別のシステムでは別のローカルラベルプレフィックスを持ちます。 .IP "\fB\-\-listing\-lhs\-width=\fR\fInumber\fR" 4 .IX Item "--listing-lhs-width=number" アセンブラリストにおける出力データコラムの最大幅を \fInumber\fR 語に設定します。 .IP "\fB\-\-listing\-lhs\-width2=\fR\fInumber\fR" 4 .IX Item "--listing-lhs-width2=number" アセンブラリストにおける継続行の出力データコラムの最大幅を \fInumber\fR 語に設定します。 .IP "\fB\-\-listing\-rhs\-width=\fR\fInumber\fR" 4 .IX Item "--listing-rhs-width=number" リストで表示される入力ソース行の最大幅を \fInumber\fR バイトに設定します。 .IP "\fB\-\-listing\-cont\-lines=\fR\fInumber\fR" 4 .IX Item "--listing-cont-lines=number" リスト中で入力 1 行に対応する表示行の最大を \fInumber\fR + 1 行に設定します。 .IP "\fB\-o\fR \fIobjfile\fR" 4 .IX Item "-o objfile" \fBas\fR の出力オブジェクトファイル名を \fIobjfile\fR に設定します。 .IP "\fB\-R\fR" 4 .IX Item "-R" データセクションをテキストセクションへ混入させます。 .IP "\fB\-\-statistics\fR" 4 .IX Item "--statistics" アセンブルに使用した最大空間 (バイト数) と合計時間 (秒数) を表示します。 .IP "\fB\-\-strip\-local\-absolute\fR" 4 .IX Item "--strip-local-absolute" ローカルの絶対シンボルを出力先のシンボル方から削除します。 .IP "\fB\-v\fR" 4 .IX Item "-v" .PD 0 .IP "\fB\-version\fR" 4 .IX Item "-version" .PD \fBas\fR のバージョンを表示します。 .IP "\fB\-\-version\fR" 4 .IX Item "--version" \fBas\fR のバージョンを表示し、終了します。 .IP "\fB\-W\fR" 4 .IX Item "-W" .PD 0 .IP "\fB\-\-no\-warn\fR" 4 .IX Item "--no-warn" .PD 警告メッセージの出力を抑制します。 .IP "\fB\-\-fatal\-warnings\fR" 4 .IX Item "--fatal-warnings" 警告を、エラーとして扱います。 .IP "\fB\-\-warn\fR" 4 .IX Item "--warn" 警告を抑制しませんし、エラーとしても扱いません。 .IP "\fB\-w\fR" 4 .IX Item "-w" 無視されます。 .IP "\fB\-x\fR" 4 .IX Item "-x" 無視されます。 .IP "\fB\-Z\fR" 4 .IX Item "-Z" エラーの後でもオブジェクトファイルを生成します。 .IP "\fB\-\- |\fR \fIfiles\fR \fB...\fR" 4 .IX Item "-- | files ..." アセンブル対象のソースファイルまたは標準入力です。 .PP 次のオプションは、\s-1ARC\s0 プロセッサ用に設定された場合に使用可能です。 .IP "\fB\-marc[5|6|7|8]\fR" 4 .IX Item "-marc[5|6|7|8]" This option selects the core processor variant. .IP "\fB\-EB | \-EL\fR" 4 .IX Item "-EB | -EL" Select either big-endian (\-EB) or little-endian (\-EL) output. .PP 次のオプションは、 \s-1ARM\s0 プロセッサファミリ用に設定された場合に使用可能です。 .IP "\fB\-mcpu=\fR\fIprocessor\fR\fB[+\fR\fIextension\fR\fB...]\fR" 4 .IX Item "-mcpu=processor[+extension...]" どの \s-1ARM\s0 プロセッサがターゲットであるかを指定します。 .IP "\fB\-march=\fR\fIarchitecture\fR\fB[+\fR\fIextension\fR\fB...]\fR" 4 .IX Item "-march=architecture[+extension...]" どの \s-1ARM\s0 アーキテクチャがターゲットであるかを指定します。 .IP "\fB\-mfpu=\fR\fIfloating-point-format\fR" 4 .IX Item "-mfpu=floating-point-format" どの浮動小数点数アーキテクチャがターゲットであるかを指定します。 .IP "\fB\-mthumb\fR" 4 .IX Item "-mthumb" Thumb 命令のみのデコードを有効にします。 .IP "\fB\-mapcs\-32 | \-mapcs\-26 | \-mapcs\-float | \-mapcs\-reentrant | \-moabi\fR" 4 .IX Item "-mapcs-32 | -mapcs-26 | -mapcs-float | -mapcs-reentrant | -moabi" どのプロシジャ呼び出し規約を使用するのかを指定します。 .IP "\fB\-EB | \-EL\fR" 4 .IX Item "-EB | -EL" ビッグエンディアン (\-EB) 出力かリトルエンディアン出力か (\-EL) を選択します。 .IP "\fB\-mthumb\-interwork\fR" 4 .IX Item "-mthumb-interwork" Thumb と \&\s-1ARM\s0 が相互動作することを考慮に入れてコード生成 されたことを指定します。 .IP "\fB\-k\fR" 4 .IX Item "-k" \s-1PIC\s0 コードが生成されたことを指定します。 .PP CRIS 固有のオプションの記述は info ページを参照してください。 .PP 次のオプションは、 D10V プロセッサ用に設定された場合に使用可能です。 .IP "\fB\-O\fR" 4 .IX Item "-O" 命令を並列化して出力を最適化します。 .PP 次のオプションは、 D30V プロセッサ用に設定された場合に使用可能です。 .IP "\fB\-O\fR" 4 .IX Item "-O" 命令を並列化して出力を最適化します。 .IP "\fB\-n\fR" 4 .IX Item "-n" nop が出力されたときに警告します。 .IP "\fB\-N\fR" 4 .IX Item "-N" 32 ビット掛け算の後に nop が出力されたときに警告します。 .PP 次のオプションは、 80960 プロセッサ用に設定された場合に使用可能です。 .IP "\fB\-ACA | \-ACA_A | \-ACB | \-ACC | \-AKA | \-AKB | \-AKC | \-AMC\fR" 4 .IX Item "-ACA | -ACA_A | -ACB | -ACC | -AKA | -AKB | -AKC | -AMC" どの 960 アーキテクチャがターゲットであるかを指定します。 .IP "\fB\-b\fR" 4 .IX Item "-b" 実際に行われた分岐に関する統計情報を収集するコードを追加します。 .IP "\fB\-no\-relax\fR" 4 .IX Item "-no-relax" ロングディスプレースメントの「比較-分岐」という命令列に対して 変更を加えません。 場合によってはエラーが発生します。 .PP 次のオプションは、 Mitsubishi M32R シリーズ用に設定された場合に使用可能です。 .IP "\fB\-\-m32rx\fR" 4 .IX Item "--m32rx" M32R ファミリのどのプロセッサがターゲットであるかを指定します。 デフォルトは、通常、M32R ですが、 本オプションを指定すると M32RX になります。 .IP "\fB\-\-warn\-explicit\-parallel\-conflicts or \-\-Wp\fR" 4 .IX Item "--warn-explicit-parallel-conflicts or --Wp" 疑わしい parallel constructs に出会った場合、警告します。 .IP "\fB\-\-no\-warn\-explicit\-parallel\-conflicts or \-\-Wnp\fR" 4 .IX Item "--no-warn-explicit-parallel-conflicts or --Wnp" 疑わしい parallel constructs に出会った場合でも、警告しません。 .PP 次のオプションは、 Motorola 68000 シリーズ用に設定された場合に使用可能です。 .IP "\fB\-l\fR" 4 .IX Item "-l" 2 ワードではなく、1 ワードの短い参照を未定義シンボルに適用します。 .IP "\fB\-m68000 | \-m68008 | \-m68010 | \-m68020 | \-m68030\fR" 4 .IX Item "-m68000 | -m68008 | -m68010 | -m68020 | -m68030" .PD 0 .IP "\fB| \-m68040 | \-m68060 | \-m68302 | \-m68331 | \-m68332\fR" 4 .IX Item "| -m68040 | -m68060 | -m68302 | -m68331 | -m68332" .IP "\fB| \-m68333 | \-m68340 | \-mcpu32 | \-m5200\fR" 4 .IX Item "| -m68333 | -m68340 | -mcpu32 | -m5200" .PD -68000 ファミリのどのプロセッサがターゲットかを指定します +68000 ファミリのどのプロセッサがターゲットかを指定します。 デフォルトは 68020 ですが、設定時に変更可能です。 .IP "\fB\-m68881 | \-m68882 | \-mno\-68881 | \-mno\-68882\fR" 4 .IX Item "-m68881 | -m68882 | -mno-68881 | -mno-68882" ターゲットは浮動小数点数コプロセッサを持っています (持っていません)。 デフォルトでは、68020, 68030, cpu32 用のコプロセッサを仮定します。 素の 68000 は 68881 と互換ではありませんが、 コプロセッサ命令をメインプロセッサでのエミュレーション可能ですので、 両者の組み合わせも指定可能です。 .IP "\fB\-m68851 | \-mno\-68851\fR" 4 .IX Item "-m68851 | -mno-68851" ターゲットマシンはメモリ管理ユニットコプロセッサを持っています (持っていません)。 デフォルトでは、68020 以上用の \s-1MMU\s0 を仮定します。 .PP \s-1PDP\-11\s0 機種依存機能オプションについての詳細は、 \f(CW@ref\fR{PDP\-11\-Options} を参照してください。 .IP "\fB\-mpic | \-mno\-pic\fR" 4 .IX Item "-mpic | -mno-pic" 位置独立 (または位置依存) コードを生成します。 デフォルトは \fB\-mpic\fR です。 .IP "\fB\-mall\fR" 4 .IX Item "-mall" .PD 0 .IP "\fB\-mall\-extensions\fR" 4 .IX Item "-mall-extensions" .PD すべての命令セット拡張を有効にします。 これがデフォルトです。 .IP "\fB\-mno\-extensions\fR" 4 .IX Item "-mno-extensions" すべての命令セット拡張を無効にします。 .IP "\fB\-m\fR\fIextension\fR \fB| \-mno\-\fR\fIextension\fR" 4 .IX Item "-mextension | -mno-extension" 特定の命令セット拡張を有効 (無効) にします。 .IP "\fB\-m\fR\fIcpu\fR" 4 .IX Item "-mcpu" 特定の \s-1CPU\s0 でサポートされる命令セット拡張を有効にし、 他のすべての拡張を無効にします。 .IP "\fB\-m\fR\fImachine\fR" 4 .IX Item "-mmachine" 特定のマシンモデルでサポートされる命令セット拡張を有効にし、 他のすべての拡張を無効にします。 .PP 次のオプションは、 picoJava プロセッサ用に設定された場合に使用可能です。 .IP "\fB\-mb\fR" 4 .IX Item "-mb" ``ビッグエンディアン'' フォーマット出力を行います。 .IP "\fB\-ml\fR" 4 .IX Item "-ml" ``リトルエンディアン'' フォーマット出力を行います。 .PP 次のオプションは、 Motorola 68HC11 シリーズまたは 68HC12 シリーズ用に 設定された場合に使用可能です。 .IP "\fB\-m68hc11 | \-m68hc12\fR" 4 .IX Item "-m68hc11 | -m68hc12" どのプロセッサがターゲットであるかを指定します。 デフォルトは、アセンブラを構築するときの設定オプションで定義されています。 .IP "\fB\-\-force\-long\-branchs\fR" 4 .IX Item "--force-long-branchs" 相対分岐が絶対分岐に変換されます。 条件分岐、無条件分岐、サブルーチンへの分岐が対象です。 .IP "\fB\-S | \-\-short\-branchs\fR" 4 .IX Item "-S | --short-branchs" オフセットが範囲外の場合、 相対分岐を絶対分岐に変換しません。 .IP "\fB\-\-strict\-direct\-mode\fR" 4 .IX Item "--strict-direct-mode" 命令が直接アドレッシングモードをサポートしない場合、 直接アドレッシングモードを拡張アドレッシングモードに変換しません。 .IP "\fB\-\-print\-insn\-syntax\fR" 4 .IX Item "--print-insn-syntax" エラーの場合、命令の文法を表示します。 .IP "\fB\-\-print\-opcodes\fR" 4 .IX Item "--print-opcodes" print the list of instructions with syntax and then exit. 命令一覧を文法と共に表示し、終了します。 .IP "\fB\-\-generate\-example\fR" 4 .IX Item "--generate-example" 命令となりうる各箇所に対して命令の例を 1 個表示し、終了します。 本オプションは \fBas\fR のテストにのみ有用です。 .PP 次のオプションは、\fBas\fR が \s-1SPARC\s0 シリーズ用に設定された場合に使用可能です。 .IP "\fB\-Av6 | \-Av7 | \-Av8 | \-Asparclet | \-Asparclite\fR" 4 .IX Item "-Av6 | -Av7 | -Av8 | -Asparclet | -Asparclite" .PD 0 .IP "\fB\-Av8plus | \-Av8plusa | \-Av9 | \-Av9a\fR" 4 .IX Item "-Av8plus | -Av8plusa | -Av9 | -Av9a" .PD \s-1SPARC\s0 アーキテクチャの種類を明示的に選択します。 .Sp \fB\-Av8plus\fR と \fB\-Av8plusa\fR は 32 ビット環境を選択します。 \fB\-Av9\fR と \fB\-Av9a\fR は 64 ビット環境を選択します。 .Sp \fB\-Av8plusa\fR と \fB\-Av9a\fR は \s-1SPARC\s0 V9 命令セットと UltraSPARC 拡張を有効にします。 .IP "\fB\-xarch=v8plus | \-xarch=v8plusa\fR" 4 .IX Item "-xarch=v8plus | -xarch=v8plusa" Solaris v9 アセンブラとの互換性用です。 これらのオプションは、それぞれ、 \-Av8plus と \-Av8plusa と等価です。 .IP "\fB\-bump\fR" 4 .IX Item "-bump" アセンブラが別のアーキテクチャに変わったときに警告します。 .PP 次のオプションは、\fBas\fR が \s-1MIPS\s0 シリーズ用に設定された場合に使用可能です。 .IP "\fB\-G\fR \fInum\fR" 4 .IX Item "-G num" 暗黙的に \f(CW\*(C`gp\*(C'\fR レジスタを介して参照されるオブジェクトの 最大サイズを設定します。 \s-1ECOFF\s0 フォーマットを使用するターゲット、 例えば Ultrix を実行する DECstation でのみ、受け付けられます。 デフォルト値は 8 です。 .IP "\fB\-EB\fR" 4 .IX Item "-EB" ``ビッグエンディアン'' フォーマット出力を行います。 .IP "\fB\-EL\fR" 4 .IX Item "-EL" ``リトルエンディアン'' フォーマット出力を行います。 .IP "\fB\-mips1\fR" 4 .IX Item "-mips1" .PD 0 .IP "\fB\-mips2\fR" 4 .IX Item "-mips2" .IP "\fB\-mips3\fR" 4 .IX Item "-mips3" .IP "\fB\-mips4\fR" 4 .IX Item "-mips4" .IP "\fB\-mips5\fR" 4 .IX Item "-mips5" .IP "\fB\-mips32\fR" 4 .IX Item "-mips32" .IP "\fB\-mips64\fR" 4 .IX Item "-mips64" .PD 特定の \s-1MIPS\s0 命令セットアーキテクチャ (Instruction Set Architecture) レベル用のコードを生成します。 \fB\-mips1\fR は \fB\-march=r3000\fR の別名、 \fB\-mips2\fR は \fB\-march=r6000\fR の別名、 \fB\-mips3\fR は \fB\-march=r4000\fR の別名、 \fB\-mips4\fR は \fB\-march=84000\fR の別名です。 \fB\-mips5\fR, \fB\-mips32\fR, \fB\-mips64\fR は、 それぞれ、一般の \fB\s-1MIPS\s0 V\fR, \fB\s-1MIPS32\s0\fR, \fB\s-1MIPS64\s0\fR \s-1ISA\s0 に対応します。 .IP "\fB\-march=\fR\fI\s-1CPU\s0\fR" 4 .IX Item "-march=CPU" \s-1MIPS\s0 CPU 固有のコードを生成します。 .IP "\fB\-mtune=\fR\fIcpu\fR" 4 .IX Item "-mtune=cpu" \s-1MIPS\s0 CPU 固有のスケジュールとチューニングを行います。 .IP "\fB\-mfix7000\fR" 4 .IX Item "-mfix7000" .PD 0 .IP "\fB\-mno\-fix7000\fR" 4 .IX Item "-mno-fix7000" .PD mfhi か mflo の命令の後続 2 命令に 宛先レジスタからの読み出しが存在する場合、NOP を挿入します。 .IP "\fB\-mdebug\fR" 4 .IX Item "-mdebug" .PD 0 .IP "\fB\-no\-mdebug\fR" 4 .IX Item "-no-mdebug" .PD stabs スタイルのデバッグ情報が、 標準の \s-1ELF\s0 .stabs セクションではなく、 ECOFF スタイルの .mdebug セクションへ行くようにします。 .IP "\fB\-mgp32\fR" 4 .IX Item "-mgp32" .PD 0 .IP "\fB\-mfp32\fR" 4 .IX Item "-mfp32" .PD レジスタサイズは、通常、\s-1ISA\s0 と \s-1ABI\s0 で決まりますが、 これらのフラグはある種のレジスタが常に 32 ビット幅で使われるように強制します。 \fB\-mgp32\fR は汎用レジスタの大きさを、 \fB\-mfp32\fR は浮動小数点数レジスタの大きさを、制御します。 .IP "\fB\-mips16\fR" 4 .IX Item "-mips16" .PD 0 .IP "\fB\-no\-mips16\fR" 4 .IX Item "-no-mips16" .PD \s-1MIPS\s0 16 プロセッサ用のコードを生成します。 これは、アセンブリファイルの先頭に \&\f(CW\*(C`.set mips16\*(C'\fR を挿入することと等価です。 \fB\-no\-mips16\fR は、本オプションをオフにします。 .IP "\fB\-mips3d\fR" 4 .IX Item "-mips3d" .PD 0 .IP "\fB\-no\-mips3d\fR" 4 .IX Item "-no-mips3d" .PD \s-1MIPS\-3D\s0 Application Specific Extension 用のコードを生成します。 アセンブラに対し、\s-1MIPS\-3D\s0 命令を受け付けるよう指示します。 \&\fB\-no\-mips3d\fR は、このオプションをオフにします。 .IP "\fB\-mdmx\fR" 4 .IX Item "-mdmx" .PD 0 .IP "\fB\-no\-mdmx\fR" 4 .IX Item "-no-mdmx" .PD \s-1MDMX\s0 Application Specific Extension 用のコードを生成します。 アセンブラに対し、\s-1MDMX\s0 命令を受け付けるよう指示します。 \&\fB\-no\-mdmx\fR は、このオプションをオフにします。 .IP "\fB\-\-construct\-floats\fR" 4 .IX Item "--construct-floats" .PD 0 .IP "\fB\-\-no\-construct\-floats\fR" 4 .IX Item "--no-construct-floats" .PD \fB\-\-no\-construct\-floats\fR オプションは、 倍幅の浮動小数点数定数の構築を無効化します。 倍幅の浮動小数点数定数の構築とは、 値の半分を 2 個、 倍幅レジスタを構築する 2 個の単幅浮動小数点数レジスタへロードすること で行われるものです。 デフォルトでは、\fB\-\-construct\-floats\fR が選択されており、 これらの浮動小数点数定数の構築を許しています。 .IP "\fB\-\-emulation=\fR\fIname\fR" 4 .IX Item "--emulation=name" \fBas\fR が他のターゲット用に設定されたかのようにエミュレートするよう、 \fBas\fR に指示します。 これはすべての面にわたり、 出力フォーマット (s-1ELF\s0 と \s-1ECOFF\s0 の内からのみ選択)、 デバッグ情報を生成したりシンボル表情報を格納する擬似オプコードの扱い、 デフォルトのエンディアンも含まれます。 利用可能な設定名は次の通りです: \fBmipsecoff\fR, \fBmipself\fR, \fBmipslecoff\fR, \fBmipsbecoff\fR, \fBmipslelf\fR, \fBmipsbelf\fR。 最初の 2 個は、 アセンブラが設定された第一ターゲットにおけるデフォルトから、 エンディアンを変えません。 他のものは、デフォルトをリトルエンディアンまたはビッグエンディアンにします。 これは、名前中の \fBb\fR または \fBl\fR で示されています。 いかなる場合でも、\fB\-EB\fR または \fB\-EL\fR は、 エンディアンの選択に優先します。 .Sp 本オプションが現在サポートされているのは、\fBas\fR の第一のターゲットが \s-1MIPS\s0 \s-1ELF\s0 か \s-1MIPS\s0 \s-1ECOFF\s0 に設定された場合のみです。 さらに、両方のフォーマットのサポートが必要な場合、 \fB\-\-enable\-targets=...\fR で設定時に指定される 第一のターゲットおよび他のターゲットには、 他のフォーマットのサポートを含む必要があります。 例えば、Irix 5 の設定は両者のサポートを含みます。 .Sp 最終的には、本オプションはより多くの設定をサポートし、 アセンブラの動作に対してより細粒度の制御を行い、 より多くのプロセッサでサポートされることでしょう。 .IP "\fB\-nocpp\fR" 4 .IX Item "-nocpp" \fBas\fR は本オプションを無視します。 ネイティブツールとの互換性とのために受け付けられます。 .IP "\fB\-\-trap\fR" 4 .IX Item "--trap" .PD 0 .IP "\fB\-\-no\-trap\fR" 4 .IX Item "--no-trap" .IP "\fB\-\-break\fR" 4 .IX Item "--break" .IP "\fB\-\-no\-break\fR" 4 .IX Item "--no-break" .PD 掛け算による溢れと 0 除算をどのように扱うかを制御します。 \fB\-\-trap\fR または \fB\-\-no\-break\fR (同義語です) はトラップ例外を発生します (命令セットアーキテクチャレベル 2 以上でのみ動作します)。 \fB\-\-break\fR または \fB\-\-no\-trap\fR (同義語です。デフォルト) はブレイク例外を発生します。 .IP "\fB\-n\fR" 4 .IX Item "-n" 本オプションを使用すると、 マクロ由来の nop を生成するたびに \fBas\fR は警告を発生します。 .PP 次のオプションは、\fBas\fR が MCore プロセッサ用に設定された場合に使用可能です。 .IP "\fB\-jsri2bsr\fR" 4 .IX Item "-jsri2bsr" .PD 0 .IP "\fB\-nojsri2bsr\fR" 4 .IX Item "-nojsri2bsr" .PD \s-1JSRI\s0 を \s-1BSR\s0 へ変換することを、有効または無効にします。 デフォルトでは、有効です。 コマンドラインオプション \fB\-nojsri2bsr\fR を使用して、これを無効にできます。 .IP "\fB\-sifilter\fR" 4 .IX Item "-sifilter" .PD 0 .IP "\fB\-nosifilter\fR" 4 .IX Item "-nosifilter" .PD シリコンフィルタの動作を、有効または無効にします。 デフォルトでは、無効です。 コマンドラインオプション \fB\-sifilter\fR を使用して、 デフォルトに優先させることができます。 .IP "\fB\-relax\fR" 4 .IX Item "-relax" 長いディスプレースメント用の jump 命令を変更します。 .IP "\fB\-mcpu=[210|340]\fR" 4 .IX Item "-mcpu=[210|340]" ターゲットハードウェアの CPU タイプを選択します。 これにより、どの命令をアセンブルするかを制御します。 .IP "\fB\-EB\fR" 4 .IX Item "-EB" ビッグエンディアンのターゲット用にアセンブルします。 .IP "\fB\-EL\fR" 4 .IX Item "-EL" リトルエンディアンのターゲット用にアセンブルします。 .PP MMIX 固有のオプションの記述は info ページを参照してください。 .SH "関連項目" .IX Header "関連項目" \&\fIgcc\fR\|(1) と \fIld\fR\|(1) および \fIbinutils\fR と \fIld\fR の Info エントリ。 .SH "COPYRIGHT" .IX Header "COPYRIGHT" Copyright (C) 1991, 92, 93, 94, 95, 96, 97, 98, 99, 2000, 2001, 2002 Free Software Foundation, Inc. .PP Permission is granted to copy, distribute and/or modify this document under the terms of the \s-1GNU\s0 Free Documentation License, Version 1.1 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 license is included in the section entitled \*(L"\s-1GNU\s0 Free Documentation License\*(R". .\" .SH 履歴 .\" 堀川和雄 : 2000/07/09 更新。 .\" 堀川和雄 : 2001/08/04 binutils 2.11.2 用に修正。 .\" 堀川和雄 : 2002/09/01 binutils 2.12.1 用に修正。 .\" 堀川和雄 : 2003/08/07 binutils 2.12.91 用に修正。 diff --git a/ja_JP.eucJP/man/man1/colldef.1 b/ja_JP.eucJP/man/man1/colldef.1 index b8f744a69e..c450ab0fb0 100644 --- a/ja_JP.eucJP/man/man1/colldef.1 +++ b/ja_JP.eucJP/man/man1/colldef.1 @@ -1,252 +1,252 @@ .\" Copyright (c) 1995 Alex Tatmanjants .\" at Electronni Visti IA, Kiev, Ukraine. .\" All rights reserved. .\" .\" Redistribution and use in source and binary forms, with or without .\" modification, are permitted provided that the following conditions .\" are met: .\" 1. Redistributions of source code must retain the above copyright .\" notice, this list of conditions and the following disclaimer. .\" 2. Redistributions in binary form must reproduce the above copyright .\" notice, this list of conditions and the following disclaimer in the .\" documentation and/or other materials provided with the distribution. .\" .\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE .\" ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR BE LIABLE .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF .\" SUCH DAMAGE. .\" .\" %FreeBSD: src/usr.bin/colldef/colldef.1,v 1.20 2003/09/14 13:41:57 ru Exp % .\" .\" $FreeBSD$ .\" .Dd January, 27 1995 .Dt COLLDEF 1 .Os .Sh 名称 .Nm colldef .Nd 照合シークエンスのソース定義を変換する .Sh 書式 .Nm colldef .Op Fl I Ar map_dir .Op Fl o Ar out_file .Op Ar filename .Sh 解説 .Nm ユーティリティは、照合シークエンスのソース定義を .Fn strxfrm と .Fn strcoll 関数で使えるフォーマットに変換します。すなわち、文字列をソートや照合で きるようにする様々な方法を定義するために使われます。 .Fn strxfrm 関数は、その第一引数を変換して第二引数の結果に置き換えます。 変換された文字列は、 .Fn strcmp , .Fn strncmp , .Fn memcmp を使って別の変換された文字列と比較して正しくソートできるようになります。 .Fn strcoll 関数はその引数を変換し、比較を行ないます。 .Pp .Nm ユーティリティは、 標準入力から照合シークエンスソース定義を読み込み、変換された定義を filename に格納します。 生成される出力ファイルの内容は、システムコマンドやシステムルーチンが 使える形式の照合シークエンス情報を持つデータベースです。 .Pp 次のオプションが使用可能です: .Bl -tag -width indent .It Fl I Ar map_dir .Ar charmap ファイルを探すディレクトリ名を設定します。 デフォルトでカレントディレクトリです。 .It Fl o Ar out_file 出力ファイル名を設定します。 デフォルトで .Ar LC_COLLATE になります。 .El .Pp 照合シークエンス定義は、照合要素集合、 -およびこれを含む文字列をどのように順序付けるかを定義する規則を指定します +およびこれを含む文字列をどのように順序付けるかを定義する規則を指定します。 これは異なる言語定義に最も便利です。 .Pp 指定ファイルは次の三つのステートメントから成ります: .Ar charmap , .Ar substitute, .Ar order .Pp この中で .Ar order ステートメントだけが必須です。 .Ar charmap や .Ar substitute が与えられたときは、ステートメントの順序は上のようになっていなければ なりません。 orderステートメントの後のステートメントは無視されます。 .Pp 指定ファイルの中で .Em # で始まる行はコメントと扱われ、無視されます。空行も無視されます。 .Pp .Bd -literal -offset indent charmap charmapfile .Ed .Pp .Ar charmap は、文字のマッピングと実際の文字エンコーディングへの照合要素シンボル が見つかる場所を定義します。 .Pp .Ar charmapfile のフォーマットを以下に示します。 シンボル名とその値は、タブまたは空白文字によって区切られます。 symbol-value は 16 進 (\ex\fI??\fR) または 8 進 (\e\fI???\fR) 表現で指定でき、長さは一文字を意味します。 .Pp .Bd -literal -offset indent symbol-name1 symbol-value1 symbol-name2 symbol-value2 \&... .Ed .Pp シンボル名は .Ar substitute フィールドでは指定できません。 .Pp .Ar charmap ステートメントはオプション指定です。 .Pp .Bd -literal -offset indent substitute "symbol" with "repl_string" .Ed .Pp .Ar substitute ステートメントは、文字 .Ar symbol を文字列 .Ar repl_string に置き換えます。 .Pp .Ar substitute ステートメントはオプション指定です。 .Pp .Bd -literal -offset indent order order_list .Ed .Pp .Ar order_list は、セミコロンで区切られた、照合シークエンスを定義する シンボルのリストです。 特殊シンボル .Ar ... は、簡略な形の機械語順で連なったシンボルを指定します。 .Pp orderリストの要素は、次の方法のうちのどれかで表現できます。 .Bl -bullet .It シンボル自身 (例えば、小文字の .Ar a は .Ar a と書きます)。 .It 8 進表現のシンボル (例えば、文字 .Ar a には .Ar \e141 ) 。 .It 16 進表現のシンボル (例えば、文字 .Ar a には .Ar \ex61 ) 。 .It .Ar charmap ファイル内で定義されたシンボル名 (例えば、 .Ar charmapfile の .Ar letterA \e023 に対して .Ar )。文字マップ名が、文字 .Ar > を持つ場合は、 .Ar /> , のようにエスケープされなければならず、 文字 .Ar / は .Ar // のようにエスケープされなければなりません。 .It シンボル .Ar \ea , .Ar \eb , .Ar \ef , .Ar \en , .Ar \er , .Ar \ev は、通常の C言語の意味で使うことが許されています。 .It シンボルチェーン (例えば、 .Ar abc , .Ar c , .Ar \exf1b\exf2 ) 。 .It シンボルの範囲 (例えば .Ar a;...;z ) 。 .It コンマ区切りのシンボル、範囲、チェーンは括弧でくくられます。 (例えば .Ar \&( .Ar sym1 , .Ar sym2 , .Ar ... .Ar \&) ) は同じ一次順序で割り当てられますが、異なる二次順序となります。 .It 鈎括弧でくくられたコンマ区切りのシンボル、範囲、チェーン (例えば、 .Ar \&{ .Ar sym1 , .Ar sym2 , .Ar ... .Ar \&} ) は、同じ一次順序だけに割り当てられます)。 .El .Pp バックスラッシュ文字 .Ar \e は、行の継続に使われます。この場合、バックスラッシュ文字の後には どんな文字も書かれてはなりません。 .Sh 診断 .Nm ユーティリティは、次の戻り値で終了します。 .Bl -tag -width indent .It Li 0 エラーがなく、出力の生成に成功した場合 .It Li !=0 エラーが見つかった場合 .El .Sh 関連ファイル .Bl -tag -width indent .It Pa /usr/share/locale/ Ns Ao Ar language Ac Ns Pa /LC_COLLATE locale .Aq Ar language の配下で、locale の照合順序のための標準共有位置 .El .Sh 関連項目 .Xr mklocale 1 , .Xr setlocale 3 , .Xr strcoll 3 , .Xr strxfrm 3 diff --git a/ja_JP.eucJP/man/man1/crunchgen.1 b/ja_JP.eucJP/man/man1/crunchgen.1 index c55539c9f1..aae5285588 100644 --- a/ja_JP.eucJP/man/man1/crunchgen.1 +++ b/ja_JP.eucJP/man/man1/crunchgen.1 @@ -1,471 +1,471 @@ .\" .\" Copyright (c) 1994 University of Maryland .\" All Rights Reserved. .\" .\" Permission to use, copy, modify, distribute, and sell this software and its .\" documentation for any purpose is hereby granted without fee, provided that .\" the above copyright notice appear in all copies and that both that .\" copyright notice and this permission notice appear in supporting .\" documentation, and that the name of U.M. not be used in advertising or .\" publicity pertaining to distribution of the software without specific, .\" written prior permission. U.M. makes no representations about the .\" suitability of this software for any purpose. It is provided "as is" .\" without express or implied warranty. .\" .\" U.M. DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE, INCLUDING ALL .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS, IN NO EVENT SHALL U.M. .\" BE LIABLE FOR ANY SPECIAL, INDIRECT OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES .\" WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN .\" ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR .\" IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. .\" .\" Author: James da Silva, Systems Design and Analysis Group .\" Computer Science Department .\" University of Maryland at College Park .\" %FreeBSD: src/usr.sbin/crunch/crunchgen/crunchgen.1,v 1.28 2002/05/30 07:51:22 ru Exp % .\" .\" $FreeBSD$ .Dd November 16, 2000 .Dt CRUNCHGEN 1 .Os .Sh 名称 .Nm crunchgen .Nd クランチバイナリ構築環境を作成する .Sh 書式 .Bk -words .Nm .Op Fl foql .Op Fl h Ar makefile-header-name .Op Fl m Ar makefile-name .Op Fl p Ar obj-prefix .Op Fl c Ar c-file-name .Op Fl e Ar exec-file-name .Op Ar conf-file .Ek .Sh 解説 クランチバイナリ (crunched binary) は、 たくさんの別々のプログラムをひとつにまとめて 単一の実行形式にしたプログラムです。 クランチバイナリの .Fn main 関数は、 .Va argv[0] の値をみて、 どのコンポーネントプログラムが実行されるべきかを決定します。 複数プログラムをクランチしてひとつにまとめる主たる理由は、 インストールフロッピあるいはシステム回復フロッピ上に、 できるだけ多くのプログラムを収納するためです。 .Pp .Nm ユーティリティは .Ar conf-file に記述されたクランチバイナリのための設定項目を読み込み、 .Pa Makefile とそれに付随するトップレベルの C ソースファイルを生成します。 これらはビルド時に各コンポーネントプログラムからクランチした実行形式を 作成します。 オプションにより、 .Nm は、各コンポーネントプログラムに対して、 そのソースディレクトリの .Pa Makefile から プログラムを構成するオブジェクトファイル (.o) を決定することも試みます。 この情報は実行のたびにキャッシュされます。 .Nm ユーティリティは関連するもうひとつのプログラム .Xr crunchide 1 を用い、全ての不要なシンボルを隠すことで コンポーネントプログラム間のリンク時のシンボル競合を防ぎます。 .Pp .Nm ユーティリティは特殊な要件をパッケージの .Pa Makefile に課しており、このことが原因で .Pa Makefile が非 .Bx ソース用に使えなくなっています。 特に、 .Pa Makefile はターゲット .Ic depend を含むことが必要であり、全オブジェクトファイルを変数 .Va OBJS で定義することが必要です。 場合によっては、偽の .Pa Makefile を使えるでしょう。 .Nm は、ソースディレクトリ .Pa foo 中の .Pa Makefile を見る前に、現在のディレクトリ中の .Pa Makefile.foo を見ます。 .Pp .Nm 実行後、 .Dq Li make -f .mk を実行することで クランチバイナリを作成できます。 コンポーネントプログラムのオブジェクトファイルは既に作成されている 必要があります。 出力される makefile に含まれる .Ic objs ターゲットは、 各コンポーネントプログラムのソースディレクトリで .Xr make 1 を実行し、ユーザのためにオブジェクトファイルを作成してくれます。 しかしこのターゲットは自動的には実行されません。 リリースエンジニアリング環境では、オブジェクトを他のディレクトリで 修正するのは一般に望ましくないからです。 .Pp オプションは以下の通りです: .Bl -tag -width indent .It Fl c Ar c-file-name 出力する C のファイル名を .Ar c-file-name とします。デフォルトの名前は .Pa .c です。 .It Fl e Ar exec-file-name クランチバイナリの実行形式ファイルの名前を .Ar exec-file-name とします。デフォルトの名前は .Pa です。 .It Fl f キャッシュを消去し、キャッシュされていたパラメータを強制的に再計算します。 .It Fl l 名前の表示。このバイナリが対応する名前を一覧表示します。 .It Fl h Ar makefile-header-name .Nm が生成する .Pa Makefile の先頭に含めるファイルの名前を設定します。 make の変数を定義するのに便利です。 これには、 .Xr make 1 の動作に影響を与え、環境変数を介してでは面倒である、 .Va RELEASE_CRUNCH が含まれます。 .It Fl m Ar makefile-name 出力する .Pa Makefile の名前を .Ar makefile-name とします。デフォルトの名前は .Pa .mk です。 .It Fl o 各プログラムの make ターゲットに対し、 .Dq Li make obj ルールを追加します。 .It Fl p Ar obj-prefix .Ic objdir を計算するときに、 .Ic srcdir の前に付けるパス名を設定します。 このオプションが存在しない場合、使用するプレフィックスは .Ev MAKEOBJDIRPREFIX 環境変数の内容か、または .Pa /usr/obj です。 .It Fl q 静粛処理モード。状況報告メッセージを抑制します。 .El .Sh CRUNCHGEN コンフィギュレーションファイルコマンド .Nm ユーティリティは、クランチバイナリのコンポーネントについて記述した設定項目を .Ar conf-file から読み取ります。 最も単純な場合は、各コンポーネントプログラム名を、 そのソースファイルが置かれたトップレベルのディレクトリ名とともに、 単に列挙するだけです。 次に .Nm ユーティリティは (ソースの makefile によって) オブジェクトファイルリストと その位置を求め、それをキャッシュします。 もっと特殊な場合には、 .Nm が必要とするあらゆるパラメータを、ユーザが手動で指定することができます。 .Pp .Ar conf-file のコマンドは以下の通りです: .Bl -tag -width indent .It Ic srcdirs Ar dirname ... コンポーネントプログラムのソースディレクトリがあるソースツリーのリスト。 これらのディレクトリは .Bx の .Dq Pa // 方式を用いて検索されます。 .Ic srcdirs 行は複数あってもよく、ディレクトリは記述された順に検索されます。 .It Ic progs Ar progname ... クランチバイナリを構成するプログラムのリスト。 .Ic progs 行は複数あっても構いません。 .It Ic libs Ar libspec ... クランチバイナリのリンク時に含めるライブラリ指定のリスト。 .Ic libs 行は複数あっても構いません。 .It Ic buildopts Ar buildopts ... 各 make ターゲットに追加追加される、ビルドオプションのリスト。 .It Nm ln Ar progname linkname .Va argv[0] に .Ar linkname が現われたときはいつも .Ar progname を起動するよう、クランチバイナリに要請します。 これにより、起動時の名前によって振る舞いを変えるようなプログラムも 正しく動作するようにできます。 .El .Pp 特別な状況、例えば ソースファイルがないとか、 従来の .Pa Makefile によらないビルドを行うといった場合に対応するため、以下に述べる .Ic special コマンドを用いてコンポーネントプログラムの .Nm パラメータを指定できます。 .Bl -tag -width indent .It Ic special Ar progname Ic srcdir Ar pathname プログラム用 .Ar progname のオブジェクトファイル一覧を保持する make 変数の名前を設定します。 これは通常 .Nm OBJS ですが、Makefile によっては、他の約束が好ましい場合や、 .Nm SSHD_OBJS のようにプログラム名が前に付くものがあります。 .It Nm special Ar progname Nm srcdir Ar pathname プログラム .Ar progname のソースディレクトリを指定します。 通常は指定されたディレクトリ .Ic srcdirs 内の .Ar progname ディレクトリを検索して決定されます。 .It Ic special Ar progname Ic objdir Ar pathname プログラム .Ar progname の .Pa obj ディレクトリを指定します。 通常、 .Pa obj ディレクトリは、 ソースディレクトリ名の前に次のいずれかのコンポーネントを付けたものとして 計算され、コンポーネントには次の順番で優先度があります: コマンドラインにおける .Fl p の引数、環境変数 .Ev MAKEOBJDIRPREFIX の値、または .Pa /usr/obj です。 もしディレクトリが見つからなければ、ディレクトリ .Ic srcdir 自身が .Ic objdir となります。 .It Ic special Ar progname Ic buildopts Ar buildopts ビルドオプション集合を定義します。 .Ar progname 処理時には、 .Nm buildopts で指定されたものに加え、これらが追加されて .Xr make 1 のターゲットが作成されます。 .It Ic special Ar progname Ic objs Ar object-file-name ... プログラム .Ar progname のオブジェクトファイルのリストを指定します。 通常は、 .Dq Ic srcdir Ns / Ns Pa Makefile をインクルードし .Va $(OBJS) の値を出力するような一時 makefile を構築する ことで決定されます。 .It Ic special Ar progname Ic objpaths Ar full-pathname-to-object-file ... プログラム .Ar progname のオブジェクトファイルのパス名を指定します。 通常は .Ic objs リスト中の各ファイルのパス名の先頭に .Ic objdir を付加することで決定されます。 .It Ic special Ar progname Ic objvar Ar variable_name プログラム .Ar progname 用のオブジェクトファイルリストを保持する .Xr make 1 変数名を設定します。 これは通常 .Va OBJS ですが、 .Pa Makefile によっては別の規約を使用したいかもしれませんし、 変数名の前にプログラム名を付けたいかもしれません。例えば .Va SSHD_OBJS など。 .It Ic special Ar progname Ic lib Ar library-name ... .Ar progname Ns Pa .lo を生成するためにオブジェクトファイルとリンクするライブラリを指定します。 標準ライブラリに含まれるルーチンを再定義するライブラリを使用するときに 有用です。 .It Ic special Ar progname Ic keep Ar symbol-name ... プログラム .Ar progname の保持リストに、指定するシンボルのリストを追加します。 各シンボルの前にはアンダスコア .Pq Ql _ が付加され、 .Xr crunchide 1 フェーズでは .Fl k -オプションの引数となります +オプションの引数となります。 このオプションはシンボルが衝突するときの最後の拠所ですが、 シンボル解決の唯一の方法である場合もあります。 .It Ic special Ar progname Ic ident Ar identifier .Ar progname に対する .Pa Makefile Ns / Ns Tn C 識別子を設定します。 これは通常、 .Ar progname を元に、 .Ql - を .Ql _ にマップし、他のすべての非識別子文字を無視することにより、生成されます。 この結果、 .Qq Li foo.bar と .Qq Li foobar は、同一の識別子にマップされてしまいます。 .El .Pp 実際に .Nm が必要とするのは .Ic objpaths だけですが、 これは .Ic objdir と .Ic objs から求められ、これらも .Ic srcdir から求められます。 ですから、もし可能なら、初期のパラメータを指定し、あとは .Nm に求めさせたほうが便利な場合もあります。 .Pp .Nm が生成する makefile はオプションのターゲット .Ic objs を含みます。 これは、各コンポーネントプログラムのソースディレクトリ内で .Xr make 1 を実行してオブジェクトファイルを作成するターゲットです。 これがうまく動作するためには .Ic srcdir および .Ic objs パラメータが正しいものでなくてはなりません。 もしこれらの値があるプログラムに対して不正なものであると、 .Ic objs ターゲットではそのプログラムはスキップされてしまいます。 .Sh 実行例 .Nm の入力コンフィギュレーションファイルの例として .Dq Pa kcopy.conf の内容を示します。 .Pp .Bd -literal -offset indent srcdirs /usr/src/bin /usr/src/sbin progs test cp echo sh fsck halt init mount umount myinstall progs anotherprog ln test [ # test は [ として起動することもできる ln sh -sh # init は argv[0] を "-sh" としてシェルを起動する special myprog objpaths /homes/leroy/src/myinstall.o # ソースなし special anotherprog -DNO_FOO WITHOUT_BAR=YES libs -lutil -lcrypt .Ed .Pp このコンフィギュレーションファイルでは、 いくつかの基本的なシステムユーティリティと 自家製のインストールプログラム .Dq Pq myinstall から成る 小さなクランチバイナリを記述しています。 ソースディレクトリは全く指定されていませんが、 オブジェクトファイルは .Nm special 行で直接指定されています。 .Pp さらに、 .Dq Pa anotherprog 構築時には、引数 .Pp .Dl -DNO_FOO WITHOUT_BAR=YES .Pp がすべてのビルドターゲットに対して追加されます。 .Pp クランチバイナリ .Dq Pa kcopy は以下のようにして作成できます: .Pp .Bd -literal -offset indent % crunchgen -m Makefile kcopy.conf # Makefile と kcopy.c 作成 % make objs # コンポーネントプログラムの *.o 作成 % make # クランチバイナリ kcopy の作成 % kcopy sh # シェル sh を起動できるかどうか試すと.. $ # うまくいった! .Ed .Pp ここまでくれば、バイナリ .Dq Pa kcopy をインストールフロッピにコピーし、 各コンポーネントプログラムの名前でハードリンクを設けることができます。 .Sh 関連項目 .Xr crunchide 1 .Xr make 1 .Sh 警告 .Nm はクランチバイナリ中の各コンポーネントプログラム間のリンク競合を 除去するのに気を配っていますが、依然としてリンクされたライブラリ間で 競合が発生する可能性が残っています。 ライブラリ順の入れ換えが必要な場合もありますし、 二つのライブラリ間にどうしても解消できない競合が発生し、 結局ひとつにまとめられない場合も稀にあります。 .Pp .Bx のバージョンによっては、デフォルトのビルド環境では 単一ソースファイルのプログラムに対して 中間オブジェクトファイルを作成しないことがあります。 その場合は .Dq Li make objs ターゲットを用いてオブジェクトファイルを 作成するか、他の調整を施す必要があります。 .Sh 作者 .Nm ユーティリティは .An James da Silva Aq jds@cs.umd.edu によって作成されました。 .Pp Copyright (c) 1994 University of Maryland. All Rights Reserved. diff --git a/ja_JP.eucJP/man/man1/md5.1 b/ja_JP.eucJP/man/man1/md5.1 index 2d663b8a31..5c07d94ec9 100644 --- a/ja_JP.eucJP/man/man1/md5.1 +++ b/ja_JP.eucJP/man/man1/md5.1 @@ -1,82 +1,82 @@ .\" %FreeBSD: src/sbin/md5/md5.1,v 1.19 2003/11/02 23:12:08 se Exp % .\" .\" $FreeBSD$ .Dd February 14, 1994 .Dt MD5 1 .Os .Sh 名称 .Nm md5 .Nd ファイルに対するフィンガプリント(チェックサム)を計算する .Sh 書式 .Nm .Op Fl pqrtx .Op Fl s Ar string .Op Ar .Sh 解説 .Nm ユーティリティは、任意の長さのメッセージを入力にとり、128 ビットの .Dq フィンガプリント もしくは .Dq メッセージの要約 と呼ばれるものを出力として生成します。 同じ要約を持つようなメッセージを二つ造る事も、 これと決めた要約を持つように狙ってメッセージを造り出す事も、 計算量的に不可能であると推論されています。 電子署名アプリケーションにおいて、大きなファイルは .Em RSA の様な公開鍵暗号システムで非公開 (秘密) 鍵によって符号化される前に、 安全に .Dq 圧縮 されなければなりません。 MD5 はまだ (2001-09-03) 破られていませんが、 セキュリティに対するいくらかの疑いをもたらす十分な攻撃がなされています。 MD5 に対する攻撃は、 .Dq 衝突 -を見つけるという種類のものです +を見つけるという種類のものです。 すなわち、同じ値にハッシュされる複数の入力を見つけるというものです。 しかしながら、ハッシュ値から元の入力を正確に決定することは、 まだ攻撃者にとって可能ではなさそうです。 .Pp MD5 アルゴリズムは、そのような電子署名アプリケーション向けに開発されています。 .Pp 以下のオプションを組み合わせて使うことができますが、 コマンド行のファイル名より前になければなりません。 コマンド行の各ファイルの MD5 チェックサムが、 オプション処理後に表示されます。 .Bl -tag -width indent .It Fl s Ar string 与えられた .Ar string のチェックサムを表示します。 .It Fl p 標準入力を標準出力に送り、MD5 の合計を標準出力に付け加えます。 .It Fl q 静かなモード - MD5 の合計だけを表示します。 .Fl r オプションに優先します。 .It Fl r 出力フォーマットを逆にします。 視覚による差分の助けになります。 .Fl ptx オプションと組み合わせると、なにもしません。 .It Fl t 組み込みの時間試行を実行します。 .It Fl x 組み込みのテストスクリプトを実行します。 .El .Sh 診断 .Nm プログラムは、成功時には 0 で終了し、 少なくとも 1 個の入力ファイルの読み取りに失敗した場合に 1 で終了します。 .Sh 関連項目 .Xr cksum 1 .Rs .%A R. Rivest .%T The MD5 Message-Digest Algorithm .%O RFC1321 .Re .Sh 謝辞 このプログラムは、RSA Data Security 社により、 一般的な利用に対してパブリックドメインとされています。 diff --git a/ja_JP.eucJP/man/man1/smbutil.1 b/ja_JP.eucJP/man/man1/smbutil.1 index 08f1b7988f..4a91e83d0b 100644 --- a/ja_JP.eucJP/man/man1/smbutil.1 +++ b/ja_JP.eucJP/man/man1/smbutil.1 @@ -1,136 +1,136 @@ -.\" $Id: smbutil.1,v 1.2 2002-08-26 02:34:10 horikawa Exp $ +.\" $Id: smbutil.1,v 1.3 2004-02-19 15:03:10 horikawa Exp $ .\" $FreeBSD$ .Dd February 14, 2000 .Dt SMBUTIL 1 .Os .Sh 名称 .Nm smbutil .Nd "SMB リクエスタとのインタフェース" .Sh 書式 .Nm .Op Fl hv .Ar command .Op Fl Ar options .Op Ar args .Sh 解説 .Nm コマンドは、SMB リクエスタの制御と、様々なコマンドの発行に使用されます。 .Pp 指定される .Ar command に対して 2 種類のオプション、 すなわち共通オプションと個別オプションがあります。 .Pp 共通オプションは次の通りです: .Bl -tag -width indent .It Fl h 短かいヘルプメッセージを表示します。 .It Fl v 出力を冗長にします。 .El .Pp コマンドと対応する個別オプションは次の通りです: .Bl -tag -width indent .It Cm crypt Op Ar password クリアテキストパスワードを暗号化して、 .Pa ~/.nsmbrc ファイルに格納できるようにします。 暗号化されたパスワードは、 .Ql $$1 というシンボルで開始します。 警告: 暗号化関数は非常に弱く、 クリアテキストパスワードを隠すことだけを意図しています。 コマンドラインに .Ar password が指定されないと、 .Nm は入力を促します。 .It Cm help Ar command .Ar command に関する使用方法を表示します。 .It Cm lc アクティブな接続とそれらのパラメータを列挙します。 .It Xo .Cm login .Op Fl Ar connection_options .No // Ns Ar user Ns @ Ns Ar server Ns Op / Ns Ar share .Xc 指定した .Ar server や .Ar share に対し、 .Ar user として、ログイン/接続します。 このコマンドは、SMB サーバに対する接続を作成して認証した後、 これをアクティブなままにして終了します。 よって、ユーザはただ 1 度だけログインすればよく、 その後は認証手続きや追加の接続無しに他の SMB コマンドを使用可能です。 .Op Fl connection_options の解説については、 .Xr mount_smbfs 8 マニュアルページを参照してください (すべての大文字のオプションは、接続オプションです)。 .It Xo .Cm logout .No // Ns Ar user Ns @ Ns Ar server Ns Op / Ns Ar share .Xc 指定した .Ar server や .Ar share に対し、 .Ar user -として、ログアウト/接続切り離しを行います +として、ログアウト/接続切り離しを行います。 このコマンドは、 .Cm login コマンドで作成した接続を破棄します。 他のプログラムが使用中の接続は、すぐには閉鎖されません。 .It Xo .Cm lookup .Op Fl w Ar host .Ar name .Xc 指定した .Ar name を、IP アドレスに解決します。 NetBIOS 名前サーバは、 .Fl w オプションで直接指定可能です。 .It Xo .Cm print .Op Fl Ar connection_options .No // Ns Ar user Ns @ Ns Ar server Ns / Ns Ar share .Ar file .Xc 指定した .Ar file を、指定したリモートサーバのキューに送ります。 .Ar file が .Pa - の場合、標準入力が使用されます。 .It Xo .Cm view .Op Fl Ar connection_options .No // Ns Ar user Ns @ Ns Ar server .Xc 指定した .Ar server 上でユーザ .Ar user が使用可能な資源を列挙します。 .El .Sh 関連ファイル .Bl -tag -width ".Pa ~/.nsmbrc" -compact .It Pa ~/.nsmbrc 各接続の記述を保持します。 詳細は .Pa ./examples/dot.nsmbrc を参照してください。 .El .Sh 作者 .An Boris Popov Aq bp@butya.kz , .Aq bp@FreeBSD.org .Sh バグ どんなバグでも作者に報告してください。 diff --git a/ja_JP.eucJP/man/man1/tip.1 b/ja_JP.eucJP/man/man1/tip.1 index 34850e4fc5..132ce8e58f 100644 --- a/ja_JP.eucJP/man/man1/tip.1 +++ b/ja_JP.eucJP/man/man1/tip.1 @@ -1,618 +1,618 @@ .\" $OpenBSD: tip.1,v 1.19 2001/09/23 06:15:30 pvalchev Exp $ .\" $NetBSD: tip.1,v 1.7 1994/12/08 09:31:05 jtc Exp $ .\" .\" Copyright (c) 1980, 1990, 1993 .\" The Regents of the University of California. All rights reserved. .\" .\" Redistribution and use in source and binary forms, with or without .\" modification, are permitted provided that the following conditions .\" are met: .\" 1. Redistributions of source code must retain the above copyright .\" notice, this list of conditions and the following disclaimer. .\" 2. Redistributions in binary form must reproduce the above copyright .\" notice, this list of conditions and the following disclaimer in the .\" documentation and/or other materials provided with the distribution. .\" 3. All advertising materials mentioning features or use of this software .\" must display the following acknowledgement: .\" This product includes software developed by the University of .\" California, Berkeley and its contributors. .\" 4. Neither the name of the University nor the names of its contributors .\" may be used to endorse or promote products derived from this software .\" without specific prior written permission. .\" .\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE .\" ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF .\" SUCH DAMAGE. .\" .\" @(#)tip.1 8.4 (Berkeley) 4/18/94 .\" %FreeBSD: src/usr.bin/tip/tip/tip.1,v 1.22 2003/09/06 18:36:51 hmp Exp % .\" $FreeBSD$ .\" .Dd September 9, 2001 .Dt TIP 1 .Os .Sh 名称 .Nm tip , .Nm cu .Nd リモートシステムとの接続を行なう .Sh 書式 .Nm .Op Fl nv .Op Fl Ar speed .Op Ar system-name .Nm cu .Op Fl ehot .Op Fl a Ar acu .Op Fl l Ar line .Op Fl s Ar speed .Op Fl Ar # .Op Ar phone-number .Sh 解説 .Nm および .Nm cu のユーティリティは、他のマシンとの間に全二重のコネクションを確立し、 リモートマシンへ直接ログインしてみせます。 言うまでもないことですが、コネクションを張りたいマシンに対しては、 ログインアカウント (かそれに相当するもの) がなければなりません。 好まれるインタフェースは .Nm です。 .Nm cu インタフェースは、 .At v7 の .Dq call Ux コマンドから離れられない方々のために含まれています。 本マニュアルページは .Nm のみを記述します。 .Pp 以下のオプションが使用可能です: .Bl -tag -width ".Fl s Ar speed" .It Fl a Ar acu acu を設定します。 .It Fl l Ar line .Nm cu では、使用する回線を指定します。 .Pa tty00 や .Pa /dev/tty00 のどちらの形式も許されます。 .It Fl n エスケープ無し (チルダの無効化)。 .It Fl s Ar speed .Nm cu では、接続速度を設定します。 デフォルトは 9600 です。 .It Fl v 冗長モードを設定します。 .El .Pp .Ar speed が指定された場合、使用されるシステム記述で指定されたボーレートに優先します。 .Pp .Ar speed も .Ar system-name も指定されない場合、 .Ar system-name は .Ev HOST 環境変数の値に設定されます。 .Pp .Ar speed が指定されたものの .Ar system-name が指定されない場合、 .Dq Li tip に .Ar speed を追加した値に .Ar system-name を設定します。 例えば .Nm Fl 1200 は .Ar system-name を .Dq Li tip1200 に設定します。 .Pp 入力された文字は通常は直接リモートマシンに転送されます (それは同様にエコーされます)。 行頭にチルダ文字 .Pq Ql ~ が入力された場合には、これはエスケープ文字として 働きます; 以下の組み合わせが認識されます: .Bl -tag -width indent .It Xo .Ic ~^D または .Ic ~. .Xc コネクションを切断し、プログラムを終了します (リモートマシンにはログインしたままでいることもできます)。 .It Ic ~c Op Ar name ローカルのカレントディレクトリを .Ar name で指定したものに変更します (引数が指定されない場合には、ホームディレクトリに移動します)。 .It Ic ~! シェルを起動します (シェルを終了すると、 .Nm に戻ります)。 .It Ic ~> ローカルマシンのファイルをリモートマシンにコピーします。 .Nm ユーティリティは、ローカルファイル名の入力プロンプトを出します。 .It Ic ~< リモートシステムのファイルをローカルマシンに転送します。 .Nm ユーティリティは、まず転送されるファイル名の入力プロンプトを出し、 それからリモートマシンで実行するコマンドのプロンプトを出します。 .It Ic ~p Ar from Op Ar to リモートの .Ux ホストにファイルを送ります。put コマンドは .Nm が .Dq from ファイルを送っている間、リモートの .Ux システム上で .Dq Nm cat Li \&> Ar to コマンドを実行します。 .Dq to ファイル名が指定されない場合には、 このファイル名には .Dq from ファイル名を使用します。 このコマンドは、実際には .Ic ~> コマンドを .Ux システムに特定して実装したバージョンです。 .It Ic ~t Ar from Op Ar to リモートの .Ux ホストからファイルを受信します。put コマンドと同じく、 .Ar to ファイル名 が指定されない場合には、このファイル名は .Ar from ファイル名と同じになります。 リモートホストでは .Nm にファイル転送を行なうために .Dq Nm cat Ar from ; Nm echo Li ^A を実行します。 .It Ic ~| リモートコマンドからの出力を、ローカル .Ux プロセスへパイプを用いてリダイレクトします。 ローカル .Ux システムに送られるコマンド文字列は、シェルで処理されます。 .It Ic ~$ ローカル .Ux プロセスからパイプを介してリモートホストへ出力します。 ローカル .Ux システムに送られるコマンド文字列は、シェルで処理されます。 .It Ic ~C ローカルシステム上で .Tn XMODEM などの特別なプロトコルを扱うための 子プロセスを起動します。この子プロセスは特別に用意された、次のような ファイル記述子を用いて動作します。 .Bd -literal -offset indent 0 <-> 自側 tty 入力 1 <-> 自側 tty 出力 2 <-> 自側 tty 出力 3 <-> 相手側 tty 入力 4 <-> 相手側 tty 出力 .Ed .It Ic ~# .Dv BREAK 信号をリモートホストに送信します。 必要な .Fn ioctl システムコールをサポートしていないシステムの場合には、回線速度の 変更と .Dv DEL 文字の組み合わせでブレイクをシミュレートします。 .It Ic ~s 変数をセットします (以下の記述を参照してください)。 .It Ic ~v すべての変数とその値 (設定されてる場合) を表示します。 .It Ic ~^Z .Nm を停止します (システムがジョブコントロールをサポートしている場合にのみ使用可能です)。 .It Ic ~^Y .Dq ローカル側の .Nm のみ停止します (システムがジョブコントロールをサポートしている場合にのみ使用可能です); .Nm の .Dq リモート側 すなわちリモートホストの表示出力については引続き走行します。 .It Ic ~? チルダエスケープで使用できるコマンド一覧を表示します。 .El .Pp システム記述、すなわち .Ar system-name の動作特性を見付けるために、 .Nm は名前が .Ar system-name -と合致するシステム記述を検索します +と合致するシステム記述を検索します。 検索順序は次の通りです: .Bl -enum -offset indent .It 環境変数 .Ev REMOTE が .Ql \&/ で開始しない場合、これはシステム記述と仮定され、最初に検討されます。 .It 環境変数 .Ev REMOTE が .Ql \&/ で開始する場合、これは .Xr remote 5 データベースのパスと仮定され、指定されたデータベースが検索されます。 .It デフォルトの .Xr remote 5 データベース .Pa /etc/remote が検索されます。 .El .Pp システム記述に関する文書は .Xr remote 5 を参照してください。 .Pp システム記述中で .Va br ケーパビリティを使用することで、 コネクションを確立するボーレートを指定可能です。 指定された値が適当でない場合には、使用されるボーレートは コマンドラインで指定されたものになり得ます。 例えば .Dq Li "tip -300 mds" です。 .Pp .Nm がコネクションを確立すると、使用されるシステム記述の .Va cm ケーパビリティで指定されているコネクションメッセージを、 リモートホストに送信します。 .Pp .Nm に引数の入力を促されている場合 (例えば、ファイル転送の設定の間) には、入力された行は標準の erase や kill 文字で編集することが許されています。 入力を促されている時に空行を入力したり操作を中断 した場合には、入力を促す画面から抜け出し、リモートマシンとの対話に戻ります。 .Pp .Nm ユーティリティは、モデムや回線の排他制御や .Xr uucico 8 で採用されているロックプロトコルを用いることで、複数のユーザが リモートシステムへ接続することを制限しています。 .Pp ファイル転送時には .Nm は転送した行数を表示します。 .Ic ~> や .Ic ~< コマンドを使用した場合には、 .Va eofread 変数や .Va eofwrite 変数は、ファイル読み込時の end-of-file 文字の認識や、ファイル書き込み時 の end-of-file 文字の指定に用いられます (後述)。ファイル転送時のフロー制御は、 通常は tandem モードで行なわれます。リモートシステムが tandem モードをサポートしない場合には、 .Va echocheck が設定され、 .Nm が相手に転送した文字のエコーを用いてリモートシステムと同期します。 .Pp .Nm が他システムとの接続のために電話をかける場合には、 動作を示すさまざまな表示を行ないます。 .Nm ユーティリティは、システム記述中の .Va at ケーパビリティにおいて、様々な自動呼び出し機器やモデムをサポートします。 .Pp Ventel 212+ (ventel), Hayes AT-style (hayes), USRobotics Courier (courier), Telebit T3000 (t3000), Racal-Vadic 831 (vadic) のサポートは、デフォルトで有効です。 .Pp Bizcomp 1031[fw] (biz31[fw]), Bizcomp 1022[fw] (biz22[fw]), DEC DF0[23]-AC (df0[23]), DEC DN-11 (dn11), Racal-Vadic 3451 (v3451) のサポートは、 .Nm を適切な定義付きで再コンパイルすることで追加可能です。 .Pp Racal-Vadic 831 および 3451 のサポートを両方有効にすると、 それぞれ v831 および v3451 と参照されます。 どちらか一方のみサポートすると、それは vadic と参照されます。 .Ss 変数 .Nm ユーティリティは、自己を制御するために、 変数 を取り扱います。 いくつかの変数は、一般ユーザの権限では参照のみで変更することはできません (スーパユーザのみ、これらの変数の変更が許可されています)。変数は、 .Ic ~s エスケープにて、参照および変更が可能です。変数設定の書式は、 .Xr vi 1 や .Xr Mail 1 での変数設定の書式と同様です。コマンドの引数に .Dq Li all を指定することで、 ユーザが読み出し可能なすべての変数を表示することができます。また、ユーザは 特定の変数について、変数名の最後に .Ql \&? を付加することにより、 その値を表示することができます。 例えば .Dq Li escape? とすることで、現在のエスケープ文字を表示します。 .Pp 変数値として採用されるものは、数値、文字列、文字、もしくは論理値です。 論理変数の設定については、単に変数名を設定するだけで設定されます; これらは、変数名の前に .Ql \&! 文字をつけることにより偽に設定 されます。他の変数型については、変数と値の間を .Ql = でつなぐことで設定 できます。すべての設定について、その指定中に空白を入れてはいけません。 単独の set コマンドは、変数の値を設定するだけでなく、変数の値を知るため にも用いられます。 変数は実行時に set コマンドを実行することで初期化されます ( ホームディレクトリの .Pa .tiprc ファイル中で、 .Ic ~s プレフィックスがない場合です)。 .Fl v オプションを指定することで、 .Nm が初期化時に行なった設定を表示します。 確実に共通変数と思われるものについては、略号表記されます。 以下に共通変数およびその略号と、デフォルトの値の一覧を示します。 .Bl -tag -width indent .It Va beautify .Pq Vt 論理値 セッション確立時に受けとった表示不可の文字については無視します; .Va be と略号表記されます。 .It Va baudrate .Pq Vt 数値 コネクション確立時の通信速度を指定します; .Va ba と略号表記されます。 .It Va dialtimeout .Pq Vt 数値 相手先に電話をかける際に、コネクション確立までの待ち時間 (秒単位) を 指定します; .Va dial と略号表記されます。 .It Va echocheck .Pq Vt 論理値 ファイル転送時のリモートホストとの同期を、 送信された最後の文字のエコーを待つことで取ります; 本変数のデフォルト値は .Cm off です。 .It Va eofread .Pq Vt 文字列 .Ic ~< コマンドを用いてファイル転送した場合に、 転送終了を示す文字群です; .Va eofr と略号表記されます。 .It Va eofwrite .Pq Vt 文字列 .Ic ~> コマンドを用いてファイル転送した場合に、 転送終了を示すために送る文字列です; .Va eofw と略号表記されます。 .It Va eol .Pq Vt 文字列 行末を示す文字群です。 .Nm ユーティリティは、 行末文字の直後に現れたエスケープ文字のみ、エスケープ文字として認識します。 .It Va escape .Pq Vt 文字 コマンドプレフィックス (エスケープ) 文字です; .Va es と略号表記されます; 本変数のデフォルト値は .Ql ~ です。 .It Va exceptions .Pq Vt 文字列 beautification の指定で無視されない文字群を指定します; .Va ex と略号表記されます; 本変数のデフォルト値 .Dq Li \et\en\ef\eb です。 .It Va force .Pq Vt 文字 リテラルデータ送信を強制する文字です; .Va fo と略号表記されます; 本変数のデフォルト値は .Ql ^P です。 .It Va framesize .Pq Vt 数値 ファイルを受信した場合に、ファイルシステムとの間にあるバッファに バッファリングするデータ量 (バイト単位) です; .Va fr と略号表記されます。 .It Va host .Pq Vt 文字列 接続しているホスト名です; .Va ho と略号表記されます。 .It Va prompt .Pq Vt 文字 リモートホストの行末文字です; .Va pr と略号表記されます; 本変数のデフォルト値は .Ql \en です。本変数は、データ転送時の同期を取るのに 用いられます。ファイル転送時に行なう転送行のカウントは、この文字を いくつ受けとったかということに基づきます。 .It Va raise .Pq Vt 論理値 大文字に変換するモードです; .Va ra と略号表記されます; 本変数のデフォルト値は .Cm off です。 本モードが有効になると、すべての小文字の文字列は、リモートホストへの転送時に .Nm によって大文字に変更されます。 .It Va raisechar .Pq Vt 文字 大文字へ変換するモードの切り替えを行なう入力文字です; .Va rc と略号表記されます; 本変数のデフォルト値は .Ql ^A です。 .It Va record .Pq Vt 文字列 セッションの記録を取るファイル名です; .Va rec と略号表記されます; 本変数のデフォルト値は .Pa tip.record です。 .It Va script .Pq Vt 論理値 セッションの記録を取るモードです; .Va sc と略号表記されます; 本変数のデフォルト値は .Cm off です。 .Va script が .Cm true の場合には、 .Nm はリモートホストから転送されたすべてのデータを .Va record に指定されたファイルに記録します。 .Va beautify スイッチが有効になっている場合には、表示可能な .Tn ASCII 文字 (文字コードに換算して 040 から 0177 までの間) についてのみ記録されます。 beautification 規則の例外を指定する .Va exceptions 変数による設定も有効となります。 .It Va tabexpand .Pq Vt 論理値 ファイル転送時にタブ文字を空白文字に展開するモードです; .Va tab と略号表記されます。 本変数のデフォルト値は .Cm false です。 本モードが有効になっている場合には、タブ文字は空白文字 8 つに展開されます。 .It Va verbose .Pq Vt 論理値 冗長モードです; .Va verb と略号表記されます; 本変数のデフォルト値は .Cm true です。 冗長モードが有効になっている場合には、 .Nm はダイヤル時にメッセージを出力したり、ファイル転送を行なっている際の 現在の転送行数を指定したりします。 .El .Sh 環境変数 .Bl -tag -width indent .It Ev SHELL .Ic ~! コマンド実行時に使用するシェルの名前です; デフォルト値は .Pa /bin/sh です。 .It Ev HOME .Ic ~c コマンド実行時に用いるホームディレクトリです。 .It Ev HOST コマンドラインで指定が無い場合の、デフォルトの .Va system-name 値です。 .It Ev REMOTE システム記述であるか、 .Xr remote 5 システム記述データベースへの絶対パスです。 .It Ev PHONES .Xr phones 5 データベースへのパスです。 .El .Sh 関連ファイル .Bl -tag -width ".Pa /var/spool/lock/LCK..*" -compact .It Pa /etc/remote グローバル .Xr remote 5 データベース。 .It Pa /etc/phones デフォルト .Xr phones 5 ファイル。 .It Pa ~/.tiprc 初期化ファイル。 .It Pa tip.record 記録ファイル。 .It Pa /var/log/aculog 回線アクセス記録。 .It Pa /var/spool/lock/LCK..* .Xr uucp 1 との回線競合を避けるための回線排他制御ファイル。 .El .Sh 関連項目 .Xr remote 5 , .Xr phones 5 .Sh 歴史 .Nm コマンドは .Bx 4.2 から登場しました。 .Sh バグ すべての変数が文書化されているわけではありません。文書化されていないものは おそらく削除されるでしょう。 diff --git a/ja_JP.eucJP/man/man3/rpc.3 b/ja_JP.eucJP/man/man3/rpc.3 index d0054bcc6e..0e54c5ebb8 100644 --- a/ja_JP.eucJP/man/man3/rpc.3 +++ b/ja_JP.eucJP/man/man3/rpc.3 @@ -1,1462 +1,1462 @@ .\" @(#)rpc.3n 2.4 88/08/08 4.0 RPCSRC; from 1.19 88/06/24 SMI .\" %FreeBSD: src/lib/libc/rpc/rpc.3,v 1.11.2.5 2001/12/14 18:33:56 ru Exp % .\" $FreeBSD$ .\" .Dd February 16, 1988 .Dt RPC 3 .Os .Sh 名称 .Nm rpc .Nd リモートプロシージャコール用ライブラリルーチン .Sh ライブラリ .Lb libc .Sh 書式 .In rpc/rpc.h .Pp 関数の説明については .Sx 解説 を参照してください。 .Sh 解説 このルーチンでは、C プログラムを使用して、 ネットワークを通して別のマシンでプロシージャ呼び出しを実行できます。 まずクライアントがプロシージャを呼び出し、 データパケットをサーバに送信します。 パケットを受け取ったサーバは、ディスパッチルーチンを呼び出し、 要求されたサービスを実行してから応答を送り返します。 最後に、プロシージャ呼び出しがクライアントに戻ります。 .Pp Secure .Tn RPC ( DES 認証) に使用するルーチンについては、 .Xr rpc_secure 3 で説明します。 Secure .Tn RPC は .Tn DES 暗号化が使用できる場合にのみ使用できます。 .Bl -tag -width indent -compact .Pp .It Xo .Ft void .Xc .It Xo .Fn auth_destroy "AUTH *auth" .Xc .Pp .Fa auth に関連する認証情報を破壊するマクロです。 一般的に、破壊にはプライベートデータ構造の解放も含まれます。 .Fn auth_destroy を呼び出した後で .Fa auth を使用した結果は不定になります。 .Pp .It Xo .Ft "AUTH *" .Xc .It Xo .Fn authnone_create .Xc .Pp 各リモートプロシージャコールで使用できない認証情報を渡す .Tn RPC 認証ハンドルを作成して戻します。 .Tn RPC は、この認証をデフォルトで使用します。 .Pp .It Xo .Ft "AUTH *" .Xc .It Xo .Fn authunix_create "char *host" "int uid" "int gid" "int len" "int *aup_gids" .Xc .Pp 認証情報を含む .Tn RPC .Ux 認証ハンドルを作成して戻します。 パラメータ .Fa host は、情報を作成するマシンの名前です。 .Fa uid は、ユーザのユーザ ID です。 .Fa gid は、ユーザの現行グループ ID です。 .Fa len と .Fa aup_gids は、ユーザが属するグループの配列を表します。 あるユーザになりすますことが容易です。 .Pp .It Xo .Ft "AUTH *" .Xc .It Xo .Fn authunix_create_default .Xc .Pp 適切なパラメータで .Fn authunix_create を呼び出します。 .Pp .It Xo .Fo callrpc .Fa "char *host" .Fa "u_long prognum" .Fa "u_long versnum" .Fa "u_long procnum" .Fa "xdrproc_t inproc" .Fa "char *in" .Fa "xdrproc_t outproc" .Fa "char *out" .Fc .Xc .Pp マシン .Fa host で .Fa prognum , .Fa versnum , .Fa procnum に関連するリモートプロシージャを呼び出します。 パラメータ .Fa in は、プロシージャの引数アドレスで、 .Fa out は結果を配置するアドレスです。 .Fa inproc は、プロシージャのパラメータをデコードするために使用し、 .Fa outproc は、プロシージャの結果をデコードするために使用します。 このルーチンは、問題がなければ 0 を戻し、 問題がある場合は、 .Vt "enum clnt_stat" を整数にキャストした値を戻します。 エラーステータスをメッセージに変換するには、ルーチン .Fn clnt_perrno が便利です。 .Pp 警告: このルーチンでリモートプロシージャを呼び出す場合は、 .Tn UDP/IP がトランスポート層として使用されます。 制限事項については、 .Fn clntudp_create を参照してください。 このルーチンを使用した場合、タイムアウトや認証は制御できません。 .Pp .It Xo .Ft "enum clnt_stat" .Xc .It Xo .Fo clnt_broadcast .Fa "u_long prognum" .Fa "u_long versnum" .Fa "u_long procnum" .Fa "xdrproc_t inproc" .Fa "char *in" .Fa "xdrproc_t outproc" .Fa "char *out" .Fa "bool_t (*eachresult)(caddr_t, struct sockaddr_in *) .Fc .Xc .Pp ローカルで接続されているすべてのブロードキャストネットに 呼び出しメッセージがブロードキャストされることを除けば、 .Fn callrpc と同じです。 このルーチンは、応答を受け取るたびに、以下の形式の .Fn eachresult を呼び出します。 .Bd -ragged -offset indent .Ft bool_t .Fn eachresult "caddr_t out" "struct sockaddr_in *addr" .Ed .Pp .Fa out は、リモートプロシージャの出力がデコードされることを除けば、 .Fn clnt_broadcast に渡される .Fa out と同じです。 .Fa addr は、結果を送信するマシンのアドレスを指します。 .Fn eachresult が 0 を戻す場合、 .Fn clnt_broadcast は次の応答を待ちます。 0 を戻さない場合は、適切なステータスで戻ります。 .Pp 警告: ブロードキャストソケットのサイズは、 データリンクの最大転送単位に制限されています。 イーサネットの場合、この値は 1500 バイトです。 .Pp .It Xo .Ft "enum clnt_stat" .Xc .It Xo .Fo clnt_call .Fa "CLIENT *clnt" .Fa "u_long procnum" .Fa "xdrproc_t inproc" .Fa "char *in" .Fa "xdrproc_t outproc" .Fa "char *out" .Fa "struct timeval tout" .Fc .Xc .Pp .Fn clnt_create などの .Tn RPC クライアント作成ルーチンで入手した、クライアントハンドル .Fa clnt に関連するリモートプロシージャ .Fa procnum を呼び出すマクロです。 パラメータ .Fa in はプロシージャの引数のアドレスで、 .Fa out は結果を配置するアドレスです。 .Fa inproc はプロシージャのパラメータのデコードに使用し、 .Fa outproc はプロシージャの結果のデコードに使用します。 .Fa tout は、結果が戻るまでの時間です。 .Pp .It Xo .Ft void .Fn clnt_destroy "CLIENT *clnt" .Xc .Pp クライアントの .Tn RPC ハンドルを破壊するマクロです。 通常の場合、破壊には、 .Fa clnt も含めたプライベートデータ構造の解放も含まれます。 .Fn clnt_destroy を呼び出した後で .Fa clnt を使用した結果は不定になります。 .Tn RPC ライブラリが関連ソケットを開いた場合はそれも閉じます。 関連ソケットを開いていない場合、ソケットは開いたまま残ります。 .Pp .It Xo .Ft CLIENT * .Xc .It Xo .Fn clnt_create "char *host" "u_long prog" "u_long vers" "char *proto" .Xc .Pp 一般的なクライアント作成ルーチンです。 .Fa host は、サーバが配置されているリモートホストの名前を指定します。 .Fa proto は、使用する転送プロトコルの種類を指定します。 このフィールドで現在サポートされている値は、 .Qq Li udp と .Qq Li tcp です。 タイムアウトはデフォルトが設定されていますが、 .Fn clnt_control を使用して修正できます。 .Pp 警告: .Tn UDP の使用には短所があります。 .Tn UDP ベースの .Tn RPC メッセージは、 8 キロバイトのエンコード済みデータまでしか維持できないので、 大きな引数を取るプロシージャや、 大きな結果を戻すプロシージャでは使用できません。 .Pp .It Xo .Ft bool_t .Xc .It Xo .Fn clnt_control "CLIENT *cl" "u_int req" "char *info" .Xc .Pp クライアントオブジェクトのさまざまな情報の変更や取り出しを行うマクロです。 .Fa req はオペレーションのタイプを指定し、 .Fa info は情報のポインタです。 .Tn UDP と .Tn TCP の両方でサポートされている .Fa req の値、引数タイプ、実行内容は以下の通りです。 .Bl -column "CLSET_RETRY_TIMEOUT" "struct sockaddr_in" .It Dv CLSET_TIMEOUT Ta Xo .Vt "struct timeval" Ta "総タイムアウトの設定" .Xc .It Dv CLGET_TIMEOUT Ta Xo .Vt "struct timeval" Ta "総タイムアウトの入手" .Xc .El .Pp 注意: タイムアウトを .Fn clnt_control で設定すると、 .Fn clnt_call に渡されるタイムアウトパラメータは、 後のすべての呼び出しで無視されます。 .Bl -column "CLSET_RETRY_TIMEOUT" "struct sockaddr_in" .It Dv CLGET_SERVER_ADDR Ta Xo .Vt "struct sockaddr_in" Ta "get server's address" .Xc .El .Pp 以下のオペレーションは .Tn UDP のみで有効です。 .Bl -column "CLSET_RETRY_TIMEOUT" "struct sockaddr_in" .It Dv CLSET_RETRY_TIMEOUT Ta Xo .Vt "struct timeval" Ta "再試行タイムアウトの設定" .Xc .It Dv CLGET_RETRY_TIMEOUT Ta Xo .Vt "struct timeval" Ta "再試行タイムアウトの入手" .Xc .It Dv CLSET_CONNECT Ta Vt "int" Ta Xr connect 2 を使用 .El .Pp 再試行タイムアウトは、サーバが応答してから要求を再送することを .Tn "UDP RPC" が待機する時間です。 .Pp .It Xo .Ft bool_t .Fn clnt_freeres "CLIENT *clnt" "xdrproc_t outproc" "char *out" .Xc .Pp .Tn RPC/XDR システムが .Tn RPC 呼び出しの結果をデコードする場合に割り振ったデータを解放するマクロです。 パラメータ .Fa out は結果のアドレスで、 .Fa outproc は結果を記述する .Tn XDR ルーチンです。 このルーチンは、結果が問題なく解放された場合は 1 を戻し、 問題が発生した場合は 0 を戻します。 .Pp .It Xo .Ft void .Xc .It Xo .Fn clnt_geterr "CLIENT *clnt" "struct rpc_err *errp" .Xc .Pp クライアントハンドルのエラー構造を、アドレス .Fa errp の構造体にコピーするマクロです。 .Pp .It Xo .Ft void .Xc .It Xo .Fn clnt_pcreateerror "char *s" .Xc .Pp クライアント .Tn RPC ハンドルを作成できない理由を表すメッセージを標準エラーに出力します。 メッセージの最初には、文字列 .Fa s とコロンが付きます。 これは、 .Fn clnt_create , .Fn clntraw_create , .Fn clnttcp_create , .Fn clntudp_create のいずれかがエラーとなった場合に使用します。 .Pp .It Xo .Ft void .Xc .It Xo .Fn clnt_perrno "enum clnt_stat stat" .Xc .Pp .Fa stat が示す条件に対応するメッセージを標準エラーに出力します。 .Fn callrpc の後で使用してください。 .Pp .It Xo .Ft void .Fn clnt_perror "CLIENT *clnt" "char *s" .Xc .Pp .Tn RPC 呼び出しがエラーになった理由を示すメッセージを標準エラーに出力します。 .Fa clnt は、呼び出しの実行に使用したハンドルです。 メッセージ最初には、文字列 .Fa s とコロンが付きます。 .Fn clnt_call の後で使用してください。 .Pp .It Xo .Ft "char *" .Xc .It Xo .Fn clnt_spcreateerror "char *s" .Xc .Pp 標準エラーに出力する代わりに文字列を戻すことを除けば、 .Fn clnt_pcreateerror と同じです。 .Pp バグ: 各呼び出しで上書きされた静的データのポインタを戻します。 .Pp .It Xo .Ft "char *" .Xc .It Xo .Fn clnt_sperrno "enum clnt_stat stat" .Xc .Pp .Fn clnt_perrno と同じ引数を取りますが、 .Tn RPC 呼び出しがエラーになった理由を示すメッセージを標準エラーに送信する代わりに、 メッセージを含む文字列のポインタを戻します。 文字列は改行 .Pq Ql "\en" で終わります。 .Pp プログラムに標準エラーがない場合 (サーバとして実行しているプログラムには標準エラーがないことが多い)、 またはメッセージを .Fn printf で出力する必要がない場合、 あるいは .Fn clnt_perrno がサポートするもの以外のメッセージフォーマットを使用する場合は、 .Fn clnt_perrno の代わりに .Fn clnt_sperrno を使用します。 .Pp 注意: .Fn clnt_sperror と .Fn clnt_spcreaterror とは異なり、 .Fn clnt_sperrno は静的データのポインタを戻しますが、 結果は各呼び出しで上書きされません。 .Pp .It Xo .Ft "char *" .Xc .It Xo .Fn clnt_sperror "CLIENT *rpch" "char *s" .Xc .Pp .Fn clnt_sperrno と同じように、標準エラーに出力せずに文字列を戻すことを除けば、 .Fn clnt_perror と同じです。 .Pp バグ: 各呼び出しで上書きされた静的データのポインタを戻します。 .Pp .It Xo .Ft "CLIENT *" .Xc .It Xo .Fn clntraw_create "u_long prognum" "u_long versnum" .Xc .Pp リモートプログラム .Fa prognum バージョン .Fa versnum のトイ .Tn RPC クライアントを作成します。 サービスにメッセージを渡す実際のトランスポートは、 プロセスのアドレススペース内にあるバッファなので、 対応する .Tn RPC サーバは同じアドレススペースに存在する必要があります。 .Fn svcraw_create を参照してください。 これにより、 .Tn RPC のシミュレーション、およびラウンドトリップタイムなど、 .Tn RPC オーバヘッドの取得をカーネルの干渉なしに実行できます。 このルーチンは、エラーが発生すると .Dv NULL を戻します。 .Pp .It Xo .Ft "CLIENT *" .Xc .It Xo .Fo clnttcp_create .Fa "struct sockaddr_in *addr" .Fa "u_long prognum" .Fa "u_long versnum" .Fa "int *sockp" .Fa "u_int sendsz" .Fa "u_int recvsz" .Fc .Xc .Pp リモートプログラム .Fa prognum バージョン .Fa versnum の .Tn RPC クライアントを作成します。 クライアントは、トランスポートとして .Tn TCP/IP を使用します。 リモートプログラムは、インターネットアドレス .Fa addr にあります。 .Fa addr\->sin_port が 0 である場合は、 リモートプログラムが注意を向ける実際のポートに設定されます ( .Xr portmap 8 サービスはこの情報で調べられます)。 パラメータ .Fa sockp はソケットです。このパラメータが .Dv RPC_ANYSOCK である場合、このルーチンは新しいソケットを開いて .Fa sockp を設定します。 .Tn TCP ベースの .Tn RPC はバッファによる .Tn I/O を使用するので、ユーザはパラメータ .Fa sendsz と .Fa recvsz で送信バッファと受信バッファのサイズを指定できます。 値を 0 にすると、適切なデフォルトが選択されます。 このルーチンは、エラーになると .Dv NULL を戻します。 .Pp .It Xo .Ft "CLIENT *" .Xc .It Xo .Fo clntudp_create .Fa "struct sockaddr_in *addr" .Fa "u_long prognum" .Fa "u_long versnum" .Fa "struct timeval wait" .Fa "int *sockp" .Fc .Xc .Pp リモートプログラム .Fa prognum バージョン .Fa versnum の .Tn RPC クライアントを作成します。 クライアントは、トランスポートとして .Tn UDP/IP を使用します。 リモートプログラムは、インターネットアドレス .Fa addr にあります。 .Fa addr\->sin_port が 0 である場合は、 リモートプログラムが注意を向ける実際のポートに設定されます (リモート .Xr portmap 8 サービスは、この情報で調べられます)。 パラメータ .Fa sockp はソケットです。 このパラメータが .Dv RPC_ANYSOCK である場合、このルーチンは新しいソケットを開いて .Fa sockp を設定します。 .Tn UDP トランスポートは、応答を受け取るまで、 または呼び出しがタイムアウトになるまで、 .Fa wait 時間間隔で呼び出しメッセージを再送信します。 呼び出しがタイムアウトとなる時間は、 で指定します。 .Pp 警告: .Tn UDP ベースの .Tn RPC メッセージは、 8 キロバイトのエンコード済みデータまでしか維持できないので、 大きな引数を取るプロシージャや 大きな結果を戻すプロシージャでは使用できません。 .Pp .It Xo .Ft "CLIENT *" .Xc .It Xo .Fo clntudp_bufcreate .Fa "struct sockaddr_in *addr" .Fa "u_long prognum" .Fa "u_long versnum" .Fa "struct timeval wait" .Fa "int *sockp" .Fa "unsigned int sendsize" .Fa "unsigned int recosize" .Fc .Xc .Pp リモートプログラム .Fa prognum バージョン .Fa versnum の .Tn RPC クライアントを作成します。 クライアントは、トランスポートとして .Tn UDP/IP を使用します。 リモートプログラムは、インターネットアドレス .Fa addr にあります。 .Fa addr\->sin_port が 0 である場合は、 リモートプログラムが注意を向ける実際のポートに設定されます (リモート .Xr portmap 8 サービスは、この情報で調べられます)。 パラメータ .Fa sockp はソケットです。このパラメータが .Dv RPC_ANYSOCK である場合、このルーチンは新しいソケットを開いて .Fa sockp を設定します。 .Tn UDP トランスポートは、応答を受け取るまで、 または呼び出しがタイムアウトになるまで .Fa wait 時間間隔で呼び出しメッセージを再送信します。 呼び出しがタイムアウトになる時間は、 .Fn clnt_call で指定します。 .Pp ユーザは、 .Tn UDP ベースの .Tn RPC メッセージの送受信を行う、最大パケットサイズを指定できます。 .Pp .It Xo .Ft int .Xc .It Xo .Fn get_myaddress "struct sockaddr_in *addr" .Xc .Pp .Pa /etc/hosts を処理するライブラリルーチンを参考にせず、マシンの .Tn IP アドレスを .Fa addr に入れます。ポート番号は、常に .Fn htons PMAPPORT に設定されます。 問題がない場合は 0 を戻し、問題がある場合は 0 以外を戻します。 .Pp .It Xo .Ft "struct pmaplist *" .Xc .It Xo .Fn pmap_getmaps "struct sockaddr_in *addr" .Xc .Pp .Xr portmap 8 サービスのユーザインタフェースで、 .Tn IP アドレス .Fa addr にあるホストの .Tn RPC プログラムとポートの現行のマッピングのリストを戻します。 このルーチンは .Dv NULL を戻すことがあります。 コマンド .Dq Nm rpcinfo Fl p はこのルーチンを使用します。 .Pp .It Xo .Ft u_short .Xc .It Xo .Fo pmap_getport .Fa "struct sockaddr_in *addr" .Fa "u_long prognum" .Fa "u_long versnum" .Fa "u_long protocol" .Fc .Xc .Pp .Xr portmap 8 サービスのユーザインタフェースで、 プログラム番号 .Fa prognum バージョン .Fa versnum をサポートするサービスを待ち、 .Fa protocol に関連する転送プロトコルを表すポート番号を戻します。 .Fa protocol の値は、ほとんどの場合 .Dv IPPROTO_UDP か .Dv IPPROTO_TCP です。マッピングが存在しない場合、または .Tn RPC システムがリモート .Xr portmap 8 サービスと接触できない場合、戻り値は 0 になります。 後者の場合、 .Va rpc_createerr には .Tn RPC ステータスが入ります。 .Pp .It Xo .Ft "enum clnt_stat" .Xc .It Xo .Fo pmap_rmtcall .Fa "struct sockaddr_in *addr" .Fa "u_long prognum" .Fa "u_long versnum" .Fa "u_long procnum" .Fa "xdrproc_t inproc" .Fa "char *in" .Fa "xdrproc_t outproc" .Fa "char *out" .Fa "struct timeval tout" .Fa "u_long *portp" .Fc .Xc .Pp .Xr portmap 8 サービスのユーザインタフェースで、 .Tn IP アドレス .Fa addr のホストのプロシージャを .Tn RPC 呼び出しにするように、そのホストの .Xr portmap 8 に命令します。 プロシージャで問題が発生しない場合、パラメータ .Fa portp はプログラムのポート番号に修正されます。 その他のパラメータについては、 .Fn callrpc と .Fn clnt_call -を参照してください +を参照してください。 このプロシージャは、 .Dq ping 以外で使用することはありません。 .Fn clnt_broadcast も参照してください。 .Pp .It Xo .Ft bool_t .Fn pmap_set "u_long prognum" "u_long versnum" "u_long protocol" "u_short port" .Xc .Pp .Xr portmap 8 サービスのユーザインタフェースで、 .Pq Fa prognum , versnum , protocol の 3 つ、およびマシンの .Xr portmap 8 サービスでの .Fa port の間にマッピングを確立します。 .Fa protocol の値は、ほとんどの場合 .Dv IPPROTO_UDP か .Dv IPPROTO_TCP . です。 このルーチンは問題がないと 1 を戻し、問題がある場合は 0 を戻します。 これは、 .Fn svc_register で自動的に実行されます。 .Pp .It Xo .Ft bool_t .Fn pmap_unset "u_long prognum" "u_long versnum" .Xc .Pp .Xr portmap 8 サービスのユーザインタフェースで、 .Pq Fa prognum , versnum , * の 3 つ、および .Xr portmap 8 サービスでの .Fa port の間に存在するマッピングをすべて破壊します。 このルーチンは、問題がなければ 1 を戻し、問題がある場合は 0 を戻します。 .Pp .It Xo .Ft bool_t .Fo registerrpc .Fa "u_long prognum" .Fa "u_long versnum" .Fa "u_long procnum" .Fa "char *(*procname)(void)" .Fa "xdrproc_t inproc" .Fa "xdrproc_t outproc" .Fc .Xc .Pp .Tn RPC サービスパッケージでプロシージャ .Fa procname を登録します。 プログラム .Fa prognum バージョン .Fa versnum プロシージャ .Fa procnum が要求されると、パラメータのポインタで .Fa procname が呼び出されます。 .Fa progname は、静的結果のポインタを戻します。 .Fa inproc はパラメータのデコードに使用され、 .Fa outproc は結果のエンコードに使用されます。 このルーチンは、登録で問題が発生しなければ 0 を戻し、 問題が発生したら \-1 を戻します。 .Pp 警告: この形式で登録されたリモートプロシージャは、 .Tn UDP/IP トランスポートでアクセスされます。 制限事項については .Fn svcudp_create を参照してください。 .Pp .It Xo .Vt "struct rpc_createerr" rpc_createerr ; .Xc .Pp エラーになった .Tn RPC クライアント作成ルーチンで値が設定されるグローバル変数です。 エラーの原因を出力するには、ルーチン .Fn clnt_pcreateerror を使用します。 .Pp .It Xo .Ft bool_t .Fn svc_destroy "SVCXPRT * xprt" .Xc .Pp .Tn RPC サービス転送ハンドル .Fa xprt を破壊するマクロです。 一般的に破壊処理には、 .Fa xprt も含むプライベートデータ構造の解放も含まれます。 このルーチンを呼び出した後で .Fa xprt を使用した結果は不定となります。 .Pp .It Xo .Vt fd_set svc_fdset ; .Xc .Pp .Tn RPC サービスサイドの読み込みファイル記述子ビットマスクを表すグローバル変数です。 .Xr select 2 システムコールのテンプレートパラメータとして最適です。 サービスの設計者が .Fn svc_run を呼び出さず、非同期のイベント処理を行う場合のみに重要です。 この変数は読み込み専用ですが (アドレスを .Xr select 2 に渡しませんが)、 .Fn svc_getreqset か作成ルーチンを呼び出した後で変更できます。 .Dv FD_SETSIZE , を越える記述子の制限がプロセスにある場合、この変数は .Dv FD_SETSIZE 記述子でしか使用できないことに注意してください。 .Pp .It Xo .Vt int svc_fds ; .Xc .Pp .Va svc_fdset に似ていますが、32 個の記述子に制限されています。 このインタフェースは .Va svc_fdset で置き換えられました。 .Pp .It Xo .Ft bool_t .Fn svc_freeargs "SVCXPRT *xprt" "xdrproc_t inproc" "char *in" .Xc .Pp .Tn RPC/XDR システムが .Fn svc_getargs を使用して引数をサービスプロシージャにデコードした場合に 割り振ったデータを解放するマクロです。 このルーチンは、結果が問題なく解放されると 1 を戻し、 問題が発生した場合は 0 を戻します。 .Pp .It Xo .Ft bool_t .Fn svc_getargs "SVCXPRT *xprt" "xdrproc_t inproc" "char *in" .Xc .Pp .Tn RPC サービス転送ハンドル .Fa xprt .Tn RPC 要求の引数をデコードするマクロです。 パラメータ .Fa in は、引数を配置する場所のアドレスです。 .Fa inproc は、引数をデコードする .Tn XDR ルーチンです。 このルーチンは、デコードで問題が発生しなければ 1 を戻し、 問題が発生した場合は 0 を戻します。 .Pp .It Xo .Ft "struct sockaddr_in *" .Xc .It Xo .Fn svc_getcaller "SVCXPRT *xprt" .Xc .Pp .Tn RPC サービス転送ハンドル .Fa xprt に関連するプロシージャの呼び出し側の ネットワークアドレスを入手する確実な方法です。 .Pp .It Xo .Ft void .Fn svc_getreqset "fd_set *rdfds" .Xc .Pp このルーチンは、サービスの設計者が .Fn svc_run を呼び出さず、独自の非同期イベント処理を実現する場合にのみ重要です。 .Tn RPC 要求が .Tn RPC ソケットに到着したと .Xr select 2 システムコールが判断した場合に呼び出されます。 .Fa rdfds は、作成された読み込み記述子ビットマスクです。 このルーチンは、 .Fa rdfds の値に関連したすべてのソケットサービスを受けた場合に戻ります。 .Pp .It Xo .Ft void .Fn svc_getreq "int rdfds" .Xc .Pp .Fn svc_getreqset , に似ていますが、32 個の記述子に制限されています。 このインタフェースは .Fn svc_getreqset で置き換えられました。 .Pp .It Xo .Ft bool_t .Fo svc_register .Fa "SVCXPRT *xprt" .Fa "u_long prognum" .Fa "u_long versnum" .Fa "void (*dispatch)(struct svc_req *, SVCXPRT *)" .Fa "int protocol" .Fc .Xc .Pp .Fa prognum と .Fa versnum をサービスディスパッチプロシージャ .Fn dispatch に関連付けます。 .Fa protocol が 0 である場合、サービスは .Xr portmap 8 サービスで登録されません。 .Fa protocol が 0 以外である場合、 .Pq Fa prognum , versnum , protocol の 3 つと .Fa xprt\->xp_port のマッピングがローカル .Xr portmap 8 サービスで確立されます (一般的に .Fa protocol は 0 か .Dv IPPROTO_UDP か .Dv IPPROTO_TCP です)。 プロシージャ .Fn dispatch の形式は以下の通りです。 .Bd -ragged -offset indent .Fn bool_t .Fn dispatch "struct svc_req *request" "SVCXPRT *xprt" .Ed .Pp .Fn svc_register ルーチンは、問題がなければ 1 を戻し、問題がある場合は 0 を戻します。 .Pp .It Xo .Fn svc_run .Xc .Pp このルーチンは戻りません。 .Tn RPC 要求の到着を待ち、到着すると .Fn svc_getreq を使用して適切なサービスプロシージャを呼び出します。 通常の場合、このプロシージャは、 .Xr select 2 システムコールが戻るのを待ちます。 .Pp .It Xo .Ft bool_t .Fn svc_sendreply "SVCXPRT *xprt" "xdrproc_t outproc" "char *out" .Xc .Pp .Tn RPC サービスのディスパッチルーチンで呼び出され、 リモートプロシージャコールの結果を送信します。 パラメータ .Fa xprt は要求の関連転送ハンドルです。 .Fa outproc は、結果のエンコードに使用する .Tn XDR ルーチンです。 .Fa out は結果のアドレスです。 このルーチンは、問題がなければ 1 を戻し、問題がある場合は 0 を戻します。 .Pp .It Xo .Ft void .Xc .It Xo .Fn svc_unregister "u_long prognum" "u_long versnum" .Xc .Pp .Pq Fa prognum , versnum の 2 つとディスパッチルーチンのマッピング、および .Pq Fa prognum , versnum , * の 3 つとポート番号のマッチングをすべて削除します。 .Pp .It Xo .Ft void .Xc .It Xo .Fn svcerr_auth "SVCXPRT *xprt" "enum auth_stat why" .Xc .Pp 認証エラーのために、リモートプロシージャコールの実行を拒否する サービスディスパッチルーチンが呼び出します。 .Pp .It Xo .Ft void .Xc .It Xo .Fn svcerr_decode "SVCXPRT *xprt" .Xc .Pp パラメータを問題なくデコードできない サービスディスパッチルーチンが呼び出します。 .Fn svc_getargs も参照してください。 .Pp .It Xo .Ft void .Xc .It Xo .Fn svcerr_noproc "SVCXPRT *xprt" .Xc .Pp 呼び出し側が要求したプロシージャ番号を 実現しないサービスディスパッチルーチンが呼び出します。 .Pp .It Xo .Ft void .Xc .It Xo .Fn svcerr_noprog "SVCXPRT *xprt" .Xc .Pp 目的のプログラムが .Tn RPC パッケージで登録されていない場合に呼び出されます。 サービスの設計者には、通常の場合このルーチンは必要ありません。 .Pp .It Xo .Ft void .Xc .It Xo .Fn svcerr_progvers "SVCXPRT *xprt" "u_long low_vers" "u_long high_vers" .Xc .Pp プログラムの目的のバージョンが .Tn RPC パッケージで登録されていない場合に呼び出されます。 サービスの設計者には、通常の場合このルーチンは必要ありません。 .Pp .It Xo .Ft void .Xc .It Xo .Fn svcerr_systemerr "SVCXPRT *xprt" .Xc .Pp サービスディスパッチルーチンが、 特定プロトコルでカバーされていないシステムエラーを検出した場合に呼び出します。 たとえばサービスが記憶域を割り振れない場合は、 このルーチンが呼び出されます。 .Pp .It Xo .Ft void .Xc .It Xo .Fn svcerr_weakauth "SVCXPRT *xprt" .Xc .Pp 認証パラメータが足りないために、 リモートプロシージャコールの実行を拒否する サービスディスパッチルーチンが呼び出します。 このルーチンは、 .Fn svcerr_auth xprt AUTH_TOOWEAK を呼び出します。 .Pp .It Xo .Ft "SVCXPRT *" .Xc .It Xo .Fn svcraw_create void .Xc .Pp ポインタを戻すためのトイ .Tn RPC クライアントを作成します。 実際のトランスポートは、 プロセスのアドレススペース内にあるバッファなので、対応する .Tn RPC クライアントは同じアドレススペースに存在する必要があります。 .Fn clntraw_create を参照してください。 このルーチンにより、 .Tn RPC のシミュレーション、およびラウンドトリップタイムなど、 .Tn RPC オーバヘッドの取得をカーネルの干渉なしに実行できます。 このルーチンは、エラーが発生すると .Dv NULL を戻します。 .Pp .It Xo .Ft "SVCXPRT *" .Xc .It Xo .Fn svctcp_create "int sock" "u_int send_buf_size" "u_int recv_buf_size" .Xc .Pp ポインタを戻す、 .Tn TCP/IP ベースの .Tn RPC サービストランスポートを作成します。 トランスポートにはソケット .Fa sock が関連します。ソケットが .Dv RPC_ANYSOCK である場合は、新しいソケットが作成されます。 ソケットがローカル .Tn TCP ポートに結合していない場合、 このルーチンはソケットを任意のポートに結合します。処理が終わると、 .Fa xprt\->xp_sock はトランスポートのソケット記述子になり、 .Fa xprt\->xp_port はトランスポートのポート番号になります。 このルーチンは、エラーが発生すると .Dv NULL を戻します。 .Tn TCP ベースの .Tn RPC はバッファによる .Tn I/O を使用するので、ユーザはバッファサイズを指定できます。 値を 0 にすると、適切なデフォルトが選択されます。 .Pp .It Xo .Ft "SVCXPRT *" .Xc .It Xo .Fn svcfd_create "int fd" "u_int sendsize" "u_int recvsize" .Xc .Pp 開いている記述子の最上位にサービスを作成します。 一般的にこの記述子は、 .Tn TCP などのストリームプロトコルの接続済みソケットです。 .Fa sendsize と .Fa recvsize は、送信バッファと受信バッファのサイズを指定します。 このサイズが 0 である場合は、適切なデフォルトが選択されます。 .Pp .It Xo .Ft "SVCXPRT *" .Xc .It Xo .Fn svcudp_bufcreate "int sock" "u_int sendsize" "u_int recvsize" .Xc .Pp ポインタを戻す .Tn UDP/IP ベースの .Tn RPC サービストランスポートを作成します。 トランスポートにはソケット .Fa sock が関連します。ソケットが .Dv RPC_ANYSOCK である場合は、新しいソケットが作成されます。 ソケットがローカル .Tn UDP ポートに結合していない場合、 このルーチンはソケットを任意のポートに結合します。 処理が終わると、 .Fa xprt\->xp_sock はトランスポートのソケット記述子になり、 .Fa xprt\->xp_port はトランスポートのポート番号になります。 このルーチンは、エラーが発生すると .Dv NULL を戻します。 .Pp これにより、ユーザは、 .Tn UDP ベースの送信 .Tn RPC メッセージと受信メッセージの最大パケットサイズを指定できます。 .Pp .It Xo .Ft bool_t .Fn xdr_accepted_reply "XDR *xdrs" "struct accepted_reply *ar" .Xc .Pp .Tn RPC 応答メッセージのエンコードに使用します。 このルーチンでは、 .Tn RPC パッケージを使用せずに、 .Tn RPC スタイルのメッセージを作成する場合に便利です。 .Pp .It Xo .Ft bool_t .Fn xdr_authunix_parms "XDR *xdrs" "struct authunix_parms *aupp" .Xc .Pp .Ux 証明書の記述に使用します。 このルーチンは、 .Tn RPC 認証パッケージを使用せずに、証明書を作成する場合に便利です。 .Pp .It Xo .Ft void .Xc .It Xo .Ft bool_t .Fn xdr_callhdr "XDR *xdrs" "struct rpc_msg *chdr" .Xc .Pp .Tn RPC コールヘッダメッセージの記述に使用します。 このルーチンでは、 .Tn RPC パッケージを使用せずに、 .Tn RPC スタイルのメッセージを作成する場合に便利です。 .Pp .It Xo .Ft bool_t .Fn xdr_callmsg "XDR *xdrs" "struct rpc_msg *cmsg" .Xc .Pp .Tn RPC コールメッセージの記述に使用します。 このルーチンは、 .Tn RPC パッケージを使用せずに、 .Tn RPC スタイルのメッセージを作成する場合に便利です。 .Pp .It Xo .Ft bool_t .Fn xdr_opaque_auth "XDR *xdrs" "struct opaque_auth *ap" .Xc .Pp .Tn RPC 認証情報メッセージの記述に使用します。 このルーチンでは、 .Tn RPC パッケージを使用せずに、 .Tn RPC スタイルのメッセージを作成する場合に便利です。 .Pp .It Xo .Vt struct pmap ; .Xc .It Xo .Ft bool_t .Fn xdr_pmap "XDR *xdrs" "struct pmap *regs" .Xc .Pp さまざまな .Xr portmap 8 プロシージャのパラメータの記述に外部的に使用します。 このルーチンは、 .Fn pmap_* インタフェースを使用せずに、このパラメータを作成する場合に便利です。 .Pp .It Xo .Ft bool_t .Fn xdr_pmaplist "XDR *xdrs" "struct pmaplist **rp" .Xc .Pp ポートマッピングのリストの記述に外部的に使用します。 このルーチンは、 .Fn pmap_* インタフェースを使用せずに、このパラメータを作成する場合に便利です。 .Pp .It Xo .Ft bool_t .Fn xdr_rejected_reply "XDR *xdrs" "struct rejected_reply *rr" .Xc .Pp .Tn RPC 応答メッセージの記述に使用します。 このルーチンは .Tn RPC パッケージを使用せずに、 .Tn RPC スタイルのメッセージを作成する場合に便利です。 .Pp .It Xo .Ft bool_t .Fn xdr_replymsg "XDR *xdrs" "struct rpc_msg *rmsg" .Xc .Pp .Tn RPC 応答メッセージの記述に使用します。 このルーチンは .Tn RPC パッケージを使用せずに、 .Tn RPC スタイルのメッセージを作成する場合に便利です。 .Pp .It Xo .Ft void .Xc .It Xo .Fn xprt_register "SVCXPRT *xprt" .Xc .Pp .Tn RPC サービストランスポートハンドルが作成されたら、 .Tn RPC サービスパッケージで登録する必要があります。 このルーチンは、グローバル変数 .Va svc_fds を修正します。サービスの設計者には、 通常の場合このルーチンは必要ありません。 .Pp .It Xo .Ft void .Xc .It Xo .Fn xprt_unregister "SVCXPRT *xprt" .Xc .Pp .Tn RPC サービストランスポートハンドルを破壊する前には、 .Tn RPC サービスパッケージで登録を解除する必要があります。 このルーチンは、グローバル変数 .Va svc_fds を修正します。サービスの設計者には、 通常の場合このルーチンは必要ありません。 .El .Sh 関連項目 .Xr rpc_secure 3 , .Xr xdr 3 .Rs .%T "Remote Procedure Calls: Protocol Specification" .Re .Rs .%T "Remote Procedure Call Programming Guide" .Re .Rs .%T "rpcgen Programming Guide" .Re .Rs .%T "RPC: Remote Procedure Call Protocol Specification" .%O RFC1050 .%Q "Sun Microsystems, Inc., USC-ISI" .Re diff --git a/ja_JP.eucJP/man/man3/strftime.3 b/ja_JP.eucJP/man/man3/strftime.3 index 7ebc9f52d2..c138332afe 100644 --- a/ja_JP.eucJP/man/man3/strftime.3 +++ b/ja_JP.eucJP/man/man3/strftime.3 @@ -1,254 +1,254 @@ .\" Copyright (c) 1989, 1991, 1993 .\" The Regents of the University of California. All rights reserved. .\" .\" This code is derived from software contributed to Berkeley by .\" the American National Standards Committee X3, on Information .\" Processing Systems. .\" .\" Redistribution and use in source and binary forms, with or without .\" modification, are permitted provided that the following conditions .\" are met: .\" 1. Redistributions of source code must retain the above copyright .\" notice, this list of conditions and the following disclaimer. .\" 2. Redistributions in binary form must reproduce the above copyright .\" notice, this list of conditions and the following disclaimer in the .\" documentation and/or other materials provided with the distribution. .\" 3. All advertising materials mentioning features or use of this software .\" must display the following acknowledgement: .\" This product includes software developed by the University of .\" California, Berkeley and its contributors. .\" 4. Neither the name of the University nor the names of its contributors .\" may be used to endorse or promote products derived from this software .\" without specific prior written permission. .\" .\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE .\" ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF .\" SUCH DAMAGE. .\" .\" @(#)strftime.3 8.1 (Berkeley) 6/4/93 .\" %FreeBSD: src/lib/libc/stdtime/strftime.3,v 1.18.2.7 2001/12/14 18:33:59 ru Exp % .\" $FreeBSD$ .\" .Dd October 4, 1997 .Dt STRFTIME 3 .Os .Sh 名称 .Nm strftime .Nd 日付と時間をフォーマット .Sh ライブラリ .Lb libc .Sh 書式 .In time.h .Ft size_t .Fn strftime "char *buf" "size_t maxsize" "const char *format" "const struct tm *timeptr" .Sh 解説 .Fn strftime 関数は、 .Fa timeptr からの情報を .Fa format によって指される文字列に従ってバッファ .Fa buf にフォーマットします。 .Pp .Fa format 文字列は、0 以上の変換指定および通常の文字から構成されます。 すべての通常文字は、直接バッファにコピーされます。 変換指定は、パーセント記号 .Dq Ql % ともう 1 つの文字から構成されます。 .Pp 配列には .Fa maxsize 個を超えない文字が置かれます。 結果として生じる文字の総数が終端のヌル文字を含めて .Fa maxsize を超えない場合は、 .Fn strftime は終端のヌルを数えないで配列中の文字数を返します。 それ以外の場合は 0 を返し、バッファの内容は不定になります。 .Pp 変換指定は、以下に示すような形で展開した後バッファにコピーされます : .Bl -tag -width "xxxx" .It Cm \&%A 各国の表現で完全な曜日名で置き換えられます。 .It Cm %a 各国の表現で省略した曜日名で置き換えられます。 ここで、略称は最初の 3 文字です。 .It Cm \&%B 各国の表現で完全な月名で置き換えられます。 .It Cm %b 各国の表現で省略した月名で置き換えられます。 ここで、略称は最初の 3 文字です。 .It Cm \&%C (西暦年 / 100) の 10 進数で置き換えられます。 1 桁の数字の前には 0 が付きます。 .It Cm %c -各国の表現で時刻と日付で置き換えられます +各国の表現で時刻と日付で置き換えられます。 書式は .Xr ctime 3 が生成するものと同様であり、"%a %Ef %T %Y" と等価です。 これはまた、"3+1+6+1+8+1+4" の出力フォーマットを意味します。 .It Cm \&%D .Dq Li %m/%d/%y と同等です。 .It Cm %d 日を示す 10 進数 (01-31) で置き換えられます。 .It Cm \&%E* Cm \&%O* POSIX の地域拡張です。 %Ec %EC %Ex %EX %Ey %EY %Od %Oe %OH %OI %Om %OM %OS %Ou %OU %OV %Ow %OW %Oy というシーケンスは、代替的な表現を与えるものと見なされます。 .Pp 更に、%Ef は短縮形の月の名前と日を示し、 また %EF は長い形式の月と日を示し、 また %OB は別の形式の月の名前を示します (単独で使用し日付は指定しません)。 .It Cm %e 日を示す 10 進数 (1-31) で置き換えられます。 1 桁の数字の前には空白が付きます。 .It Cm \&%G 百年紀付きの年の 10 進数で置き換えられます。 この年は、週の大部分を含んだものとなります (月曜日を週の最初の日として)。 .It Cm %g .Dq Li %G と同じ年ですが、百年紀なしの 10 進数 (00-99) で置き換えられます。 .It Cm \&%H (24 時間時計で) 時間を示す 10 進数 (00-23) で置き換えられます。 .It Cm %h %b と同じです。 .It Cm \&%I (12 時間時計で) 時間を示す 10 進数 (01-12) で置き換えられます。 .It Cm %j 1 年の日を示す 10 進数 (001-366) で置き換えられます。 .It Cm %k (24 時間時計で) 時間を示す 10 進数 (0-23) で置き換えられます。 1 桁の数字の前には空白が付きます。 .It Cm %l (12 時間時計で) 時間を示す 10 進数 (1-12) で置き換えられます。 1 桁の数字の前には空白が付きます。 .It Cm \&%M 分を示す 10 進数 (00-59) で置き換えられます。 .It Cm %m 月を示す 10 進数 (01-12) で置き換えられます。 .It Cm %n 改行で置き換えられます。 .It Cm \&%O* %E* と同じです。 .It Cm %p 各国の表現で "午前" または "午後" の いずれか該当する表示で置き換えられます。 .It Cm \&%R .Dq Li %H:%M と同等です。 .It Cm %r .Dq Li %I:%M:%S %p と同等です。 .It Cm \&%S 秒を示す 10 進数 (00-60) で置き換えられます。 .It Cm %s 世界標準時基準時点からの秒数で置き換えられます .Xr (mktime 3 参照)。 .It Cm \&%T .Dq Li %H:%M:%S と同等です。 .It Cm %t タブで置き換えられます。 .It Cm \&%U 1 年のうちの週数 (日曜日を週の最初の日として) を示す 10 進数 (00-53) で置き換えられます。 .It Cm %u 1 週のうちの日 (月曜日を週の最初の日として) を示す 10 進数 (1-7) で置き換えられます。 .It Cm \&%V 1 年のうちの週数 (月曜日を週の最初の日として) を示す 10 進数 (01-53) で置き換えられます。 新年の 1 月 1 日を含む週に 4 日以上の日がある場合は、 その週が第 1 週となります。 それ以外の場合は、その週は前年の最後の週となり、 その次の週が第 1 週となります。 .It Cm %v .Dq Li %e-%b-%Y と同等です。 .It Cm \&%W 1 年のうちの週数 (月曜日を週の最初の日として) を示す 10 進数 (00-53) で置き換えられます。 .It Cm %w 1 週のうちの日 (日曜日を週の最初の日として) を示す 10 進数 (0-6) で置き換えられます。 .It Cm \&%X 各国の表現で時刻で置き換えられます。 .It Cm %x 各国の表現で日付で置き換えられます。 .It Cm \&%Y 百年紀付きの年を示す 10 進数で置き換えられます。 .It Cm %y 百年紀なしの年を示す 10 進数 (00-99) で置き換えられます。 .It Cm \&%Z 時間帯名で置き換えられます。 .It Cm \&%z は UTC からの時間帯の差で置き変えられます。 先頭のプラス記号は UTC から東を意味し、 マイナス記号は UTC から西を意味します。 続く時間と分は、それぞれ 2 桁であり、間に区切り文字はありません (RFC 822 時刻ヘッダに共通です)。 .It Cm %+ 各国の表現で日付と時刻を示すもので置き換えられます (フォーマットは .Xr date 1 によって作成されるものと同じです)。 .It Cm %% .Ql % で置き換えられます。 .El .Sh 参照 .Xr date 1 , .Xr printf 1 , .Xr ctime 3 , .Xr printf 3 , .Xr strptime 3 .Sh 規格 .Fn strftime 関数は、 .Ql %C , .Ql \&%D , .Ql %E* , .Ql %e , .Ql %G , .Ql %g , .Ql %h , .Ql %k , .Ql %l , .Ql %n , .Ql %O* , .Ql \&%R , .Ql %r , .Ql %s , .Ql \&%T , .Ql %t , .Ql %u , .Ql \&%V , .Ql %z , .Ql %+ などを含む多くの拡張を含めて、 .St -isoC に適合しています。 .Pp .Ql %G , .Ql %g , および .Ql \&%V の置き換えにおける特殊な週数および年数は、 ISO 8601: 1988 に定義されています。 .Sh バグ 月の象に関する変換指定は備えていません。 diff --git a/ja_JP.eucJP/man/man7/groff_mdoc.7 b/ja_JP.eucJP/man/man7/groff_mdoc.7 index 159d002163..af798da70d 100644 --- a/ja_JP.eucJP/man/man7/groff_mdoc.7 +++ b/ja_JP.eucJP/man/man7/groff_mdoc.7 @@ -1,4193 +1,4193 @@ .\" groff_mdoc.man .\" .\" A complete reference of the mdoc macro package for GNU troff. .\" .\" Based on NetBSD's mdoc.samples.7, version 1.21. .\" .\" .\" Warning: You can't format this file with the old mdoc macros! .\" .\" .\" Copyright (c) 1990, 1993 .\" The Regents of the University of California. All rights reserved. .\" .\" Redistribution and use in source and binary forms, with or without .\" modification, are permitted provided that the following conditions .\" are met: .\" 1. Redistributions of source code must retain the above copyright .\" notice, this list of conditions and the following disclaimer. .\" 2. Redistributions in binary form must reproduce the above copyright .\" notice, this list of conditions and the following disclaimer in the .\" documentation and/or other materials provided with the distribution. .\" 3. All advertising materials mentioning features or use of this software .\" must display the following acknowledgement: .\" This product includes software developed by the University of .\" California, Berkeley and its contributors. .\" 4. Neither the name of the University nor the names of its contributors .\" may be used to endorse or promote products derived from this software .\" without specific prior written permission. .\" .\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE .\" ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF .\" SUCH DAMAGE. .\" .\" @(#)mdoc.samples.7 8.2 (Berkeley) 12/30/93 .\" .\" This reference invokes every macro in the package several .\" times and is guaranteed to give a worst case performance .\" for an already extremely slow package. .\" .\" $FreeBSD$ .\" Copyright (c) 2001 FreeBSD jpman project .\" This is for Japanese translation done by FreeBSD jpman project. .\" WORD: epoch 基準時点 (協定世界時 1970年1月1日 00:00:00) .\" WORD: display ディスプレイ .\" WORD: bracket 角括弧 [] .\" WORD: brace 中括弧 () .\" WORD: angle bracket 山括弧 <> .\" WORD: acronym 頭字語 .\" WORD: keep キープ .\" WORD: literal リテラル .\" WORD: content macro コンテントマクロ .\" WORD: command modifier コマンド修飾子 .\" WORD: enclosure 囲い .\" WORD: quoting クォート .\" WORD: nest 入れ子 .\" WORD: block ragged 凹凸ブロック .\" WORD: constant width character 定幅文字 .\" WORD: scale indicator スケール指示子 .\" WORD: hanging tag ぶら下がりタグ .\" WORD: overhanging tag オーバハングタグ .\" WORD: parsed 構文解析される .\" WORD: callable 呼び出し可能 . .Dd February 27, 2003 .Os .Dt GROFF_MDOC 7 . . .Sh 名称 . .Nm groff_mdoc .Nd groff mdoc の実装に関するリファレンス . . .Sh 書式 . .Nm groff Fl m Ns Cm doc Ar . . .Sh 解説 . .Tn GNU .Xr troff 1 用の .Em コンテントベース でかつ .Em 領域ベース な整形用パッケージである .Nm \-mdoc マクロパッケージを使って .Ux マニュアルページを書くための完全なリファレンスです。 前身である .Xr \-man 7 パッケージは、フォントの操作や他の写植方法の詳細は個々の作者に任せ、 ページのレイアウトを取り扱ってきました。 .Nm \-mdoc では、ページレイアウトマクロは タイトル、セクションのヘッダ、ディスプレイ、リストのマクロからなる .Em "ページ構造領域" を形成しています。本質的にこれらの要素は整形されたページにおける テキストの物理的位置に影響を与えます。 ページ構造領域に加え、さらに .Em マニュアル 領域および .Em 一般 テキスト領域の 2 つの領域があります。 一般テキスト領域は、テキストの一部をクォートしたり強調したりと いったような作業を実行するマクロとして定義されています。 マニュアル領域はコマンドやルーチン、それに .Ux の関連ファイルを記述するための日常使用されるインフォーマルな言葉の サブセットであるマクロとして定義されています。 マニュアル領域のマクロはコマンド名、コマンド行の引数とオプション、 関数名、関数のパラメータ、パス名、変数名、他のマニュアルページへの クロスリファレンスなどを扱います。 これらの領域の項目は作者とマニュアルページの将来のユーザの両者に とって価値のあるものです。 マニュアル間で一貫性を高めることによって将来のドキュメントツールへの 移行が容易になることが期待されます。 .Pp .Ux マニュアルページ全体を通して、マニュアルのエントリは単純に マニュアルページ (a man page) とみなされます。 これは実際のページ数と関係ありませんし、性差別をする意図もありません。 .\" 訳注: a man page -- 1 ページ (a page) と男 (man) の意味 . . .Sh "さあ、始めよう" . このドキュメントの残りの部分で説明されている題材は以下のような構成に なっています。 . .Bl -enum -width 3n -offset indent . It . Tn "TROFF に特有な表現" . . Bl -tag -width 2n -compact . It "マクロの使用方法" . It "引数に空白文字を指定する" . It "行末の空白文字" . It "特殊文字のエスケープ" . It "その他の注意点" . El . . It . Tn "マニュアルページのテンプレート" . . It . Tn "使用法" . . It . Tn "タイトルマクロ" . . It . Tn "マニュアル領域および一般テキスト領域の紹介" . . Bl -tag -width 2n -compact . It "この名前には何が" Ns ... . It "一般的な構文" . El . . It . Tn "マニュアル領域" . . Bl -tag -width 2n -compact . It "アドレス" . It "作者名" . It "引数" . It "コンフィギュレーション宣言 (セクション 4 のみ)" . It "コマンド修飾子" . It "定義済みの変数" . It "errno (セクション 2 のみ)" . It "環境変数" . It "フラグ" . It "関数の宣言" . It "関数の型" . It "関数 (ライブラリルーチン)" . It "関数の引数" . It "戻り値" . It "終了ステータス" . \" .It "ヘッダファイル (ソースコードを含む)" . It "対話的なコマンド" . It "ライブラリ名" . It "リテラル" . It "名称" . It "オプション" . It "パス名" . It "標準" . It "変数の型" . It "変数" . It "マニュアルページのクロスリファレンス" . El . . It . Tn "一般テキスト領域" . . Bl -tag -width 2n -compact . It "AT&T マクロ" . It "BSD マクロ" . It "NetBSD マクロ" . It "FreeBSD マクロ" . It "OpenBSD マクロ" . It "BSD/OS マクロ" . It "UNIX マクロ" . It "強調マクロ" . It "フォントモード" . It "囲い/クォート マクロ" . It "無操作もしくは通常テキストマクロ" . It "空白なしマクロ" . It "セクションのクロスリファレンス" . It "記号" . It "数式記号" . It "参考文献と引用" . It "商標名 (頭字語とタイプ名)" . It "拡張引数" . El . . It . Tn "ページ構造領域" . . Bl -tag -width 2n -compact . It "セクションヘッダ" . It "サブセクションヘッダ" . It "段落と行スペース" . It "キープ" . It "例示とディスプレイ" . It "リストとカラム" . El . . It . Tn "その他のマクロ" . . It . Tn "定義済みの文字列" . . It . Tn "診断" . . It . Tn "GROFF, TROFF および NROFF を使用した整形" . . It . Tn "関連ファイル" . . It . Tn "関連項目" . . It . Tn "バグ" .El . .\" XXX .if t \ . ne 7 . . .Sh "TROFF に特有な表現" . .Nm \-mdoc パッケージは、マニュアルページを記述するプロセスを簡単にすることを 目的としています。 .Nm \-mdoc を使うために .Tn GNU .Xr troff 1 のゴタゴタした詳細を学ぶ必要がないのが理想ですが、 いくつか片付けるべき避けられない制限事項があります。 また、このパッケージは高速で .Em ない ということも予め警告しておきます。 . .Ss "マクロの使用方法" . .Tn GNU .Xr troff 1 のように、マクロは .Ql .\& (ドット) を行頭に置き、それに続けて 2 文字 (または 3 文字) からなる マクロの名称を指定することによって呼び出されます。 -ドットとマクロの間にはスペースかタブを置くことができます +ドットとマクロの間にはスペースかタブを置くことができます。 引数はマクロの後にスペースで区切って指定することができます (タブは使用 .Em できません ) 。 行頭にドットを指定することによって .Tn GNU .Xr troff 1 にそれに続く 2 文字 (あるいはそれより多い文字) を マクロ名として解釈するよう指示しています。 最初にドット 1 文字をとり、その後ろに何も来ない場合は 無視されます。 マクロを起動させたくないような文脈で、入力行の先頭に .Ql .\& (ドット) を置くためには、 .Ql .\& (ドット) の前にエスケープシーケンス .Ql \e& を指定します。 .Ql \e& は文字通りスペース幅が 0 として解釈され、出力には現れません。 .Pp 一般的に .Tn GNU .Xr troff 1 マクロは取り得る引数の数に制限はありません (9 つ以上の 引数を扱うことのできない他のバージョンの troff とは違います)。 限られた場合ではありますが、引数を次の行に続けたり、拡張したり することができます (後述の .Sx 拡張引数 のセクションを参照)。 ほとんどすべてのマクロで引用符に囲まれた引数を扱うことができます (後述の .Sx 引数に空白文字を指定する のセクションを参照)。 .Pp .Nm \-mdoc での一般テキスト領域とマニュアル領域のほとんどのマクロは、 呼び出し可能なマクロ名を決定するためにその引数のリストが .Em 構文解析 されるという点で特別なものです。 これはつまり、一般テキスト領域またはマニュアル領域のマクロ名に一致し (かつ、呼び出し可能であると定義された) 引数リスト中の引数は、 処理される時に実行されるか、もしくは呼び出されるということです。 この場合、引数がマクロの名前であっても .Ql .\& (ドット) で前置されません。 このようにしてたくさんのマクロを入れ子にすることができます。 例えばオプションマクロ .Ql .Op はフラグマクロおよび引数マクロ .Ql \&Fl と .Ql \&Ar を .Em 呼び出し て、オプションのフラグを引数とともに指定することができます: . .Bl -tag -width ".Op Fl s Ar bytes" -offset indent .It Op Fl s Ar bytes は .Ql ".Op Fl s Ar bytes" で生成されます。 .El . .Pp 文字列がマクロ名と解釈されないようにするには、 その文字列の前にエスケープシーケンス .Ql \e& を指定します。 . .Bl -tag -width ".Op \&Fl s \&Ar bytes" -offset indent .It Op \&Fl s \&Ar bytes は .Ql ".Op \e&Fl s \e&Ar bytes" で生成されます。 .El . .Pp ここで文字列 .Ql \&Fl と .Ql \&Ar はマクロとして解釈されていません。 このドキュメントを通じて、 呼び出し可能な引数を調べるために引数リストが構文解析されるマクロは .Em 構文解析される マクロとして参照し、 引数リストから呼び出されることができるマクロは .Em 呼び出し可能 なマクロとして参照します。 .Nm \-mdoc のマクロはほとんどすべてが構文解析されるのですから、これは技術的には .Em 適当でない 表現ですが、常にマクロを「呼び出し可能である」とか「他のマクロを 呼び出すことができる」と表現するのは面倒なことであるため、 「構文解析される」という用語を使います。 . .Pp 以降、この区別が必要な場合、行頭 (でドットで開始する) .Nm \-mdoc マクロを .Em コマンド と呼びます。 . .Ss "引数に空白文字を指定する" . 1 つ以上の空白文字を含む文字列を引数として指定したい 場合があります。 引数リスト中の要素が特定の並びをしていることを 期待しているコマンドに引数を指定する時に必要になることがあります。 さらに、こうすると .Nm \-mdoc が速く実行されるようになるのです。 例えば、関数コマンド .Ql .Fn では第 1 引数は関数名であり、残りの引数が関数のパラメータであると 想定されています。 .Tn ANSI\~C では、関数のパラメータ宣言を括弧で囲まれたパラメータリスト中に 明示することを規定しているので、 各パラメータは最低でも 2 語の文字列となります。 例えば、 .Fa int foo のようになります。 .Pp 空白を含む引数を指定するには 2 通りの方法があります。 1 つは、空白を含む文字列を渡すのに、固定の空白、 つまりパディングされない空白文字 .Ql \e\ を使う方法です。すなわち、空白の前にエスケープ文字 .Ql \e を指定します。 この方法はどのマクロでも使うことができますが、1 行が長くなり過ぎた テキストを調整するときの邪魔になるという副作用があります。 .Xr troff では、固定の空白は他の印刷可能な文字と同様に扱われ、通常期待されるように その箇所で文字列を空白や改行で分けることは行われなくなります。 この方法は文字列が行の境界にまたがることが好ましくない場合に有用です。 代替案としては、 パディング可能 (すなわち伸長可能) で分割不可能な空白 .Ql \e~ を使うことがあります (これは、 .Tn GNU .Xr troff 1 拡張です)。 2 つ目の方法は、文字列をダブルクォートで括ることです。 .Pp 例えば、次のようにします: . .Bl -tag -width ".Fn fetch char\ *str" -offset indent .It Fn fetch char\ *str は .Ql ".Fn fetch char\e *str" で生成されます。 .It Fn fetch "char *str" も .Ql ".Fn fetch \*[q]char *str\*[q]" で生成することができます。 .El . .Pp もし、最初の例の空白の前もしくは次の例のダブルクォートの前の .Ql \e が省略されていた場合には .Ql .Fn は引数が 3 つであるとみなし、その結果は .Pp .Dl Fn fetch char *str .Pp となります。 .\" For an example of what happens when the parameter list overlaps a newline .\" boundary, see the .\" .Sx BUGS .\" section. . .Ss "行末の空白文字" . .Xr Troff は行末に空白文字があると混乱してしまうことがあります。 .Ao 空白 Ac Ns Ao 行末 Ac の文字の並びからすべての空白文字を取り除くのは良い予防策です。 どうしても行末に空白文字をおく必要性が出てきた場合は、 パディングされない空白とエスケープ文字 .Ql \e& を使用することによって対応できます。 例えば、 .Ql string\e\ \e& のようにします。 . .Ss "特殊文字のエスケープ" . 改行 .Ql \en のような特殊文字は、バックスラッシュを保存するために .Ql \e を .Ql \ee で置き換え (たとえば .Ql \een とする) て扱います。 . .Ss "その他の注意点" . 表示領域外で空の入力行が見つかった場合には警告が発生します (後述)。 代わりに .Ql .sp を使用してください ( .Nm \-mdoc マクロを使用して、低レベルコマンドを使用しないようにすると ずっと良いです)。 .Pp 先頭に空白を置くと行分割が生じ、そのまま出力されてしまいます。 可能ならばこうなることを避けてください。 同様に、通常のテキスト行において単語間に 2 つ以上の空白文字を 使用しないでください。これは、他のテキストフォーマッタとは 対照的です。空白文字を 2 つ以上置いても 1 つの空白文字に .Em 置き換わりません 。 .Pp 引数として .Ql \*[q] を直接渡すことはできません。 代わりに .Ql \e*[q] (あるいは .Ql \e*q ) を使用してください。 .Pp デフォルトでは、 .Xr troff 1 は文を終了させる句読点の後に空白文字を 2 つ挿入します。 つまり、 .Ql \&) あるいは .Ql \&' などの文字はそのまま扱われ、文の終了には影響を与えません。 この動作を変更するには、 ドットの前あるいは後に .Ql \e& を挿入してください。 . .Bd -literal -offset indent The \&.Ql . character. \&.Pp The \&.Ql \e&. character. \&.Pp \&.No test . test \&.Pp \&.No test. test .Ed .Pp . は、 . .Bd -filled -offset indent The .Ql . character. .Pp The .Ql \&. character. .Pp .No test . test .Pp .No test. test .Ed .Pp となります。 .Pp . 1 行目および 3 行目にみられるように、 .Nm \-mdoc はマクロ引数の中では句読点を特別に扱います。 これについては、後述の .Sx 一般的な構文 の節で述べます。 同様の方法で、幅 0 の空白を続けることで、 省略形の後に続いたピリオドを保護しなくてはなりません。 例えば .Ql e.g.\e& のようにします。 .Pp マニュアルページのソースファイル中のコメントは、 独立した行では .Ql .\e" 、何らかの入力があった後では .Ql \e" を、あるいはどのような場所でも使いたい場合は .Ql \e# を使うことができます (後者は .Tn GNU .Xr troff 1 拡張です)。このような行の残りの部分は無視されます。 . . .Sh "マニュアルページのテンプレート" . マニュアルページの中身は次のような基本的なテンプレートから 簡単に作成できます。 . .Bd -literal -offset indent \&.\e" 以下のコマンドはすべてのマニュアルページで必要な項目です。 \&.Dd 月 日, 年 \&.Os [オペレーティングシステム] [バージョン/リリース] \&.Dt ドキュメントタイトル [セクション番号] [アーキテクチャ/ボリューム] \&.Sh NAME \&.Nm 名称 \&.Nd 名称についての 1 行での説明 \&.\e" 次のコマンドはセクション 2, 3 でのみ必要なものです。 \&.\e" .Sh LIBRARY \&.Sh SYNOPSIS \&.Sh DESCRIPTION \&.\e" 以下のコマンドについては、必要に応じてコメントをはずして使用してく \&.\e" ださい。 \&.\e" .Sh IMPLEMENTATION NOTES \&.\e" この次のコマンドはセクション 2, 3, 9 でのみ必要な、関数の \&.\e" 戻り値です。 \&.\e" .Sh RETURN VALUES \&.\e" 次のコマンドはセクション 1, 6, 7, 8, 9 でのみ必要なものです。 \&.\e" .Sh ENVIRONMENT \&.\e" .Sh FILES \&.\e" .Sh EXAMPLES \&.\e" 次のコマンドはセクション 1, 6, 7, 8, 9 でのみ必要なものです。 \&.\e" ((シェルへの)コマンドの戻り値と \&.\e" fprintf/stderr タイプの診断です) \&.\e" .Sh DIAGNOSTICS \&.\e" .Sh COMPATIBILITY \&.\e" 次のコマンドはセクション 2, 3, 9 でのみ必要な、 \&.\e" エラーハンドリングとシグナルハンドリングです。 \&.\e" .Sh ERRORS \&.\e" .Sh SEE ALSO \&.\e" .Sh STANDARDS \&.\e" .Sh HISTORY \&.\e" .Sh AUTHORS \&.\e" .Sh BUGS .Ed .Pp . このテンプレートにおける最初のコマンドはマクロ .Ql .Dd , .Ql .Os , および .Ql .Dt であり、それぞれドキュメントの日付、 マニュアルページもしくは題材となっているソースの開発や変更の 対象となったオペレーティングシステム、そして マニュアルページのタイトルを属するマニュアルのセクション番号と ともに ( .Em 大文字で ) 指定したもの、となっています。 これらのコマンドはそのページを識別するものであり、後述の .Sx タイトルマクロ で解説されます。 .Pp テンプレート中の残りの項目はセクションのヘッダ .Pf ( Li .Sh ) であり、それらのうち .Sx NAME , .Sx SYNOPSIS , および .Sx DESCRIPTION は必須項目です。 これらのヘッダについては .Sx "マニュアル領域" を説明した後、 .Sx "ページ構造領域" で解説されます。 いくつかのコンテントマクロはページレイアウトマクロの説明に 使用されていますので、ページレイアウトマクロの前にコンテントマクロに ついて読むことを推奨します。 . . .Sh 使用法 . 次に説明するマクロはすべて、オプションの引数は 角括弧 ([]) で括られます。 省略符号 .Pf ( Sq ... ) はさらに 0 個以上の引数があることを表しています。 パラメータの代替値は .Ql | で区切って示します。 必須パラメータに代替値がある場合は、 ( .Ql | と一緒に) 中括弧 ({}) を用い、値の組を括ります。 メタ変数は山括弧 (<>) の中で指定されます。 .Pp 例: . .Bl -tag -width 6n -offset indent .It Li .Xx Xo .Aq foo .Brq bar1 | bar2 .Op \-test1 Op \-test2 | \-test3 .No ... .Xc .El . .Pp とくに明示しない限り、すべてのマクロは 構文解析され、呼び出し可能なものです。 .Pp マクロの効果が持続するのは、 次のネストしたマクロまでであることに注意してください。 例えば .Ql ".Ic foo Aq bar" は .Sq Ic "foo " とはならず .Sq Ic foo Aq bar となります。 この結果、最初の引数がマクロである場合、 ほとんどのコマンドに対して警告が出力されます。 マクロがコマンド呼び出しの効果を完全に打ち消してしまうからです。 また、マクロをクォートしても、文字通りのクォートは挿入されないことは重要です。 .Sq Ic "foo " は .Ql ".Ic \*[q]foo \*[q]" から生成されます。 .Pp 大部分のマクロはデフォルトの幅の値を持っており、これを .Ql .Bl および .Ql .Bd マクロ用にラベル width .Pf ( Fl width ) あるいは offset .Pf ( Fl offset ) を指定するのに使用することができます。 .Nm \-mdoc パッケージのローカルな変更に依存することのないように、 このとても曖昧な機能は使わないことを推奨します。 . . .Sh "タイトルマクロ" . タイトルマクロはページ構造領域の一部ですが、 マニュアルページを昨日書き始めようと思ったという人のために、 最初に、他のとは別に記述されています。 3 つのヘッダマクロでドキュメントまたはマニュアルページのタイトル、 オペレーティングシステム、および原著の日付を指定します。 これらのマクロはドキュメントの最初で一度だけ呼び出されるもので、 ヘッダとフッタを構成するためだけに使用されます。 . .Bl -tag -width 6n .It Li .Dt Xo .Op Aq ドキュメントタイトル .Op Aq セクション番号 .Op Aq ボリューム .Xc ドキュメントタイトルはマニュアルページの主題であり、 troff の制限により .Tn 大文字 でなければいけません。 省略された場合、 .Sq Tn UNTITLED が使われます。 セクション番号は .No 1,\~ Ns ... Ns ,\~9 の範囲の番号もしくは .Ql unass , .Ql draft , .Ql paper のいずれかを取ることができます。 セクション番号が指定されており、ボリューム名が与えられていない 場合には、デフォルトのボリューム名が使用されます。 . .Pp .Tn \*[operating-system] では、次のセクションが定義されています: .Pp .Bl -column LOCAL -offset indent -compact .It Li 1 Ta "\*[volume-operating-system] \*[volume-ds-1]" .It Li 2 Ta "\*[volume-operating-system] \*[volume-ds-2]" .It Li 3 Ta "\*[volume-operating-system] \*[volume-ds-3]" .It Li 4 Ta "\*[volume-operating-system] \*[volume-ds-4]" .It Li 5 Ta "\*[volume-operating-system] \*[volume-ds-5]" .It Li 6 Ta "\*[volume-operating-system] \*[volume-ds-6]" .It Li 7 Ta "\*[volume-operating-system] \*[volume-ds-7]" .It Li 8 Ta "\*[volume-operating-system] \*[volume-ds-8]" .It Li 9 Ta "\*[volume-operating-system] \*[volume-ds-9]" .El .Pp . ボリューム名は任意であるか、もしくは次のものを 取ることができます: . .Pp .Bl -column LOCAL -offset indent -compact .It Li USD Ta "\*[volume-ds-USD]" .It Li PS1 Ta "\*[volume-ds-PS1]" .It Li AMD Ta "\*[volume-ds-AMD]" .It Li SMM Ta "\*[volume-ds-SMM]" .It Li URM Ta "\*[volume-ds-URM]" .It Li PRM Ta "\*[volume-ds-PRM]" .It Li KM Ta "\*[volume-ds-KM]" .It Li IND Ta "\*[volume-ds-IND]" .It Li LOCAL Ta "\*[volume-ds-LOCAL]" .It Li CON Ta "\*[volume-ds-CON]" .El .Pp . 互換性を保つため、 .Ql IND の代わりに .Ql MMI を使用することができ、 .Ql LOCAL の代わりに .Ql LOC を使用できます。 先の表の値は、新しいボリューム名を指定します。 第 3 パラメータがコンピュータアーキテクチャを表すキーワードで ある場合、その値は第 2 パラメータで指定したボリューム名の 前に追加されます。 デフォルトでは次のアーキテクチャに関するキーワードが定義されています: . \# we use `No' to avoid hyphenation .Bd -ragged -offset indent .No alpha , amiga , arc , arm26 , arm32 , atari , bebox , cobalt , evbsh3 , .No hp300 , hpcmips , i386 , luna68k , m68k , mac68k , macppc , mips , .No mmeye , mvme68k , news68k , newsmips , next68k , ofppc , pc532 , pmax , .No powerpc , prep , sgimips , sh3 , sparc , sparc64 , sun3 , tahoe , vax , .No x68k .Ed .Pp . セクション番号が 1 から 9 の範囲の数値ではなく、 また前述のキーワードでない場合、 第 3 パラメータがそのままボリューム名として使用されます。 .Pp 次の例では、マニュアルページのヘッダの左側 (これは右側と同じものです) と 中央に書かれる文字列を示しています。 .Ql \e& が数値 7 を正当な数値として解釈されないようにしている点に注意してください。 . .Bd -ragged .Bl -tag -width ".Li .Dt\ FOO\ 2\ i386" -compact -offset indent .It Li ".Dt FOO 7" .Ql FOO(7) .Ql \*[volume-operating-system] \*[volume-ds-7] .It Li ".Dt FOO 7 bar" .Ql FOO(7) .Ql \*[volume-operating-system] \*[volume-ds-7] .It Li ".Dt FOO \e&7 bar" .Ql FOO(7) .Ql bar .It Li ".Dt FOO 2 i386" .Ql FOO(2) .Ql \*[volume-operating-system]/\*[volume-as-i386] \*[volume-ds-2] .It Li ".Dt FOO \*[q]\*[q] bar" .Ql FOO .Ql bar .El .Ed .Pp . ローカルな追加項目や OS に特化した追加項目が、ファイル .Pa mdoc.local にあるかもしれません。このファイル中で .Ql volume-ds-XXX (前者のタイプについて) および .Ql volume-as-XXX (後者のタイプについて) という名前の文字列を検索してください。ここで .Ql XXX は .Ql .Dt マクロで使用されるキーワードを表しています。 .Pp このマクロは呼び出し不可能であり、構文解析もされません。 . .It Li .Os Xo .Op Aq オペレーティングシステム .Op Aq リリース番号 .Xc 第 1 パラメータが空の場合、 デフォルト値 .Sq Tn "\*[operating-system]" が使用されます。 これは、ローカルの設定ファイル .Pa mdoc.local で上書きできます。一般的には、 オペレーティングシステムの名称には一般的な頭字語 (略称) を 使わなければなりません。 例えば .Tn BSD や .Tn ATT といったものです。 リリース番号は、各システムでの標準のリリースの命名法を使用します。 次の表では、いくつか事前に定義されているオペレーティングシステムに 対して取り得る第 2 引数をリストしています。 .Ql .Dt と同じように、ローカルな追加項目が .Pa mdoc.local に定義されているかもしれません。このファイル中で .Ql operating-system-XXX-YYY という名前の文字列を検索してください。ここで .Ql XXX はオペレーティングシステムの頭字語 (略称) そして .Ql YYY がリリース ID です。 . .Bd -ragged -compact .Bl -tag -width ".No FreeBSD" -offset indent .It ATT 7th, 7, III, 3, V, V.2, V.3, V.4 .It BSD 3, 4, 4.1, 4.2, 4.3, 4.3t, 4.3T, 4.3r, 4.3R, 4.4 .It NetBSD 0.8, 0.8a, 0.9, 0.9a, 1.0, 1.0a, 1.1, 1.2, 1.2a, 1.2b, 1.2c, 1.2d, 1.2e, 1.3, 1.3a, 1.4, 1.5, 1.6 .It FreeBSD 1.0, 1.1, 1.1.5, 1.1.5.1, 2.0, 2.0.5, 2.1, 2.1.5, 2.1.6, 2.1.7, 2.2, 2.2.1, 2.2.2, 2.2.5, 2.2.6, 2.2.7, 2.2.8, 3.0, 3.1, 3.2, 3.3, 3.4, 3.5, 4.0, 4.1, 4.2, 4.3, 4.4, 4.5, 4.6, 5.0 .El .Ed .Pp . .Tn ATT に関しては、判別できない第 2 パラメータがある時には それを文字列 .Tn UNIX に置き換えます。事前に定義されているその他の頭字語 (略称) に ついては、そのようなパラメータは無視され、警告メッセージが 出力されます。 認識できない引数は、ページフッタ中に記述された通りに 表示されます。例えば、典型的なフッタは次のようになるでしょう: .Pp .Dl .Os BSD 4.3 .Pp は .Ql 4.3\~Berkeley Distribution となります。また、ローカルで作られたセットの例では、 .Pp .Dl .Os CS Department .Pp は .Ql CS\~Department となります。 .Pp .Ql .Os マクロがない場合、ページの左下隅は見苦しくなってしまうでしょう。 .Pp このマクロは呼び出し不可能であり、構文解析もされません。 . .It Li .Dd Oo .Aq 月 .Aq 日 , .Aq 年 .Oc .Ql Dd に引数がない場合は、日付には .Ql "基準時点 (協定世界時 1970年1月1日 00:00:00)" が使用されます。 ちょうど 3 つ引数がある場合には、それらは連結され、 分割できない空白で分けられたものになります。 .Pp .Dl .Dd January 25, 2001 .Pp それ以外の場合は現在の日付が使用され、パラメータは無視されます。 .Pp このマクロは呼び出し不可能であり、構文解析もされません。 .El . . .Sh "マニュアル領域および一般テキスト領域の紹介" . .Ss "この名前には何が" Ns ... . マニュアル領域のマクロ名はコマンドやサブルーチン、それに関連ファイルを 説明するために使われている日常のインフォーマルな言葉から取られています。 この言葉と少し違うバリエーションのものがマニュアルページを書く上での 3 つの異なった側面を記述するのに使われます。 最初のものは、 .Nm \-mdoc マクロコマンド使用方法の説明です。2 番目は .Nm \-mdoc マクロを .Em 用いた .Ux コマンドの記述です。 3 番目はコマンドを通常の言葉の感覚でユーザに示したものです。 これはすなわち、マニュアルページのテキスト中でのコマンドの 説明となります。 .Pp 最初のケースでは、 .Xr troff 1 マクロはそれ自身、一種のコマンドとなっています。 troff コマンドは一般的に以下のような形式をとります。 . .Bd -filled -offset indent .Li ".Xx argument1 argument2" ... .Ed .Pp . .Ql .Xx はマクロコマンドを示しており、それに続くものは すべて処理されるべき引数として処理されます。 2 番目のケースでは、コンテントマクロを使用する .Ux コマンドの記述がもう少し含まれます。 典型的な .Sx SYNOPSIS コマンド行はこのように表示されます。 . .Bd -filled -offset indent .Nm filter .Op Fl flag .Ao Ar infile Ac Ao Ar outfile Ac .Ed .Pp . ここで .Nm filter はコマンド名であり、角括弧で囲まれた文字列 .Fl flag は .Em フラグ 引数で、これは角括弧で囲むことによってオプションであることを 示しています。 .Nm \-mdoc の用語では、 .Ao Ar infile Ac および .Ao Ar outfile Ac は .Em メタ引数 と称されています。 この例では、ユーザは山括弧 (<>) の中で与えられたメタ引数を 実際のファイル名に置き換えなくてはなりません。 このドキュメントでは、メタ引数は .Nm \-mdoc コマンドを記述するのに使用していることに注意してください。 多くのマニュアルページでは、メタ変数はわざわざ山括弧を使って 書かれていません。 上の例を整形したマクロは以下のものです。 . .Bd -literal -offset indent \&.Nm filter \&.Op Fl flag \&.Ao Ar infile Ac Ao Ar outfile Ac .Ed .Pp . 3 番目のケースでは、コマンドの説明や構文に上記の例の両方が使われ、 さらに細かい記述が追加されるでしょう。 上の例での引数 .Ao Ar infile Ac および .Ao Ar outfile Ac は .Em オペランド もしくは .Em ファイル引数 として参照されます。 コマンド行の引数のリストはかなり長くなる場合もあります。 . .Bd -ragged .Bl -tag -width ".Nm make" -offset indent -compact .It Nm make .Op Fl eiknqrstv .Op Fl D Ar variable .Op Fl d Ar flags .Op Fl f Ar makefile .Op Fl I Ar directory .Op Fl j Ar max_jobs .Op Ar variable Ns = Ns Ar value .Bk .Op Ar target ... .Ek .El .Ed .Pp . ここではコマンド .Nm make について記述しており、 .Ar makefile をフラグ .Fl f の引数としています。 またオプションのファイルオペランドである .Ar target についても言及しています。 言葉での説明では、こういった詳細な記述が混乱を防いでくれますが、 .Nm \-mdoc パッケージにはフラグ .Em への 引数のためのマクロがありません。 その代わりに .Ar target のようなオペランドやファイル引数に使われる引数マクロ .Ql \&Ar が .Ar variable のようなフラグへの引数と同様に使われます。 この make コマンド行は次の指定により生成されています。 . .Bd -literal -offset indent \&.Nm make \&.Op Fl eiknqrstv \&.Op Fl D Ar variable \&.Op Fl d Ar flags \&.Op Fl f Ar makefile \&.Op Fl I Ar directory \&.Op Fl j Ar max_jobs \&.Op Ar variable Ns = Ns Ar value \&.Bk \&.Op Ar target ... \&.Ek .Ed .Pp . マクロ .Ql .Bk および .Ql .Ek は .Sx キープ セクションにおいて解説されています。 . .Ss "一般的な構文" . マニュアル領域のマクロと一般テキスト領域のマクロとはいくつか 小さな違いがあるものの、同様な構文を使用しています。とりわけ、 .Ql .Ar , .Ql .Fl , .Ql .Nm , および .Ql .Pa は引数なしで呼び出された時の違いしかありません。また、 .Ql .Fn および .Ql .Xr は引数のリストの順番が異なります。 すべてのコンテントマクロが句読点を認識し、それを正しく扱うには、 各々の句読点文字が先行する空白で分離されている必要があります。 次のようにコマンドが指定されている場合、 .Pp .Dl \&.Ar sptr, ptr), .Pp その結果は以下のようになります。 .Pp .Dl Ar sptr, ptr), .Pp ここでは句読点は認識されず、すべての出力は .Ql .Ar で使用されるフォントで行われています。 句読点が空白文字で区切られている場合、 .Pp .Dl \&.Ar "sptr , ptr ) ," .Pp 結果は以下のようになります。 .Pp .Dl Ar sptr , ptr ) , .Pp 今度は句読点が認識され、出力はデフォルトのフォントで行われ 引数文字列とは区別されています。 句読点文字の特別な意味を取り除くには、 .Ql \e& でエスケープしてください。 .Pp .Nm \-mdoc は次の句読点文字を認識します。 . .Bl -column -offset indent-two XXXXXX XXXXXX XXXXXX XXXXXX .It Li .\& Ta Li ,\& Ta Li :\& Ta Li ;\& Ta Li (\& .It Li )\& Ta Li [\& Ta Li ]\& Ta Li ?\& Ta Li !\& .El .Pp . .Xr troff はマクロ言語としての限界から、以下のような、数学、論理学、引用符の 集合のメンバを含んだ文字列を表現するのは困難です。 . .Bd -literal -offset indent-two {+,\-,/,*,%,<,>,<=,>=,=,==,&,`,',"} .Ed .Pp . 問題なのは、文字によって示唆されている操作もしくは評価が、 実行されるべきであると .Xr troff が仮定する場合があることです。 これらの文字が予期しない形で評価されないようにするには、 .Ql \e& でこれらをエスケープしてください。 最初のコンテントマクロは、以下の .Ql .Ad において、その典型的な構文が示されています。 . . .Sh "マニュアル領域" . .Ss "アドレス" . アドレスマクロはアドレスの構成を識別します。 .Pp .Dl 使い方: .Ad Ao アドレス Ac ... .Pp .Bl -tag -width ".Li .Ad\ f1\ ,\ f2\ ,\ f3\ :" -compact -offset 15n .It Li ".Ad addr1" .Ad addr1 .It Li ".Ad addr1 ." .Ad addr1 . .It Li ".Ad addr1 , file2" .Ad addr1 , file2 .It Li ".Ad f1 , f2 , f3 :" .Ad f1 , f2 , f3 : .It Li ".Ad addr ) ) ," .Ad addr ) ) , .El .Pp . デフォルトの文字幅は 12n です。 . .Ss "作者名" . .Ql .An コマンドは文書化されている項目の作者の名前、もしくは実際の マニュアルページの作者の名前を指定するために使われます。 .Pp .Dl 使い方: .An Ao 作者名 Ac ... .Pp .Bl -tag -width ".Li .An\ \*[q]Joe\ Author\*[q]\ )\ )\ ," -offset 15n .It Li ".An \*[q]Joe Author\*[q]" .An "Joe Author" .It Li ".An \*[q]Joe Author\*[q] ," .An "Joe Author" , .It Li ".An \*[q]Joe Author\*[q] Aq nobody@FreeBSD.org" .An "Joe Author" Aq nobody@FreeBSD.org .It Li ".An \*[q]Joe Author\*[q] ) ) ," .An "Joe Author" ) ) , .El .Pp . デフォルトの文字幅は 12n です。 .Pp .Sx AUTHORS セクションでは、 .Ql .An リクエストは改行を引き起こし、新しい名前がそれぞれの行に表示されます。 この動作が望ましくない場合、 . .Bd -literal -offset indent \&.An -nosplit .Ed .Pp . を呼び出すことで無効にできます。 それぞれの行に表示させる動作に戻したい場合は、 . .Bd -literal -offset indent \&.An -split .Ed .Pp . と記述します。 . .Ss "引数" . 引数マクロ .Li .Ar はコマンド行の引数を参照する際にはいつでも使用することができます。 引数なしで呼ばれた場合、 .Sq Ar が出力になります。 .Pp .Dl 使い方: .Ar Oo Ao 引数 Ac Oc ... .Pp .Bl -tag -width ".Li .Ar\ file1\ file2" -compact -offset 15n .It Li .Ar .Ar .It Li ".Ar file1" .Ar file1 .It Li ".Ar file1 ." .Ar file1 . .It Li ".Ar file1 file2" .Ar file1 file2 .It Li ".Ar f1 f2 f3 :" .Ar f1 f2 f3 : .It Li ".Ar file ) ) ," .Ar file ) ) , .El .Pp . デフォルト幅は 12n です。 . .Ss "コンフィギュレーション宣言 (セクション 4 のみ)" . .Ql .Cd コマンドはセクション 4 のマニュアルにおいて、デバイスインタフェースの .Xr config 8 による宣言の説明に使われます。 .Pp .Dl 使い方: .Cd Ao 引数 Ac ... .Pp .Bl -tag -width ".Li .Cd\ Xdevice\ le0\ at\ scode?X" -offset 15n .It Li ".Cd \*[q]device le0 at scode?\*[q]" .Cd "device le0 at scode?" .El .Pp .Sx SYNOPSIS セクションでは .Ql .Cd リクエストはその引数が表示される前後で改行を入れます。 .Pp . デフォルト幅は 12n です。 . .Ss "コマンド修飾子" . コマンド修飾子は .Ql .Cm マクロがすべての引数の前にダッシュ文字を付けないことを除いて、 .Ql .Fl (フラグ) コマンドと同じです。 伝統的にフラグはダッシュ文字に引き続いて指定されますが、 この方法を使わないコマンドやコマンドのサブセットもあります。 コマンド修飾子はエディタコマンドのような対話的なコマンドでも 指定されることがあります。 .Sx フラグ セクションを参照してください。 .Pp デフォルト幅は 10n です。 . .Ss "定義済みの変数" . インクルードファイルにおいて定義されている変数 (もしくは定数) は マクロ .Ql .Dv によって指定します。 .Pp .Dl 使い方: .Dv Ao 定義済みの変数 Ac ... .Pp .Bl -tag -width ".Li .Dv\ MAXHOSTNAMELEN" -compact -offset 15n .It Li ".Dv MAXHOSTNAMELEN" .Dv MAXHOSTNAMELEN .It Li ".Dv TIOCGPGRP )" .Dv TIOCGPGRP ) .El .Pp . デフォルト幅は 12n です。 . .Ss errno . .Ql .Er errno マクロは、セクション 2, 3, 9 のライブラリルーチンにおける エラーの戻り値を指定します。 下記の 2 番目の例では .Ql .Er は一般テキスト領域マクロである .Ql .Bq (これはセクション 2 のマニュアルページで使われています) と共に 使われています。 .Pp .Dl 使い方: .Er Ao errno のタイプ Ac ... .Pp .Bl -tag -width ".Li .Bq\ Er\ ENOTDIR" -compact -offset 15n .It Li ".Er ENOENT" .Er ENOENT .It Li ".Er ENOENT ) ;" .Er ENOENT ) ; .It Li ".Bq Er ENOTDIR" .Bq Er ENOTDIR .El .Pp . デフォルト幅は 17n です。 . .Ss "環境変数" . .Ql .Ev マクロは環境変数を指定します。 .Pp .Dl 使い方: .Ev Ao 引数 Ac ... .Pp .Bl -tag -width ".Li .Ev\ PRINTER\ )\ )\ ," -compact -offset 15n .It Li ".Ev DISPLAY" .Ev DISPLAY .It Li ".Ev PATH ." .Ev PATH . .It Li ".Ev PRINTER ) ) ," .Ev PRINTER ) ) , .El .Pp . デフォルト幅は 15n です。 . .Ss "フラグ" . .Ql .Fl マクロはコマンド行のフラグを扱います。 フラグの前にはダッシュ .Ql \- が挿入されます。 ダッシュがつかない対話的なコマンドのために .Ql .Cm (コマンド修飾子) マクロが用意されています。 これはダッシュを付けないことを除いて同じ働きをします。 .Pp .Dl 使い方: .Fl Ao 引数 Ac ... .Pp .Bl -tag -width ".Li .Fl\ xyz\ )\ ," -compact -offset 15n .It Li .Fl .Fl .It Li ".Fl cfv" .Fl cfv .It Li ".Fl cfv ." .Fl cfv . .It Li ".Cm cfv ." .Cm cfv . .It Li ".Fl s v t" .Fl s v t .It Li ".Fl \- ," .Fl \- , .It Li ".Fl xyz ) ," .Fl xyz ) , .It Li ".Fl |" .Fl | .El .Pp 引数なしで .Ql .Fl マクロを指定すると、標準入力/標準出力を意味するダッシュとなります。 .Ql .Fl マクロにダッシュを 1 つ与えると、2 つのダッシュとなることに 注意して下さい。 .Pp デフォルト幅は 12n です。 . .Ss "関数の宣言" . .Ql .Fd コマンドは .Sx SYNOPSIS セクションにおいて、セクション 2 または 3 の関数の説明で使われます。 このマクロは呼び出し不可能であり、構文解析もされせん。 .Pp .Dl 使い方: .Fd Ao 引数 Ac ... .Pp .Bl -tag -width ".Li .Fd\ X#include\ X" -compact -offset 15n .It Li ".Fd \*[q]#include \*[q]" .Fd "#include " .El .Pp .Sx SYNOPSIS セクションでは、 関数がすでに示されており、改行がまだされていない場合には .Ql .Fd リクエストは改行を入れます。 これによって前の関数呼び出しと次の関数の宣言の間に 最適な行間が設定されます。 . .Pp .Ql .In マクロは、 .Sx SYNOPSIS セクションで使用すると、 .Li #include 文を表現するものであり、以上の例を短く記述したものです。 このマクロは C プログラム中でインクルードされる C ヘッダファイルを指定します。 このマクロも改行を挿入します。 .Pp .Sx SYNOPSIS セクション以外で使用すると、 山括弧で括られたヘッダファイルを表現します。 .Pp .Dl 使い方: .In Ao ヘッダファイル Ac .Pp .Bl -tag -width ".Li .In\ stdio.h" -compact -offset 15n .nr in-synopsis-section 1 .It Li ".In stdio.h" .In stdio.h .nr in-synopsis-section 0 .It Li ".In stdio.h" .In stdio.h .El . .Ss "関数の型" . このマクロは .Sx SYNOPSIS セクションで使うものです。 マニュアルページ中の他の場所でも問題なく使うことができますが、 セクション 2 と 3 の .Sx SYNOPSIS セクションにおいてカーネルの通常の形式で関数の型を示すことが このマクロの目的です (このマクロは関数名が次の行に置かれるように改行を挿入します)。 .Pp .Dl 使い方: .Ft Ao 型 Ac ... .Pp .Bl -tag -width ".Li .Ft\ struct\ stat" -compact -offset 15n .It Li ".Ft struct stat" .Ft struct stat .El . .Ss "関数 (ライブラリルーチン)" . .Ql .Fn マクロは .Tn ANSI\~C の記法を規範としています。 .Pp .Dl 使い方: .Fn Ao 関数 Ac Oo Ao パラメータ Ac Oc ... .Pp .Bl -tag -width ".Li .Fn\ align\ Xchar\ *ptrX\ ," -compact -offset 15n .It Li ".Fn getchar" .Fn getchar .It Li ".Fn strlen ) ," .Fn strlen ) , .It Li ".Fn align \*[q]char *ptr\*[q] ," .Fn align "char *ptr" , .El .Pp 他のマクロを呼び出すと .Ql .Fn 呼び出しの終了を意味することに注意してください (閉じ括弧がその箇所に挿入されます)。 .Pp 多くのパラメータをとる関数 (これは滅多にないことですが) では、 .Ql .Fo マクロ (関数マクロの開始) と .Ql .Fc マクロ (関数マクロの終了) を .Ql .Fa (関数の引数) と共に使って、この制限を回避することができます。 .Pp 使用例: . .Bd -literal -offset indent \&.Ft int \&.Fo res_mkquery \&.Fa "int op" \&.Fa "char *dname" \&.Fa "int class" \&.Fa "int type" \&.Fa "char *data" \&.Fa "int datalen" \&.Fa "struct rrec *newrr" \&.Fa "char *buf" \&.Fa "int buflen" \&.Fc .Ed .Pp . 生成結果: . .Bd -ragged -offset indent .Ft int .Fo res_mkquery .Fa "int op" .Fa "char *dname" .Fa "int class" .Fa "int type" .Fa "char *data" .Fa "int datalen" .Fa "struct rrec *newrr" .Fa "char *buf" .Fa "int buflen" .Fc .Ed .Pp . .Sx SYNOPSIS セクションでは、関数は常に行の先頭から開始されます。 .Sx SYNOPSIS セクションにおいて複数の関数が示されており、関数の型が 示されない場合、改行が挿入され、現在の関数名とその前の 関数名の間に最適な改行量が設定されます。 .Pp .Ql .Fn および .Ql .Fo のデフォルト幅の値はそれぞれ 12n と 16n です。 . .Ss "関数の引数" . .Ql .Fa マクロは関数の引数 (パラメータ) を マニュアルの .Sx SYNOPSIS のセクション外で参照する場合、あるいは .Ql .Fn の代わりに .Ql .Fo および .Ql .Fc 囲いマクロを使用した場合には .Sx SYNOPSIS のセクション内で参照する場合にも使われます。 .Ql .Fa は構造体のメンバを参照する場合にも使われます。 .Pp .Dl 使い方: .Fa Ao 関数の引数 Ac ... .Pp .Bl -tag -width ".Li .Fa\ d_namlen\ )\ )\ ," -compact -offset 15n .It Li ".Fa d_namlen ) ) ," .Fa d_namlen ) ) , .It Li ".Fa iov_len" .Fa iov_len .El .Pp . デフォルト幅は 12n です。 . .Ss "戻り値" . .Ql .Rv マクロは .Sx RETURN VALUES のセクションで使うテキストを生成します。 .Pp .Dl 使い方: .Rv Oo -std Oc Op Ao 関数 Ac ... .Pp 例えば、 .Ql ".Rv -std atexit" は次のテキストを生成します。 . .Bd -ragged -offset -indent \# a small hack to suppress a warning message .ds section-old "\*[section] .ds section 3 .\" following part came from doc.tmac workaround the effect of .\" -dlang=ja_JP.eucJP .ds str-Rv-std-prefix "The .ds str-Rv-std-suffix "function returns the value\~0 if successful; .as str-Rv-std-suffix " otherwise the value\~-1 is returned and .as str-Rv-std-suffix " the global variable \*[Va-font]errno\f[P] .as str-Rv-std-suffix " is set to indicate the error. .ds str-Rv-stds-prefix "The .ds str-Rv-stds-and "and .ds str-Rv-stds-suffix "functions return the value\~0 if successful; .as str-Rv-stds-suffix " otherwise the value\~-1 is returned and .as str-Rv-stds-suffix " the global variable \*[Va-font]errno\f[P] .as str-Rv-stds-suffix " is set to indicate the error. .ds str-Rv-std0 "Upon successful completion, the value\~0 is returned; .as str-Rv-std0 " otherwise the value\~-1 is returned and .as str-Rv-std0 " the global variable \*[Va-font]errno\f[P] .as str-Rv-std0 " is set to indicate the error. .Rv -std atexit .ds section "\*[section-old] .Ed .Pp . .Fl std オプションはセクション 2 と 3 のマニュアルページでのみ有効です。 現在のところ、このマクロは .Fl std フラグなしで使用しても何も起こりません。 . .Ss "終了ステータス" . .Ql .Ex マクロは .Sx DIAGNOSTICS のセクションで使うテキストを生成します。 .Pp .Dl 使い方: .Ex Oo -std Oc Op Ao ユーティリティ Ac ... .Pp 例えば .Ql ".Ex -std cat" は次のテキストを生成します。 . .Bd -ragged -offset -indent \# a small hack to suppress a warning message .ds section-old "\*[section] .ds section 1 .\" following part came from doc.tmac workaround the effect of .\" -dlang=ja_JP.eucJP .ds str-Ex-std-prefix "The .ds str-Ex-std-suffix "utility exits\~0 on success, .as str-Ex-std-suffix " and\~>0 if an error occurs. .ds str-Ex-stds-prefix "The .als str-Ex-stds-and str-Rv-stds-and .ds str-Ex-stds-suffix "utilities exit\~0 on success, .as str-Ex-stds-suffix " and\~>0 if an error occurs. .Ex -std cat .ds section "\*[section-old] .Ed .Pp . .Fl std オプションはセクション 1 と 6 と 8 のマニュアルページでのみ有効です。 現在のところ、このマクロは .Fl std フラグなしで使用しても何も起こりません。 . .Ss "対話的なコマンド" . .Ql .Ic マクロは対話的なコマンド、もしくは内部コマンドを指定します。 .Pp .Dl 使い方: .Ic Ao 引数 Ac ... .Pp .Bl -tag -width ".Li .Ic\ setenv\ ,\ unsetenv" -compact -offset 15n .It Li ".Ic :wq" .Ic :wq .It Li ".Ic \*[q]do while {...}\*[q]" .Ic "do while {...}" .It Li ".Ic setenv , unsetenv" .Ic setenv , unsetenv .El .Pp . デフォルト幅は 12n です。 . .Ss "ライブラリ名" . .Ql .Lb マクロは、関数がどのライブラリに組み込まれるかを指定します。 .Pp .Dl 使い方: .Lb Ao 引数 Ac ... .Pp .Ql .Lb マクロに対して使用可能な引数と結果は次の通りです: . .Pp .Bl -tag -width ".Li libossaudio" -compact -offset indent .It Li libarm32 .Lb libarm32 .It Li libc .Lb libc .It Li libcompat .Lb libcompat .It Li libcrypt .Lb libcrypt .It Li libcurses .Lb libcurses .It Li libedit .Lb libedit .It Li libi386 .Lb libi386 .It Li libipsec .Lb libipsec .It Li libkvm .Lb libkvm .It Li libm .Lb libm .It Li libmenu .Lb libmenu .It Li libossaudio .Lb libossaudio .It Li libposix .Lb libposix .It Li libresolv .Lb libresolv .It Li libtermcap .Lb libtermcap .It Li libutil .Lb libutil .It Li libz .Lb libz .El .Pp . ローカルな追加項目や OS 特有の追加項目が、ファイル .Pa mdoc.local にあるかもしれません。 .Ql str-Lb-XXX という名前の文字列を検索してください。ここで .Ql XXX は .Ql .Lb マクロとともに使用されるキーワードを示しています。 .Pp .Sx ライブラリ のセクションでは、 .Ql .Lb コマンドは、引数の表示の前後でラインブレイクを引き起こします。 .Pp . .Ss リテラル . リテラルマクロ .Ql .Li は特殊文字や変数定数、その他タイプされた通りに表示する必要があるものに 使用することができます。 .Pp .Dl 使い方: .Li Ao 引数 Ac ... .Pp .Bl -tag -width ".Li .Li\ cntrl-D\ )\ ," -compact -offset 15n .It Li ".Li \een" .Li \en .It Li ".Li M1 M2 M3 ;" .Li M1 M2 M3 ; .It Li ".Li cntrl-D ) ," .Li cntrl-D ) , .It Li ".Li 1024 ..." .Li 1024 ... .El .Pp . デフォルト幅は 16n です。 . .Ss 名称 . .Ql .Nm マクロは文書のタイトルやサブジェクト名を指定するために使われます。 このマクロは呼び出された時の第 1 引数を覚えておくという 変わった特性を持っており、 それは常にそのページのサブジェクト名であるべきです。 引数なしで呼び出されると .Ql .Nm は作者のために最低限の仕事をするという意味で、 この初期化された名称を出力します。 注: セクション 2 または 3 のドキュメントの関数名は .Sx NAME セクションにおいて .Ql .Nm で指定され、 .Sx SYNOPSIS セクションや残りのセクションでは .Ql .Fn で指定されます。 .Xr csh 1 での .Ql while コマンドのキーワードのような対話的なコマンドでは .Ql .Ic マクロを使う必要があります。 .Ql .Ic はほとんど .Ql .Nm と同一ですが、 それが使われたときの第 1 引数を記憶することはできません。 .Pp .Dl 使い方: .Nm Oo Ao 引数 Ac Oc ... .Pp .Bl -tag -width ".Li .Nm\ groff_mdoc" -compact -offset 15n .It Li ".Nm groff_mdoc" .Nm groff_mdoc .It Li ".Nm \e-mdoc" .Nm \-mdoc .It Li ".Nm foo ) ) ," .Nm foo ) ) , .It Li ".Nm :" .Nm : .El .Pp . デフォルト幅は 10n です。 . .Ss オプション . .Ql .Op マクロはコマンド行の残りのすべての引数を オプションであることを示す角括弧で囲み、 末尾の句読点は角括弧の外に置きます。 .Ql .Oo マクロと .Ql .Oc マクロ (それぞれ開き角括弧と閉じ角括弧を生成します) は 複数行に渡って使うことができ、また閉じ括弧の正確な位置を 指定するのに使うことができます。 .Pp .Dl 使い方: .Op Oo Ao オプション Ac Oc ... .Pp .Bl -tag -width ".Li .Op\ Fl\ c\ Ar\ objfil\ Op\ Ar\ corfil\ ," -compact -offset 15n .It Li .Op .Op .It Li ".Op Fl k" .Op Fl k .It Li ".Op Fl k ) ." .Op Fl k ) . .It Li ".Op Fl k Ar kookfile" .Op Fl k Ar kookfile .It Li ".Op Fl k Ar kookfile ," .Op Fl k Ar kookfile , .It Li ".Op Ar objfil Op Ar corfil" .Op Ar objfil Op Ar corfil .It Li ".Op Fl c Ar objfil Op Ar corfil ," .Op Fl c Ar objfil Op Ar corfil , .It Li ".Op word1 word2" .Op word1 word2 .It Li ".Li .Op Oo Ao option Ac Oc ..." .Li .Op Oo Ao options Ac Oc ... .El .Pp これは、 .Ql .Oo マクロと .Ql .Oc マクロを使った典型的な例です: . .Bd -literal -offset indent \&.Oo \&.Op Fl k Ar kilobytes \&.Op Fl i Ar interval \&.Op Fl c Ar count \&.Oc .Ed .Pp . 出力結果: . .Bd -filled -offset indent .Oo .Op Fl k Ar kilobytes .Op Fl i Ar interval .Op Fl c Ar count .Oc .Ed .Pp . .Ql .Op マクロおよび .Ql .Oo マクロのデフォルト幅はそれぞれ 14n と 10n です。 . .Ss パス名 . .Ql .Pa マクロはパス名もしくはファイル名を整形します。 引数なしで呼ばれた場合、 .Sq Pa 文字列が出力となり、これは現在のユーザのホームディレクトリを 表しています。 .Pp .Dl 使い方: .Pa Oo Ao パス名 Ac Oc ... .Pp .Bl -tag -width ".Li .Pa\ /tmp/fooXXXXX\ )\ ." -compact -offset 15n .It Li .Pa .Pa .It Li ".Pa /usr/share" .Pa /usr/share .It Li ".Pa /tmp/fooXXXXX ) ." .Pa /tmp/fooXXXXX ) . .El .Pp . デフォルト幅は 32n です。 . .Ss 規格 . .Ql .St マクロは、規格の短縮名称を正式名称に置換します。 .Pp .Dl 使い方: .St Ao 短縮名称 Ac ... .Pp 使用可能な .Dq 短縮名称/正式名称 の組は次の通りです: . .Pp .Tn ANSI/ISO C .Pp .Bl -tag -width ".Li -iso9945-1-90" -compact -offset indent .It Li -ansiC .St -ansiC .It Li -ansiC-89 .St -ansiC-89 .It Li -isoC .St -isoC .It Li -isoC-99 .St -isoC-99 .El .Pp . .Tn POSIX パート 1: System API .Pp .Bl -tag -width ".Li -p1003.1g-2000" -compact -offset indent .It Li -iso9945-1-90 .St -iso9945-1-90 .It Li -iso9945-1-96 .St -iso9945-1-96 .It Li -p1003.1 .St -p1003.1 .It Li -p1003.1-88 .St -p1003.1-88 .It Li -p1003.1-90 .St -p1003.1-90 .It Li -p1003.1-96 .St -p1003.1-96 .It Li -p1003.1b-93 .St -p1003.1b-93 .It Li -p1003.1c-95 .St -p1003.1c-95 .It Li -p1003.1g-2000 .St -p1003.1g-2000 .It Li -p1003.1i-95 .St -p1003.1i-95 .El .Pp . .Tn POSIX パート 2: シェルとユーティリティ .Pp .Bl -tag -width ".Li -p1003.1g-2000" -compact -offset indent .It Li -iso9945-2-93 .St -iso9945-2-93 .It Li -p1003.2 .St -p1003.2 .It Li -p1003.2-92 .St -p1003.2-92 .It Li -p1003.2a-92 .St -p1003.2a-92 .El .Pp . X/Open .Bl -tag -width ".Li -p1003.1g-2000" -compact -offset indent .Pp .It Li -susv2 .St -susv2 .It Li -svid4 .St -svid4 .It Li -xbd5 .St -xbd5 .It Li -xcu5 .St -xcu5 .It Li -xcurses4.2 .St -xcurses4.2 .It Li -xns5 .St -xns5 .It Li -xns5.2 .St -xns5.2 .It Li -xpg3 .St -xpg3 .It Li -xpg4 .St -xpg4 .It Li -xpg4.2 .St -xpg4.2 .It Li -xsh5 .St -xsh5 .El .Pp . その他 .Pp .Bl -tag -width ".Li -p1003.1g-2000" -compact -offset indent .It Li -ieee754 .St -ieee754 .It Li -iso8802-3 .St -iso8802-3 .El . .Ss "変数の型" . .Ql .Vt マクロは型を参照するときにはいつでも使用することができます。 .Sx SYNOPSIS セクションでは改行が挿入されます (古いスタイルの変数宣言では便利です)。 .Pp .Dl 使い方: .Vt Ao 型 Ac ... .Pp .Bl -tag -width ".Li .Vt\ extern\ char\ *optarg\ ;" -compact -offset 15n .It Li ".Vt extern char *optarg ;" .Vt extern char *optarg ; .It Li ".Vt FILE *" .Vt FILE * .El . .Ss 変数 . 一般的な変数への参照です。 .Pp .Dl 使い方: .Va Ao 変数 Ac ... .Pp .Bl -tag -width ".Li .Va\ Xchar\ sX\ ]\ )\ )\ ," -compact -offset 15n .It Li ".Va count" .Va count .It Li ".Va settimer ," .Va settimer , .It Li ".Va \*[q]int *prt\*[q] ) :" .Va "int *prt" ) : .It Li ".Va \*[q]char s\*[q] ] ) ) ," .Va "char s" ] ) ) , .El .Pp . デフォルト幅は 12n です。 . .Ss "マニュアルページのクロスリファレンス" . .Ql .Xr マクロは最初の引数にマニュアルページの名称をとります。 オプションである第 2 引数は、文字列 (マニュアルセクションを定義します) であれば 括弧で囲われます。 .Pp .Dl 使い方: .Xr Ao マニュアルページの名称 Ac Oo Ao セクション Ac Oc ... .Pp .Bl -tag -width ".Li .Xr\ xinit\ 1x\ ;" -compact -offset 15n .It Li ".Xr mdoc" .Xr mdoc .It Li ".Xr mdoc ," .Xr mdoc , .It Li ".Xr mdoc 7" .Xr mdoc 7 .It Li ".Xr xinit 1x ;" .Xr xinit 1x ; .El .Pp . デフォルト幅は 10n です。 . . .Sh "一般テキスト領域" . .Ss "AT&T マクロ" . .Pp .Dl 使い方: .At Oo Ao バージョン Ac Oc ... .Pp .Bl -tag -width ".Li .At\ v6\ ." -compact -offset 15n .It Li .At .At .It Li ".At v6 ." .At v6 . .El .Pp .Ao バージョン Ac には次の値をとることができます: .Pp .Dl 32v, v1, v2, v3, v4, v5, v6, v7, V, V.1, V.2, V.3, V.4 . .Ss "BSD マクロ" . .Pp .Dl "使い方: .Bx" Bro -alpha | -beta | -devel Brc ... .Dl " .Bx" Oo Ao バージョン Ac Oo Ao リリース Ac Oc Oc ... .Pp .Bl -tag -width ".Li .Bx\ -devel" -compact -offset 15n .It Li .Bx .Bx .It Li ".Bx 4.3 ." .Bx 4.3 . .It Li ".Bx \-devel" .Bx -devel .El .Pp .Ao バージョン Ac が文字列 .Sq Bx の前につきます。 .Ao リリース Ac には次の値をとることができます: .Pp .Dl Reno, reno, Tahoe, tahoe, Lite, lite, Lite2, lite2 . .Ss "NetBSD マクロ" . .Pp .Dl 使い方: .Nx Oo Ao バージョン Ac Oc ... .Pp .Bl -tag -width ".Li .Nx\ 1.4\ ." -compact -offset 15n .It Li .Nx .Nx .It Li ".Nx 1.4 ." .Nx 1.4 . .El .Pp .Ao バージョン Ac にとり得る値については前述の .Sx "タイトルマクロ" セクションの .Ql .Os コマンドの説明を参照してください。 . .Ss "FreeBSD マクロ" . .Pp .Dl 使い方: .Fx Oo Ao バージョン Ac Oc ... .Pp .Bl -tag -width ".Li .Fx\ 2.2\ ." -compact -offset 15n .It Li .Fx .Fx .It Li ".Fx 2.2 ." .Fx 2.2 . .El .Pp .Ao バージョン Ac にとり得る値については前述の .Sx "タイトルマクロ" セクションの .Ql .Os コマンドの説明を参照してください。 . .Ss "OpenBSD マクロ" . .Pp .Dl 使い方: .Ox Oo Ao バージョン Ac Oc ... .Pp .Bl -tag -width ".Li .Ox\ 1.0" -compact -offset 15n .It Li ".Ox 1.0" .Ox 1.0 .El . .Ss "BSD/OS マクロ" . .Pp .Dl 使い方: .Bsx Oo Ao バージョン Ac Oc ... .Pp .Bl -tag -width ".Li .Bsx\ 1.0" -compact -offset 15n .It Li ".Bsx 1.0" .Bsx 1.0 .El . .Ss "UNIX マクロ" . .Pp .Dl 使い方: .Ux ... .Pp .Bl -tag -width ".Li .Ux" -compact -offset 15n .It Li .Ux .Ux .El . .Ss "強調マクロ" . テキストは .Ql .Em マクロを用いて強調することができます。 通常強調に用いられるフォントはイタリック体です。 .Pp .Dl 使い方: .Em Ao 引数 Ac ... .Pp .Bl -tag -width ".Li .Em\ vide\ infra\ )\ )\ ," -compact -offset 15n .It Li ".Em does not" .Em does not .It Li ".Em exceed 1024 ." .Em exceed 1024 . .It Li ".Em vide infra ) ) ," .Em vide infra ) ) , .El .Pp . デフォルト幅は 10n です。 . .Ss "フォントモード" . .Ql .Bf フォントモードは .Ql .Ef マクロで終了しなくてはなりません (後者のマクロは引数をとりません)。 フォントモードは別のフォントモード内に入れ子にできます。 .Pp .Ql .Bf は次の文法をもっています: .Pp .Dl .Bf Ao フォントモード Ac .Pp .Ao フォントモード Ac は次の 3 種類のうちのいずれかでなくてはなりません。 .Pp .Bl -tag -width ".Sy \&Sy | Fl symbolic" -compact -offset indent .It Sy \&Em | Fl emphasis .Ql .Em マクロがテキストのブロック全体に対して使用された場合と 同じになります。 .It Sy \&Li | Fl literal .Ql .Li マクロがテキストのブロック全体に対して使用された場合と 同じになります。 .It Sy \&Sy | Fl symbolic .Ql .Sy マクロがテキストのブロック全体に対して使用された場合と 同じになります。 .El .Pp いずれのマクロも呼び出し不可能であり、構文解析もされません。 . .Ss "囲い/クォートマクロ" . 囲いの概念はクォートと似たものです。 1 つ以上の文字列が引用符や括弧のような文字のペアで囲まれている オブジェクトを指します。 クォートと囲いという用語はこの文書を通して同じ意味で使われます。 ほとんどの 1 行の囲いマクロはクォートであることをほのめかすために、 小文字の .Ql q で終了しますが、例外もいくつかあります。 各々の囲いマクロに対し、開始マクロと終了マクロのペアもあり、 それぞれ小文字の .Ql o と .Ql c で終了します。 .Pp \# XXX .if t \ . ne 10 . .Bd -filled -offset 4n .Bl -column "クォート" "終了" "開始" "クォートされたリテラル" "`string' もしくは string" .Em クォート Ta Em 開始 Ta Em 終了 Ta Em 機能 Ta Em 結果 .No .Aq Ta .Ao Ta .Ac Ta "山括弧による囲い" Ta Ao string Ac .No .Bq Ta .Bo Ta .Bc Ta "角括弧による囲い" Ta Bo string Bc .No .Brq Ta .Bro Ta .Brc Ta "中括弧による囲い" Ta Bro string Brc .No .Dq Ta .Do Ta .Dc Ta "2 重引用符" Ta Do string Dc .No .Eq Ta .Eo Ta .Ec Ta "囲い文字列 (XX による)" Ta XXstringXX .No .Pq Ta .Po Ta .Pc Ta "括弧による囲い" Ta Po string Pc .No .Ql Ta Ta Ta "クォートされたリテラル" Ta So string Sc もしくは Li string .No .Qq Ta .Qo Ta .Qc Ta "まっすぐな 2 重引用符" Ta Qo string Qc .No .Sq Ta .So Ta .Sc Ta "1 重引用符" Ta So string Sc .El .Ed .Pp .Sq q および .Sq o で終わるマクロはすべてデフォルト幅が 12n です。 . .Bl -tag -width ".Li .Ec , .Eo" .It Li .Eo , .Ec これらのマクロはそれぞれ第 1 引数に囲い始めに使う文字列と 囲い終わりに使う文字列をとります。 .It Li .Es , .En オリジナルの troff プログラムでは、引数の数が 9 つまでという 制限がありましたので、(Eo, Ec とは) 別の 2 つのマクロが 実装されています。現在は非推奨になっています。 .Ql .Es は第 1 引数と第 2 引数に左囲い文字列および右囲い文字列を とります。この文字列は、 .Ql .En の引数を囲うのに使用されます。 デフォルト幅は、どちらのマクロも 12n です。 .It Li .Eq このマクロの第 1、第 2 引数はそれぞれ囲い始めに使う文字列と 囲い終わりに使う文字列であり、この文字列の後に 囲われる引数が続きます。 .It Li .Ql クォートされたリテラルマクロは troff モードと nroff モードで 違った挙動をします。 .Xr nroff で整形された場合、 クォートされたリテラルは常にクォートされます。 troff で整形された場合、その要素の幅が固定幅文字 3 文字分の幅よりも 小さいときのみクォートされます。 これにより、リテラル (固定幅) フォントへフォントを変更すると 目立たなくなってしまうような短い文字列がより見やすくなります。 .Pp デフォルト幅は 16n です。 .It Li .Pf プレフィックスマクロは第 1 引数と第 2 引数の間の ホワイトスペースをなくします: . .Bl -tag -width ".Li .Pf\ (\ Fa\ name2" -offset indent .It Li ".Pf ( Fa name2" .Pf ( Fa name2 .El .Pp . デフォルト幅は 12n です。 .Pp .Ql .Ns マクロ (後述参照) は同じようにサフィックスに働きます。 .It Li .Ap .Ql .Ap マクロはアポストロフィを追加し、特別なテキストモードから 抜けます。そして .Ql .No モードで続けます。 .El .Pp . クォートの例: . .Pp .Bl -tag -width ".Li .Bq\ Em\ Greek\ ,\ French\ ." -compact -offset indent .It Li .Aq .Aq .It Li ".Aq Pa ctype.h ) ," .Aq Pa ctype.h ) , .It Li .Bq .Bq .It Li ".Bq Em Greek , French ." .Bq Em Greek , French . .It Li .Dq .Dq .It Li ".Dq string abc ." .Dq string abc . .It Li ".Dq \'^[A-Z]\'" .Dq \'^[A-Z]\' .It Li ".Ql man mdoc" .Ql man mdoc .It Li .Qq .Qq .It Li ".Qq string ) ," .Qq string ) , .It Li ".Qq string Ns )," .Qq string Ns ), .It Li .Sq .Sq .It Li ".Sq string" .Sq string .It Li ".Em or Ap ing" .Em or Ap ing .El .Pp . 囲いマクロの入れ子についての良い例については、 オプションマクロ .Ql .Op を参照してください。 このマクロは上でリストされているような囲いマクロと同じベースの上に 作られています。 .Ql .Xo と .Ql .Xc 拡張引数リストマクロについては後で述べます。 . .Ss "無操作もしくは通常テキストマクロ" . .Ql .No マクロは、マクロコマンド行において整形されては .Em ならない パラメータ用に使用できます。 この英単語 (マクロでなく) をパラメータとして 本当に使いたい場合は、この単語 .Ql \&No に .Ql \e& を足すように注意してください。 .Pp .Dl 使い方: .No Ao 引数 Ac ... .Pp .Bl -tag -width ".Li .No\ test\ Ta\ with\ Ta\ tabs" -compact -offset 15n .It Li ".No test Ta with Ta tabs" .No test Ta with Ta tabs .El .Pp . デフォルト幅は 12n です。 . .Ss "空白なしマクロ" . .Ql .Ns マクロは、現在の位置とマクロの第 1 パラメータとの間に 空白を挿入するのを抑止します。 例えば、フラグと引数の間に空白を含まない古いスタイルの 引数リストを使う場合に便利です: .Pp .Dl "使い方:" ... Ao 引数 Ac \&Ns Oo Ao 引数 Ac Oc ... .Dl " " .Ns Ao 引数 Ac ... .\" 訳注: 2 行目 Dl マクロの第 1 引数の空白の数は 1 行目と一致させる .Pp .Bl -tag -width ".Li .Op\ Fl\ I\ Ns\ Ar\ directory" -compact -offset 15n .It Li ".Op Fl I Ns Ar directory" .Op Fl I Ns Ar directory .El .Pp 注: .Ql .Ns マクロは他のマクロ名が続かなければ、スペースを除去したあとに .Ql .No マクロを常に起動します。 コマンドとして使用される場合 (つまり、 .Sq 使い方 の行での 2 番目の形式です)、 .Ql .Ns マクロは .Ql .No と同一です。 . .Ss "セクションのクロスリファレンス" . .Ql .Sx マクロは同一文書内でのセクションのヘッダへの参照を指定します。 .Pp .Dl 使い方: .Sx Ao セクションの参照 Ac ... .Pp .Bl -tag -width ".Li .Sx\ FILES" -offset 15n .It Li ".Sx FILES" .Sx FILES .El .Pp . デフォルト幅は 16n です。 . .Ss 記号 . 記号体強調マクロは、記号の意味でも伝統的な英語の 使い方においても通常はボールド体マクロとなっています。 .Pp .Dl 使い方: .Sy Ao 記号 Ac ... .Pp .Bl -tag -width ".Li .Sy\ Important\ Notice" -compact -offset 15n .It Li ".Sy Important Notice" .Sy Important Notice .El .Pp . デフォルト幅は 6n です。 . .Ss 数学記号 . 数学記号やそれに似たものについては、このマクロを使用して ください。 .Pp .Dl 使い方: .Ms Ao 数学記号 Ac ... .Pp .Bl -tag -width ".Li .Ms\ sigma" -compact -offset 15n .It Li ".Ms sigma" .Ms sigma .El .Pp . デフォルト幅は 6n です。 . .Ss "参考文献と引用" . 次のマクロは多少なりとも参考文献を扱えるようにと意図したものです。 これらのマクロは、せいぜい .Xr refer 1 スタイルの参考文献のサブセットを手動で 作成しやすくする程度です。 .Pp .Bl -tag -width 6n -offset indent -compact .It Li .Rs 参考文献の開始 (引数はとりません)。 .Sx "SEE ALSO" セクションでは改行を挿入し、参考文献の終了マクロが 読み込まれるまで参考文献の情報を収集します。 .It Li .Re 参考文献の終了 (引数はとりません)。 参考文献が表示されます。 .It Li .%A 参考文献の作者名。1 回の呼び出しにつき、作者名をひとつ指定します。 .It Li .%B 書籍のタイトル。 .It Li .%C 市 / 場所 (まだ実装されていません)。 .It Li .%D 日付。 .It Li .%I 発行者/出版社名。 .It Li .%J 定期刊行物の名称。 .It Li .%N 発行番号。 .It Li .%O 追加情報。 .It Li .%P ページ番号。 .It Li .%Q 組織内部、あるいは外部の著者。 .It Li .%R 報告書の名称。 .It Li .%T 記事のタイトル。 .It Li .%V 巻数。 .El .Pp .Ql % で始まるマクロは呼び出し不可能ですが、 通常の方法で複数の引数をとることができます。 パラメータとしては .Ql .Tn マクロのみ扱います。その他のマクロを使うと 奇妙な出力が得られてしまいます。 .Ql .%B および .Ql .%T を .Ql .Rs/.Re 環境の外側では使用することができます。 .Pp 使用例: . .Bd -literal -offset indent \&.Rs \&.%A "Matthew Bar" \&.%A "John Foo" \&.%T "Implementation Notes on foobar(1)" \&.%R "Technical Report ABC-DE-12-345" \&.%Q "Drofnats College, Nowhere" \&.%D "April 1991" \&.Re .Ed .Pp 出力結果 . .Bd -ragged -offset indent .Rs .%A "Matthew Bar" .%A "John Foo" .%T "Implementation Notes on foobar(1)" .%R "Technical Report ABC-DE-12-345" .%Q "Drofnats College, Nowhere" .%D "April 1991" .Re .Ed . .Ss "商標名 (頭字語とタイプ名)" . 商標名マクロは、引数をより小さなフォントで出力します。 意図される使い方は、大文字の頭字語用に小さな大文字フォントを 似せて作ることです。 .Pp .Dl 使い方: .Tn Ao シンボル Ac ... .Pp .Bl -tag -width ".Li .Tn\ ASCII" -compact -offset 15n .It Li ".Tn DEC" .Tn DEC .It Li ".Tn ASCII" .Tn ASCII .El .Pp . デフォルト幅は 10n です。 . .Ss "拡張引数" . .Li .Xo と .Li .Xc マクロによって、 .Ql .It マクロ (後述) についてマクロ境界での引数リストを 拡張することができます。 .Li .Xo と .Li .Xc マクロは囲いを開いたり閉じたりする他のすべてのマクロに 対して同じように実装されている (もちろん文字は挿入しません) ということに注意してください。 つまり、次の例もこれらのマクロには当てはまります。 .Pp 次は、スペーシングをオフにするために 空白モードマクロを使った .Ql .Xo の使用例です。 . .Bd -literal -offset indent \&.Sm off \&.It Xo Sy I Ar operation \&.No \een Ar count No \een \&.Xc \&.Sm on .Ed .Pp . これは以下のような結果になります。 .Bd -filled -offset indent .Bl -tag -compact .Sm off .It Xo Sy I Ar operation .No \en Ar count No \en .Xc .Sm on .El .Ed .Pp . 例をもうひとつ: . .Bd -literal -offset indent \&.Sm off \&.It Cm S No / Ar old_pattern Xo \&.No / Ar new_pattern \&.No / Op Cm g \&.Xc \&.Sm on .Ed .Pp . これは以下のような結果になります。 . .Bd -filled -offset indent .Bl -tag -compact .Sm off .It Cm S No \&/ Ar old_pattern Xo .No \&/ Ar new_pattern .No \&/ Op Cm g .Xc .Sm on .El .Ed .Pp . 囲いマクロを使った .Ql .Xo の他の例: 変数の値をテストして下さい。 . .Bd -literal -offset indent \&.It Xo \&.Ic .ifndef \&.Oo \e&! Oc Ns Ar variable Oo \&.Ar operator variable ... \&.Oc Xc .Ed .Pp . 結果は以下の通りです。 . .Bd -filled -offset indent .Bl -tag -width flag -compact .It Xo .Ic .ifndef .Oo \&! Oc Ns Ar variable Oo .Ar operator variable ... .Oc Xc .El .Ed .Pp . . .Sh "ページ構造領域" . .Ss "セクションヘッダ" . 次の .Ql .Sh セクションヘッダマクロは、すべてのマニュアルページで必須のものです。 残りのセクションヘッダはマニュアルページの作者の裁量において、 推奨されているものです。 .Ql .Sh マクロは構文解析されますが、一般的には呼び出し不可能です。 .Ql .Sh を呼び出すときだけは、このマクロは引数として使用することができます。 この場合、 .Ql .Sh 用のデフォルトフォントを再度有効にします。 .Pp デフォルト幅は 8n です。 . .Bl -tag -width ".Li .Sh\ RETURN\ VALUES" .It Li ".Sh NAME" .Ql ".Sh NAME" マクロは必須です。 これが指定されていないと、ヘッダとフッタ、それにデフォルトの ページレイアウトが設定されず、結果はかなり好ましくないものに なるでしょう。 .Sx NAME セクションは最低 3 つの項目からなります。 最初のものは名称マクロ .Ql .Nm であり、マニュアルページのサブジェクトとなります。 2 番目のものは名称説明マクロ .Ql .Nd であり、サブジェクト名を 3 つめの項目、 すなわちその名称の説明と分離します。 説明に割り当てられるスペースは小さいものですので、 できるだけ簡潔で分かりやすいものでなければなりません。 .Pp .Ql .Nd は全ての引数の頭に .Ql - , を印字します。 . .It Li ".Sh LIBRARY" このセクションは、セクション 2 および 3 の関数呼び出しの ためにあります。 このセクションには、 .Ql .Lb マクロ呼び出し 1 つのみが含まれている必要があります。 .Sx "ライブラリ名" を参照してください。 . .It Li ".Sh SYNOPSIS" .Sx SYNOPSIS セクションはそのマニュアルページのサブジェクトとなっている項目の 典型的な使用法を説明します。 .Ql .Nm , .Ql .Cd , あるいは .Ql .Fn です (他には .Ql .Fo , .Ql .Fc , .Ql .Fd , .Ql .Ft のマクロも必要な場合があります)。 関数名マクロ .Ql .Fn はセクション 2 と 3 のマニュアルページにおいて必須のもので、 コマンドと一般名称マクロ .Ql .Nm はセクション 1, 5, 6, 7, 8 で必須の項目です。 セクション 4 のマニュアルでは .Ql .Nm か .Ql .Fd 、もしくは設定デバイス使用法マクロ .Ql .Cd が必要です。 その他のいくつかのマクロが次に示すような書式行を生成するために 必要なことがあります: . .Bd -filled -offset indent .Nm cat .Op Fl benstuv .Op Fl .Ar .Ed .Pp . 次のマクロが使われています: .Pp .Dl ".Nm cat" .Dl ".Op Fl benstuv" .Dl ".Op Fl" .Dl .Ar . .It Li ".Sh DESCRIPTION" ほとんどの場合、 .Sx "DESCRIPTION" セクションでの最初のテキストはそのコマンド、関数もしくは ファイルについての短い段落で、オプションの構文リストと それぞれの説明がそれに続きます。 そのようなリストを作成するには .Ql .Bl (リスト開始マクロ)、 .Ql .It (リスト項目マクロ)、 .Ql .El (リスト終了マクロ) を使用します (後述の .Sx リストとカラム セクションを参照)。 . .It Li ".Sh IMPLEMENTATION NOTES" 特定の実装に関する情報はここに置く必要があります。 . .It Li ".Sh RETURN VALUES" セクション 2, 3, 9 の関数の戻り値はここに来る必要があります。 .Ql .Rv を使用して、セクション 2 および 3 のライブラリ関数の .Sx RETURN VALUES セクションを生成することができます。 .Sx "戻り値" の項を参照してください。 .El .Pp . 次の .Ql .Sh セクションヘッダはマニュアルページの好ましいレイアウトの一部であり、 一貫性を保つために適切に使われなければなりません。 これらは使われる順番にリストされています。 . .Bl -tag -width ".Li .Sh\ COMPATIBILITY" .It Li ".Sh ENVIRONMENT" .Sx ENVIRONMENT セクションでは関連する環境変数および それらの振るまいや使用方法に関する手がかりを明らかにする 必要があります。 . .It Li ".Sh FILES" マニュアルページのサブジェクトによって使用されるか生成されるファイルで、 .Sx FILES セクション中でマクロ .Ql .Pa によってリストする必要があります。 . .It Li ".Sh EXAMPLES" 使用例を生成するにはいくつか方法があります。 詳細は後述の .Sx 使用例 セクションを参照してください。 . .It Li ".Sh DIAGNOSTICS" コマンドからの診断メッセージはこのセクションに置く必要があります。 . .It Li ".Sh COMPATIBILITY" 知られている互換性の問題 (例えば、非推奨になったオプションや パラメータ) をここにリストする必要があります。 . .It Li ".Sh ERRORS" 特定のエラーハンドリング、特にライブラリ関数 (マニュアルページのセクション 2, 3, 9) でのエラーハンドリングは ここで説明する必要があります。 .Ql .Er マクロはエラー (errno) を指定するのに使用されます。 . .It Li ".Sh SEE ALSO" .Sx "SEE ALSO" セクションには、そのマニュアルページの題材に関する資料への参照と 他の関連するマニュアルページへのクロスリファレンスが記載されます。 クロスリファレンスは .Ql .Xr マクロによって指定されます。 現在、 .Xr refer 1 スタイルのリファレンスには適合していません。 .Pp クロスリファレンスはセクション番号順、同一セクションにあるものは アルファベット順に並べ、コンマで区切ることを推奨します。 以下に例を示します: .Pp .Xr ls 1 , .Xr ps 1 , .Xr group 5 , .Xr passwd 5 . .It Li ".Sh STANDARDS" コマンドやライブラリ関数やファイルが、 .St -p1003.2 や .St -ansiC のような特定の実装によるものであれば、ここで記述します。 もしコマンドがどの規格にも基づいていなければ、その歴史は .Sx HISTORY のセクションで説明されなければなりません。 . .It Li ".Sh HISTORY" 特定の規格に基づいていないコマンドは、 このセクションでその歴史の概要を説明する必要があります。 . .It Li ".Sh AUTHORS" クレジットはここに置く必要があります。 人物名を指定するには .Ql .An マクロを使用する必要があります。 . .It Li ".Sh BUGS" あきらかな問題はここで記述します。 .El .Pp . ユーザ指定の .Ql .Sh セクションを追加することができます。 例えば、このセクションは以下のように設定されています。 . .Bd -literal -offset 15n \&.Sh "ページ構造領域" .Ed . .Ss "サブセクションヘッダ" . サブセクションヘッダはセクションヘッダとまったく同じ文法を しています。 .Ql .Ss は構文解析されますが、一般的に呼び出し不可能です。 このマクロは、 .Ql .Ss の呼び出し時にのみ引数として使用できます。このとき、 .Ql .Ss のデフォルトフォントが再度有効になります。 .Pp デフォルト幅は 8n です。 . .Ss "段落と行スペース" . .Bl -tag -width ".Li .Pp" .It Li .Pp .Ql .Pp 段落コマンドは必要な場合に行スペースを指定するために使われます。 このマクロは .Ql .Sh マクロや .Ql .Ss マクロの後、ならびに .Ql .Bl マクロや .Ql .Bd マクロの前では必要ありません (いずれのマクロも .Fl compact フラグが指定されていなければ垂直方向の距離を宣言します)。 .Pp このマクロは呼び出し不可能であり、構文解析もされません。そして 引数をとりません。別名は .Ql .Lp です。 .El . .\" XXX . .\" This worked with version one, need to redo for version three .\" .Pp .\" .Ds I .\" .Cw (ax+bx+c) \ is\ produced\ by\ \& .\" .\".Cw (ax+bx+c) \&.Va_by_) \&_and_\& \&[?/]m_b1_e1_f1[?/]\& .\" .Cl Cx \t\t .\" .Li \&.Cx\ ( .\" .Cx .\" .Cl Cx \t\t .\" .Li \&.Va ax .\" .Cx .\" .Cl Cx \t\t .\" .Li \&.Sy \+ .\" .Cx .\" .Cl Cx \&(\& .\" .Va ax .\" .Cx + .\" .Va by .\" .Cx + .\" .Va c ) .\" .Cx \t .\" .Em is produced by .\" .Cx \t .\" .Li \&.Va by .\" .Cx .\" .Cl Cx \t\t .\" .Li \&.Sy \+ .\" .Cx .\" .Cl Cx \t\t .\" .Li \&.Va c ) .\" .Cx .\" .Cl Cx \t\t .\" .Li \&.Cx .\" .Cx .\" .Cw .\" .De .\" .Pp .\" This example shows the same equation in a different format. .\" The spaces .\" around the .\" .Li \&+ .\" signs were forced with .\" .Li \e : .\" .Pp .\" .Ds I .\" .Cw (ax\ +\ bx\ +\ c) \ is\ produced\ by\ \& .\" .\".Cw (ax+bx+c) \&.Va_by_) \&_and_\& \&[?/]m_b1_e1_f1[?/]\& .\" .Cl Cx \t\t .\" .Li \&.Cx\ ( .\" .Cx .\" .Cl Cx \t\t .\" .Li \&.Va a .\" .Cx .\" .Cl Cx \t\t .\" .Li \&.Sy x .\" .Cx .\" .Cl Cx \t\t .\" .Li \&.Cx \e\ +\e\ \e& .\" .Cx .\" .Cl Cx \&(\& .\" .Va a .\" .Sy x .\" .Cx \ +\ \& .\" .Va b .\" .Sy y .\" .Cx \ +\ \& .\" .Va c ) .\" .Cx \t .\" .Em is produced by .\" .Cl Cx \t\t .\" .Li \&.Va b .\" .Cx .\" .Cl Cx \t\t .\" .Li \&.Sy y .\" .Cx .\" .Cl Cx \t\t .\" .Li \&.Cx \e\ +\e\ \e& .\" .Cx .\" .Cl Cx \t\t .\" .Li \&.Va c ) .\" .Cx .\" .Cl Cx \t\t .\" .Li \&.Cx .\" .Cx .\" .Cw .\" .De .\" .Pp .\" The incantation below was .\" lifted from the .\" .Xr adb 1 .\" manual page: .\" .Pp .\" .Ds I .\" .Cw \&[?/]m_b1_e1_f1[?/]\& is\ produced\ by .\" .Cl Cx \t\t .\" .Li \&.Cx Op Sy ?/ .\" .Cx .\" .Cl Cx \t\t .\" .Li \&.Nm m .\" .Cx .\" .Cl Cx Op Sy ?/ .\" .Nm m .\" .Ad \ b1 e1 f1 .\" .Op Sy ?/ .\" .Cx \t .\" .Em is produced by .\" .Cx \t .\" .Li \&.Ar \e\ b1 e1 f1 .\" .Cx .\" .Cl Cx \t\t .\" .Li \&.Op Sy ?/ .\" .Cx .\" .Cl Cx \t\t .\" .Li \&.Cx .\" .Cx .\" .Cw .\" .De .\" .Pp . .Ss キープ . 現在実装されているキープは単語に対するものだけです。 マクロは .Ql .Bk (キープ開始) と .Ql .Ek (キープ終了) です。 現在 .Ql .Bk が受け付けるオプションは .Fl words のみで (オプションを何も与えていなければこれがデフォルトでもあります) オプションの途中で改行が入らないようにするのに便利です。 make コマンド行の引数を生成する例 ( .Sx この名前には何が の項を参照) において、キープは .Xr nroff がフラグと引数を別の行に分けないように使われています。 .Pp いずれのマクロも呼び出し不可能であり、構文解析もされません。 .Pp キープマクロについてはもっと作業をする必要があります。 特に .Fl line オプションは追加する必要があるでしょう。 . .Ss "例示とディスプレイ" . ディスプレイには 7 つのタイプがあります。 .Pp .Bl -tag -width ".Li .D1" .It Li .D1 (D-いちです) インデントされたテキストを 1 行表示します。 このマクロは構文解析されますが、呼び出し不可能です。 .Pp .D1 Fl ldghfstru .Pp これは次の指定で生成されたものです: .Li ".D1 Fl ldghfstru" . .It Li .Dl (D-エルです) インデントされた .Em リテラル テキストを 1 行表示します。 .Ql .Dl マクロの例は本ファイル中にわたって使われています。 これによって 1 行のテキストのインデント (表示) が可能になります。 デフォルトフォントは固定幅 (リテラル) に設定されます。 .Ql .Dl は構文解析されますが、呼び出し不可能です。 .Pp .Dl % ls -ldg /usr/local/bin .Pp これは、次の指定で生成されたものです: .Li ".Dl % ls -ldg /usr/local/bin" . .It Li .Bd ディスプレイ開始。 .Ql .Bd ディスプレイは .Ql .Ed マクロで終了しなければなりません。 これは、次の書式をとります: .Pp .Bd -ragged -compact .Bl -tag -width ".Li .Bd" -offset indent .It Li .Bd Xo .Bro \-literal | \-filled | \-unfilled | \-ragged | \-centered Brc .Oo \-offset Ao 文字列 Ac Oc Oo \-file Ao ファイル名 Ac Oc Oo \-compact Oc Xc .El .Ed .Pp . .Bl -tag -width ".Fl file Ao Ar ファイル名 Ac " -compact .It Fl ragged 行詰めされますが、右マージンは調整しません (左マージンのみです)。 .It Fl centered 現在の左マージンと右マージン間の中央線です。 線それぞれが中央揃えになるということに注意してください。 .It Fl unfilled 行詰めしません。テキストのブロックを入力されたままの状態で 表示します。改行もユーザが指定した通りに使われます。 このため、何の警告メッセージも出さずに長過ぎる行を 生成する可能性があります。 .It Fl filled 行詰めされたブロックを表示します。 テキストブロックが整形されます (つまり、 テキストは左右どちら側にも揃えられます)。 .It Fl literal リテラルフォント (通常固定幅) でブロックを表示します。 ソースコードや、単純にタブもしくは空白で整えられた テキストには便利です。 .It Fl file Ao Ar ファイル名 Ac .Fl file フラグに続いた名前を持ったファイルが読み込まれ、 指定されたディスプレイタイプで .Ql .Bd と .Ql .Ed マクロで囲まれたデータよりも前に表示されます。 ファイル中の .Xr troff/ Ns Nm \-mdoc コマンドはどんなものでも処理されます。 .It Fl offset Ao Ar 文字列 Ac .Fl offset が以下の文字列のいずれかとともに指定されていると、 その文字列は次のテキストのブロックのインデントのレベルを示すものとして 解釈されます。 . .Pp .Bl -tag -width ".Ar indent-two" -compact .It Ar left ブロックを現在の左マージンに揃えます。 これは .Ql .Bd のデフォルトのモードです。 .It Ar center ブロックを中央揃えにします。 残念ながら現時点では、 単にブロックの左側を仮想的な中央マージンに揃えるだけです。 .It Ar indent デフォルトのインデント値もしくはタブの分だけインデントします。 デフォルトのインデント値は .Ql .D1 および .Ql .Dl マクロでも使われていますので、この 2 つのディスプレイと 行が揃うことが保証されています。 インデント値は通常 6n つまり約 2/3 インチ (固定幅文字 6 つ分) です。 .It Ar indent-two デフォルトのインデント値の 2 倍分インデントします。 .It Ar right これはブロックをページの右端から約 2 インチ離して .Em 左 揃えします。 このマクロはちゃんと動作する必要があるのですが、 .Xr troff ではまったくちゃんと動作してくれていません。 .El .Pp . .Ao 文字列 Ac がそれ以外で正しい数値表現をしている場合 .Pf ( Sq Em u .Em 以外のスケール指示子を伴う)、 インデント用にその値を使用します。 スケール指示子のなかで最も役に立つものは .Sq m および .Sq n です。これらはいわゆる .Em \&Em と .Em "En square" を指定します。 これらはそれぞれ、現在のフォントでの文字 .Sq m および文字 .Sq n の幅とほぼ同じです ( nroff の出力については、 どちらのスケール指示子でも同じ値が得られます )。 .Ao 文字列 Ac が数値表現をしていない場合、文字列は .Nm \-mdoc マクロ名であるかどうか検査され、このマクロに関連する デフォルトのオフセット値が使われます。 最終的にすべてのテストが失敗した場合 the width of .Ao 文字列 Ac の幅 (固定幅フォントでのタイプセット) がオフセットと見なされます。 .It Fl compact ディスプレイを開始するときに垂直方向の空白を挿入しないようにします。 .El . .It Li .Ed ディスプレイの終了 (引数はとりません)。 .El . .Ss "リストとカラム" . リスト開始マクロ .Ql .Bl で開始できるリストには何種類かあります。 リスト中の項目は項目マクロ .Ql .It で指定され、各リストは .Ql .El マクロで終了しなければなりません。 リストはリスト自身やディスプレイの中で入れ子にすることができます。 リスト中でカラムを使ったり、カラムの中でリストを使ったりすることに ついては検証されていません。 .Pp さらに、タグ幅、リストのオフセット、コンパクトの度合 (項目間の空白行が許されているかどうか) のような リストの属性をいくつか指定することができます。 本ドキュメントのほとんどはタグ .Pf ( Fl tag ) スタイルリストで整形されています。 .Pp このマクロは次の文法規則を持っています: . .Pp .Bd -ragged -compact .Bl -tag -width ".Li .Bl" -offset indent -compact .It Li .Bl Xo .Bro \-hang | \-ohang | \-tag | \-diag | \-inset Brc .Oo \-width Ao 文字列 Ac Oc .Oo \-offset Ao 文字列 Ac Oc Oo \-compact Oc Xc .It Li .Bl Xo .No \-column Oo \-offset Ao 文字列 Ac Oc .Ao 文字列1 Ac Ao 文字列2 Ac ... Xc .It Li .Bl Xo .Bro \-item | \-enum Oo \-nested Oc | \-bullet | \-hyphen | \-dash Brc .Oo \-offset Ao 文字列 Ac Oc Oo \-compact Oc Xc .El .Ed .Pp . 次に、このリストタイプの詳細な解説を行います。 . .Pp .Bl -tag -width ".Fl column" -compact .It Fl bullet ビュレットリストです。 . .Bd -literal -offset indent \&.Bl -bullet -offset indent -compact \&.It 1 つ目のビュレットはここにきます。 \&.It 2 つ目のビュレットはここにきます。 \&.El .Ed .Pp . 生成結果は次の通りです: . .Pp .Bl -bullet -offset indent -compact .It 1 つ目のビュレットはここにきます。 .It 2 つ目のビュレットはここにきます。 .El .Pp . .It Fl dash No ( または Fl hyphen ) ダッシュ文字によるリストです。 . .Bd -literal -offset indent \&.Bl -dash -offset indent -compact \&.It 1 つ目のダッシュはここにきます。 \&.It 2 つ目のダッシュはここにきます。 \&.El .Ed .Pp . 生成結果は次の通りです: . .Pp .Bl -dash -offset indent -compact .It 1 つ目のダッシュはここにきます。 .It 2 つ目のダッシュはここにきます。 .El .Pp . .It Fl enum 箇条書きリストです。 . .Bd -literal -offset indent \&.Bl -enum -offset indent -compact \&.It 1 つ目の項目はここにきます。 \&.It 2 つ目の項目はここにきます。 \&.El .Ed .Pp . 生成結果は次の通りです: . .Pp .Bl -enum -offset indent -compact .It 1 つ目の項目はここにきます。 .It 2 つ目の項目はここにきます。 .El .Pp . 箇条書きリストを入れ子にしたい場合、 .Fl nested フラグを使用してください (第 2 レベルのリストが開始されます): . .Bd -literal -offset indent \&.Bl -enum -offset indent -compact \&.It 1 つ目の項目はここにきます。 \&.Bl -enum -nested -compact \&.It 2 つ目の項目はここにきます。 \&.It 3 つ目の項目はここにきます。 \&.It \&.El \&.It 4 つ目の項目はここにきます。 \&.El .Ed .Pp . 生成結果は次の通りです: . .Pp .Bl -enum -offset indent -compact .It 1 つ目の項目はここにきます。 .Bl -enum -nested -compact .It 2 つ目の項目はここにきます。 .It 3 つ目の項目はここにきます。 .El .It 4 つ目の項目はここにきます。 .El .Pp . .It Fl item リストの印をつけない .Fl item タイプのリストです。 . .Bd -literal -offset indent \&.Bl -item -offset indent \&.It 1 つ目の項目はここにきます。 1 つ目の項目はここにきます。 1 つ目の項目はここにきます。 \&.It 2 つ目の項目はここにきます。 2 つ目の項目はここにきます。 2 つ目の項目はここにきます。 \&.El .Ed .Pp . 生成結果は次の通りです: . .Pp .Bl -item -offset indent .It 1 つ目の項目はここにきます。 1 つ目の項目はここにきます。 1 つ目の項目はここにきます。 .It 2 つ目の項目はここにきます。 2 つ目の項目はここにきます。 2 つ目の項目はここにきます。 .El .Pp . .It Fl tag タグつきリストです。 タグ幅を指定するには .Fl width を使用してください。 . .Pp .Bl -tag -width "PPID" -compact -offset indent .It SL プロセスが sleep している時間 (ブロックされた秒数) .It PAGEIN そのプロセスによって、まだメモリにロードされていないページへの参照が 起こることにより生じたディスク .Tn I/O の回数 .It UID 数値表記によるプロセス所有者のユーザ ID .It PPID 数値表記による親プロセスの ID、プロセスの優先度 (割り込み不可の待機状態のときには、正でない値になる) .El .Pp . 元のテキストは次の通りです: . .Bd -literal -offset indent \&.Bl -tag -width "PPID" -compact -offset indent \&.It SL プロセスが sleep している時間 (ブロックされた秒数) \&.It PAGEIN そのプロセスによって、まだメモリにロードされていないページへの参照が 起こることにより生じたディスク \&.Tn I/O の回数 \&.It UID 数値表記によるプロセス所有者のユーザ ID \&.It PPID 数値表記による親プロセスの ID、プロセスの優先度 (割り込み不可の待機状態のときには、正でない値になる) \&.El .Ed .Pp . .It Fl diag 診断リストはセクション 4 の診断リストを生成するもので、 呼び出し可能なマクロが無視されることを除き、inset リストと似ています。 フラグ .Fl width は、この文脈では意味がありません。 .Pp 使用例: . .Bd -literal -offset indent \&.Bl -diag \&.It ここで Sy を使うことはできません。 このメッセージはすべて出力されます。 \&.El .Ed .Pp . 生成結果 . .Bl -diag .It ここで Sy を使うことはできません。 このメッセージはすべて出力されます。 .El .Pp . .It Fl hang ぶら下がりタグつきリストです。 . .Bl -hang -offset indent .It Em Hanged ラベル幅よりもラベルが小さい場合には ぶら下げられたラベルはタグつきリストと同じように見えます。 .It Em Longer hanged list labels ラベル幅より長いぶら下がりリストのラベルは、 タグつき段落ラベルとは違い、段落に溶け込みます。 .El .Pp 以上の文章を生成した、整形前のテキストは 次の通りです: . .Bd -literal -offset indent \&.Bl -hang -offset indent \&.It Em Hanged ラベル幅よりもラベルが小さい場合には ぶら下げられたラベルはタグつきリストと同じようにみえます。 \&.It Em Longer Hanged list labels ラベル幅より長いぶら下がりリストのラベルは、 タグつき段落ラベルとは違い、段落に溶け込みます。 \&.El .Ed .Pp . .It Fl ohang オーバハングタグ (overhanging tags) を用いたリストは 項目に対してインデントを使いません。 タグは別の行に出力されます。 .Pp .Bl -ohang -offset indent .It Sy SL プロセスが sleep している時間 (ブロックされた秒数) .It Sy PAGEIN そのプロセスによって、まだメモリにロードされていないページへの参照が 起こることで生じたディスク .Tn I/O の回数 .It Sy UID 数値表記によるプロセス所有者のユーザ ID .It Sy PPID 数値表記による親プロセスの ID、プロセスの優先度 (割り込み不可の待機状態のときには、正でない値になる) .El .Pp . 元のテキストは次の通りです: . .Bd -literal -offset indent \&.Bl -ohang -offset indent \&.It Sy SL プロセスが sleep している時間 (ブロックされた秒数) \&.It Sy PAGEIN そのプロセスによって、まだメモリにロードされていないページへの参照が 起こることで生じたディスク \&.Tn I/O の回数 \&.It Sy UID 数値表記によるプロセス所有者のユーザ ID \&.It Sy PPID 数値表記による親プロセスの ID、プロセスの優先度 (割り込み不可の待機状態のときには、正でない値になる) \&.El .Ed .Pp . .It Fl inset 次は、inset ラベルの例です: .Bl -inset -offset indent .It Em tag タグリスト (タグ段落とも呼びます) は バークレーのマニュアルで使われている最も一般的な 種類のリストです。 後で述べるように、 .Fl width 属性を使用してください。 .It Em diag 診断リストはセクション 4 の診断リストを生成し、 呼び出し可能なマクロを無視するという点を除けば inset リストと似ています。 .It Em hang ぶら下がりラベルは気分の問題です。 .It Em ohang オーバハングラベルは空白に制限がある場合には良いです。 .It Em inset inset ラベルは段落ブロックを制御するのに便利で、 .Nm \-mdoc マニュアルを別のフォーマットに変換するのに有用です。 .El .Pp 上の例を生成したソーステキストはこうなっています: . .Bd -literal -offset indent \&.Bl -inset -offset indent \&.It Em tag タグリスト (タグ段落とも呼びます) は バークレーのマニュアルで使われている最も一般的な 種類のリストです。 後で述べるように、 \&.Fl width 属性を使用してください。 \&.It Em diag 診断リストはセクション 4 の診断リストを生成し、 呼び出し可能なマクロを無視するという点を除けば inset リストと似ています。 \&.It Em hang ぶら下がりラベルは気分の問題です。 \&.It Em ohang オーバハングラベルは空白に制限がある場合には良いです。 \&.It Em inset inset ラベルは段落ブロックを制御するのに便利で、 \&.Nm \-mdoc マニュアルを別のフォーマットに変換するのに有用です。 \&.El .Ed .Pp . .It Fl column この種類のリストは複数カラムを生成します。 カラムの数および各カラムの幅は .Fl column リストへの引数、 .Aq Ar string1 , .Aq Ar string2 等によって決定されます。 .Aq Ar stringN が .Ql .\& (ドット) で開始し直後に有効な .Nm \-mdoc マクロ名が続く場合、 .Aq Ar stringN を解釈して結果の幅を使用します。 そうでない場合、 .Aq Ar stringN (固定幅フォントでのタイプセット) は .Ar N 番目の桁の幅になります。 .Pp .Ql .It 引数はそれぞれ構文解析され行を生成します。 行中の各列はタブや .Ql .Ta マクロで分けられた引数です。 .Pp 次の表、 . .Bl -column -offset indent ".Sy 文字列" ".Sy nroff" ".Sy troff" .It Sy 文字列 Ta Sy nroff Ta Sy troff .It Li <= Ta <= Ta \*(<= .It Li >= Ta >= Ta \*(>= .El .Pp . は次のようにして生成されています: . .Bd -literal -offset indent \&.Bl -column -offset indent ".Sy 文字列" ".Sy nroff" ".Sy troff" \&.It Sy 文字列 Ta Sy nroff Ta Sy troff \&.It Li <= Ta <= Ta \e*(<= \&.It Li >= Ta >= Ta \e*(>= \&.El .Ed .El .Pp . その他のキーワード: . .Bl -tag -width ".Fl indent Ao Ar 文字列 Ac" .It Fl width Ao Ar 文字列 Ac .Aq Ar 文字列 が .Ql .\& (ドット) で開始し直後に有効な .Nm \-mdoc マクロ名が続く場合、 .Aq Ar 文字列 を解釈し、その結果の幅を使います。 本ドキュメントのほとんどすべてのリストは このオプションを使用しています。 .Pp 使用例: . .Bd -literal -offset indent \&.Bl -tag -width ".Fl test Ao Ar 文字列 Ac" \&.It Fl test Ao Ar 文字列 Ac これは、 \&.Fl width フラグをタグリストと一緒に使うとどのように 働くかを見るためのもっと長い文です。 \&.El .Ed .Pp . 生成結果: . .Bl -tag -width ".Fl test Ao Ar 文字列 Ac" .It Fl test Ao Ar 文字列 Ac これは、 .Fl width フラグをタグリストと一緒に使うとどのように 働くかを見るためのもっと長い文です。 .El .Pp . .Ao 文字列 Ac が解釈される前に現在の .Nm \-mdoc の状態が保存されることに注意してください。 文字列が解釈された後ですべての変数が再度復元されます。 しかし、ボックス (囲いに使用される) は .Tn GNU .Xr troff 1 では保存されません。結果としては、醜いエラーを防ぐためには 引数は常に .Em 平衡がとれて いなくてはなりません。 例えば、本当に開き山括弧だけが必要である場合には .Ql ".Ao Ar 文字列" と書いてはだめで、代わりに .Ql ".Ao Ar 文字列 Xc" と書かなくてはなりません。 .Pp そうでない場合、 .Aq Ar 文字列 が正当な数値表現である場合 .Sq ( Em u .Em 以外のスケール指示子を伴う)、 インデント用にその値を使用します。 最も有用なスケール指示子は .Sq m と .Sq n です。 これらはいわゆる .Em \&Em および .Em "En square" を指定します。 これらはそれぞれ、現在のフォントでの文字 .Sq m および文字 .Sq n の幅とほぼ同じです (nroff の出力については、 どちらのスケール指示子でも同じ値が得られます)。 .Aq Ar 文字列 が数値表現をしていない場合、文字列は .Nm \-mdoc マクロ名であるかどうか検査され、このマクロに関連する デフォルトのオフセット値が使われます。 最終的にすべてのテストが失敗した場合 .Aq Ar 文字列 の幅 (固定幅フォントでのタイプセット) がオフセットと見なされます。 .Pp タグリストタイプ用に幅が指定されていない場合、 .Ql .It が起動される度に適切な幅を決定しようと試みます。 .Ql .It の第 1 引数が呼び出し可能なマクロである場合、 そのマクロのデフォルト幅が使われます。 そうでなければ、 .Ql .No のデフォルト幅が使われます。 .Pp .It Fl offset Ao Ar 文字列 Ac .Aq Ar 文字列 が .Ar indent である場合、デフォルトのインデント値 (通常 6n に設定されており、 .Ql .Dl または .Ql .Bd で使われる値と似ています) が使われます。 .Aq Ar 文字列 が正当な数値表現である場合 .Pf ( Sq Em u 以外のスケール指示子を伴う )、 その値をインデントに使用します。 最も有用なスケール指示子は .Sq m と .Sq n であり、これらはいわゆる .Em \&Em および .Em "En square" です。 これらはそれぞれ、それぞれ現在のフォントでの .Sq m と .Sq n の幅とほぼ同じです (nroff の出力については、 どちらのスケール指示子も同じ値をとります)。 .Ao 文字列 Ac が数値表現でない場合、その文字列が .Nm \-mdoc のマクロ名であるかどうか検査され、このマクロに関連する デフォルトのオフセット値が使われます。 最終的にすべてのテストが失敗した場合、 .Aq Ar 文字列 の幅 (固定幅フォントでのタイプセット) がオフセットとして とられます。 .It Fl compact リストの前およびリスト項目間に垂直方向の空白を挿入しないように します。 .El . . .Sh "その他のマクロ" . ここには、いままでのセクションにはうまく当てはまらなかった 残りのマクロのリストがあります。 次のマクロに対しては本物の使用例を見つけられませんでした。 それは .Ql .Me と .Ql .Ot です。この 2 つについても完璧を期するためにここに 文書化はしています。もしこの 2 つのマクロの 適切な使い方をご存知であれば .Mt bug-groff@gnu.org までメールを送ってください (例つきで)。 . .Bl -tag -width ".Li .Bt" .It Li .Bt は . .Bd -ragged -offset indent .Bt .Ed .Pp を表示します。 .Pp このマクロは呼び出し不可能であり、構文解析もされません。 また引数もとりません。 . .It Li .Fr .Pp .Dl 使い方: .Fr Ao 関数の戻り値 Ac ... .Pp このマクロは使わないでください。 このマクロは戻り値 (通常は数字 1 個) の直前での 改行を許してしまいます。 印刷時の振る舞いとしては悪いことです。 直前の単語と戻り値とを結合させるには .Ql \e~ を使用してください。 . .It Li .Hf (ヘッダ) ファイルをそのまま含めるにはこのマクロを 使ってください。 このマクロは、最初に .Ql File: とファイル名を表示し、その後で .Ao ファイル Ac の内容を表示します。 .Pp .Dl 使い方: .Hf Ao ファイル Ac .Pp このマクロは呼び出し不可能であり、構文解析もされません。 . .It Li .Lk 将来書かれる予定です。 . .It Li .Me 正確な使用方法は分かりません。 .Nm \-mdoc ソースファイル中の記述では .Dq "メニューエントリ" となっています。 .Pp デフォルト幅は 6n です。 . .It Li .Mt 将来書かれる予定です。 . .It Li .Ot 正確な使用方法は分かりません。 .Nm \-mdoc ソースファイル中の記述では .Dq "古い関数タイプ (fortran)" となっています。 . .It Li .Sm 空白モードを有効に (トグル) します。 .Pp .Dl 使い方: .Sm Oo on | off Oc ... .Pp 空白モードが off の場合、マクロ引数の間に空白は 挿入されません。引数なしで呼ばれた場合 (あるいは 次の引数が .Ql on でも .Ql off でもない場合) .Ql .Sm マクロは空白モードに入ります。 . .It Li .Ud マクロは . .Bd -ragged -offset indent .Ud .Ed .Pp を表示します。 .Pp このマクロは呼び出し不可能であり、構文解析もされません。 また引数もとりません。 .El . . .Sh "定義済み文字列" . 次の文字列が定義済みです: .Pp .Bl -column 文字列 infinity "troff " "まっすぐなダブルクォート" -offset indent .It Sy 文字列 Ta Sy nroff Ta Sy troff Ta Sy 意味 .It Li <= Ta <= Ta \*[<=] Ta "以下" .It Li >= Ta >= Ta \*[>=] Ta "以上" .It Li Rq Ta '' Ta \*[Rq] Ta "右側のダブルクォート" .It Li Lq Ta `` Ta \*[Lq] Ta "左側のダブルクォート" .It Li ua Ta ^ Ta \*[ua] Ta "上向き矢印" .It Li aa Ta \' Ta \*[aa] Ta "アキュートアクセント" .It Li ga Ta \` Ta \*[ga] Ta "グレーブアクセント" .It Li q Ta \&" Ta \*[q] Ta "まっすぐなダブルクォート" .It Li Pi Ta pi Ta \*[Pi] Ta "ギリシャ語のパイ" .It Li Ne Ta != Ta \*[Ne] Ta "不等号" .It Li Le Ta <= Ta \*[Le] Ta "以下" .It Li Ge Ta >= Ta \*[Ge] Ta "以上" .It Li Lt Ta < Ta \*[Lt] Ta "小なり" .It Li Gt Ta > Ta \*[Gt] Ta "大なり" .It Li Pm Ta +\- Ta \*[Pm] Ta "プラスマイナス" .It Li If Ta infinity Ta \*[If] Ta "無限" .It Li Am Ta \*[Am] Ta \*[Am] Ta "アンパサンド" .It Li Na Ta \*[Na] Ta \*[Na] Ta "非数値" .It Li Ba Ta \*[Ba] Ta \*[Ba] Ta "垂直線" .El .Pp カラムの名前 .Sy nroff と .Sy troff は少々誤解を招くものです。 .Sy nroff は .Tn ASCII 文字を表示しますが、 .Sy troff では利用可能なもののうち一番良いグリフ形式を 表示します。 例えば、Unicode を使用可能にした .Tn TTY デバイスはすべての文字列に対して適切なグリフ表現を 持っていますが、それに対して Latin1 に対して機能を強化した .Tn TTY デバイスはプラスマイナス記号しか持っていません。 .Pp 文字を 2 つ含んだ文字列名は .Ql \e*(xx として表記できます。 文字を 1 文字だけ含んだ文字列名は .Ql \e*x と表記できます。 どのような長さの文字列名に対しても、一般的な文法は .Ql \e*[xxx] となります ( これは .Tn GNU .Xr troff 1 拡張です)。 . . \# \#===================================================================== \# .Sh 診断 . 以前のバージョンの .Nm \-mdoc パッケージでは利用可能だったデバッグ用マクロ .Ql .Db は取り除かれました。なぜなら、 .Tn GNU .Xr troff 1 ではパラメータをチェックするのにもっと良いファシリティを 提供しているからです。さらに、このマクロパッケージには エラーや警告メッセージが多数追加されており、よりロバストで 饒舌なものになっています。 .Pp 唯一残ったデバッグ用マクロは .Ql .Rd であり、これはすべてのグローバルレジスタならびに文字列の レジスタダンプを出力するものです。 通常のユーザが使う必要は決してないでしょう。 . . .Sh "GROFF, TROFF, および NROFF を使用した整形" . デフォルトでは、このパッケージでは .Sq latin1 や .Sq unicode のような .Tn TTY デバイスで表示する場合には改ページやヘッダ、フッタは 禁止されており、マニュアルをオンラインで効率良く 見ることができるようになっています。 この振る舞いは、 .Xr groff 1 を呼んでいるときにレジスタ .Ql cR に 0 を指定することで変更することができます (例えば、 .Tn TTY 出力のハードコピーを作成したいときなど)。 .Pp .Dl groff -Tlatin1 -rcR=0 -mdoc foo.man > foo.txt .Pp 両面印刷用には、レジスタ .Ql D を 1 に設定してください: .Pp .Dl groff -Tps -rD1 -mdoc foo.man > foo.ps .Pp ドキュメントのフォントサイズを 11pt や 12pt に変更したい 場合は、レジスタ .Ql S をそれに合わせて設定してください: .Pp .Dl groff -Tdvi -rS11 -mdoc foo.man > foo.dvi .Pp レジスタ .Ql S は .Tn TTY デバイスに対しては無視されます。 . . .Pp 行およびタイトルの長さを変えたい場合、それぞれレジスタ .Ql LL と .Ql LT を設定してください: .Pp .Dl groff -Tutf8 -rLL=100n -rLT=100n -mdoc foo.man | less .Pp 設定されていない場合、TTY デバイスに対してはレジスタ値は 78n に、 その他の場合 6.5i になります。 .Sh 関連ファイル . .Bl -tag -width mdoc/doc-ditroff -compact .It Pa doc.tmac 主なマニュアル用マクロパッケージです。 .It Pa mdoc.tmac .Pa doc.tmac を呼ぶラッパファイルです。 .It Pa mdoc/doc-common 共通する文字列、定義、および印刷出力に関連する項目です。 .It Pa mdoc/doc-nroff .Tn TTY 出力デバイス用に使用される定義です。 .It Pa mdoc/doc-ditroff その他すべてのデバイス用に使用される定義です。 .It Pa mdoc.local ローカルマシンでの追加項目およびカスタマイズ項目です。 .It Pa andoc.tmac このファイルは .Nm \-mdoc パッケージと .Nm \-man パッケージのどちらを使用すべきかをチェックします。 .El . . .Sh "関連項目" . .Xr groff 1 , .Xr man 1 , .Xr troff 1 , .Xr groff_man 7 . . .Sh バグ . セクション 3f はヘッダルーチンには追加されていません。 .Pp .Ql \&.Nm .Sx NAME セクションにおいては、フォントを変更するべきです。 .Pp 行の長さが短すぎる場合に行が分割されるのを防ぐために .Ql \&.Fn がチェックを行う必要があります。 ときどき、最後の括弧が分割されることがあり、 行詰めモードであるときにおかしな結果になることがあります。 .Pp リストマクロおよびディスプレイマクロは何のキープも 行いませんが、これはキープを行うべきです。 .\" Note what happens if the parameter list overlaps a newline .\" boundary. .\" to make sure a line boundary is crossed: .\" .Bd -literal .\" \&.Fn struct\e\ dictionarytable\e\ *dictionarylookup struct\e\ dictionarytable\e\ *tab[] .\" .Ed .\" .Pp .\" produces, nudge nudge, .\" .Fn struct\ dictionarytable\ *dictionarylookup char\ *h struct\ dictionarytable\ *tab[] , .\" .Fn struct\ dictionarytable\ *dictionarylookup char\ *h struct\ dictionarytable\ *tab[] , .\" nudge .\" .Fn struct\ dictionarytable\ *dictionarylookup char\ *h struct\ dictionarytable\ *tab[] . .\" .Pp .\" If double quotes are used, for example: .\" .Bd -literal .\" \&.Fn \*qstruct dictionarytable *dictionarylookup\*q \*qchar *h\*q \*qstruct dictionarytable *tab[]\*q .\" .Ed .\" .Pp .\" produces, nudge nudge, .\" .Fn "struct dictionarytable *dictionarylookup" "char *h" "struct dictionarytable *tab[]" , .\" nudge .\" .Fn "struct dictionarytable *dictionarylookup" "char *h" "struct dictionarytable *tab[]" , .\" nudge .\" .Fn "struct dictionarytable *dictionarylookup" "char *h" "struct dictionarytable *tab[]" . .\" .Pp .\" Not a pretty sight... .\" In a paragraph, a long parameter containing unpaddable spaces as .\" in the former example will cause .\" .Xr troff .\" to break the line and spread .\" the remaining words out. .\" The latter example will adjust nicely to .\" justified margins, but may break in between an argument and its .\" declaration. .\" In .\" .Xr nroff .\" the right margin adjustment is normally ragged and the problem is .\" not as severe. . .\" Local Variables: .\" mode: nroff .\" End: .\" .SH 履歴 .\" Yoshiteru Kageyama 2001/06/10 mdoc.samples.7 .\" を参考に翻訳 .\" MORI Kouji 2001/08/21 訳チェック diff --git a/ja_JP.eucJP/man/man7/groff_ms.7 b/ja_JP.eucJP/man/man7/groff_ms.7 index 4c8b190018..c50ff41ddd 100644 --- a/ja_JP.eucJP/man/man7/groff_ms.7 +++ b/ja_JP.eucJP/man/man7/groff_ms.7 @@ -1,1004 +1,1004 @@ '\" t .ig Copyright (C) 1989-1995, 2001, 2002 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. .. .\" $FreeBSD$ .TH GROFF_MS 7 "11 October 2002" "Groff Version 1.19" .SH 名称 groff_ms \- groff ms マクロ .SH 書式 .B groff .B \-ms [ .IR options .\|.\|.\& ] [ .IR files .\|.\|.\& ] .br .B groff .B \-m\ ms [ .IR options .\|.\|.\& ] [ .IR files .\|.\|.\& ] .\" ----- .SH 解説 このマニュアルページは GNU バージョンの .I ms マクロの解説をします。 このマクロは、 .I groff 文書整形システムの一部分です。 この .I ms マクロは、4.3 .SM BSD Unix .I ms マクロの文書化された機能と互換であるように設計されています (詳細は後述の .I troff ms との違い を参照してください)。 .I ms マクロは、報告書、手紙、書籍、技術文書に適しています。 .\" ----- .SH 使用法 .I ms マクロパッケージは、ファイルにある程度の構造があることを期待しています。 最も単純な文書は、段落マクロで開始し、 段落マクロか単なる空行で区切られたテキストからなります。 長い文書は、次の構造を持ちます: .TP .B "文書タイプ" 文書の先頭に .B RP (報告書) マクロを置くと、 .I groff は表紙の情報をそのページに印字します。 そうでない場合は、この情報は最初のページに印字され、 直後に文書のテキストが続きます。 AT&T .I troff の他の文書書式は AT&T か Berkeley 固有であり、 .IR "groff ms" ではサポートされていません。 .TP .B "書式とレイアウト" 数値レジスタを設定することで、文書の活字 (フォントと大きさ)、 マージン、間隔、ヘッダ、フッタ、脚注を変えられます。 詳細は後述の .I "文書制御レジスタ" を参照してください。 .TP .B "表紙" 表紙ページは、タイトル、省略可能な著者名と組織名、 アブストラクト、日付からなります。 さらなる詳細は後述の .I "表紙ページマクロ" を参照してください。 .TP .B "本文" 表紙ページに、あなたの文書が続きます。 これは、段落、見出し、リストからなります。 .TP .B "目次" 長い文書は、通常、目次を含みます。 これは、文書の最後に .B TC マクロを置くことで可能となります。 .\" ----- .SS "文書制御レジスタ" 次の表は、文書制御レジスタを列挙しています。 一貫性のために、マージンに関するレジスタは、文書の先頭で、もしくは .B RP マクロの直後で設定してください。 .LP .ne 9 .B マージン設定 .RS .na .TS cb s cb s s cb s cb s afCW s l s s l s l s. レジスタ 定義 効果対象 デフォルト _ PO T{ ページオフセット (左マージン) T} T{ 次ページ T} 1i LL T{ 行長 T} 次段落 6i LT T{ ヘッダ/フッタ長 T} 次段落 6i HM T{ トップ (ヘッダ) マージン T} 次ページ 1i FM T{ ボトム (フッタ) マージン T} 次ページ 1i _ .TE .RE .LP .ne 7 .B テキスト設定 .RS .TS cb s cb s s cb s cb s afCW s l s s l s l s. レジスタ 定義 効果対象 デフォルト _ PS T{ ポイントサイズ T} 次段落 10p VS T{ 行間 (先行) T} 次段落 12p _ .TE .RE .LP .ne 7 .B 段落設定 .RS .TS cb cb s cb cb afCW l s l l . レジスタ 定義 効果対象 デフォルト _ PI T{ 初期インデント T} 次段落 5n PD T{ 段落間の間隔 T} 次段落 0.3v QI T{ 引用段落のインデント T} 次段落 5n _ .TE .RE .LP .ne 7 .B 脚注設定 .RS .TS cb cb cb cb afCW l l l . レジスタ 定義 効果対象 デフォルト _ FL 脚注の長さ 次の脚注 LL*5/6 FI 脚注のインデント 次の脚注 2n FF 脚注の書式 次の脚注 0 _ .TE .RE .LP .ne 6 .B 他の設定 .RS .TS cb s cb s s cb s cb s afCW s l s s l s l s. レジスタ 定義 効果対象 デフォルト _ MINGW T{ カラム間の最小幅 T} 次ページ 2n _ .TE .ad .RE .\" ----- .SS "表紙ページマクロ" 次のマクロを次の順序で使用することで、文書の表紙ページを作成してください。 .TP .B \&.RP [no] 文書の報告書書式を指定します。 報告書書式は、独立した表紙ページを作成します。 .B RP マクロを指定しないと、 .I groff は、表紙のサブセットを文書のページ 1 に印字します。 .IP 省略可能な .B no 引数を使用すると、 .I groff は表紙ページを印字しますが、表紙ページ情報 (タイトル、著者、アブストラクト等) を文書のページ 1 に続けません。 .TP .B \&.P1 (P に数字の 1) ページ 1 にヘッダを印字します。 デフォルトは、ヘッダを抑制します。 .TP .BI "\&.DA [" xxx ] (省略可能) 現在の日付かマクロに引数があればそれを、 表紙ページ (指定されていれば) とフッタに印字します。 これは .IR nroff のデフォルトです。 .TP .BI "\&.ND [" xxx ] (省略可能) 現在の日付かマクロに引数があればそれを、 表紙ページ (指定されていれば) に印字しますが、フッタには印字しません。 これは .IR troff のデフォルトです。 .TP .B \&.TL 文書のタイトルを指定します。 .I groff は .B TL マクロから著者かアブストラクトまでのテキストを集め、タイトルとします。 .TP .B \&.AU 著者名を指定します。 複数の著者を指定するには、各著者に対して .B AU マクロを使用します。 .TP .B \&.AI 著者の組織を指定します。 複数の組織を指定可能です。 .TP .B \&.AB [no] アブストラクトを開始します。 デフォルトでは、語 .BR ABSTRACT を中央寄せイタリックにて、アブストラクトのテキストの上に印字します。 オプションの .B no は、この見出しを抑制します。 .TP .B \&.AE アブストラクトの終了です。 .\" ----- .SS 段落 インデント付きの段落を作成するには .B PP マクロを使用し、初期インデント無しの段落を作成するには .B LP マクロを使用します。 .PP .B QP マクロは、すべてのテキストを、左および右のマージンに対してインデントします。 効果は、HTML の .B
要素と同じです。 次段落や見出しは、マージンを通常に戻します。 .PP .B XP マクロは、拡張段落を生成します。 段落の最初の行は左マージンから開始し、続く行がインデントされます .RB ( PP の逆です)。 .SS 見出し 文書に階層構造を作成するには、見出しを使用します。 .I ms マクロでは、本文と同じフォントファミリで同じポイントサイズの .B ボールド にて、見出しを印字します。 .PP 次の見出しマクロが使用可能です: .TP .BI \&.NH \0xx 数字付き見出し。 引数 .I xx は、見出しのレベルを示す数値引数であるか、 .I S\ xx\ xx\ \c \&".\|.\|." という形式の明示的なセクション番号です。 順番からは外れた見出しレベル、例えば .BR ".NH\ 1" の後に .B ".NH\ 3" を指定すると、 .I groff は標準エラーに警告を表示します。 .TP .B \&.SH 数字無しの副見出しです。 .\" ----- .SS 強調印字 .I ms マクロには、テキストを強調するための様々な方法があります: .TP .BI "\&.B [" txt " [" post " [" pre ]]] 最初の引数を .B "ボールドタイプ" にします。 第 2 引数を指定すると、 .I groff は、それを以前のフォントにて、空白を挟まずに印字します (強調テキストの後に、句読点を強調せずに置けます)。 同様に、(存在すれば) 第 3 引数を以前のフォントにて、最初の引数の .B 前 に印字します。 例えば .RS .IP \&.B foo ) ( .RE .IP は次のように印字されます: .RB ( foo ) .IP このマクロに引数を指定しないと、 次の強調・段落・見出しマクロまでの後続するすべてのテキストを、 .I groff はボールドで印字します。 .TP .BI "\&.R [" txt " [" post " [" pre ]]] 最初の引数をローマン (通常) タイプにします。 他は .B B マクロと同様に動作します。 .TP .BI "\&.I [" txt " [" post " [" pre ]]] 最初の引数を .IR "イタリックタイプ" にします。 他は .B B マクロと同様に動作します。 .TP .BI "\&.CW [" txt " [" post " [" pre ]]] 最初の引数を等幅フェースにします。 他は .B B マクロと同様に動作します。 .TP .BI "\&.BI [" txt " [" post " [" pre ]]] 最初の引数をボールドイタリックタイプにします。 他は .B B マクロと同様に動作します。 .TP .BI "\&.BX [" txt ] 引数を印字し、その周りに箱を描きます。 空白を含む文字列を箱で囲みたい場合、数値幅の空白 (\[rs]0) を使用してください。 .TP .BI "\&.UL [" txt " [" post ]] 最初の引数を下線付きで印字します。 第 2 引数を指定すると、 .I groff は、それを以前のフォントにて、 空白を挟まずに下線付きテキストの後に印字します。 .TP .B \&.LG 次のフォントサイズ・強調・段落・見出しマクロまでの後続するすべてのテキストを、 大きなタイプ (現在のポイントサイズより 2 ポイント大) で印字します。 このマクロを複数回指定することで、 必要な大きさになるまでポイントサイズを大きくすることができます。 .TP .B \&.SM 次のフォントサイズ・強調・段落・見出しマクロまでの後続するすべてのテキストを、 小さなタイプ (現在のポイントサイズより 2 ポイント小) で印字します。 このマクロを複数回指定することで、 必要な小ささになるまでポイントサイズを小さくすることができます。 .TP .B \&.NL 後続するすべてのテキストを通常のポイントサイズ .RB ( PS レジスタの値) で印字します。 .TP .BI \[rs]*{ text \[rs]*} 括られた .I テキスト を上付き文字として印字します。 .\" ----- .SS インデント テキストの一部をインデントする必要があるかもしれません。 典型的なインデントの使用法は、 入れ子のリストやサブリストを作成することです。 .PP インデントされたテキスト部分の開始と終了には、それぞれ .B RS および .B RE のマクロを使用します。 .B PI レジスタは、インデント量を制御します。 .PP .B RS および .BR RE の組を入れ子で使用することで、 インデントされた部分を必要なだけ深く入れ子にすることができます。 .\" ----- .SS リスト .B IP マクロは、すべてのリストの仕事を操作します。 この構文は次の通りです: .TP .BI ".IP [" marker " [" width ]] .IP .I marker は、通常、順番無しリストでは中黒文字 .B \[rs](bu 、番号付きリストでは番号 (または自動的に増加する数値レジスタ)、 インデント付き (用語解説スタイル) リストでは語や句です。 .IP .I width は、各リスト項目の本文用のインデントを指定します。 ひとたび指定すると、次に指定されるまで、 文書中のすべてのリスト項目に対してインデントは同じままです。 .\" ----- .br .ne 15 .SS "タブストップ" 必要に応じてタブストップを設定するには .B ta リクエストを使用します。 タブストップをデフォルト (5n 毎) に戻すには .B TA マクロを使用します。 別のデフォルトタブストップ集合を作りたい場合には、 .B TA マクロを再定義します。 .\" ----- .SS "ディスプレイとキープ" テキストベースの例や図 (コードリスト等) を印字するには、 ディスプレイを使用します。 ディスプレイはフィルをオフにしますので、各行の間に .B br リクエストを挿入せずにコードがそのまま印字されます。 ディスプレイは、単一ページ上に .I キープ することもできますし、ページをまたがった分割を許すこともできます。 .RS .ne 11 .na .TS cb s s s cbt s s cb s cb s ^ s s lfCW s lfCW s l s s. ディスプレイマクロ ディスプレイのタイプ キープ有 キープ無 _ \&.DS L \&.LD Left-justified. \&.DS I [\fIindent\fP] \&.ID T{ インデント付き (デフォルトのインデントは \fBDI\fP レジスタ値)。 T} \&.DS B \&.BD T{ ブロック中央寄せ (左寄せで、最長行が中央寄せされます)。 T} \&.DS C \&.CD 中央寄せ。 \&.DS R \&.RD 右寄せ。 _ .TE .RE .ad .LP ディスプレイタイプを終了するには .B DE マクロを使用します。 .PP 直後に続く表 (やリストや他の項目) を参照する段落等、テキストを同じページに .I キープ するには、 .B KS および .B KE のマクロを使用します。 .B KS マクロは、単一ページにキープされるべきテキストブロックを開始し、 .B KE マクロはそのブロックを終了します。 .PP .I "フローティングキープ" は、 .B KF および .B KE のマクロで指定可能です。 このキープが現在のページに入り切らない場合、 .I groff はキープの内容を保持し、(ソースファイル中で) キープに続くテキストで 現在のページの残りを埋めます。 改ページ時、すなわち明示的な .B bp リクエスト時もしくはページの終了時に、 .I groff は新規ページの先頭にフローティングキープを印字します。 指定したその場所に現れる必要が無い大きなグラフィックや表を 印字するときに有用です。 .\" ----- .SS "表、図、式、参照" .I -ms マクロは標準の .I groff プリプロセッサ .IR tbl , .IR pic , .IR eqn , .IR refer をサポートします。 プリプロセッサ用のテキストは、次のタグの組で括ってください: .TP .BR "\&.TS [H]" " と " \&.TE .I tbl プリプロセッサで処理されるべき表を表現します。 オプションの .B H 引数は、 .B TH マクロまでの情報を使用して、ランニングヘッダを作成すべきことを .I groff に指示します。 .I groff は表の先頭にヘッダを印字し、表が別のページにまたがるときには次ページにも .I groff はヘッダを印字します。 .TP .BR \&.PS " と " \&.PE .I pic プリプロセッサで処理されるべきグラフィックを表現します。 .I pic ファイルは、ウェブから入手可能な AT&T .I pic マニュアルを参考にして手動で作成できますし、 .IR xfig のようなグラフィックプログラムを使用して作成することも可能です。 .TP .BR "\&.EQ [\fI\,align\/\fP]" " と " \&.EN .I eqn プリプロセッサで処理されるべき式を表現します。 オプションの .I align 引数は、 .BR C , .BR L , .B I のいずれかであり、 式をそれぞれ中央寄せ (デフォルト)、左寄せ、インデントします。 .TP .BR \&.[ " と " \&.] .I refer プリプロセッサで処理されるべき参照を表現します。 GNU .IR refer (1) マニュアルページは、プリプロセッサの分かり易い参照と、 参考文献データベースの書式を解説しています。 .\" ----- .SS 脚注 .I ms -マクロは、柔軟な脚注システムを提供します +マクロは、柔軟な脚注システムを提供します。 数字付き脚注は、 .B \[rs]** エスケープに、 .B FS および .B FE のマクロに括られた脚注テキストを続けることで、指定可能です。 .PP シンボルの脚注は、印の文字 (例えば .B \[rs](dg はダガー文字) を本文に置き、これに続けて .B FS\ \[rs](dg および .B FE のマクロで括られた脚注テキストを続けることで、指定可能です。 .PP .I groff が脚注番号を印字する方法は、 .B FF レジスタを次のように変えることで、制御可能です: .RS .ne 7 .TP 0 脚注番号を上付き文字として印字し、脚注をインデントします (デフォルト)。 .TP 1 番号に続けてピリオドを印字し (例えば 1.)、脚注をインデントします。 .TP 2 1 に似ていますが、インデントしません。 .TP 3 1 に似ていますが、脚注番号をぶら下がり段落として印字します。 .LP .RE 脚注は、キープおよびディスプレイ中で安全に使用可能ですが、 フローティングキープ中では、番号付き脚注の使用は避けてください。 第 2 の .B \[rs]** を、 .B \[rs]** とこれに対応する .BR .FS の間に置けます。 ただし、各 .B .FS は対応する .B \[rs]** の後に置かれ、 .B .FS の登場順序は対応する .BR \[rs]** の登場順序と同じであることが必要です。 .\" ----- .SS "ヘッダとフッタ" ヘッダとフッタを定義する方法が 2 通りあります: .IP \(bu 3n 文字列 .BR LH , .BR CH , .B RH を使用して、左・中央・右のヘッダを設定します。 .BR LF , .BR CF , .B RF を使用して、左・中央・右のフッタを設定します。 奇数ページと偶数ページを区別しない文書で、もっとも良く動作します。 .IP \(bu .B OH と .B EH のマクロで、偶数ページと奇数ページのヘッダを定義します。 .B OF と .B EF のマクロで、偶数ページと奇数ページのフッタを定義します。 これは、個別の文字列を定義するより柔軟な方法です。 これらのマクロの構文は次の通りです: .RS .IP .BI "\&.OH '" left ' center ' right ' .RE .IP クォート (') は、ヘッダやフッタのテキストに登場しない 任意の文字に置き換え可能です。 .\" ----- .SS マージン マージンの制御は、数値レジスタを設定することで行います。 次の表は、レジスタ名とデフォルトを列挙します: .RS .ne 8 .na .TS cb s cb s s cb s cb s afCW s l s s l s l s. レジスタ 定義 効果対象 デフォルト _ PO T{ ページオフセット (左マージン) T} 次ページ 1i LL T{ 行長 T} 次段落 6i LT T{ ヘッダ/フッタ長 T} 次段落 6i HM T{ トップ (ヘッダ) マージン T} 次ページ 1i FM T{ ボトム (フッタ) マージン T} 次ページ 1i _ .TE .RE .ad .PP 右マージン設定が無いことに注意してください。 ページオフセットと行長の組み合わせが、右マージンを算出する情報を提供します。 .\" ----- .SS "複数カラム" .I ms マクロは、ページにうまく納めるように、テキストを複数カラムに植字可能です。 次のマクロが使用可能です。 複数カラムモードが既に設定済みの場合、これらは改ページを強制します。 しかしながら、現在のモードが単一カラムであり、複数カラムを開始する場合には、 改ページを強制 .I しません 。 .TP .B \&.1C 単一カラムモード。 .TP .B \&.2C 2 カラムモード。 .TP .BI "\&.MC [" width " [" gutter ]] 複数カラムモード。 引数を指定しない場合には、 .B 2C マクロと等価です。 そうでない場合、 .I width は、各カラムの幅であり、 .I gutter はカラム間の空間です。 .B MINGW 数値レジスタが、デフォルトのガター幅です。 .\" ----- .SS "目次の作成" 目次に登場させたいテキストを .B XS および .B XE のマクロで包んでください。 .B TC マクロは、目次を文書の最後に印字し、ページ番号を .B i (ローマ数字の 1) にリセットします。 .PP .BR XS の最初の引数としてページ番号を指定することで、目次を手動で作成可能です。 続くエントリを .B XA マクロを使用して追加してください。 例えば: .RS .PP .ne 8 .nf \&.XS 1 Introduction \&.XA 2 A Brief History of the Universe \&.XA 729 Details of Galactic Formation \&.\|.\|. \&.XE .fi .RE .LP ページ番号をリセットせずに、手動で生成された目次を印字するには、 .B PX マクロを使用してください。 .PP .B PX もしくは .BR TC に引数 .B no を指定すると、 .I groff は .B \[rs]*[TOC] 文字列で指定されたタイトルの印字を抑制します。 .\" ----- .SH "troff ms との違い" .I "groff ms" マクロは、完全な再実装であり、 元々の AT&T のコードは使用されていません。 .IR groff の拡張機能を使用していますので、これらは AT&T の .IR troff では使用できません。 他の違いは次の通りです: .IP \(bu 3n .I "groff ms" の内部は Unix .I ms の内部とは同じではありません。 したがって、Unix .I ms の実装の細部に依存する書式については .I "groff ms" で機能しないとしてももっともでしょう。 .IP \(bu エラー処理の方針については、 .I "groff ms" は、沈黙したままエラーを無視したりせず、エラーを検出してレポートします。 .IP \(bu Bell Labs 方言は実装されていません。 .IP \(bu Berkeley 方言、特に、 .B TM や .B CT マクロは、実装されていません。 .IP \(bu .I "groff ms" は、互換モードでは機能しません (例えば、 .B \-C オプションなど)。 .IP \(bu タイプライタ様のデバイスには、サポートはありません。 .IP \(bu .I "groff ms" では、カットマークは提供しません。 .IP \(bu 重複した行送りは許されません (代わりに、大きな垂直行送りを使用して下さい)。 .IP \(bu ある Unix .I ms の文書には、数値レジスタの .B CW と .B GW とが、それぞれカラム幅とガター幅 を制御する為に 使用できると述べられています。 これらの数値レジスタは、groff ms では使用されません。 .IP \(bu リセットを引き起こすマクロ (段落や見出し) はインデントを設定します。 インデントを変更するマクロはインデントを増減するのではなく、 むしろインデントを絶対的に設定します。 このことによって、独自のマクロを追加定義している文書に 問題が生じるかも知れません。 これを解決するには、 .B in リクエストを用いずに、代わりに .B RS や .B RE マクロを用いて下さい。 .IP \(bu 数値レジスタの .B GS は、 .I "groff ms" マクロによって 1 に設定されます。 しかし、この数値レジスタは Unix .I ms マクロでは使用されていません。 このレジスタの目的は、 Unix .I ms か .I "groff ms" かのどちらによってフォーマットされているのかを判定する 必要のある文書によって利用されることです。 .br .ne 22 .SS 文字列 次の文字列は、 .I "groff ms" マクロを英語以外の言語に適合させるために 再定義することができます: .TS center; cb cb afCW l . 文字列 デフォルト値 _ REFERENCES References ABSTRACT ABSTRACT TOC Table of Contents MONTH1 January MONTH2 February MONTH3 March MONTH4 April MONTH5 May MONTH6 June MONTH7 July MONTH8 August MONTH9 September MONTH10 October MONTH11 November MONTH12 December _ .TE .PP .B \[rs]*- 文字列は、em ダッシュを印字します \[em] こんな感じです。 .\" ----- .SS テキスト設定 .B FAM 文字列は、デフォルトのフォントファミリを設定します。 この文字列が初期化時に未定義の場合、Times に設定されます。 .LP 脚注のポイントサイズ、垂直行送り幅、そして段落間の行送り幅は、 数値レジスタの .BR FPS , .BR FVS , .B FPD で制御されます。 初期化時に、これらは、それぞれ .BR \[rs]n(PS-2 , .BR \[rs]n[FPS]+2 , .B \[rs]n(PD/2 に設定されます。 しかし、これらのレジスタのいずれかでも初期化前に定義されていれば、 初期化マクロはこれらを変更しません。 .LP .RB ( .hy リクエストによって設定される) ハイフネーションフラグは、 .B HY レジスタから取られて設定されます。 デフォルトは 14 です。 .PP (元々 Berkeley の .I ms バージョンで定義された) 進歩したアクセント記号は、文書の先頭で .B AM マクロを定義することで使用可能です。 対象となる文字の直後に、アクセントを定義する文字列を指定することで、 ほとんどの文字にアクセントを置けます。 例えば .B n\[rs]*~ は、n の上にチルダを置いたものを生成します。 .\" ----- .SH "命名規則" .LP 次のような命名規則が、マクロ、文字列そして数値レジスタに適用されています。 .I "groff ms" マクロを使用する文書に利用出来る外部名は、大文字と数字だけからなります。 .LP 内部的には、マクロはモジュールに分割されます。 命名規則は次の通りです: .IP \(bu 3n ある一つのモジュールの中だけで使用される名前は、 .IB \%module * name\fR という形をしています。 .IP \(bu 定義されているモジュールの外部で使用される名前は、 .IB \%module @ name\fR という形をしています。 .IP \(bu ある特別の環境に関わる名前は、 .IB \%environment : name という形をしています。 これらの名前は、 .B par モジュールの中でのみ使われます。 .IP \(bu .I name には、モジュールは接頭辞としてつきません。 .IP \(bu 組み合わされた名前で配列を実装するのに使われるものは、 .IB \%array ! index\fR という形をしています。 .PP 以上より groff ms では以下の名前を予約しています: .IP \(bu 3n .BR * , .BR @ , .BR : を含んでいる名前。 .IP \(bu 大文字と数字だけを含んでいる名前。 .SH 関連ファイル .B /usr/share/tmac/ms.tmac .RB ( s.tmac のラッパファイル) .br .B /usr/share/tmac/s.tmac .SH "関連項目" .BR groff (1), .BR troff (1), .BR tbl (1), .BR pic (1), .BR eqn (1), .BR refer (1), .I Groff: The GNU Implementation of troff by Trent Fisher and Werner Lemberg. .SH 作者 元々のマニュアルページを James Clark 等が記述しました。 Larry Kollar (\fIlkollar@despammed.com\fR) が書き直しました。 .\" Local Variables: .\" mode: nroff .\" End: diff --git a/ja_JP.eucJP/man/man8/bsdlabel.8 b/ja_JP.eucJP/man/man8/bsdlabel.8 index add2897f3a..515b7499fa 100644 --- a/ja_JP.eucJP/man/man8/bsdlabel.8 +++ b/ja_JP.eucJP/man/man8/bsdlabel.8 @@ -1,480 +1,480 @@ .\" Copyright (c) 1987, 1988, 1991, 1993 .\" The Regents of the University of California. All rights reserved. .\" .\" This code is derived from software contributed to Berkeley by .\" Symmetric Computer Systems. .\" .\" Redistribution and use in source and binary forms, with or without .\" modification, are permitted provided that the following conditions .\" are met: .\" 1. Redistributions of source code must retain the above copyright .\" notice, this list of conditions and the following disclaimer. .\" 2. Redistributions in binary form must reproduce the above copyright .\" notice, this list of conditions and the following disclaimer in the .\" documentation and/or other materials provided with the distribution. .\" 3. All advertising materials mentioning features or use of this software .\" must display the following acknowledgment: .\" This product includes software developed by the University of .\" California, Berkeley and its contributors. .\" 4. Neither the name of the University nor the names of its contributors .\" may be used to endorse or promote products derived from this software .\" without specific prior written permission. .\" .\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE .\" ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF .\" SUCH DAMAGE. .\" .\" @(#)disklabel.8 8.2 (Berkeley) 4/19/94 .\" %FreeBSD: src/sbin/bsdlabel/bsdlabel.8,v 1.55 2003/09/08 19:57:18 ru Exp % .\" .\" $FreeBSD$ .\" .Dd March 15, 2003 .Dt BSDLABEL 8 .Os .Sh 名称 .Nm bsdlabel .Nd ディスクラベルの読み書きを行う .Sh 書式 .Nm .Op Fl A .Ar disk .Nm .Fl w .Op Fl \&An .Op Fl B Op Fl b Ar boot .Op Fl m Ar machine .Ar disk .Op Ar type .Nm .Fl e .Op Fl \&An .Op Fl B Op Fl b Ar boot .Op Fl m Ar machine .Ar disk .Nm .Fl R .Op Fl \&An .Op Fl B Op Fl b Ar boot .Op Fl m Ar machine .Ar disk protofile .Sh 解説 .Nm ユーティリティは、ディスクパーティション上に .Bx ラベルを 書きこんだり、確認したり、修正したりするために使われます。 また .Nm は同時にブートストラップコードを インストールすることもできます。 .Ss ディスクデバイス名 デバイス指定時には、 .Pa /dev/ のパスプレフィックスは省略可能です。 .Nm ユーティリティは自動的にこれを前に付けます。 .Ss 一般的なオプション .Fl A オプションをつけると、 .Bx ラベルの中で歴史的な理由で残っている部分を 処理できるようになります。このオプションを与えない場合、これらの フィールドには適切な値が設定されます。 .Pp .Fl n オプションは、ディスクが変更される直前で .Nm の実行を止め、実行結果をディスクに書きこまずに表示します。 .Pp .Fl m Ar machine 引数は、指定されたマシンに合ったレイアウトを使うように .Nm に指示を行います。 .Ss ディスクラベルの読み込み ディスクドライブ上のラベルを確認するためには オプションを指定せずに .Nm を使用します。 .Pp .Nm .Op Fl A .Op Fl m Ar machine .Ar disk .Pp .Ar disk は対象とするディスクを示します。 また .Pa da0 や .Pa /dev/da0 のような書式でも指定することができます。 これによってパーティションのレイアウトを表示します。 .Ss 標準的なラベルの書き込み 標準的なラベルを書き込むには、 以下の書式を使います。 .Pp .Nm .Fl w .Op Fl \&An .Op Fl m Ar machine .Ar disk .Op Ar type .Pp ドライブの種類が指定されている場合、 .Xr disktab 5 ファイル内の同名のエントリが使用され、 指定されていない場合はデフォルトのレイアウトが使われます。 .Ss 既存のディスクラベルの編集 既存のディスクラベルを編集するには、 以下の書式を使います。 .Pp .Nm .Fl e .Op Fl \&An .Op Fl m Ar machine .Ar disk .Pp このコマンドは、デフォルトのエディタでディスクラベルをオープンし、 エディタ終了時にディスクラベルを検証し、正しければそれをディスクに 書きこみます。 .Ss ファイルからのディスクラベルの復元 .Pp ファイルからディスクラベルを復元するには、 以下の書式を使います。 .Pp .Nm .Fl R .Op Fl \&An .Op Fl m Ar machine .Ar disk protofile .Pp .Nm は以前の操作により .Tn ASCII フォーマットのファイルに保存されたディスクラベル を復元することができます。 ラベルを作成するときに使われるプロトタイプファイルは、ラベルを読み込んだり 編集したりするときのものと同じフォーマットである必要があります。 コメントは .Ql # と改行で区切られます。 .Ss ブートストラップのインストール .Fl B 引数が指定された場合、ブートストラップコードが .Pa /boot/boot から読みこまれ、それがディスクに書きこまれます。 .Fl b Ar boot 引数を用いると、別のファイルが使用できます。 .Sh 関連ファイル .Bl -tag -width ".Pa /etc/disktab" -compact .It Pa /boot/boot デフォルトのブートイメージ .It Pa /etc/disktab ディスクを説明したファイル .El .Sh 保存されたファイルの書式 .Nm ユーティリティは、 ディスクラベルを確認、編集、または復元する際に .Tn ASCII 形式のラベルを使用します。 フォーマットは以下のとおりです。 .Bd -literal -offset 4n 8 partitions: # size offset fstype [fsize bsize bps/cpg] a: 81920 0 4.2BSD 1024 8192 16 b: 160000 81920 swap c: 1173930 0 unused 0 0 # "raw" part, don't edit .Ed .Pp .Fl A オプションが指定されている場合、フォーマットは次のようになります: .Bd -literal -offset 4n # /dev/da1c: type: SCSI disk: da0s1 label: flags: bytes/sector: 512 sectors/track: 51 tracks/cylinder: 19 sectors/cylinder: 969 cylinders: 1211 sectors/unit: 1173930 rpm: 3600 interleave: 1 trackskew: 0 cylinderskew: 0 headswitch: 0 # milliseconds track-to-track seek: 0 # milliseconds drivedata: 0 8 partitions: # size offset fstype [fsize bsize bps/cpg] a: 81920 0 4.2BSD 1024 8192 16 b: 160000 81920 swap c: 1173930 0 unused 0 0 # "raw" part, don't edit .Ed .Pp .Ql # で始まる行はコメントです。 .Pp パーティションテーブルは 8 つまでエントリを持つことができ、 以下の情報を含みます: .Bl -tag -width indent .It Ar # パーティションの識別子は .Ql a から .Ql h の 1 文字です。 慣例的な理由により、 .Ql c パーティションは ディスク全体を表すために予約されています。 .It Ar size セクタ単位でのパーティションの大きさです。 .Cm K (キロバイト - 1024), .Cm M (メガバイト - 1024*1024), .Cm G (ギガバイト - 1024*1024*1024), .Cm % ( .Ql c 以外の固定長のパーティションを取り除いた .Em 後の 空間に対するパーセント)か、 .Cm * (固定長のパーティションとパーセント指定のパーティションを取り除いた .Em 後の 空間すべて)。 パーティション .Ql c に対して .Cm * -を指定すると、ディスク全体を意味します +を指定すると、ディスク全体を意味します。 小文字の .Cm K , M , .Cm G も許されます。 大きさと型の間には空白を入れてはなりません。 .Pp 例: 2097152, 1G, 1024M, 1048576K はすべて同じ大きさです (512 バイトセクタを仮定)。 .It Ar offset ドライブの先頭からパーティションの開始位置までのオフセット値 (セクタ単位)です。 .Cm * は、使用すべき正しいオフセット (直前のパーティションの終端に 1 を加えたもの) を、 .Nm に計算させます。ただしパーティション .Ql c は無視します。 パーティション .Ql c に対しては、 .Cm * はオフセット 0 と解釈されます。 .It Ar fstype パーティションの使用目的を表します。 例では現在使用されているパーティション型を示します。 .Tn UFS ファイルシステムおよび .Xr ccd 4 では .Cm 4.2BSD が使われます。 Vinum ドライブでは .Cm vinum が使われます。 他の一般的な型は .Cm swap と .Cm unused です。 取り決めでは、パーティション .Ql c はスライス全体を表し、型 .Cm unused であるべきですが、 .Nm はこの取り決めを強制しません。 .Nm ユーティリティは多くの他のパーティション型を知っていますが、 それらは現在使用されていません。 (詳細は、 .In sys/disklabel.h ファイルで .Dv FS_UNUSED で始まっている定義を参照してください。 .It Ar fsize .Cm 4.2BSD と .Tn LFS のファイルシステムに対してのみ有効です。 フラグメントの大きさを意味します。 1 GB 未満のパーティションに対するデフォルトは 1024 で、 1 GB 以上に対するデフォルトは 4096 です。 .It Ar bsize .Cm 4.2BSD と .Tn LFS のファイルシステムに対してのみ有効です。 ブロックの大きさを意味します。 1 GB 未満のパーティションに対するデフォルトは 8192 で、 1 GB 以上に対するデフォルトは 16384 です。 .It Ar bps/cpg .Cm 4.2BSD ファイルシステムに対しては、 シリンダグループ中のシリンダ数を意味します。 .Tn LFS ファイルシステムに対しては、 セグメントシフト値を意味します。 1 GB 未満のパーティションに対するデフォルトは 16 で、 1 GB 以上に対するデフォルトは 64 です。 .El .Sh 使用例 .Dl "bsdlabel da0s1" .Pp .Pa da0 の最初のスライス用に、 .Pa /dev/da0s1 から得たものとしてラベルを表示します .Pp .Dl "bsdlabel da0s1 > savedlabel" .Pp .Pa da0s1 に対する カーネル内のコピーをファイルに .Pa savedlabel に保存します。 このファイルは後で .Fl R オプションを用いてラベルを復元する際に使用できます。 .Pp .Dl "bsdlabel -w /dev/da0s1" .Pp .Pa da0s1 のラベルを作成します。 .Pp .Dl "bsdlabel -e da0s1" .Pp .Pa da0s1 のラベルを読み込み、編集し、その結果を書き込みます。 .Pp .Dl "bsdlabel -e -n da0s1" .Pp .Pa da0s1 のディスク上のラベルを読み、編集し、新規ラベルがどのようになるかを (セクタ単位で) 表示します。 新規ラベルは、メモリにもディスクにもインストール .Em しません 。 .Pp .Dl "bsdlabel -w da0s1" .Pp .Pa da0s1 にデフォルトのラベルを書きこみます。 パーティション情報やファイルシステム情報を編集するには、 この後で .Nm Fl e コマンドを使って下さい。 .Pp .Dl "bsdlabel -R da0s1 savedlabel" .Pp .Pa savedlabel に書かれている情報を .Pa da0s1 のラベルとして書き込みます。 ディスク上のラベルとともにカーネル内コピーも書き換えられます。 .Pp .Dl "bsdlabel -R -n da0s1 label_layout" .Pp パーティションレイアウト .Pa label_layout を使用すると、 .Pa da0s1 のラベルがどのようになるかを表示します。 .Cm % と .Cm * に基くパーティションの大きさ指定を使用するラベル方式を使用した場合に、 各パーティションにどれだけ割り当てられるかを判定するのに有用です。 .Pp .Dl "bsdlabel -B da0s1" .Pp .Pa da0s1 に新たにブートストラップコードを書き込みます. ブートストラップコードは .Pa /boot/boot です。 .Pp .Dl "bsdlabel -w -B -b newboot /dev/da0s1" .Pp 新たなラベルとブートストラップコードを書き込みます。 ブートストラップコードは カレントディレクトリにある .Pa newboot です。 .Bd -literal -offset indent dd if=/dev/zero of=/dev/da0 bs=512 count=32 fdisk -BI da0 dd if=/dev/zero of=/dev/da0s1 bs=512 count=32 bsdlabel -w -B da0s1 bsdlabel -e da0s1 .Ed .Pp ディスク上の既存の情報を完全に削除し、 ディスク全体を覆う 1 つのスライスを含んだ .Tn DOS パーティションテーブル付きの ブート可能ディスクを新規に作成します。 次にスライスを初期化し、編集します。 .Pa dd はオプションですが、 .Tn BIOS によっては正しくディスクを認識するために必要です。 .Pp これは、 .Cm % , M , G , .Cm * といった新規パーティションサイズ型を使用する、ディスクラベルの例です。 次のコマンドラインのソースファイルとして使用可能です: .Dq Li "bsdlabel -R ad0s1c new_label_file" .Bd -literal -offset 4n # /dev/ad0s1c: 8 partitions: # size offset fstype [fsize bsize bps/cpg] a: 400M 0 4.2BSD 4096 16384 75 # (Cyl. 0 - 812*) b: 1G * swap c: * * unused e: 204800 * 4.2BSD f: 5g * 4.2BSD g: * * 4.2BSD .Ed .Sh 関連項目 .Xr ccd 4 , .Xr geom 4 , .Xr md 4 , .\" Xr bsdlabel 5 , .Xr disktab 5 , .Xr boot0cfg 8 , .Xr fdisk 8 .Sh 診断 デバイスドライバは、 オープンされているパーティションに関して、 サイズが小さくなることおよびオフセットが変化することを許しません。 diff --git a/ja_JP.eucJP/man/man8/newsyslog.8 b/ja_JP.eucJP/man/man8/newsyslog.8 index 68ebd5983a..d05be8f1e2 100644 --- a/ja_JP.eucJP/man/man8/newsyslog.8 +++ b/ja_JP.eucJP/man/man8/newsyslog.8 @@ -1,509 +1,509 @@ .\" This file contains changes from the Open Software Foundation. .\" .\" from: @(#)newsyslog.8 .\" %FreeBSD: src/usr.sbin/newsyslog/newsyslog.8,v 1.42 2003/04/27 23:37:31 gad Exp % .\" .\" Copyright 1988, 1989 by the Massachusetts Institute of Technology .\" .\" Permission to use, copy, modify, and distribute this software .\" and its documentation for any purpose and without fee is .\" hereby granted, provided that the above copyright notice .\" appear in all copies and that both that copyright notice and .\" this permission notice appear in supporting documentation, .\" and that the names of M.I.T. and the M.I.T. S.I.P.B. not be .\" used in advertising or publicity pertaining to distribution .\" of the software without specific, written prior permission. .\" M.I.T. and the M.I.T. S.I.P.B. make no representations about .\" the suitability of this software for any purpose. It is .\" provided "as is" without express or implied warranty. .\" .\" $FreeBSD$ .\" .Dd April 27, 2003 .Dt NEWSYSLOG 8 .Os .Sh 名称 .Nm newsyslog .Nd システムのログファイルを保守し、適切なサイズに保つ .Sh 書式 .Nm .Op Fl CFnrsv .Op Fl R Ar tagname .Op Fl a Ar directory .Op Fl f Ar config_file .Op Ar .Sh 解説 .Nm ユーティリティは .Xr cron 8 から定期的に実行されるようにスケジュールされるべきプログラムです。 実行されると、 .Nm は必要に応じてログファイルを保存 (アーカイブ) します。 あるログファイルを保存する必要があると判断すると、 .Dq Va logfile が空になり、 .Dq Va logfile Ns Li \&.0 に前回のログファイルが入り、 .Dq Va logfile Ns Li \&.1 に前々回のログが入り‥‥ といった具合に、 ユーザが指定した数の保存ログが残るよう、 .Nm はファイルを再編します。 オプションにより、保存ログを圧縮してスペースを節約することもできます。 .Pp ログが保存されるのは次の 3 つの場合です: .Bl -enum -offset indent .It ログが設定サイズ (キロバイト単位で指定) より大きくなった。 .It 前回ログを保存してから指定した時間が経過した。 .It ログ入れ替えを行う指定時間になった。 .El .Pp .Nm の粒度は、このコマンドが .Xr cron 8 からどの程度の頻度で実行されるかに依存しています。 .Nm の実行は十分速いので、毎時間実行するようにスケジュールしても 悪影響はありませんし、 第 3 のモード (前述) はそうなっていることを仮定しています。 .Pp 起動されると、 .Nm は設定ファイルを読み込んで、 どのログファイルが潜在的に保存されうるかを決定します。 デフォルトでは、この設定ファイルは .Pa /etc/newsyslog.conf です。 設定ファイルの各行には、 .Nm が処理すべき特定のログファイルに関する情報を記述します。 各行は 5 つの必須フィールドと、4 つのオプションフィールドからなり、 それらは空白で区切られています。 空行や ``#'' で始まる行は無視されます。 ``#'' が行の途中にある場合、 ``#'' 文字とこの後の行の残りは無視されます。 この特殊な意味を避けるために、``#'' を ``\\'' でエスケープ可能です。 この場合、前の ``\\'' は削除され、``#'' は通常文字として扱われます。 設定ファイルの各フィールドは以下の通りです: .Pp .Bl -tag -width indent .It Ar logfile_name 保存するシステムログファイル名か、リテラル文字列の ``'' です。 特別なデフォルトエントリが使用されるのは、 .Nm コマンドのコマンドライン上でログファイル名が与えられ、 このログファイル名が設定ファイル注の他のどの行ともマッチしない場合だけです。 .It Ar owner : Ns Ar group このフィールドはオプションであり、 保存ファイルの所有者とグループ名を指定します。 .Ar owner あるいは .Ar group が空白のままである場合でも ":" は必須です。 指定は数値、あるいは .Pa /etc/passwd か .Pa /etc/group にある名前で行います。 .It Ar mode ログファイルと保存ログファイルのモードを指定します。 .It Ar count ログファイルそのものに加えて保存しておく保存ファイルの数を指定します。 .It Ar size ログファイルのサイズが .Ar size キロバイトに達すると、ログファイルは上記のように入れ換えられます。 このフィールドがアスタリスク .Pq Ql \&* で置き換えられると、ログファイル入れ換えに際して そのサイズは考慮されなくなります。 .It Ar when .Ar when フィールドは、インターバル、特定の時刻、もしくは両方です。 .Ar when フィールドがアスタリスク .Pq Ql \&* の場合、ログ入れ替えは .Ar size フィールドにのみ依存します。 そうでない場合、 .Ar when フィールドは、オプションの、時間単位のインターバルからなります。 これに続けて、単一の .So Li \&@ Sc 記号と制限された .Tn ISO 8601 フォーマットで時刻を指定することもできますし、単一の .So Li \&$ Sc 記号と時刻を指定し、日に 1 回か週に 1 回か月に 1 回の決まった時刻に ログファイルを入れ替えるように指定することもできます。 .Pp 時刻を指定すると、指定した時刻の 1 時間以内に .Nm が実行された場合のみ、ログファイルを入れ替えます。 インターバル時間が指定された場合、 最後の入れ替えからその時間数が経過した場合に、ログファイルを入れ替えます。 時刻とインターバルの両方が指定された場合、入れ替えが実行されるには、 両方の条件が満たされることが必要です。 .Pp タイムゾーンは指定できません。 現在の実装では、明確に分や秒の部分を指定することは、ほとんどできません。 「1 時間以内」であることのみ、比較するからです。 .Pp .Sy ISO 8601 制限付時刻フォーマット .Pp 制限付 .Tn ISO 8601 時刻の先行文字は .So Li \&@ Sc 記号です。制約付 .Tn ISO 8601 フォーマットでの特定の時刻の指定は次の通りです: .Sm off .Oo .Oo .Oo .Oo .Oo .Va \&cc .Oc .Va \&yy .Oc .Va \&mm .Oc .Va \&dd .Oc .Oo .Li \&T .Oo .Va \&hh .Oo .Va \&mm .Oo .Va \&ss .Oc .Oc .Oc .Oc .Oc です。 .Sm on 日付フィールドはオプションであり、デフォルトは現在の日付です。 時刻フィールドはオプションであり、デフォルトは午前 0 時です。 よって、今日が 1999 年 1 月 22 日の場合、次の日付指定はすべて同等です: .Pp .Bl -item -compact -offset indent .It .Sq Li 19990122T000000 .It .Sq Li 990122T000000 .It .Sq Li 0122T000000 .It .Sq Li 22T000000 .It .Sq Li T000000 .It .Sq Li T0000 .It .Sq Li T00 .It .Sq Li 22T .It .Sq Li \&T .It .Sq Li \& .El .Pp .Sy 日・週・月の時刻フォーマット .Pp 日・週・月の時刻フォーマットの先行文字は .So Li \&$ Sc 記号です。 日・週・月の指定の特定のフォーマットはそれぞれ次の通りです: .Op Va D\&hh , .Op Va W\&w Ns Op Va D\&hh , .Op Va M\&dd Ns Op Va D\&hh 。 オプションの時刻フィールドのデフォルトは、午前 0 時です。 日と時間の指定の範囲は次の通りです: .Pp .Bl -tag -width Ds -compact -offset indent .It Ar hh 時間であり、0 から 23 の範囲 .It Ar w 曜日であり、0 から 6 の範囲で、0 が日曜日 .It Ar dd 日であり、1 から 31 の範囲か、最終日を指定するための文字 .Em L または .Em l .El .Pp 以下に例を示します: .Pp .Bl -tag -width Ds -compact -offset indent .It Ar $D0 毎晩午前 0 時に入れ替えます .Ar ( @T00 と同じです) .It Ar $D23 毎晩 23:00 に入れ替えます .Ar ( @T23 と同じです) .It Ar $W0D23 毎週日曜日の 23:00 に入れ替えます .It Ar $W5D16 毎週金曜日の 16:00 に入れ替えます .It Ar $M1D0 毎月最初の日の午前 0 時に入れ替えます (その日の開始時点です; .Ar @01T00 と同じです) .It Ar $M5D6 毎月 5 日の 6:00 に入れ替えます .Ar ( @05T06 と同じです) .El .It Ar flags このオプションフィールドは 1 つ以上の文字からなり、 この行にマッチするログファイルに対して行われる特殊処理を指定します。 次の正当なフラグがあります: .Bl -tag -width indent .It Sy B ファイルがバイナリファイルまたは特殊フォーマットであることを指示します。 通常、 .Nm はログファイルが入れ換えるときに .Tn ASCII メッセージをログファイルに挿入し、 何時そして時には何故ログが入れ換えられたかを示します .Sy B が指定された場合、この情報メッセージはログファイルへ挿入されません。 .It Sy C ログファイルが存在せず、かつ .Fl C オプションがコマンドラインに指定されていた場合、 ログファイルが作成されるべきことを指示します。 .It Sy G 指定した .Ar logfile_name がシェルパターンであることを示し、 このパターンにマッチする全ファイル名を .Nm がアーカイブすることを意味します。 文法とマッチ規則についての詳細は、 .Xr glob 3 を参照してください。 .It Sy J スペース節約のために、保存ファイルの .Xr bzip2 1 での圧縮を試みるべきことを .Nm へ指示します。 .It Sy N このログファイルを入れ替えるときに、 通知されるべきプロセスが存在しないことを示します。 .It Sy U .Ar path_to_pid_file で示されるファイルが、プロセス ID ではなくプロセスグループ ID を 含むことを指示します。 このオプションは、そのファイル中の最初の行が負数であり、 プロセス ID と区別できるようになっていることを必要とします。 .It Sy W .Sy Z や .Sy J フラグと組み合わせて使用すると、本エントリに対する新規ジョブの前に、 直前に開始した圧縮ジョブの完了を .Nm が待つべきことを示します。 .Sy G フラグと組み合わせて使用すると、 パターンに複数のログファイルがマッチし、これらが圧縮される場合、 .Nm が同時には 1 個の圧縮しか実行しないことを保証します。 これは、同時には 1 個の圧縮ジョブしか走行しないことを保証します。 .It Sy Z スペース節約のために、保存ファイルの .Xr gzip 1 での圧縮を試みるべきことを .Nm へ指示します。 .It Sy - マイナス記号は何も特別な処理を引き起こしませんが、後続フィールド指定時に、 .Ar flags フィールドの埋め草として使用可能です。 .El .Pp .It Ar path_to_pid_file このオプションのフィールドは、 デーモンのプロセス ID、または .Sy U フラグ指定時にはデーモンのプロセスグループ ID を調べるために 読むファイルを指定します。 このフィールドが存在する場合、 このファイルに書かれたプロセス ID に .Ar signal_number が送られます。 このフィールドが存在しない場合、 .Sy N 指定時を除き、SIGHUP シグナルが .Xr syslogd 8 へ送られます。 正しく認識するために、このフィールドは "/" から開始する必要があります。 .It Ar signal_number このオプションフィールドは、 デーモンプロセスに送られるシグナル番号を指定します。 デフォルトで SIGHUP が送られます。 .El .Sh オプション .Nm では以下のオプションが利用できます: .Bl -tag -width indent .It Fl f Ar config_file 設定ファイルとして .Pa /etc/newsyslog.conf に代えて .Ar config_file を使用します。 .It Fl a Ar directory アーカイブしたログファイルを書き込む .Ar directory を指定します。 相対パスを指定した場合、 これを各ログファイルのパスに後置したディレクトリに、 このログファイルのアーカイブログを書き込みます。 絶対パスを指定した場合、 すべてのアーカイブログは指定した .Ar directory に書き込まれます。 パス .Ar directory のコンポーネントが存在しない場合、 .Nm が実行されるときに生成されます。 .It Fl v .Nm を詳細情報出力モードにします。 このモードでは、ログを入れ換えるあるいはそれをスキップするたびに、 そのログファイル名と理由を表示します。 .It Fl n 実際にログの入れ換えは行わず、このオプションが指定されない場合に 本来行うはずの処理内容を表示します。 .It Fl r .Nm は root として動作しなければならない、という制約を取り除きます。 もちろん、 .Nm は .Xr syslogd 8 に HUP シグナルを送れなくなりますから、 このオプションはデバッグにのみ用いるべきです。 .It Fl s ログファイル入れ替え時に通常は送っていたはずの デーモンプロセスへのシグナルを、一切送らないようにします。 入れ替えられるログファイルにとっては、 このオプションは通常次の意味も持ちます。 すなわち、このオプションが無かった場合に通知されるデーモンがいる場合 には、入れ替えられたログファイルは圧縮されないという意味です。 しかしながら、本オプションがもっとも有用なのはおそらく .Fl R オプションと共に指定された場合であり、この場合圧縮は行われます。 .It Fl C 1 回指定すると、存在しないが設定ファイルに .Sy C が指定されているログファイルを .Nm は作成します。 複数回指定すると、 .Nm は存在しないファイルをすべて作成します。 ログファイルがコマンドライン上に指定されると、 .Fl C もしくは .Fl CC は、これらのログファイルにのみ適用されます。 .It Fl F ログを入れ替える条件に合致しないとしても、強制的に .Nm にログを入れ替えさせます。 システムの問題を診断しているときには、 このオプションの使用により、 問題のみを含む新しいログを提供できるので有用です。 .It Fl R Ar tagname 入れ換え条件が成立していなくても、 .Nm が指定されたリストのファイルを入れ替えるべきことを指示します。 .Ar tagname は、入れ替えられるログファイルに書き込まれるメッセージにのみ使用されます。 これが .Fl F オプションと違うのは、ひとつ以上のファイルを指定する必要があり、 .Nm がこれらの指定されたファイルに対してのみ動作するという点です。 このオプションの主たる目的は、 複数のログファイルを書くデーモンやプログラムで、 それら自身の条件で入れ替えを引き起こしたいもののために使用することです。 このオプションを使用すると、入れ替えたいときにそれらは .Nm を実行でき、またシステム管理者が依然として入れ換え規則 (バックアップ保存数や圧縮の種類等) を指定可能とします。 デーモンが .Nm を .Fl R オプション付きで呼び出すとき、 .Nm の呼び出し前にそのデーモンは全ログファイルがクローズされていることを 保証することと、 .Nm -が戻った後にログファイルをリオープンすることが必要です +が戻った後にログファイルをリオープンすることが必要です。 通常、呼び出しプロセスは .Fl s オプションも指定したいでしょうから、入れ替えを強制したプロセス自身には .Nm はシグナルを送らないでしょう。 シグナル処理を行わないということは、 .Nm は通常シグナル送信後に数秒待ちますので、 .Nm は高速に戻ることを意味します。 .El .Pp 追加のコマンド行引数を指定すると、 .Nm はこれらの引数にマッチするログファイルのみを検査します。 そうでない場合、設定ファイルに列挙された全ファイルを検査します。 .Sh 関連ファイル .Bl -tag -width /etc/newsyslog.confxxxx -compact .It Pa /etc/newsyslog.conf .Nm の設定ファイル .El .Sh バグ セキュリティ侵害を見つけるためにログを自動的に読むことは、 まだ行っていません。 .Sh 作者 .An Theodore Ts'o , MIT Project Athena .Pp Copyright 1987, Massachusetts Institute of Technology .Sh 互換性 以前のバージョンの .Nm ユーティリティは、グループ名の識別にドット (``.'') を使用していました。 .Fx 3.3 からは、これはコロン (``:'') 文字になりましたので、 ユーザ名とグループ名にドット文字を含めることが可能です。 後方互換性のために、ドット (``.'') 文字はまだ受け付けられます。 .Sh 関連項目 .Xr gzip 1 , .Xr syslog 3 , .Xr chown 8 , .Xr syslogd 8 diff --git a/ja_JP.eucJP/man/man9/devstat.9 b/ja_JP.eucJP/man/man9/devstat.9 index 2daae7fc73..53d09e96a1 100644 --- a/ja_JP.eucJP/man/man9/devstat.9 +++ b/ja_JP.eucJP/man/man9/devstat.9 @@ -1,439 +1,439 @@ .\" .\" Copyright (c) 1998, 1999 Kenneth D. Merry. .\" All rights reserved. .\" .\" Redistribution and use in source and binary forms, with or without .\" modification, are permitted provided that the following conditions .\" are met: .\" 1. Redistributions of source code must retain the above copyright .\" notice, this list of conditions and the following disclaimer. .\" 2. Redistributions in binary form must reproduce the above copyright .\" notice, this list of conditions and the following disclaimer in the .\" documentation and/or other materials provided with the distribution. .\" 3. The name of the author may not be used to endorse or promote products .\" derived from this software without specific prior written permission. .\" .\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE .\" ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF .\" SUCH DAMAGE. .\" .\" %FreeBSD: src/share/man/man9/devstat.9,v 1.20 2003/10/23 01:54:06 hmp Exp % .\" .\" $FreeBSD$ .Dd May 22, 1998 .Dt DEVSTAT 9 .Os .Sh 名称 .Nm devstat , .Nm devstat_add_entry , .Nm devstat_end_transaction , .Nm devstat_end_transaction_bio , .Nm devstat_remove_entry , .Nm devstat_start_transaction .Nd デバイス統計の記録のためのカーネルインタフェース .Sh 書式 .In sys/devicestat.h .Ft void .Fo devstat_add_entry .Fa "struct devstat *ds" .Fa "const char *dev_name" .Fa "int unit_number" .Fa "u_int32_t block_size" .Fa "devstat_support_flags flags" .Fa "devstat_type_flags device_type" .Fa "devstat_priority priority" .Fc .Ft void .Fn devstat_remove_entry "struct devstat *ds" .Ft void .Fn devstat_start_transaction "struct devstat *ds" .Ft void .Fo devstat_end_transaction .Fa "struct devstat *ds" .Fa "u_int32_t bytes" .Fa "devstat_tag_type tag_type" .Fa "devstat_trans_flags flags" .Fc .Ft void .Fo devstat_end_transaction_bio .Fa "struct devstat *ds" .Fa "struct bio *bp" .Fc .Sh 解説 devstat サブシステムは、その名称が暗示する様に、 デバイス統計を記録するためのインタフェースです。 この目的は、適度に詳細な統計情報を記録しつつ、 記録に使用する CPU 時間を最小とするというものです。 従って、 .Nm のコードのカーネル内の部分では、実際の統計的な計算は行なわれていません。 代わりに、これはユーザプログラムが取り扱うように残されています。 .Pp .Fn devstat_add_entry は .Nm サブシステムにデバイスを登録します。 呼び出し側はこの関数の呼び出しの前に、既に割当てられ \fB0 でクリア された\fR devstat 構造体を持っていることを期待されています。 .Fn devstat_add_entry は幾つかの引数を取ります。 .Bl -tag -width device_type .It ds クライアントによって割当てられ 0 でクリアされた、 .Va devstat 構造体です。 .It dev_name デバイスの名前です。 例えば da, cd, sa です。 .It unit_number デバイスユニット番号です。 .It block_size サポートされている場合には、デバイスのブロックサイズです。 デバイスがブロックサイズをサポートしていない場合、または .Nm リストにそのデバイスが追加される時点ではブロックサイズが判っていない場合には、 0 に設定されるべきです。 .It flags デバイスによって操作がサポートされているかサポートされていないかを示す フラグです。 詳細は以下を参照してください。 .It device_type デバイスの型です。 これは 3 つの部分、基本的なデバイスの型 (例えば、直接アクセス、CDROM、 順次アクセス)、インタフェースの型 (IDE, SCSI またはその他) および 通過するデバイスを示すためのパススルーフラグに、分割されます。 完全な型のリストは以下を参照してください。 .It priority デバイスの優先度です。 優先度はデバイスの .Nm devstat リストの中でどのようにデバイスを並び替えるかを決定するために使用されます。 デバイスは最初に優先度 (高い方から低い方) によって、 それからアタッチされた順番によって並び替えられます。 利用可能な優先度の完全なリストは以下を参照してください。 .El .Pp .Fn devstat_remove_entry は .Nm サブシステムからデバイスを削除します。 これは引数として当のデバイスの devstat 構造体を取ります。 .Nm 世代番号は増やされデバイスの数は減らされます。 .Pp .Fn devstat_start_transaction は .Nm サブシステムに処理の開始を登録します。 個々の処理の開始でビジーカウントが増やされます。 デバイスがアイドルからビジーに移ったときには、システム uptime が .Va devstat 構造体の .Va start_time フィールドに記録されます。 .Pp .Fn devstat_end_transaction は .Nm サブシステムに処理の終了を登録します。 これは 4 つの引数を取ります。 .Bl -tag -width tag_type .It ds 当のデバイスのための .Va devstat 構造体です。 .It bytes この処理で転送されたバイト数です。 .It tag_type 処理のタグの型です。 タグの型は以下を参照してください。 .It flags その処理が読込みだったのか、書込みだったのか、 または転送されたデータがなかったのかを示す処理フラグです。 .El .Pp .Fn devstat_end_transaction_bio は、biodone() の準備が整っている .Va "struct bio" からすべての情報を引き出すための、 .Fn devstat_end_transaction のためのラッパです。 .Pp .Va devstat 構造体は以下のフィールドで構成されています。 .Bl -tag -width dev_creation_time .It dev_links 個々の .Va devstat は登録されたときにリンクされたリストに置かれます。 .Va dev_links フィールドには .Va devstat 構造体のリストの中の次のエントリへのポインタが入ります。 .It device_number デバイス番号は、個々のデバイスのための一意な識別子です。 デバイス番号は、個々の新しいデバイスが登録されるごとに増やされます。 現在はデバイス番号は単なる 32 ビット整数ですが、40 億個を超える デバイス到着イベントを持つシステムがあれば、拡張するかもしれません。 .It device_name デバイス名称はドライバ登録によって与えられる文字列であり、 自分自身を識別するために使用できます。 (例えば .Dq da , .Dq cd , .Dq sa , など)。 .It unit_number ユニット番号は当の周辺装置のドライバ特有の実体を識別します。 .It bytes_written これはそのデバイスに既に書込まれたバイト数です。 この数は現在は符号なし 64 ビット整数です。 32 ビットの整数を使った場合にはシステムによってはすぐにカウンタが 一回りしてしまうという問題を、これにより回避できると期待しています。 .It bytes_read これはそのデバイスから既に読込まれたバイト数です。 .It bytes_freed これはそのデバイス上の既に解放/消去されたバイト数です。 .It num_reads これはそのデバイスからの読込み回数です。 .It num_writes これはそのデバイスへの書込み回数です。 .It num_frees これはそのデバイス上の解放/消去操作の回数です。 .It num_other これはそのデバイスへの読込みでも書込みでもない処理の回数です。 例えば、 .Tn SCSI ドライバはしばしばテストユニットレディコマンドを .Tn SCSI デバイスに送ります。 そのテストユニットレディコマンドはデータを全く読込みまたは書込みません。 これは単にその状態を返させるだけにすぎません。 .It busy_count これはそのデバイスのための現在未解決の処理の数です。 これは 0 を決して下回るべきではなく、アイドルのデバイスでは 0 になるべきです。 これらの状態のいずれかが真でない場合には、クライアントのコードの .Fn devstat_start_transaction と .Fn devstat_end_transaction の呼び出し方に問題があることを示しています。 個々の処理にはただ 1 つの処理開始イベントがあるべきであり、 各処理に対して 1 つの処理終了イベントがあるべきです。 .It block_size そのデバイスがブロックサイズを持っている場合には、 これはそのデバイスのブロックサイズです。 .It tag_types これはデバイスに送られた様々なタグの型の数を記録するための カウンタの配列です。 タグの型のリストは以下を参照してください。 .It dev_creation_time これはそのデバイスが登録されたときの .Fn getmicrotime によって報告される時間です .It busy_time これは、デバイスのビジーカウントが 0 より大きかった時間の量です。 これはビジーカウントが 0 に戻ったときにのみ更新されます。 .It start_time これはそのデバイスのビジーカウントが 0 から 1 に移ったときの .Fn getmicrouptime によって報告される時間です .It last_comp_time これは処理が完全に終わったときの .Fn getmicrouptime -によって報告される時間です +によって報告される時間です。 これはデバイスビジー時間を計算するために .Va start_time と一緒に使用されます。 .It flags これらのフラグは個々のデバイスによって、どの統計測定がサポート されているのかを示します。 これらのフラグは本来は、統計を解読するユーザ側のプログラムの補助として 働くことを意図されています。 .It device_type これはデバイスの型です。 これは 3 つの部分から構成されています。 デバイスの型 (例えば、直接アクセス、CDROM、順次アクセス、など)、 インタフェース (IDE, SCSI またはその他) および当のデバイスが パススルードライバであるかどうか、です。 デバイスの型の完全なリストは以下を参照してください。 .It priority これは優先度です。 これはデバイスを .Nm リストの何処に挿入するのかを決定するために使用される最初のパラメータです。 2 番目のパラメータはアタッチの順番です。 利用可能な優先度のリストは以下を参照してください。 .El .Pp 個々のデバイスはデバイスの型が与えられます。 パススルーデバイスは インタフェースを供給するためのデバイスと同じ基礎的なデバイスの型と インタフェースを持ちますが、パススルーフラグも設定されています。 基本のデバイスの型は .Tn SCSI のデバイス型番号と一致しています。 そのため .Tn SCSI 周辺装置では、問合せから返されたデバイスの型は、通常、 .Tn SCSI インタフェースの型ともし適切であればパススルーフラグで OR されます。 デバイスの型のフラグは以下のとおりです。 .Bd -literal -offset indent typedef enum { DEVSTAT_TYPE_DIRECT = 0x000, DEVSTAT_TYPE_SEQUENTIAL = 0x001, DEVSTAT_TYPE_PRINTER = 0x002, DEVSTAT_TYPE_PROCESSOR = 0x003, DEVSTAT_TYPE_WORM = 0x004, DEVSTAT_TYPE_CDROM = 0x005, DEVSTAT_TYPE_SCANNER = 0x006, DEVSTAT_TYPE_OPTICAL = 0x007, DEVSTAT_TYPE_CHANGER = 0x008, DEVSTAT_TYPE_COMM = 0x009, DEVSTAT_TYPE_ASC0 = 0x00a, DEVSTAT_TYPE_ASC1 = 0x00b, DEVSTAT_TYPE_STORARRAY = 0x00c, DEVSTAT_TYPE_ENCLOSURE = 0x00d, DEVSTAT_TYPE_FLOPPY = 0x00e, DEVSTAT_TYPE_MASK = 0x00f, DEVSTAT_TYPE_IF_SCSI = 0x010, DEVSTAT_TYPE_IF_IDE = 0x020, DEVSTAT_TYPE_IF_OTHER = 0x030, DEVSTAT_TYPE_IF_MASK = 0x0f0, DEVSTAT_TYPE_PASS = 0x100 } devstat_type_flags; .Ed .Pp デバイスはそれらに関連付けられた優先度を持っていて、 .Nm リストのおおよそ何処に置かれるのかを制御します。 優先度は以下のとおりです。 .Bd -literal -offset indent typedef enum { DEVSTAT_PRIORITY_MIN = 0x000, DEVSTAT_PRIORITY_OTHER = 0x020, DEVSTAT_PRIORITY_PASS = 0x030, DEVSTAT_PRIORITY_FD = 0x040, DEVSTAT_PRIORITY_WFD = 0x050, DEVSTAT_PRIORITY_TAPE = 0x060, DEVSTAT_PRIORITY_CD = 0x090, DEVSTAT_PRIORITY_DISK = 0x110, DEVSTAT_PRIORITY_ARRAY = 0x120, DEVSTAT_PRIORITY_MAX = 0xfff } devstat_priority; .Ed .Pp 個々のデバイスは何の操作がサポートされているかサポートされていないのかを示す、 それに関連付けられたフラグを持っています。 .Va devstat_support_flags の値は以下のとおりです。 .Bl -tag -width DEVSTAT_NO_ORDERED_TAGS .It DEVSTAT_ALL_SUPPORTED デバイスによって全ての統計の型がサポートされています。 .It DEVSTAT_NO_BLOCKSIZE このデバイスはブロックサイズを持っていません。 .It DEVSTAT_NO_ORDERED_TAGS このデバイスは順序タグ (ordered tag) をサポートしていません。 .It DEVSTAT_BS_UNAVAILABLE このデバイスはブロックサイズをサポートしていますが、現在は利用できません。 このフラグはリムーバブルメディアのドライバでよく使用されます。 .El .Pp デバイスへの処理は 3 つのカテゴリのうちのいずれかに分類されます。 これは .Fn devstat_end_transaction へ渡される .Va flags に表現されています。 処理の型は以下のとおりです。 .Bd -literal -offset indent typedef enum { DEVSTAT_NO_DATA = 0x00, DEVSTAT_READ = 0x01, DEVSTAT_WRITE = 0x02, DEVSTAT_FREE = 0x03 } devstat_trans_flags; .Ed .Pp .Fn devstat_end_transaction の .Va tag_type 引数には、次の 4 つの値を指定可能です: .Bl -tag -width DEVSTAT_TAG_ORDERED .It DEVSTAT_TAG_SIMPLE その処理は単純なタグを持っていました。 .It DEVSTAT_TAG_HEAD この処理はキュータグの先頭を持っていました。 .It DEVSTAT_TAG_ORDERED その処理は順序タグを持っていました。 .It DEVSTAT_TAG_NONE そのデバイスはタグをサポートしません。 .El .Pp タグの型の値は .Tn SCSI のタグの定義の下位 4 ビットと一致しています。 例えば CAM では、 CCB の .Va tag_action が 0xf と OR することにより、 .Fn devstat_end_transaction に渡すタグの型を判定します。 .\" AND じゃないの？ .Pp .In sys/devicestat.h で .Dv DEVSTAT_VERSION マクロが定義されています。 これは .Nm サブシステムの現在のバージョンで、 .Nm 統計にアクセスするユーザ側プログラムの再コンパイルが要求される変更のたびに、 増やされるべきです。 ユーザ側プログラムは、カーネルの .Nm 構造体と同期しているかどうかを決定するために、 .Va kern.devstat.version .Nm sysctl 変数を通してこのバージョンを使用します。 .Sh 関連項目 .Xr systat 1 , .Xr devstat 3 , .Xr iostat 8 , .Xr rpc.rstatd 8 , .Xr vmstat 8 .Sh 歴史 .Nm 統計システムは .Fx 3.0 で登場しました。 .Sh 作者 .An Kenneth Merry Aq ken@FreeBSD.org .Sh バグ .Nm リスト操作コード周りで .Fn spl 保護が必要かもしれません。 これは、例えば誰かが .Va kern.devstat.all .Nm sysctl 変数を取り出している間に、デバイスのリストが変更されないことを 保証するためです。 .Pp 現在の .Nm の構造では正確に処理毎の時間を測定することが不可能です。 唯一の上手くいきそうな処理毎の正確な時間測定の方法は、 処理毎にタイムスタンプを記録することです。 システムのパフォーマンスおよび各個の処理のためにタイムスタンプを 保存するための空間コストに負の影響を与えるため、 この測定は恐らくは殆んどの人々には価値のないことです。