私はパッケージ化されているプログラムのマニュアルページを書いています。作成したマンページファイルを表示して正しいことを確認するにはどうすればよいですか?man
インストールされたマニュアルページを名前で検索するのではなく、自分のファイルをコマンドに直接渡す方法はありますか?
私はman myprog.1
次のことを試しましたが、man < myprog.1
どちらの場合もマニュアルページが見つからないというエラーが発生しました。
答え1
man
ローカルファイルを読み込むオプションがあります。-l
-l、--local-file
"ローカル"モードを有効にします。システムのマニュアルコレクションを検索せずに、ローカルのマニュアルファイルをフォーマットして表示します。各マニュアルページ引数は、正しい形式のnroffソースファイルとして解釈されます。 Catファイルは生成されません。
「-」が引数の1つとしてリストされている場合、標準入力から入力を取得します。このオプションを使用せずに必要なページが見つからない場合は、エラーメッセージを表示する前に名前をファイル名として使用し、正確に一致するものを見つけて、このオプションが指定されているかのように機能しようとします。
したがって、次の手順で進行中のタスクをプレビューできます。
man -l /path/to/manfile.1
答え2
このオプション以前のシステムでは、-l
「既存」の方法は次のとおりです。
nroff -man filename | more -s
答え3
私は単に使用しました
man ./path/to/man.1
パスにスラッシュを含める必要があります。それ以外の場合は、システムディレクトリを検索します。私が持っているLinuxとOS Xシステムの両方で動作します(後者ではありません-l
)。
$ cd /tmp
$ cp /usr/share/man/man1/ls.1 .
$ man ls.1
No manual entry for ls.1
$ man ./ls.1 # works
答え4
Solarisは、マンページを上書きする検索パス-M
に切り替えます。 -man
man -M path/to/man myprog
マンページファイルは、セクションとマークアップ言語に対応する適切なサブディレクトリに配置する必要があります(例:path/to/man/man1/myprog.1
パート1のnroff-manpage)。