Linux əməliyyat sistemlərində man səhifəsi (manual page) yazmaq, bir proqram və ya komanda üçün sənədlər yaratmaq məqsədilə istifadə olunan yayğın bir üsuldur. Man səhifələri adətən “troff” adlı bir sənəd işarələmə dili ilə yazılır. Man səhifəsi yaratmaq üçün aşağıdakı addımları izləyə bilərsən:
1. Man səhifəsinin formatı:
Man səhifələri müəyyən formatda yazılır. Adətən .1, .2, .3 və s. uzantılarla yadda saxlanırlar. Məsələn, bir komanda üçün yaradılan man səhifəsi .1 uzantısını alır. Hər bölmənin müəyyən məqsədi var:
- 1: İstifadəçi komandaları (ümumi komandalar)
- 2: Sistem çağırışları (kernel funksiyaları)
- 3: Kitabxana funksiyaları
- 4: Cihaz faylları
- 5: Fayl formatları
- 6: Oyunlar və əyləncələr
- 7: Digər müxtəlif mövzular
- 8: Sistem inzibatçısı komandaları
Məsələn, bir istifadəçi komandası üçün yazılan man səhifəsi belə görünəcək: mycommand.1.
2. Man səhifəsinin strukturu:
Man səhifəsi adətən bu bölmələrdən ibarətdir:
- NAME: Komandanın və ya proqramın adı və qısa təsviri
- SYNOPSIS: Komandanın necə istifadə edildiyini göstərir
- DESCRIPTION: Komandanın ətraflı təsviri
- OPTIONS: Mövcud variantlar
- EXAMPLES: İstifadə nümunələri
- SEE ALSO: Əlaqədar komandalar və ya sənədlər
- AUTHOR: Müəllifin adı
- BUGS: Məlum xətalar
3. Man səhifəsi yazma addımları:
- Faylı Yaratmaq: Bir mətn redaktoru istifadə edərək man səhifəsini yazmağa başla. Məsələn,
mycommand.1adlı bir fayl yarat:
2. troff Formatında Man səhifəsi yazmaq: Man səhifələri troff formatında yazılır. Sadə bir nümunə:
4. Tool:
- Groff: Man səhifələrini formatlamaq üçün istifadə olunan vacib bir alətdir
Bu addımlarla öz man səhifələrini yarada və sistemdə digər man səhifələri kimi əlçatan edə bilərsən.
