2016-12-05 14 views
1

私はLinuxで多くのツールとコマンドを使用している会社で働いています(内部と外部)linuxの一般的なマニュアルを作成するには?

ツールごとに例を挙げてカスタムマニュアルを作成したいと思います。このために情報ツールを使用しての

思想:

info CompanyName tool1 
info CompanyName tool2 
info CompanyName tool3 
.. 

とそれぞれの出力は、私が追加した例やコメントの単純なテキストでなければなりません。

私の知る限りでは、Linuxの情報は特定のツール用に作成されており、カスタマイズされたニーズには適していません。

上記を達成する最良の方法は何でしょうか? 現在、私はツールごとのタブと毎回昇華を使用していますし、新しいサンプルで昇華タブを更新します。

アドバイスをいただければ幸いです。

答えて

0

私は情報ページのファンではありません。私は良い古いUnixのmanページを好んでおり、それらを書くのはとても簡単です。エディタでマニュアルページを開くだけで、ソースを見て、必要に応じてコピーすることができます。

ほとんどのシステムでは、マニュアルページは/usr/share/man/{man1,man2,man3,man4,man5,man6,man7,man8}/のようなディレクトリにあり、manコマンドの-wオプションを使用して、マニュアルページの場所を確認して開くことができます。たとえば、

$ man -w ls 
/usr/share/man/man1/ls.1.gz 
$ vim /usr/share/man/man1/ls.1.gz 

あなたはそれがどのように書かれているか分かり、あなた自身のマニュアルページを書くことができます。誰かがあなたが書いたマニュアルページを読むことができるようにするには、manページがmanページを探すディレクトリの一つにmanページをインストールしなければなりません。 Linuxでは、通常manpathコマンドを実行することでこのディレクトリの一覧を見ることができます(他のシステムでは異なる可能性があり、manコマンド自体のマニュアルページを参照する必要があります)。これらのディレクトリの1つにマニュアルページを格納する場合は、manユーティリティを使用してマニュアルページを読むことができます。

manユーティリティは、環境変数MANPATHを尊重し、あなたが標準以外の場所であなたのmanページを保存する場合manはそれを見ることができるように、あなたは、MANPATH変数を設定することができます。POSIXを1としてまた、/etc/man.confファイルを変更して、マニュアルページディレクトリを検索パスmanに追加することもできます。

ここで、マニュアルページはマークアップを行うためにマクロ言語を使用しています。手動here

を見ることができるため、Linuxシステムは、オペレーティング・システムのBSDファミリーで広く使用されているmdoc(7)と呼ばれるmanページを書くための別の現代のマクロセットは、あり、man(7)マクロ構文を使用する傾向があります。あなたはそのマニュアルを見ることができますhere

関連する問題