Linuxのマニュアルページを作成する方法

コマンド Linuxでは、すべてのLinux開発者とユーザーの筋肉の記憶に組み込まれています。文字通りすべての人が使用します。アマチュアや初心者の開発者からLinuxの専門家や専門家まで。

Linuxコマンド、構成ファイル、またはその他の機能のコマンドラインマニュアルページを読むために使用されます。マニュアルページは通常、Linuxでのソフトウェアのインストールと一緒にインストールされます。コマンドによって解析されるマニュアルページ用に定義された構文があります。

私が書いた次のbashスクリプトのマニュアルページを作成しましょう。

#!/ bin / bash if ["$ 1" == "h"];次に、["$ 1" = "b"];の場合、 "Hello" fiをエコーし​​ます。次に「バイ」fiをエコーし​​ます

このスクリプトは2つのことだけを行います。オプション「h」が引数として指定されている場合は「Hello」を出力し、オプション「b」が引数として指定されている場合は「Bye」を出力します。

このプログラムのマニュアルページを作成しましょう。つかいます vim または、テキストファイルを作成するために選択した任意のエディタ。

vim test.1

拡張子「.1」は、このマニュアルページが実行可能コマンド用であることを示しています。これは強制ではなく、manページを作成する際に広く使用されている規則です。男性用のマニュアルページ(男男 !)カテゴリを一覧表示します。

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

マニュアルページは、非常に古いroffマークアップ言語を使用して作成されます。さまざまなタイトルやセクションのコマンド(読み取りマーカー)があります。

  • .TH –これはmanファイルの最初のコマンドである必要があります。マニュアルページのタイトル見出しを指定するために使用されます。
  • .SH –セクション見出し。
  • .B –横にあるテキストを太字で表示するために使用されます。
  • .TP –コマンドの引数(フラグ)に関する情報を表示するために使用されます。
  • .BR –テキストを太字で通常のローマンフォントで表示するために使用されます。

以下は、上記の(単純な)roffコマンドのみを使用して作成された私のプログラムのマニュアルページです。

.TH test.sh 1 .SH NAME test.sh \-印刷こんにちはまたはさようなら.SH概要.Btest.sh [h] [b] .SH説明.Btest.shこれは2つのことだけを行うサンプルスクリプトです。引数が「h」の場合は「Hello」を出力し、引数が「b」の場合は「Bye」を出力します。.SHOPTIONS.TP .BR h Print Hello .TP .BR b Print Bye

ファイルを保存します 最初にを押すことによって ESC キーを押してから、 :wq ファイルを保存してvimコンソールを終了します。

以下のコマンドを使用して、作成したマニュアルページをテストします。

男./test.1

詳細については 使用法、実行 manman-pages ターミナルでコマンドを実行します。

? ヒント

これは、マニュアルページを作成するための基本的な構文です。作業を簡単にするために、txt2manなどのツールを使用して、マークアップ言語形式のファイルをroff形式に変換できます。