Programın(ların)ızın bir(er) kılavuz sayfası olmalıdır. Yoksa, bu dosyaları kılavuz sayfası şablonu olarak kullanabilirsiniz. Her biri doldurabileceğiniz taslaklardır.
Kılavuz sayfaları normalde nroff(1) ile yazılır. manpage.1.ex örneği de nroff ile yazılmıştır. Bu dosyayı nasıl düzenleyeceğinizi öğrenmek için man(7) kılavuz sayfasını inceleyiniz.
Diğer taraftan nroff yerine SGML ile yazmayı tercih ederseniz, manpage.sgml.ex şablonunu kullanabilirsiniz. Eğer bunu yapacaksanız:
- docbook-to-man paketini yüklememeli,
- control dosyasındaki Build-Depends satırına Build-Depends'ı eklemeli,
- rules dosyanızdaki build kuralında bulunan docbook-to-man çağrısını içeren satırı açıklama satırı olmaktan çıkarmalısınız. `build' kuralındaki yorum satırını kaldırmak zorundasınız.
Ve dosyanın adını gentoo.sgml gibi birşey olarak değiştirmeyi unutmayın!
Son kılavuz sayfası ismi belgelendirdiği programın ismini içermelidir, bundan dolayı "manpage" olan ismini "gentoo" olarak değiştireceğiz. Dosya adı ayrıca, dosyanın bir kullanıcı komutunun kılavuz sayfası olduğu anlamına geler ".1" sonekini içererecektir. Bunun doğru bölüm numarası olduğundan emin olmalısınız. Kılazuz sayfa bölümlerinin listesi:
Bölüm No. Bölüm ismi Açıklama
-----------------------------------------------------------------
1 Kullanıcı komutları Çalıştırılabilirler ve betikler.
2 Sistem çağrıları Çekirdek tarafından sağlanan işlevler.
3 Kütüphane çağrıları Sistem kütüphanelerindeki işlevler.
4 Özel dosyalar Genelde /dev dizinindeki aygıt dosyaları.
5 Dosya biçimleri /etc/passwd gibi dosyaların biçimleri.
6 Oyunlar Veye diğer değersiz programlar.
7 Makro paketleri Man makroları gibi makrolar.
8 Sistem yönetimi Genellikle root tarafından kullanılan komutlar.
9 Çekirdek yordamları Çekirdekle ilgili standartdışı çağrılar.
O halde, gentoo'nun kılavuz sayfası gentoo.1 olarak isimlendirilmelidir. X programları için bölüm numarasının sonuna bir "x" ilave edebilirsiniz, örn. gentoo.1x. Bir gentoo.1 kılavuz sayfası orjinal kaynakta yoktu, örnekleri ve üstdüzey belgeleri okuyarak bir tane yazdım.