ほとんどのマニュアルページにいくつかの一般的な例が含まれていない理由はありますか?彼らは通常、すべての可能なオプションを説明しますが、それは初心者にとって「通常」使用される方法を理解することをさらに難しくします。
man jq
1000行以上の例があります(Ubuntu 16.04上)
ほとんどのマニュアルページにいくつかの一般的な例が含まれていない理由はありますか?彼らは通常、すべての可能なオプションを説明しますが、それは初心者にとって「通常」使用される方法を理解することをさらに難しくします。
man jq
1000行以上の例があります(Ubuntu 16.04上)
回答:
それはマニュアルページに依存します...伝統的に、彼らは例のセクションを含んでいます-しかし、何らかの理由で通常Linuxのマニュアルページから欠落しています(そして私は他のGNUコマンドを使用していると思います-これは最近のほとんどです)。一方、Solarisでは、ほとんどすべてのマニュアルページにサンプルセクションがあり、多くの場合、いくつかのサンプルが含まれています。
私が推測した場合、FSF / GNUは長い間、man
ページの使用を推奨しておらず、ユーザーはドキュメントの代わりに情報を使用することを好みます。info
ページは、manページより包括的になる傾向があり、通常は行う例が挙げられます。 info
また、ページはより「局所的」です。つまり、関連するコマンド(たとえば、ファイルを検索するためのコマンド)を一緒に見つけることができます。
別の理由としては、GNUとそのman
ページが、互いに異なる多くの異なるオペレーティングシステムで使用されている可能性があります(異なるLinuxディストリビューションの間には多くの違いがあります)。パブリッシャーが特定のOS /ディストリビューションに関連する例を追加したことが意図された可能性があります-これは明らかにめったに行われません。
また、man
ページは「初心者を教える」ことを意図していないことも付け加えます。UNIXはコンピューターの専門家(旧称「ハッカー」)によって開発され、コンピューターの専門家が使用することを目的としています。したがって、マニュアルページは初心者に教えるためではなく、不明瞭なオプションや奇妙なファイル形式のリマインダーが必要なコンピューターの専門家を迅速に支援するために作成されました。
man
-ページはこうして意図されています
man
ページへの参照-例:構成ファイルと関連/類似のコマンドの形式について。そうは言っman
ても、manページ自体を歩くよりも使用法を説明できるので、ページに例が必要であることに非常に同意します。あまりにも悪い例は一般的にLinux man
ページでは利用できません...
Solarisのマニュアルページのサンプル部分のサンプル-zfs(1M):
(...) 例 例1 ZFSファイルシステム階層を作成する 次のコマンドは、pool / homeという名前のファイルシステムを作成します また、pool / home / bobという名前のファイルシステム。マウントポイント / export / homeは親ファイルシステムに設定されており、 子ファイルシステムによって自動的に継承されます。 #zfs createプール/ホーム #zfs set mountpoint = / export / home pool / home #zfs create pool / home / bob 例2 ZFSスナップショットを作成する 次のコマンドは、昨日という名前のスナップショットを作成します。 このスナップショットは、必要に応じて.zfs / snapshotにマウントされます pool / home / bobファイルシステムのルートにあるディレクトリ。 #zfs snapshot pool / home / bob @ yesterday 例3複数のスナップショットの作成と破棄 次のコマンドは、昨日の名前のスナップショットを作成します プール/ホームおよびそのすべての子孫ファイルシステム。各 スナップショットは、必要に応じて.zfs / snapshotディレクトリにマウントされます そのファイルシステムのルートで。2番目のコマンドは破棄します 新しく作成されたスナップショット。 #zfs snapshot -r pool / home @ yesterday #zfs destroy -r pool / home @ yesterday SunOS 5.11最終変更日:2012年7月23日51 システム管理コマンドzfs(1M) 例4ファイルシステムの圧縮の無効化と有効化 次のコマンドは、次の圧縮プロパティを無効にします。 (...)
この特定のmanページには、16個の(!)そのような例が付属しています... Solarisへの称賛!
(そして、私はこのコマンドのマニュアルページ全体を読むのではなく、私自身がほとんどこれらの例に従っていることを認めます...)
zfs
)は、ごく自然に設計されています。たとえば、zfs destroy pool/filesystem
基本的な使用法であり、ユースケースの90%で問題ありません。-r
for recursive
などの短いオプションはより意図的であり、意図しない副作用がある可能性があるため、使用する前に相談する必要があります。
場合によります:
一部のプログラムでは、開発者は特定のプログラム(またはライブラリ)の使用方法を示すサンプルプログラムまたはスクリプトを提供することを好みます。繰り返しますが、これは問題を解決するために行われます:プログラムをテストしやすくします。
いくつかの例は、ユーザーからのバグレポートに基づいている場合があり、短い場合はマニュアルで場所を見つけます。長い例がマニュアルで提供されることはめったにありません。短い例には、些細で反復的な傾向があり、ユーザーにプログラムの動作に関する十分に整理された説明ほどの洞察を実際に提供しないという問題があります。
マニュアルページの代わりを探している場合は、常にbro pagesを試すことができます。これは、コマンドに対してさまざまな例を示しているだけで、コミュニティが提出した例のリストから投票できます。たとえば、コマンドbro tar
は以下を提供します。