次のページ 前のページ 目次へ

THE LINUX MAN-PAGE-HOWTO

Jens Schweikhardt<schweikh@noc.dfn.de>

April 1996

北山 公一 <kitayama@dimgrey.av.sanyo.co.jp>

30 May 1996
この HOWTO は、man(1) コマンドから利用したいオンライン ドキュメント -- いわゆる man page -- を書こうとするときに、注意すべき事 柄について説明する。

   Copyright 1995,96 by Jens Schweikhardt <schweikh@noc.dfn.de>
               配布に関する条件については、下記を参照

                     最終変更: 1996年  4月
                       訂正及び提案を歓迎する。

この HOWTO は、man(1) コマンドから利用したいオンラインドキュメント -- いわゆる man page -- を書こうとするときに、注意すべき事柄について説明 する。

この HOWTO を通じて、manual entry のことを実際のページ数に関わらず、 [a] man page と略称する。また、この略称は、性差別主義に基づ くものでもない。

1. ドキュメンテーションについての若干の考察

2. man page はいかにしてアクセスされるか?

3. フォーマットされた man page はどのようにあるべきか?

4. どうすれば、複数のプログラムや関数を一つの man page にまとめることができるか?

5. どのマクロパッケージを使うべきか?

6. どのプリプロセッサが使えるのか?

7. 配布すべきはソースかフォーマットされたドキュメンテーションか?

8. フォントに関する取り決めとは?

9. いかにして man page をより良くしていくか?

10. ^H とか ^_ などのない man page のテキストはどうすれば得られるか?

11. 高品質のポストスクリプトの man page を得るには?

12. apropos と whatis を利用できるようにするには?

13. 著作権について


次のページ 前のページ 目次へ