MANDOC_CHAR(7) | FreeBSD Miscellaneous Information Manual | MANDOC_CHAR(7) |
名称
mandoc_char — mandoc の特殊文字解説
このページは、 mdoc(7) と man(7) の文書の特殊文字を表わすために mandoc(1) によって受け付けられる roff(7) エスケープシーケンスを文書化しています。表示は、 mandoc(1) 出力モードに依存します。 ASCII 出力で、ほとんどの文字は、まったく不鮮明 (unintelligible) です。そのような理由で、ここで文書化された特殊文字のいずれかを使用することは、 解説 で議論されたものを除いて、積極的に推奨されません。それらは、だた既存の文書との後方互換性のためにサポートされています。
特に、英語のマニュアルページで、作者の名前で国語文字を表わすために特殊文字のエスケープシーケンスを使用しないでください。代わりに、名前の ASCII 転写 (transcription) を提供します。
ダッシュとハイフン
活版印刷 (typography) では、様々な幅の異なるタイプのダッシュがあります: ハイフン (-)、マイナス記号 (-)、エンダッシュ (en-dash) (–) と全角ダッシュ (em-dash) (—)。ハイフンは、形容詞のために使用されます。合成された単語の 2 つの部分を分離するために。または、テキストの 2 つの連続する行にわたる単語を分離するために。ハイフンを、次のようにエスケープする必要はありません:
blue-eyed lorry-driver
数学的なマイナス記号は、負の数または減算のために使用されます。それは、‘\-’のように書かれるべきです:
a = 3 \- 1; b = \-2;
エンダッシュ (en-dash) は、範囲の 2 つの要素を分離するために使用されるか、または全角ダッシュ (em-dash) と同じ方法で使用することができます。それは、‘\(en’のように書かれるべきです:
pp. 95\(en97. Go away \(en or else!
中断を示すために、全角ダッシュ (em-dash) を使用することができ、またはコロン、セミコロンまたは括弧と同じ方法で使用することができます。それは、‘\(em’のように書かれるべきです:
Three things \(em apples, oranges, and bananas. This is not that \(em rather, this is that.
注: ハイフン、マイナス記号とエンダッシュ (en-dashe) は、通常の ASCII 出力で同一に見えます。 PostScript のような他の形式は、異なる幅ととともに、それらを正確に表示します。
空白
通常テキスト中の単語を分離するために、リテラル定数の段付けと整列のために、次の特殊なケースのいずれも適用しないとき、単に通常の空白文字 (‘ ’) を使用します。テキストを詰める (fill) とき、行は、単語の間でブレークされるかもしれません、すなわち、空白文字。 2 つの特別の単語の間の改行を防ぐために、通常の空白文字の代わりにブレークしない空白エスケープシーケンス (‘\~’) を使用します。例えば、入力文字列“number\~1”は、同じ出力行に“number 1”として一緒にされます。
要求とマクロの行において、通常の空白文字は、引数のデリミタとして役に立ちます。引数に空白類を含めるために、引用することは、通常最良の選択です。ある場合には、ブレークしない (‘\~’) またはブレークする (‘\ ’) 空白エスケープシーケンスのいずれかを使用することが、望ましいでしょう。マクロの名前をエスケープし、入力行の終わりの空白を保護するためには、 0 の幅の空白 (‘\&’) がしばしば役に立ちます。例えば、 mdoc(7) において、次の方法のいずれかのシングルクォートで通常の空白文字を表示することができます:
.Sq ""
.Sq \\&
クォート (引用)
要求とマクロの行で、ダブルクォート文字 (‘"’) は、クォートできるように特に取り扱われます。この特殊取り扱いを防ぐ 1 つの方法は、‘\(dq’エスケープシーケンスを使用することによって行えます。テキスト行で、リテラルのダブルクォート文字を文字通り (verbatim) に使用することができることに注意してください。他のすべてのクォートのような文字は、要求とマクロの行でさえ、同様に文字通り (verbatim) に使用することができます。
特殊文字
特殊文字は、 (1 文字のエスケープのための) ‘\X’、 (2 文字の) ‘\(XX’と (N-文字の) ‘\[N]’としてエンコードされます。詳細については、 roff(7) マニュアルの 特殊文字 サブセクションを参照してください。間隔 (spacing):
入力 | 説明 |
\~ | non-breaking, non-collapsing space |
\ | breaking, non-collapsing n-width space |
\^ | zero-width space |
\% | zero-width space |
\& | zero-width space |
\| | zero-width space |
\0 | breaking, non-collapsing digit-width space |
\c | removes any trailing space (if applicable) |
行 (lines):
入力 | 表示 | 説明 |
\(ba | | | bar |
\(br | │ | box rule |
\(ul | _ | underscore |
\(rl | ‾ | overline |
\(bb | ¦ | broken bar |
\(sl | / | forward slash |
\(rs | \ | backward slash |
テキストマーカ (text markers):
入力 | 表示 | 説明 |
\(ci | ○ | circle |
\(bu | • | bullet |
\(dd | ‡ | double dagger |
\(dg | † | dagger |
\(lz | ◊ | lozenge |
\(sq | □ | white square |
\(ps | ¶ | paragraph |
\(sc | § | section |
\(lh | ☜ | left hand |
\(rh | ☞ | right hand |
\(at | @ | at |
\(sh | # | hash (pound) |
\(CR | ↵ | carriage return |
\(OK | ✓ | check mark |
正しいシンボル (legal symbols):
入力 | 表示 | 説明 |
\(co | © | copyright |
\(rg | ® | registered |
\(tm | ™ | trademarked |
句読点 (punctuation):
入力 | 表示 | 説明 |
\(em | — | em-dash |
\(en | – | en-dash |
\(hy | ‐ | hyphen |
\e | \ | back-slash |
\. | . | period |
\(r! | ¡ | upside-down exclamation |
\(r? | ¿ | upside-down question |
クォート (quotes):
入力 | 表示 | 説明 |
\(Bq | „ | right low double-quote |
\(bq | ‚ | right low single-quote |
\(lq | “ | left double-quote |
\(rq | ” | right double-quote |
\(oq | ‘ | left single-quote |
\(cq | ’ | right single-quote |
\(aq | ' | apostrophe quote (text) |
\(dq | " | double quote (text) |
\(Fo | « | left guillemet |
\(Fc | » | right guillemet |
\(fo | ‹ | left single guillemet |
\(fc | › | right single guillemet |
角括弧 (brackets):
入力 | 表示 | 説明 |
\(lB | [ | left bracket |
\(rB | ] | right bracket |
\(lC | { | left brace |
\(rC | } | right brace |
\(la | < | left angle |
\(ra | > | right angle |
\(bv | ⎪ | brace extension |
\[braceex] | ⎪ | brace extension |
\[bracketlefttp] | ⎡ | top-left hooked bracket |
\[bracketleftbp] | ⎣ | bottom-left hooked bracket |
\[bracketleftex] | ⎢ | left hooked bracket extension |
\[bracketrighttp] | ⎤ | top-right hooked bracket |
\[bracketrightbp] | ⎦ | bottom-right hooked bracket |
\[bracketrightex] | ⎥ | right hooked bracket extension |
\(lt | ⎧ | top-left hooked brace |
\[bracelefttp] | ⎧ | top-left hooked brace |
\(lk | ⎨ | mid-left hooked brace |
\[braceleftmid] | ⎨ | mid-left hooked brace |
\(lb | ⎩ | bottom-left hooked brace |
\[braceleftbp] | ⎩ | bottom-left hooked brace |
\[braceleftex] | ⎪ | left hooked brace extension |
\(rt | ⎫ | top-left hooked brace |
\[bracerighttp] | ⎫ | top-right hooked brace |
\(rk | ⎬ | mid-right hooked brace |
\[bracerightmid] | ⎬ | mid-right hooked brace |
\(rb | ⎭ | bottom-right hooked brace |
\[bracerightbp] | ⎭ | bottom-right hooked brace |
\[bracerightex] | ⎪ | right hooked brace extension |
\[parenlefttp] | ⎛ | top-left hooked parenthesis |
\[parenleftbp] | ⎝ | bottom-left hooked parenthesis |
\[parenleftex] | ⎜ | left hooked parenthesis extension |
\[parenrighttp] | ⎞ | top-right hooked parenthesis |
\[parenrightbp] | ⎠ | bottom-right hooked parenthesis |
\[parenrightex] | ⎟ | right hooked parenthesis extension |
矢印 (arrows):
入力 | 表示 | 説明 |
\(<- | ← | left arrow |
\(-> | → | right arrow |
\(<> | ↔ | left-right arrow |
\(da | ↓ | down arrow |
\(ua | ↑ | up arrow |
\(va | ↕ | up-down arrow |
\(lA | ⇐ | left double-arrow |
\(rA | ⇒ | right double-arrow |
\(hA | ⇔ | left-right double-arrow |
\(uA | ⇑ | up double-arrow |
\(dA | ⇓ | down double-arrow |
\(vA | ⇕ | up-down double-arrow |
論理 (logical):
入力 | 表示 | 説明 |
\(AN | ∧ | logical and |
\(OR | ∨ | logical or |
\(no | ¬ | logical not |
\[tno] | ¬ | logical not (text) |
\(te | ∃ | existential quantifier |
\(fa | ∀ | universal quantifier |
\(st | ∋ | such that |
\(tf | ∴ | therefore |
\(3d | ∴ | therefore |
\(or | | | bitwise or |
数学 (mathematical):
入力 | 表示 | 説明 |
\(pl | + | plus |
\(mi | − | minus |
\- | - | minus (text) |
\(-+ | ∓ | minus-plus |
\(+- | ± | plus-minus |
\[t+-] | ± | plus-minus (text) |
\(pc | · | centre-dot |
\(mu | × | multiply |
\[tmu] | × | multiply (text) |
\(c* | ⊗ | circle-multiply |
\(c+ | ⊕ | circle-plus |
\(di | ÷ | divide |
\[tdi] | ÷ | divide (text) |
\(f/ | ⁄ | fraction |
\(** | ∗ | asterisk |
\(<= | ≤ | less-than-equal |
\(>= | ≥ | greater-than-equal |
\(<< | ≪ | much less |
\(>> | ≫ | much greater |
\(eq | = | equal |
\(!= | ≠ | not equal |
\(== | ≡ | equivalent |
\(ne | ≢ | not equivalent |
\(=~ | ≅ | congruent |
\(-~ | ≃ | asymptotically congruent |
\(ap | ∼ | asymptotically similar |
\(~~ | ≈ | approximately similar |
\(~= | ≌ | approximately equal |
\(pt | ∝ | proportionate |
\(es | ∅ | empty set |
\(mo | ∈ | element |
\(nm | ∉ | not element |
\(sb | ⊂ | proper subset |
\(nb | ⊄ | not subset |
\(sp | ⊃ | proper superset |
\(nc | ⊅ | not superset |
\(ib | ⊆ | reflexive subset |
\(ip | ⊇ | reflexive superset |
\(ca | ∩ | intersection |
\(cu | ∪ | union |
\(/_ | ∠ | angle |
\(pp | ⊥ | perpendicular |
\(is | ∫ | integral |
\[integral] | ∫ | integral |
\[sum] | ∑ | summation |
\[product] | ∏ | product |
\[coproduct] | ∐ | coproduct |
\(gr | ∇ | gradient |
\(sr | √ | square root |
\[sqrt] | √ | square root |
\(lc | ⌈ | left-ceiling |
\(rc | ⌉ | right-ceiling |
\(lf | ⌊ | left-floor |
\(rf | ⌋ | right-floor |
\(if | ∞ | infinity |
\(Ah | ℵ | aleph |
\(Im | ℑ | imaginary |
\(Re | ℜ | real |
\(pd | ∂ | partial differential |
\(-h | ℏ | Planck constant over 2π |
\[12] | ½ | one-half |
\[14] | ¼ | one-fourth |
\[34] | ¾ | three-fourths |
連結線 (ligatures):
入力 | 表示 | 説明 |
\(ff | ff | ff ligature |
\(fi | fi | fi ligature |
\(fl | fl | fl ligature |
\(Fi | ffi | ffi ligature |
\(Fl | ffl | ffl ligature |
\(AE | Æ | AE |
\(ae | æ | ae |
\(OE | Œ | OE |
\(oe | œ | oe |
\(ss | ß | German eszett |
\(IJ | IJ | IJ ligature |
\(ij | ij | ij ligature |
アクセント (accents):
入力 | 表示 | 説明 |
\(a" | ˝ | Hungarian umlaut |
\(a- | ¯ | macron |
\(a. | ˙ | dotted |
\(a^ | ^ | circumflex |
\(aa | ´ | acute |
\' | ´ | acute |
\(ga | ` | grave |
\` | ` | grave |
\(ab | ˘ | breve |
\(ac | ¸ | cedilla |
\(ad | ¨ | dieresis |
\(ah | ˇ | caron |
\(ao | ˚ | ring |
\(a~ | ~ | tilde |
\(ho | ˛ | ogonek |
\(ha | ^ | hat (text) |
\(ti | ~ | tilde (text) |
アクセント文字 (accented letters):
入力 | 表示 | 説明 |
\('A | Á | acute A |
\('E | É | acute E |
\('I | Í | acute I |
\('O | Ó | acute O |
\('U | Ú | acute U |
\('a | á | acute a |
\('e | é | acute e |
\('i | í | acute i |
\('o | ó | acute o |
\('u | ú | acute u |
\(`A | À | grave A |
\(`E | È | grave E |
\(`I | Ì | grave I |
\(`O | Ò | grave O |
\(`U | Ù | grave U |
\(`a | à | grave a |
\(`e | è | grave e |
\(`i | ì | grave i |
\(`o | ì | grave o |
\(`u | ù | grave u |
\(~A | Ã | tilde A |
\(~N | Ñ | tilde N |
\(~O | Õ | tilde O |
\(~a | ã | tilde a |
\(~n | ñ | tilde n |
\(~o | õ | tilde o |
\(:A | Ä | dieresis A |
\(:E | Ë | dieresis E |
\(:I | Ï | dieresis I |
\(:O | Ö | dieresis O |
\(:U | Ü | dieresis U |
\(:a | ä | dieresis a |
\(:e | ë | dieresis e |
\(:i | ï | dieresis i |
\(:o | ö | dieresis o |
\(:u | ü | dieresis u |
\(:y | ÿ | dieresis y |
\(^A | Â | circumflex A |
\(^E | Ê | circumflex E |
\(^I | Î | circumflex I |
\(^O | Ô | circumflex O |
\(^U | Û | circumflex U |
\(^a | â | circumflex a |
\(^e | ê | circumflex e |
\(^i | î | circumflex i |
\(^o | ô | circumflex o |
\(^u | û | circumflex u |
\(,C | Ç | cedilla C |
\(,c | ç | cedilla c |
\(/L | Ł | stroke L |
\(/l | ł | stroke l |
\(/O | Ø | stroke O |
\(/o | ø | stroke o |
\(oA | Å | ring A |
\(oa | å | ring a |
特殊文字 (special letters):
入力 | 表示 | 説明 |
\(-D | Ð | Eth |
\(Sd | ð | eth |
\(TP | Þ | Thorn |
\(Tp | þ | thorn |
\(.i | ı | dotless i |
\(.j | ȷ | dotless j |
通貨 (currency):
入力 | 表示 | 説明 |
\(Do | $ | dollar |
\(ct | ¢ | cent |
\(Eu | € | Euro symbol |
\(eu | € | Euro symbol |
\(Ye | ¥ | yen |
\(Po | £ | pound |
\(Cs | ¤ | Scandinavian |
\(Fn | ƒ | florin |
単位 (units):
入力 | 表示 | 説明 |
\(de | ° | degree |
\(%0 | ‰ | per-thousand |
\(fm | ′ | minute |
\(sd | ″ | second |
\(mc | µ | micro |
ギリシャ文字 (greek letters):
入力 | 表示 | 説明 |
\(*A | Α | Alpha |
\(*B | Β | Beta |
\(*G | Γ | Gamma |
\(*D | Δ | Delta |
\(*E | Ε | Epsilon |
\(*Z | Ζ | Zeta |
\(*Y | Η | Eta |
\(*H | Θ | Theta |
\(*I | Ι | Iota |
\(*K | Κ | Kappa |
\(*L | Λ | Lambda |
\(*M | Μ | Mu |
\(*N | Ν | Nu |
\(*C | Ξ | Xi |
\(*O | Ο | Omicron |
\(*P | Π | Pi |
\(*R | Ρ | Rho |
\(*S | Σ | Sigma |
\(*T | Τ | Tau |
\(*U | Υ | Upsilon |
\(*F | Φ | Phi |
\(*X | Χ | Chi |
\(*Q | Ψ | Psi |
\(*W | Ω | Omega |
\(*a | α | alpha |
\(*b | β | beta |
\(*g | γ | gamma |
\(*d | δ | delta |
\(*e | ε | epsilon |
\(*z | ζ | zeta |
\(*y | η | eta |
\(*h | θ | theta |
\(*i | ι | iota |
\(*k | κ | kappa |
\(*l | λ | lambda |
\(*m | μ | mu |
\(*n | ν | nu |
\(*c | ξ | xi |
\(*o | ο | omicron |
\(*p | π | pi |
\(*r | ρ | rho |
\(*s | σ | sigma |
\(*t | τ | tau |
\(*u | υ | upsilon |
\(*f | ϕ | phi |
\(*x | χ | chi |
\(*q | ψ | psi |
\(*w | ω | omega |
\(+h | ϑ | theta variant |
\(+f | φ | phi variant |
\(+p | ϖ | pi variant |
\(+e | ϵ | epsilon variant |
\(ts | ς | sigma terminal |
事前定義文字列
事前定義文字列は、歴史的な troff 実装のマクロのパッケージから継承されています。それらは、実装によって異なっているので、使用することは 推薦されません。これらの事前定義文字列を使用するマニュアルは、ほぼ確実に移植性がありません。それらの構文は、 (1 文字のエスケープのための) ‘\*X’、 (2 文字の) ‘\*(XX’と (N-文字の) ‘\*[N]’を使用する特殊文字に似ています。詳細については、 roff(7) マニュアルの 事前定義の文字列 サブセクションを参照してください。訳注: roff(7) のマニュアルには、「事前定義の文字列」のセクションは、ありません。
入力 | 表示 | 説明 |
\*(Ba | | | vertical bar |
\*(Ne | ≠ | not equal |
\*(Ge | ≥ | greater-than-equal |
\*(Le | ≤ | less-than-equal |
\*(Gt | > | greater-than |
\*(Lt | < | less-than |
\*(Pm | ± | plus-minus |
\*(If | infinity | infinity |
\*(Pi | pi | pi |
\*(Na | NaN | NaN |
\*(Am | & | ampersand |
\*R | ® | restricted mark |
\*(Tm | (Tm) | trade mark |
\*q | " | double-quote |
\*(Rq | ” | right-double-quote |
\*(Lq | “ | left-double-quote |
\*(lp | ( | right-parenthesis |
\*(rp | ) | left-parenthesis |
\*(lq | “ | left double-quote |
\*(rq | ” | right double-quote |
\*(ua | ↑ | up arrow |
\*(va | ↕ | up-down arrow |
\*(<= | ≤ | less-than-equal |
\*(>= | ≥ | greater-than-equal |
\*(aa | ´ | acute |
\*(ga | ` | grave |
\*(Px | POSIX | POSIX standard name |
\*(Ai | ANSI | ANSI standard name |
UNICODE 文字
エスケープシーケンス
\[uXXXX]
は、Unicode のコードポイントとして解釈されます。コードポイントは、U+0080 以上で U+10FFFF 未満の範囲でなければなりません。互換性に関して、ポイントは、4 文字まで 0 でパディング (詰め物) されなければなりません。 4 文字を超えているなら、0 のパディングは、許可されません。 Unicode のサロゲート (surrogate) は、許可されません。訳注: のサロゲートは、U+D800 から U+DFFF の範囲のコードポイント。
番号が付けられた文字 (NUMBERED CHARACTERS)
また、既存のマニュアルとの後方互換性のために、 mandoc(1) は、出力に現在の文字セットから文字 number を挿入する
\N' number'
エスケープシーケンスをサポートしています。もちろん、これは、本質的に移植性がなく、 Heirloom roff マニュアルで推奨されないものとして既にマークされています。例えば、\N'34' を使用しないで、\(dq を使用するか、または使用できるところで単純なな‘"’を使用します。
互換性
このセクションは、mandoc と他の troff 実装、現時点で、GNU troff (“groff”) に限定される、互換性について文書化しています。
- \N''エスケープシーケンスは、印刷可能な文字に制限されています。 groff では、任意の文字番号を受け付けます。
- -Tascii で、\(ss, \(nm, \(nb, \(nc, \(ib, \(ip, \(pp, \[sum], \[product], \[coproduct], \(gr, \(-h と\(a. 特殊文字は、 mandoc と groff の間の違いを示します。
- -Thtml と -Txhtml で、\(~=, \(nb と\(nc 特殊文字は、mandoc と groff の間の違いを示します。
- -Tps と -Tpdf モード形式は、groff でのようなグリフを表示するのではなく、 -Tascii に似ています。
- \[radicalex], \[sqrtex] と\(ru 特殊文字は、それらがしっかり文書化されていないか、またはそれらが既知の表現を持たないので、 mandoc から省略されました。
作者
mandoc_char マニュアルページは、 , kristaps@bsd.lv によって書かれました。警告
‘\*(Ba’エスケープは、 mdoc(7) の‘|’文字の振る舞いを模倣します。したがって、副作用がない垂直の棒を表示したいなら、‘\(ba’エスケープを使用してください。November 23, 2011 | FreeBSD |