Man Dosyaları
Man dosyaları /usr/share/man veya /usr/local/share/man dizinleri içinde bulunurlar. Büyük bir olasılıkla sisteminizde /usr/share/man dizini içinde olacaktır. XWindows kullanımının yaygınlaşması özellikle Linux ve Unix benzeri sistemleri yeni kullanmaya başlayan insanların pek bilmediği bir konudur. Eski bir yöntem olsa da en hızlı ve kolay yöntemdir. HTML sayfalardan oluşan yardım dosyaları son derece yaygındır. Özellikle konsol altında çalışaması için yazılmış bir uygulamanın dökümanlarına ulaşmak için HTML gösteren bir uygulamaya ihtiyaç duyulacaktır. Halbuki man tüm sistemlerde hazır olarak bulunmaktadır. Konsol altında rahatlıkla kullanılabilirler.Yazılmış olan bir uygulamanın bir man sayfasının olması kullanırlığını artıracaktır. Man dosyaları bir text editör ile kolaylıkla yazılabilir. Bunun yanında manedit ve gmanedit gibi XWindows altında çalışan yardımcı uygulamalar mevcuttur. Man dosyaları genel olarak /usr/share/man dizini içinde sıkıştırılmış olarak bulunur. Kullanımı “man prog_adi” biçiminde olmaktadır. Bir man dosyası örnek olarak aşağıdaki şekildeki gibidir.
Bir uygulamaya ait temel man çıktısı aşağıdaki şekilde olacaktır.
User Commands <program name>(1)
NAME
<program name> - <one line description of program>
SYNOPSIS
<program name> <grammar for command line>
DESCRIPTION
<detailed description of what the program does>
OPTIONS
-<a command line switch>
<description of what that switch does>
-<a command line switch>
<description of what that switch does>
<etc . . .>
SEE ALSO
<a list of related man pages>
BUGS
<known bugs if any>
Sistemlerde yaygın olarak ingilizce man dosyaları ile karşılaşıldığı için sizlere ingilizce bir man taslağını sunmayı uygun gördüm. Buradaki şekilde herşey ingilizce tanımlanacak diye bir kural yoktur. Tüm alanlarını Türkçe man dosyaları yazılırken Türkçe olarak da tanımlanabilir.
.TH "<program name>" 1
.SH NAME
<program name> \- <one line description of program>
.SH SYNOPSIS
.B <program name>
<grammar for command line>
.SH DESCRIPTION
<detailed description of what the program does>
.SH OPTIONS
.TP
.B \-<a command line switch>
<description of what that switch does>
.TP
.B \-<a command line switch>
<description of what that switch does>
.TP
.B <etc . . .>
.SH "SEE ALSO"
<a list of related man pages>
.SH BUGS
<known bugs if any>
Uygulamanın adı, açıklaması, yazarı, ilgli bakılması gereken diğer bölümler gibi bir çok alt başlık açılabilir. Bu alanlar Türkçe veya başka bir dilde yazılabilir.
Örnek olarak;
NAME
<program name> - <one line description of program>
biçiminde olan bir alanı,
İSMİ
<uygulama adı> - <bir satırlık uygulama açıklaması>
biçiminde Türkçe olarak, man kodları içinde tanımlanabilir. Bu alanın yukarıdaki şekilde uygun yazılmasını sağlayan kod aşağıdaki şekildedir.
.SH "İSMİ"
uygulama adı - Uygulamaya ait bir satırlık açıklama
Yazım sırasında vurgu yapılması farklı formatlarda yazılması için özel komutlarda mevcuttur. Bu komutlar aşağıdaki şekildedir.
.B : Kalın yazar.
.BI : Kalın ve yatık yazar.
.BR : Kalın ve roman font ile yazar.
.I : Yatık yazar.
.IB : Yatık ve kalın yazar.
.IR : Yatık roman fontlu yazar.
.R : Roman fontlu yazar.
.RI : Roman fontlu ve yatık yazar.
.RB : Roman fontlu kalın yazar.
Bir man dosyasında genel olarak bulunan alanlar.
NAME - İSMİ
Bu alan olması zorunlu bir alandır. Her man dosyasında uygulamanın adı ve temel bir açıklaması bulunur.
SYNOPSIS- KULLANIM
Uygulamanın alabileceği parametreler ve kullanımı hakkında bilgiler yazılır.
DESCRIPTION - AÇIKLAMA
Uygulamanın neler yapabildiği, nasıl çalıştığının ne işe yaradığının yazıldığı kısımdır.
FILES - DOSYALAR
Uygulamanın kullandığı dosyalar ve o dosyaların nasıl bir yapıda olduğu anlatılan bölümdür. Örnek olarak /etc/apache/httpd.conf dosyası şu şekilde kullanılır gibi.
BUGS - SORUNLAR
Uygulamanın bilinen sorunları yazılır.
AUTHOR - YAZAN
Uygulamayı geliştiren kişi ve kişilerin kimler olduğu yazılır ve nasıl ulaştırılacağına dair bir e-posta adresi veya bir WEB adresi verilir.
SEE ALSO - BAKILACAK
Uygulama ile ilgili bakılabilecek diğer uygulamalar veya kaynaklar yazılır.
Man dosyası oluşturulduktan sonra deneme.man olarak kayıt edelim ve daha sonra aşağıdaki komutlar ile sıkıştıralım. Man dosyaları sistemde sıkıştırılmış olarak bulunurlar.
# gzip –c deneme.man > deneme.1.gz
Dizin içinde deneme.1.gz isimli dosya oluşacaktır. Bu dosyayı kullanabilmek için /usr/share/man/man1 dizini içine kopyalayalım ve aşağıdaki komutu çalıştıralım.
# mandb
Purging old database entries in /usr/share/man...
Processing manual pages under /usr/share/man...
Updating index cache for path `/usr/share/man/man1'. Wait...done.
Checking for stray cats under /usr/share/man...
Checking for stray cats under /var/cache/man...
Purging old database entries in /usr/local/man...
Processing manual pages under /usr/local/man...
Purging old database entries in /usr/local/share/man...
Processing manual pages under /usr/local/share/man...
1 man subdirectories contained newer manual pages.
2 manual pages were added.
0 stray cats were added.
0 old database entries were purged.
Bu komut sonrasında sistemde konsol altında “man deneme” yazarak hazırlamış olduğumuz man sayfasına erişebiliriz.
Downloads
Author