私はLinuxとFreeBSD用の小さなCライブラリを書いており、それを文書化する予定です。マニュアルページの作成について詳しく調べようとしましたが、ライブラリ用のマニュアルページの作成に関するベストプラクティスの説明や説明が見つかりませんでした。特に、関数のマニュアルページのどの部分が配置されているかに興味があります。サム?たぶん良い例やマニュアルがありますか?ライブラリのすべての機能についてマニュアルページを作成するのは悪い考えですか?
ベストアンサー1
ライブラリのマニュアルページはセクション 3 に配置されます。
マニュアルページの良い例については、一部のマニュアルページがgroffの特定の詳細で書かれているか、または実際に移植性のない特定のマクロを使用していることに注意してください。
一部のシステムでは特殊機能を使用する場合と使用しない場合があるため、マニュアルページの移植性には常にいくつかのトラップがあります。たとえば、ロギング時にdialog
、さまざまなシステムで示されている例の違いを覚えて解決する必要があります(これは不合理です)。
次から始まった読むman man
標準マクロの関連部分に言及し、比較するこの説明はFreeBSDとLinuxに関するものです。
ライブラリ用に1つのマニュアルページを作成するか、関数(または機能グループ)に対して別々のマニュアルページを作成するかを選択するかどうかは、関数の説明の複雑さによって異なります。
追加資料: