web-dev-qa-db-ja.com

MANページの概要セクションのコマンド例構文の読み方

ドキュメントを使用してコマンド構文を理解しようとしていますが、コマンドに渡すことができるすべてのオプションとパラメーターを示す使用されている記号を完全に理解していないことに気付きました。

たとえば、man Zip：

SYNOPSIS

   Zip  [-aABcdDeEfFghjklLmoqrRSTuvVwXyz!@$] [--longoption ...]  [-b path]
   [-n suffixes] [-t date] [-tt date] [zipfile [file ...]]  [-xi list]

またはman bzip2：

SYNOPSIS
       bzip2 [ -cdfkqstvzVL123456789 ] [ filenames ...  ]
       bzip2 [ -h|--help ]
       bunzip2 [ -fkvsVL ] [ filenames ...  ]
       bunzip2 [ -h|--help ]
       bzcat [ -s ] [ filenames ...  ]
       bzcat [ -h|--help ]
       bzip2recover filename

この構文の読み方を調べて、各記号の意味を教えてくれるリソースはありますか？

command-linebashmanpage
4
timbram

良いリソースは this （私は恥知らずにコピーした）

UNIXの初心者にとって最も難しい部分の1つは、ドキュメントを見つけることです。システムにオンラインマニュアルが付属していると聞くと、通常は安ighのため息がつきます。あなたが知らないのは、マニュアルページが技術的な参考資料であることです。それは本当に悪いように聞こえるかもしれませんが、そうではありません！マニュアルページの基本を学ぶと、それらがどのように書かれているかを理解するようになります。情報が必要で、時間を無駄にしないなら、manコマンドはあなたが頼る人です。

このドキュメントは、unixマニュアルの読み方を教えることを試みています。これは一般にmanページと呼ばれています。一般的な引用

最初のマニュアルページにジャンプする前に、それらで使用されるいくつかの一般的なシンボルを見てみましょう。これらの記号は、引用符と呼ばれることもあります。

マニュアルページの主な用途は、プログラムのパラメーターを検索することです。ほとんどのパラメーターはオプションであるため、角括弧で囲まれます。

[optional]
[-abcgln]

一部のオプションには、選択肢の限られたリストがあります。選択肢のリストはコンマで区切られ、中括弧で囲まれます。

{choice1,choice2}
{yes,no}

ヘルプドキュメントの多くのソースでは、必須パラメータを小なり記号/大なり記号で囲んでいます。

<manditory>
<program_name>

上記のマンディトリーの引用は通常マニュアルページでは使用されませんが、知っておくと良いでしょう。

2
A.B.

man manページから：

次の規則は、「概要」セクションに適用され、他のセクションのガイドとして使用できます。 man synopsis description

正確なレンダリングは、出力デバイスによって異なる場合があります。たとえば、端末で実行している場合、通常、人間は斜体をレンダリングできません。通常、下線付きまたは色付きのテキストを代わりに使用します。

コマンドまたは関数の図は、可能なすべての呼び出しに一致するパターンです。場合によっては、このマニュアルページの「概要」セクションに示されているように、いくつかの排他的な呼び出しを示すことをお勧めします。

0
Jules Randolph