私のプログラムにオプションを追加しようとしたときにすでに使用中であるというエラーが表示されたときに、-h
この問題を初めて発見しました。-h
add_help=True
、Pythonはargparse
パラメータのヘルプページを自動的に生成します。-h
--help
-h
ただし、ヘルプページを表示するためにとの両方を使用することは、ほとんどのプログラムではそのようには機能しません--help
。そうですか?どの人気のあるコマンドが-h
略語として使用されますか--help
?いくつかのコマンドを見ましたが、通常は--human-readable
ヘルプとは無関係の略語または他のオプションです。ヘルプメッセージは、-h
で動作しません。たとえば、私がテストしたいくつかのコマンドは確かに完全または代表的なリストではありませんが、非常に人気のあるコマンドです。ls
cd
df
diff
歴史的に-h
ヘルプページを表示するためのデフォルトパラメータとして使用されていて、--help
後で登場した可能性がありますか?man
ページのソースはどこですかinfo
?
-h
これが広く使用されているデフォルトの場合は、ヘルプページ以外のものを使用してユーザーを混乱させたくありません。しかし個人的に私は一度も使ったことがなく、いつも-h
使ってきました--help
。
答え1
-h
とても古い習慣。 DOSシステムでは、-?
またはが頻繁に表示されます/?
。
そのようなことを言っている人の言葉を聞かないでください。男性このページは初心者に適しています。これは非常に価値があり、Unixシステムに追加されました。1971年Unixはわずか2年後に誕生しました。 1973年からtroffを使って組版されました。それでも必要POSIX互換(しかしのエイリアスかもしれませんinfo
)。持っている非常に長い歴史今日、インターネットに熱狂している世界にもっと興味を持っていないのは残念です。マニュアルページやユーザーを叱責する人は、マニュアルページを自分で作ることをしばしば「忘れます」(気にしない)。文書は重要。
残念ながら、Linuxのマニュアルページはうまく保存されていないため、多くのユーザーがそれを古いと見なしています。しかし、FreeBSDでは(そして他のBSDでも同様であると確信しています)、最新の状態を維持し、システムとコマンドを学ぶのに最適な方法です。
情報1980年代後半のGNUの背景から来ており、ハイパーテキストに基づいています。 Linuxシステムで広く使用されていますが、残念ながらうまく統合されていません。多くのツールには情報ページがありません。
--help
別のGNUismが導入されました。長いオプション内部にGNU Cライブラリ1990年代初頭。これは後のルールですが、長いオプションをサポートしている場合は良いルールです。
私にとって良いプログラムは、コマンドラインオプションの非常に簡単な要約を提供します-h
。プログラムが長いオプションをサポートしている場合は、同じことを行い、--help
マニュアルページに正しい指示を入力してください。
しかし、これは単なる慣例です。しかし、あなたがそれらに従いたくない場合でも、-h
私は助け以外のものを使用することに非常に注意します。または、少なくとも非破壊的なオプションであることを確認してください(例df -h
:。
今日マンページを作成します。文書。非常にシンプルで、他の場所で使用するためにMarkdown、PDF、またはHTMLで処理できるツールがたくさんあります。
関連する引用は以下で提供されます。文書
マニュアルのないユーティリティはまったく役に立ちません。
答え2
歴史的に、プログラムメモリは非常に重要であり、「ヘルプ」メッセージなどの無意味なメッセージを入れる余地はありませんでした。実際のUnixマスターはこれを暗記していますが、初心者はman(1)を使います。合理的なエラーメッセージ(ed(1)の悪名高い「?」)をほとんど覚えていません。どのエラー、CC(1)ただメッセージ「N行の構文エラー」)。メモリが増えると、一部のプログラムでは「-h」をヘルプ/最小使用ガイドラインとして受け入れ始めました。 GNUは「--オプション」としばしば「--help」の長いリストを導入しました。他の人は、「-u」または「-usage」を使用または認識できないオプションに関するヘルプを提供します。