loader
bg-category
Linux Lexicon  -  Linuxのmanページの解剖学

友達と共有します

著者の記事: Kenneth Douglas

短いバイトソフトウェアのmanページとドキュメントは、あらゆる種類の括弧と括弧で縛られた不可解な慣習がなければ、初心者にとっては太くて十分に難しい場合があります。ここでは、Linuxのmanページの複雑さを軽減し、理解しやすくします。

manページは通常、名前と説明、使用方法と注意事項を詳述した一連のセクションに分割されています。マニュアルページは読みにくくなる可能性がありますが、ピンチで活用できる貴重なリソースであり、インターネットも必要としません。

最初は名前の見出しです、そしてそれはそれを要約します。このセクションには、ユーティリティの名前と簡単な説明が含まれています。

概要 manページからmanページまで様々な程度の可読性がありますが、確かなことの1つは、最も難しい部分は通常毛深いあらすじを解読することです。特定のコマンドに必要な情報を示すための規則がいくつかあります。これらの規約は、さまざまな括弧と括弧、およびその他の形式の表記で構成されています。これらのさまざまな規則はすべて初心者にとっては非常に混乱を招く可能性があり、経験のあるけれどもマニュアルの分野に精通していない人にとってはなおさら困難です。以下で、私たちはちょっとした意味を消化しやすいルールに分解します。

勇気づけられる 示されているとおりに正確に入力してください。
イタリック または下線付き 適切な引数に置き換えてください。
[-abcxyz] 角括弧内のフラグはすべてオプションです。
-a | -b パイプで区切られたオプションは一緒に使用できません。
必須の引数。通常はオプションの説明にあります。
{はい・いいえ} 限られたオプション、指定されたものだけが動作します。
省略記号が続く引数は繰り返すことができます。

これらの規則は非常に単純ですが、長い関数定義で使用されている場合、特にそれらがネストされている場合には、さらに困難になり、さらに恐ろしくなります。それで、私達は私達が分解したものを構築するために下記のネスティングを見ていきます。

タール {A | c | d | r | t | u | x} [GnSkUWOmpsMBiajJzZhPlRvwo] [ARG…]

タール コマンドには多くのオプションがあります。示されているように入力する必要があるため、tarコマンドの名前は太字で示されています。それで、中括弧がパイプで区切られたオプションで開いているのがわかります。次にオプションのフラグがあります、私たちは任意の数を使うことができます、しかし、それらはすべて一緒に働くわけではないかもしれません、manページをさらに読むことはオプションのどんな潜在的な矛盾にでも光を当てるでしょう。そして最後に、私たちは繰り返し可能な議論をしています、tarの場合、あなたが操作しているファイルのためにこれ。

[オプション] [ - ] [ユーザー[引数…]]

繰り返しますが、 コマンドの名前なので、太字にしてください。次に、フラグが実際には指定されておらず、オプションであることだけがわかります。第三に、指定されている単一のフラグがありますが、それもオプションです。最後に、オプション引数の中で繰り返し可能なオプション引数があります。今、非常に不思議に見えたものはもっと理にかなっています。

誰が [{-h | –host} HOST] [{-p | –port}ポート] [-abBcdGHKlLmMrRx] [-gソース:最初] [-i ATTR [、ATTR]…] [-s SOURCE [、SOURCE] ]…] [-T TYPE [、TYPE]…] [ - 詳細] OBJECT

これは特に濃いものです。それをあなたの好きなテキストエディタにコピーし、それがあなたがそれを読むのを助けるならばそこにいくつかの余分なスペースを追加してください。これをスキャンした後、あなたはいくつかのパターンを見始めるはずです。ホスト部分とポート部分では、短い形式と長い形式のオプションに同じ形式を使用し、その後にそのオプションの引数を続けますが、どちらもそれ自体はオプションです。それから我々はオプションのフラグの文字列を見る。最初から最後までのソースについての次のビットは、manページの後半で説明されているwhoisによって期待される構文です。今、私たちは、単一の引数またはオプションの繰り返し引数のいずれかをとる、オプションのフラグのこのトリプレットを見ます。これは、最初は完全に把握するのが非常に難しい場合がある規約の複合の一種です。最後に、冗長オプションとオブジェクト(ホスト/ドメイン)があります。

そして、それはmanページの概要を読む方法です。他にもいくつかの規約がありますが、この記事で取り上げるにはあまりにもあいまいすぎます。

説明 これは一般的にプログラムやユーティリティの意図された使用法が概説されているところです。いくつかのマニュアルは他のものよりこの見出しの下ではるかに冗長になるでしょう。

オプション オプションまたは必須の可能性があるすべてのフラグとさまざまな引数を覚えていますか?これは、彼ら全員が説明されるところです。通常、ここには良い情報があります。 与えられたフラグが対応する引数を必要とすることを示す規約。マニュアルページを定義するための厳格な規則はなく、規則だけがあり、標準に準拠する意志がないため、オプションが説明部分にあることがわかります。

これは残念ながらすべてのマニュアルに含まれていない最も便利な部分の1つです。また、情報の量と例の数は大きく異なるため、すべての例が実際にこのコマンドの使用に役立つわけではないこともわかります。

さらに、あなたは定期的に作者、著作権情報、バグ報告、そしてまた参照(apropos)のセクションを見つけるでしょう。

これ以外にも、正式に定義されたものがあります。セクション 以下に定義されているmanページの一覧

1 実行可能プログラムまたはシェルコマンド
2 システムコール(カーネルが提供する機能)
3 ライブラリ呼び出し(プログラムライブラリ内の関数)
4 特別なファイル(通常は/ devにあります)
5 ファイル形式と規則(例:/ etc / passwd)
6 ゲーム
7 その他(マクロパッケージや規約を含む)、男(7)、groff(7)
8 システム管理コマンド(通常はrootのみ)
9 カーネルルーチン(通常Linuxにはありません)

多くのコマンドには複数のセクションにマニュアルがありませんが、マニュアルに含まれているもの、またはあいまいな名前が付けられているものについては、次の例のようにセクションを指定できます。

男5トピック

利用可能なセクションからわかるように、コマンドだけがマニュアルを持っているわけではありません。システムコール、設定ファイル、そして特別なデバイスは、対応するmanページを持っているかもしれません。 manページに入っている典型的なLinuxインストールに関する情報量は驚くべきものです、そして同じことが他のオープンソースのUNIXライクなオペレーティングシステムにも当てはまります。

manページでは不十分で、まだコマンドを理解できない場合は、常にオンラインで確認してください。多くの人が特定のツールについてより徹底的に説明していますが、多くのディストリビューションではソフトウェアパッケージごとにmanページがあります。ソフトウェアに慣れていてもマニュアルが欠けていると感じる場合は、自分で書いてそれぞれのプロジェクトに投稿することでいつでも貢献できます。ドキュメンテーションはソフトウェアプロジェクトの中で最も無視されている部分であることが多いので、たとえあなたがコードを書くことができなくても、他の人を助けるためにマニュアル、Wiki記事、そしてチュートリアルを書くことができます。

manページの構造を理解したので、RTFM以外に言い訳はありません(そして、 無料 18歳未満の方のためのマニュアル

友達と共有します

あなたのコメント