tcpdumpとdig manページの例 ノート

tcpdumpとdig manページの例

著者は、manページにおける例の有用性に触発され、digおよびtcpdumpツールのmanページを改善しました。主な目的は、たまにしか使わないユーザーや初心者向けに、最も基本的な例を提供することでした。この初心者やたまにしか使わないユーザーを対象としたアプローチは、効果的で好評であることが証明されています。著者は、レビュープロセスがmanページ内でより正確な情報を見つけやすくする上で価値があると感じました。また、パケットを保存する際の-vフラグなど、tcpdumpの便利な機能についても学びました。ドキュメント全般に対する懐疑的な見方にもかかわらず、著者は現在、高品質で正確なmanページの可能性に楽観的です。roffの学習を避けるため、tcpdumpのmanページ更新のためにカスタムのMarkdownからroffへのスクリプトが作成されました。これには、Markdownの抽象構文ツリーを解析し、roffコードを出力することが含まれていました。著者はまた、roffの歴史と進化、およびmandocプロジェクトについても調査しました。BSDシステムとLinuxシステムにおけるドキュメント作成の実践における技術的および文化的な違いについて、好奇心をそそられました。