pod2man - クラウドでオンライン

プログラム：

NAME

pod2man - POD データをフォーマットされた *roff 入力に変換する

SYNOPSIS

ポッド2マン [- 中心=string] [- 日にち=string] [-エラー= ]
[- 修理済み=フォント] [--fixed太字=フォント] [--fixeditalic=フォント]
[--fixed太字斜体=フォント] [- 名前=名] [--nourls]
[- 正式] [--引用符=引用] [- リリース[=バージョン]]
[- セクション=マネクスト] [--stderr] [--utf8] [-詳細]
[ [出力]...]

ポッド2マン - 助けて

DESCRIPTION

ポッド2マン Pod::Man のフロントエンドで、POD ソースから *roff 入力を生成するために使用します。
結果の *roff コードは、以下を使用して端末に表示するのに適しています。 ンロフ(1)、通常
、 man(1)、またはを使用して印刷 troffとします。

POD ソースとして読み取るファイルです (POD はコードに埋め込むことができます)。 もしも
指定しない場合は、デフォルトの「STDIN」になります。 出力が指定されている場合、それは書き込み先のファイルです。
フォーマットされた出力。 もしも 出力 が指定されていない場合、フォーマットされた出力は「STDOUT」に書き込まれます。
複数の POD ファイルを同時に処理できます ポッド2マン 呼び出し (モジュールの負荷を節約し、
コンパイル時間)、複数のペアを提供することで、 と 出力 コマンドライン上のファイル。

- セクション, - リリース, - 中心, - 日にち, - 正式 ヘッダーの設定に使用でき、
使用するフッター; 指定されていない場合、Pod::Man はさまざまなデフォルトを想定します。 以下を参照するか、
Pod::Man で詳細を確認してください。

ポッド2マン は、*roff フォーマッタに「CW」という名前の固定幅フォントがあることを前提としています。 あなたの場合
他の名前 (「CR」など) を使用する場合は、 - 修理済み それを指定します。 これは一般的にのみ
印刷用の troff 出力に関する事項。 同様に、太字に使用するフォントを設定できます。
斜体、および太字の斜体の固定幅出力。

明らかな pod 変換に加えて、Pod::Man、したがって pod2man も処理します。
書式設定 func（）、 func(n) 、および $foo や @bar などの単純な変数参照なので、
それらにはコードエスケープを使用する必要があります。 $fred{'stuff'} のような複雑な式はまだ必要です
逃げられますが。 また、ハイフンとして使用されていないダッシュを en に変換します
ダッシュ、長いダッシュ (このように) を適切な em ダッシュに変換し、「一対の引用符」を修正し、
他のいくつかの troff 固有の調整を処理します。 完全な情報については、Pod::Man を参照してください。

OPTIONS

-c string, - 中心=string
中央揃えのページ ヘッダーを string. デフォルトは「ユーザーが投稿した Perl」です。
ドキュメンテーション」、また参照 - 正式 を参照してください。

-d string, - 日にち=string
左側のフッター文字列をこの値に設定します。 デフォルトでは、変更日
入力ファイルが使用されるか、入力が「STDIN」からのものである場合は現在の日付が使用されます。
UTC に基づく (現地時間に関係なく出力を再現できるようにするため)
ゾーン）。

-エラー=
エラー処理スタイルを設定します。 「die」は、POD フォーマットで例外をスローすることを示します。
エラー。 「stderr」は、標準エラーでエラーを報告するが、エラーをスローしないように指示します。
例外。 「pod」は、結果として得られるドキュメントに POD ERRORS セクションを含めるように指示します。
エラーを要約します。 「none」は、可能な限り POD エラーを完全に無視します。

デフォルトは「死ぬ」です。

- 修理済み=フォント
逐語的なテキストとコードに使用する固定幅フォント。 デフォルトは「CW」です。 いくつかの
システムは代わりに「CR」を必要とする場合があります。 唯一の問題 troff(1) 出力。

--fixed太字=フォント
等幅フォントの太字バージョン。 デフォルトは「CB」です。 唯一の問題 troff(1)
出力。

--fixeditalic=フォント
固定幅フォントの斜体バージョン (実際には、ほとんどの
等幅フォントには斜めバージョンのみがあり、イタリック バージョンはありません)。 デフォルトは
「CI」。 唯一の問題 troff(1) 出力。

--fixed太字斜体=フォント
固定幅フォントの太字イタリック (おそらく実際には斜め) バージョン。 ポッド::男
あなたがこれを持っているとは仮定せず、デフォルトは "CB" です。 一部のシステム (Solaris など)
このフォントを「CX」として使用できるようにしてください。 唯一の問題 troff(1) 出力。

-h, - 助けて
使用情報を印刷します。

-l, --緩い
もう使用されていません。 ポッド2マン 入力がマニュアルページとして有効かどうかをチェックするために使用されますが、
これは、次の方法で行う必要があります。 ポッドチェッカー(1) 代わりに。 逆方向に受け入れられました
互換性; このオプションはもはや何もしません。

-n 名, - 名前=名
マニュアルページの名前を 名. このオプションがないと、マニュアル名が設定されます
マニュアル セクションが指定されていない限り、変換されるファイルの大文字のベース名に
この場合、パスが解析されて、Perl モジュール パスであるかどうかが確認されます。 そうであれば、
「.../lib/Pod/Man.pm」のようなパスは、「Pod::Man」のような名前に変換されます。 このオプション、
与えられた場合、名前の自動決定をオーバーライドします。

このオプションは、複数の POD ファイルを変換する場合にはおそらく役に立たないことに注意してください。
一度。 コマンドの Unix man ページの規則では、man ページのタイトルは
コマンドがそうでない場合でも、すべて大文字で。

標準入力から POD ソースを変換する場合、このオプションは必須です。
そうしないと、マニュアルページの名前として何を使用するかを知る方法がありません。

--nourls
通常、URL を含む L<> フォーマット コードですが、アンカー テキストは両方を表示するようにフォーマットされます。
アンカーテキストとURL。 言い換えると：

Lhttp://example.com/>

は次のようにフォーマットされます。

ふーhttp://example.com/>

このフラグを指定すると、アンカー テキストが指定されたときに URL が抑制されるため、この例では
単に「foo」としてフォーマットされます。 これにより、場合によっては、乱雑な出力が生成されなくなります。
URL は特に重要ではありません。

-o, - 正式
このページが標準の Perl の一部であることを示すデフォルトのヘッダーを設定します
解放する場合 - 中心 も与えられません。

-q 引用, --引用符=引用
C<> テキストを囲むために使用される引用符を次のように設定します。 引用。 場合 引用 シングルです
文字の場合、左引用符と右引用符の両方として使用されます。 もしも 引用 XNUMX文字です、
最初の文字は左側の引用符として使用され、XNUMX 番目の文字は右側の引用符として使用されます。 と
if 引用 は XNUMX 文字で、最初の XNUMX 文字は左引用符として使用され、XNUMX 番目は引用符として使用されます。
正しい引用として XNUMX つ。

引用 特別な値「none」に設定することもできます。この場合、引用符は付けられません。
C<> テキストの周りに追加されました (ただし、フォントは troff 出力用に変更されています)。

-r, - リリース
中央揃えのフッターを設定します。 デフォルトでは、これは実行する Perl のバージョンです ポッド2マン
下。 一部のシステム マクロ セットは、中央揃えのフッターが
変更日であり、「Last modified:」のようなものが先頭に追加されます。 これが
場合によっては、設定することもできます - リリース 最終更新日まで - 日にち から
バージョンナンバー。

-s, - セクション
「.TH」マクロのセクションを設定します。 標準のセクション番号付け規則は、
ユーザー コマンドには 1、システム コールには 2、関数には 3、デバイスには 4、
ファイル形式、ゲーム用に 6 つ、その他の情報用に 7 つ、管理者用に 8 つ
コマンド。 ただし、ここには多くのバリエーションがあります。 一部のシステム (Solaris など) は
ファイル形式は 4、その他の情報は 5、デバイスは 7 です。 その他
1 の代わりに 8m を使用するか、両方を組み合わせて使用​​します。 唯一のセクション番号について
信頼できる一貫性は 1、2、および 3 です。

デフォルトでは、ファイルが「.pm」で終わらない限り、セクション 1 が使用されます。
セクション 3 が選択されます。

--stderr
デフォルトでは、 ポッド2マン POD 入力でエラーが検出されると停止します。 もしも --stderr is
与えられた、または与えられなかった -エラー フラグが存在すると、エラーは標準エラーに送信されますが、 ポッド2マン
中止されません。 これは「--errors=stderr」と同等であり、逆方向でもサポートされています。
互換性。

-u, --utf8
デフォルトでは、 ポッド2マン できる限り保守的な *roff 出力を生成して、
できるだけ多くの異なる *roff 実装で動作することを確認してください。
多くの *roff 実装は非 ASCII 文字を処理できないため、これはすべての非 ASCII 文字を意味します。
ASCII 文字は、作成を試みる *roff エスケープ シーケンスのいずれかに変換されます。
適切にアクセント付きの文字 (少なくとも troff 出力の場合) または "X" に。

このオプションは、代わりにリテラル UTF-8 文字を出力するように指示します。 *roff の場合
実装はそれを処理できます。これは使用するのに最適な出力形式であり、回避します
非 ASCII 文字を含むドキュメントの破損。 ただし、次の点に注意してください。
*リテラル UTF-8 文字を含む roff ソースは、多くの実装でサポートされていません
また、セグメンテーション違反やその他の悪い動作が発生する可能性さえあります。

このオプションを使用する場合、POD ソースの入力エンコーディングは次のとおりである必要があることに注意してください。
US-ASCII または Latin-1 でない限り、適切に宣言されています。 「=encoding」のない POD 入力
コマンドは Latin-1 であると想定され、実際に UTF-8 である場合、出力は
二重エンコードされます。 見る パールポッド(1) 「=encoding」の詳細については、


-v, -詳細
生成されている各出力ファイルの名前を出力します。

EXIT ステータス

すべてのドキュメントが処理されて何らかの出力が得られる限り、その出力に次のものが含まれている場合でも、
正誤表 (「--errors=pod」で生成される「POD ERRORS」セクション)、 ポッド2マン で終了します
ステータス 0。処理中のドキュメントのいずれかが出力ドキュメントにならない場合、
ポッド2マン ステータス 1 で終了します。実行中の POD ドキュメントに構文エラーがある場合、
処理され、エラー処理スタイルはデフォルトの「die」に設定されます。 ポッド2マン 中止します
終了ステータス 255 で即座に実行されます。

診断

If ポッド2マン エラーで失敗します。詳細については、Pod::Man および Pod::Simple を参照してください。
これらのエラーは意味する場合があります。

例

pod2man プログラム > program.1
pod2man SomeModule.pm /usr/perl/man/man3/SomeModule.3
pod2man --section=7 note.pod > note.7

大量の man ページを連続して印刷したい場合は、おそらく次のように設定する必要があります
C および D レジスタを使用して、連続したページ番号付けと偶数/奇数ページングを設定します。
のいくつかのバージョン manとします。

troff -man -rC1 -rD1 perl.1 perldata.1 perlsyn.1 ...

"STDERR" でインデックス エントリを取得するには、次のように F レジスタをオンにします。

troff -man -rF1 perl.1

索引付けは、各主要ページ、セクション、サブセクション、
item、および任意の「X<>」ディレクティブ。 詳細については、Pod::Man を参照してください。

onworks.net サービスを使用してオンラインで pod2man を使用する