manページの書き方
出典: フリー百科事典『ウィキペディア(Wikipedia)』 (2022/05/30 02:23 UTC 版)
「manページ」の記事における「manページの書き方」の解説
macOSやLinuxでは、manとmdocという2つのgroffマクロのパッケージがmanページ執筆に使える。manの方が古く、UNIXの従来からのフォーマットのmanページを書くことができる。一方mdocは新しく、文書の意味論的構造をよくサポートしている。macOSおよびLinuxでこれらの使い方を知るには、man groff_manおよびman groff_mdocというコマンドを実行すればよい。 あるいは、システム内にある個々のmanページのソースコードを見て真似をすればmanページを書ける。macOSとLinuxの場合、通常/usr/share/manにmanページのソースファイルがある。ソースファイルの場所は、例えばコマンド名がcommandならばman -w commandを実行することで得られる。 manページはDocBookやLinuxDoc(英語版)フォーマットで書くこともでき、それをgroffにより変換すればよい。
※この「manページの書き方」の解説は、「manページ」の解説の一部です。
「manページの書き方」を含む「manページ」の記事については、「manページ」の概要を参照ください。
- manページの書き方のページへのリンク