Linux Lexicon —マニュアルページの構造
公開: 2016-11-01
ショートバイト：ソフトウェアのマニュアルページとドキュメントは、あらゆる種類の括弧と括弧で囲まれた不可解な規則がなければ、初心者にとっては十分に厚くて難しい場合があります。 ここでは、Linuxのマニュアルページの複雑さを軽減し、理解しやすくすることを試みます。
名前
最初は名前の見出しであり、それはそれを要約したものです。 このセクションには、ユーティリティの名前と簡単な説明が含まれています。
概要
マニュアルページごとに読みやすさの程度はさまざまですが、確かなことの1つは、最も難しい部分は通常、毛深いあらすじを解読することです。 特定のコマンドに必要な情報を示すための規則がいくつかあります。 これらの規則は、さまざまな括弧と括弧、および他の形式の表記法で構成されています。 これらのさまざまな規則はすべて、初心者にとっては非常に混乱する可能性があり、マニュアルの技術に精通しているが経験がない人にとっては依然として気が遠くなる可能性があります。 以下では、ジブリッシュを消化可能なルールに分解します。
| 大胆に | 示されているとおりに正確に入力します。 |
| 斜体または下線付き | 適切な引数に置き換えます。 |
| [-abcxyz] | 角括弧内のすべてのフラグはオプションです。 |
| -a | -b | パイプで区切られたオプションを一緒に使用することはできません。 |
| <必須> | 必須の引数。通常、オプションの説明にあります。 |
| {はい・いいえ} | 限られたオプション、指定されたものだけが機能します。 |
| … | 省略記号が後に続く引数は繰り返すことができます。 |
これらのルールはかなり単純ですが、長い関数定義で使用される場合、特にネストされている場合は、より困難になり、さらに威圧的になります。 それで、私たちが分解したものを構築するために、以下のいくつかのネストを見てみましょう。
tar {A | c | d | r | t | u | x}[GnSkUWOmpsMBiajJzZhPlRvwo][ ARG …]
tarコマンドには多くのオプションがあります。 tarコマンドの名前は、次のように入力する必要があるため、太字で表示されています。 次に、中括弧がパイプで区切られたオプションで開いているのがわかります。これは、中括弧がそれらに限定されており、1つだけを選択する必要があることを示しています。 次はオプションのフラグです。任意の数を使用できますが、すべてが連携するとは限らない場合があります。マニュアルページをさらに読むと、オプションの潜在的な競合が明らかになります。 そして最後に、繰り返し可能な引数があります。tarの場合、操作しているファイルに対してこれを使用します。
su [オプション][-][ユーザー[引数…]]
繰り返しになりますが、コマンドの名前であるため、 suは太字で表示されます。 次に、実際にはフラグが指定されておらず、オプションであることがわかります。 第三に、指定された単一のフラグがありますが、それもオプションです。 最後に、オプションの引数内で繰り返すことができるオプションの引数があります。 さて、以前は非常に神秘的に見えたものが、より理にかなっています。
whois [{-h | –host} HOST ] [{-p | –port} PORT ] [-abBcdGHKlLmMrRx] [-g SOURCE：FIRST-LAST ] [-i ATTR [、 ATTR ]…] [-s SOURCE [、ソース]…][- TTYPE [、TYPE ] …] [–verbose]オブジェクト
これは特に密度の高いものです。 それをお気に入りのテキストエディタにコピーし、読みやすくなる場合はそこにスペースを追加します。 これをスキャンした後、いくつかのパターンが表示されるようになります。 ホスト部分とポート部分は、オプションの短い形式と長い形式に同じフォーマットを使用し、その後にそのオプションの引数が続きますが、どちらもオプションです。 次に、オプションのフラグの文字列が表示されます。 ソースに関する次のビットは、最初から最後まで、whoisが期待する構文です。これについては、後でマニュアルページで説明します。 これで、単一の引数またはオプションの繰り返し引数のいずれかを取るオプションのフラグのこのトリプレットが表示されます。これは、最初は完全に理解するのが非常に難しい可能性のある規則の複合の一種です。 最後に、詳細オプションとオブジェクト（ホスト/ドメイン）があります。
そして、それがマニュアルページの概要を読む方法です。 他にもいくつかの規則がありますが、これらはあまりにもあいまいすぎて、この記事ではカバーできません。
説明
これは通常、プログラムまたはユーティリティの使用目的が概説されている場所です。 一部のマニュアルは、この見出しの下で他のマニュアルよりもはるかに冗長になります。
オプション
オプションまたは必須である可能性のあるすべてのフラグとさまざまな引数を覚えていますか？ ここで彼ら全員が説明されます。 通常、ここには適切な情報があり、<argument>規則が見つかることがよくあります。これは、特定のフラグに対応する引数が必要であることを示しています。 マニュアルページを定義する厳格なルールはなく、規則のみがあり、標準に準拠する意志があるため、オプションが説明部分にあることに気付く場合があります。
例
これは、残念ながらすべてのマニュアルに含まれているわけではない最も便利な部品の1つです。 また、情報の量と例の数は大幅に異なり、すべての例が実際にコマンドの使用に役立つわけではありません。
さらに、作者、著作権情報、バグ報告のセクションを定期的に見つけ、（適切な）も参照してください。
これに加えて、以下に定義されているように、正式に定義されたマニュアルページのセクションがあります。
| 1 | 実行可能プログラムまたはシェルコマンド |
| 2 | システムコール（カーネルが提供する関数） |
| 3 | ライブラリ呼び出し（プログラムライブラリ内の関数） |
| 4 | 特別なファイル（通常は/ devにあります） |
| 5 | ファイル形式と規則（例：/ etc / passwd） |
| 6 | ゲーム |
| 7 | その他（マクロパッケージと規則を含む）、例：man（7）、groff（7） |
| 8 | システム管理コマンド（通常はrootのみ） |
| 9 | カーネルルーチン（通常はLinuxにはありません） |
多くのコマンドには複数のセクションにマニュアルがありませんが、マニュアルがあるコマンド、またはあいまいな名前が付けられているコマンドの場合は、次の例のようにセクションを指定できます。
利用可能なセクションからわかるように、マニュアルがあるのはコマンドだけではありません。 システムコール、構成ファイル、および特殊なデバイスには、対応するマニュアルページがある可能性があります。 マニュアルページにある典型的なLinuxインストールに関する情報の量は驚くべきものであり、同じことが他のオープンソースのUNIXライクなオペレーティングシステムにも当てはまります。
マニュアルページでは不十分で、コマンドがわからない場合は、常にオンラインで確認してください。多くの人が特定のツールについてより詳細に説明していますが、多くのディストリビューションには、さまざまなソフトウェアパッケージのマニュアルページがあります。 ソフトウェアに慣れていても、マニュアルが不足していると感じたら、自分で作成してそれぞれのプロジェクトに提出することで、いつでも貢献できます。 ドキュメントはソフトウェアプロジェクトで最も無視されている部分であることが多いため、コードを記述できない場合でも、他の人を支援するためのマニュアル、Wiki記事、チュートリアルを作成できます。
マニュアルページの構造がわかったので、RTFM以外に言い訳はできません（18歳未満の方は無料のマニュアルを読んでください）;）
また読む： Linuxレキシコン：Watchコマンドを使用してX秒ごとにコマンドを実行する