Yardım (man) Sayfası Oluşturma

Eyl 06, 2013

Linux kabuklarında kullanılan programların, komutların, dosyaların her biri için bir yardım (man) sayfası hazırlanmıştır. Bu sayfalar Linux içinde nroff dili kullanılarak hazırlanmıştır. nroff eski ve karmaşık bir biçimleme dilidir fakat yardım (man) sayfalarının, Linux kullanıcılarının birinci derecede başvurdukları kaynaktır. Bir kullanıcı herhangi bir komut için yardıma ihtiyaç duyduğunda, yardım (man) sayfalarını kullanması her zaman en güvenilir yoldur. Kullanıcıların en büyük yardımcısı olan yardım (man) sayfaları şu şekilde hazırlanır:

Öncelikle her yardım (man) sayfasının Linux altındaki bölümlendirmelerden (section) birinde olması gerekir. Linux bölümlendirmelerinin en önemlilerini şu şekilde sıralanabilir:

  1. Kullanıcı komutları (User commands)
  2. Sistem çağrıları (System calls)
  3. Kütüphane fonksiyonları (Library functions)
  4. Araçlar ve ağ arayüzü (Devices and network interfaces)
  5. Dosya formatları (File formats)
  6. Oyunlar (games)
  7. Sistem yönetici araçları (System administration tools)
  8. Koruyucu komutlar (Maintenance commands)
  9. X pencere yönetimi (X window system)

Yardım (man) sayfalarında bulunan komutlar genellikle 1. bölümde yani "kullanıcı komutları (user commands)" bölümünde tutulur. Bu bölüm numarası man sayfaları dosyalarının uzantısında görülür. Örneğin "merhaba" komutu için dosya uzantısı "merhaba.1" şeklinde görüntülenmektedir..

Linux'ta yardım sayfalarına bakıldığında bir düzen halinde oldukları görülür. Ana başlıklar halinde bölümlendirilmiştir; bu ana başlıklar: "NAME", "SYNOPSIS", "DESCRIPTION", "OPTIONS", "ERRORS", "ENVIRONMENT", "DIAGNOSTICS", "EXAMPLES", "FILES", "BUGS", "RESOURCES", "NOTES", "HISTORY", "AUTHOR" ve "SEE ALSO". Her ana başlık hazırlanırken kullanılan bazı etiketler (veya komutlar) vardır. Bu ana başlıklar ve kullanılan etiketler genel anlamda şu şekilde açıklanabilir:

  • NAME: İsim bölümüdür. İstenilen komutun ismi burada yazar.
  • SYNOPSIS: Komutun kullanımı burada belirtilir.
  • DESCRIPTION: Komutun kısa bir tanımı yapılır.
  • OPTIONS: Parametrelerin belirtildiği kısımdır.
  • ENVIRONMENT: Komutu veya programı etkileyecek olan çevresel değişkenler burada belirtilir.
  • FILES: Komutun kullandığı dosyalar belirtilir.
  • DIAGNOSTICS: Komut ile ilgili karşımıza çıkan hatalarla ilgili kısa bir önizlenim ve çözüm yolunu açıklar.
  • ERRORS: Hataların gösterildiği bölümdür.
  • EXAMPLES: Örnekler ve öneriler belirtilir.
  • BUGS: Uyarı bölümüdür.
  • RESOURCES: Eğer kullanılan komut X pencere sisteminde çalışıyorsa komut için gerekli olan X kaynakları burada belirtilir.
  • NOTES: Kullanıcı komutu kullanırken ihtiyaç duyabileceği diğer bilgiler burada belirtilir.
  • HISTORY: Komut için yapılmış değişiklikler buraya yazılır.
  • AUTHOR: Ürün koordinatörü belirtilir.
  • SEE ALSO: Komut ile ilgili diğer dökümanlar veya yardım sayfaları belirtilir.

Bu başlıkların oluşturulmasında yani yardım (man) sayfası hazılanmasında kullanılan komutlar ve ne oldukları da şu şekilde sıralanabilir:

  • .TH <isim> <bölüm> <zaman> : Bu komutla ana başlık yazılır. Aranılan komutun ve ya dosyanın ismi, hangi bölümde olduğu ve en son değişiklik yapıldığı zaman burada belirtilmektedir.
  • .SH "<metin>" : Bu komut bölüm başlığı yapmak için kullanılır. Bütün bölümlerin başlığını ("NAME", "SYNOPSIS",  "DESCRIPTION",...vs) yardım (man) sayfasına bu komut yardımı ile yazdırabiliriz. Metin bölümüne hazırlanacak olan bölümün adı yazılır. Eğer metin bölümünde boşluk yoksa tırnak işaretleri kullanılmasına gerek yoktur.
  • .SS "<metin>" : Alt başlık hazırlar. Bu komutla beraber soldan en az 5 karakter boşluk bırakacak şekilde alt başlığı yazdırır. Genel olarak alt başlıkların sadece ilk harfi büyük yazılır. Tekrar ".SH" komutunda olduğu gibi eğer metin bölümünde boşluk yoksa tırnak işaretleri kullanılmasına gerek yoktur.
  • .P : Yeni paragraf başlatmak için kullanılır. ".P" komutundan sonraki satırda metin yazılmaya başlanır.
  • .IP "<öğe>" : Bu komutla daha içerden paragraf başlatılır fakat yazılan öğe bu paragrafın en sol tarafına yani eski paragraf düzenine göre baş tarafa koyulur ve yazılacak  metin daha içeriden başlar. Eğer öğe kısmı boşluk içermiyorsa tırnak kullanımına gerek kalmamaktadır.
  • .HP : İç içe paragraf oluşturulmasını sağlar. Yazacağımız metinin 1 satırdan daha uzun olması durumunda ikinci satırın 5 boşluk daha içeriden başlatılmasını sağlar.
  • .RE : Satırbaşı yapılmış bir bölgeyi tanımlamaktadır.
  • .RS : Paragraf başına göre yazılacak metni 5 boşluk kadar içeriden başlatmaktadır. Metin bu komutun altına yazılır.
  • .B "<metin>" : Bu komutla yazılacak olan metin man sayfasına kalın harflerle yazılmaktadır.
  • .I "<metin>" : Metinlerin italik yazılmasını sağlar.
  • .R : Yazı stili Roman biçiminde yazılır. Genellikle ".IR" (Roman yazı stilinde italik) veya ".BR" (Roman yazı stilinde kalın) şeklinde kullanılır.
  • .TP <sütun> : Yazılacak metne kaç sütun yer ayırılacağı belirtilir. Metin bu komutun altına yazılmaktadır.
  • .br : Satırların sonlanadırılmasını sağlar.
  • .nf : Normal satır boşluklarını sıkıştırır.
  • .fi : Normal satır boşlukları kullanmaya devam edilir. Genelde ".nf" komutundan sonra kullanılır.
  • .\" : Yorum satırlarını belirtmek için kullanılır.

Bu komutlar kullanılarak artık bir yardım sayfası oluşturulabilir. Yardım sayfası Linux işletim sisteminde çalışan bir uygulama olan manedit programında kolayca yazılabilir ve çıktısı gözlenebilir.
Aşağıda deneme komutu için bir yardım (man) sayfasının oluşumunda kullanılan komutlar verilmiştir:

 

Aşağıda da "manedit" uygulaması için ekran çıktıları gösterilmiştir.

İlk ekran çıktısı kodların yazıldığı kısmı göstermektedir:

Yardım (man) sayfalarının terminal üzerindeki görünümü:

Belirtilmiş olan kodlar "manedit" uygulamasında kullanılarak istenilen komutun yardım (man) sayfası rahatlıkla oluşturulabilmektedir.