Manpage

Man sayfaları ( İngilizce kılavuz " manuel " anlamına gelen Unix komutundan sonra ), Unix ve ilgili işletim sistemleriman için bir dizi yardım ve belge sayfasıdır . Onlar edilir aranır ve çıkış komutları ile ve . Hızlı tarama için Whatis veritabanı adı verilen ayrı bir indeks oluşturulur. Man sayfaları , Unix sistem aracı ile özel olarak tasarlanmış Makro paketi yardımıyla oluşturulur . manwhatismantroff

inşaat

Yapı, bölümler

Man sayfaları, büyük ölçüde, POSIX standardı (IEEE Std 1003.1) tarafından açıkça standartlaştırılmamıştır, ancak standardizasyon yalnızca kesinlikle gerekli olan minimum düzeyde gerçekleştirilmiştir. Bununla birlikte, çoğu Unix türevine benzeyen sözde bölümlere (bölümler, alanlar) bölünme, orijinal bölüme dayalı olarak oluşturulmuştur.

Örneğin, burada AIX altındaki bölümler ( Locale C'deki başlık ):

• (1) Kullanıcı Komutları ve Cinler ( "Kullanıcı komutları ve arka plan hizmetleri")
• (2) Sistem Çağrıları ve Çekirdek Hizmetleri (" Sistem Çağrıları ve Hizmetler")
• (3) Alt programlar ("alt programlar")
• (4) Özel dosyalar, aygıt sürücüleri ve donanım ("aygıtlar")
• (5) Yapılandırma Dosyaları ("yapılandırma dosyaları")
• (6) Oyunlar ("Oyunlar")
• (7) Çeşitli Komutlar
• (8) İdari Komutlar ve Daemonlar ("Yönetim")

Notasyonu jail(8) manuel sayfa anlamına gelir FreeBSD sistem yönetimi komut hapse notasyonu ise jail(2)FreeBSD manuel sayfa anlamına gelir sistem çağrısı hapse .

Bireysel kılavuz sayfalarının yapısı

Bölümler için kullanılana benzer gayri resmi bir sözleşme de münferit makalelerin yapısı için oluşturulmuştur. Yalnızca sistem komutlarını GNU girişiminden (Linux, FreeBSD vb.) Alan sistemler bu kuraldan büyük ölçüde sapmaktadır , çünkü GNU projesi man sayfalarını daha iyi düşündükleri alternatiflerle ( Texinfo ) değiştirmeye çalışır . Ancak, bu tür dokümantasyon içermeyen programlar için man sayfaları da vardır, çünkü bu dokümantasyon bireysel Linux dağıtımları için yaratılmıştır ( Debian projesi tüm programların bir man sayfasına sahip olmasını şart koşmaktadır ); ancak çoğu durumda bunlar yalnızca kısa açıklamalardır, bazen güncelliğini yitirir, çoğunlukla yalnızca İngilizce olarak mevcuttur ve her sistemle birlikte sağlanmamaktadır.

Bir kılavuz sayfası tipik olarak aşağıdaki alanlara bölünmüştür, köşeli parantezli bölümler isteğe bağlıdır:

SOYADI

Programın adı ve ardından tek satırlık kısa bir açıklama.

SİNOPSİS

Programlar için, parametrelerin ve seçeneklerin tam listesi burada açıklanmaktadır.

AÇIKLAMA

Komutun veya işlevin nasıl çalıştığına ilişkin bir metin açıklaması. (Genellikle kullanılmaz, aşağıya bakın.)

SEÇENEKLER / BAYRAKLAR

Genellikle alfabetik sırayla, seçenekler ve yasal argümanlarının bir listesi.

(KULLANIM)

Programı kullanma talimatları.

ÇIKIŞ DURUMU

Olası dönüş değerlerinin ve anlamlarının açıklaması.

(ÖRNEKLER)

Bazı kullanım örnekleri.

(DOSYALAR)

Belirli dosyalar (ör. Yapılandırma dosyaları) programın işleviyle ilgiliyse veya bunların yürütülmesinden etkilenmişse, burada listelenir ve işlevleri açıklanır.

AYRICA BAKINIZ

Benzer veya ilgili komutların veya işlevlerin bir listesi; etkilenen dosyalar için Bölüm 5'teki karşılık gelen girişlere atıfta bulunulur.

kullanım

Belirli bölümlerdeki Man sayfalarına genellikle giriş başlığı ( N ) şeklinde atıfta bulunulur ; burada N, syslogd (1) veya syslogd (8) gibi bölüm numarasıdır . Çoğu programın yalnızca bir bölümü vardır. Çağrılırken manbölüm numarası belirtilmezse, bulunan ilk bölüm görüntülenir.

Man sayfaları, tek tek belgeler olarak standarda tabidir /usr/share/man, yani sabit bir dizin hiyerarşisinde, yerel ayarda (belgelerin genellikle İngilizce olarak yazılan yerel dil çevirileri), bölüm vb. manOrtam değişkeni, uygulamasının çoğu uygulaması tarafından da MANPATHanlaşılmaktadır, ancak kullanımı açıkça POSIX standardı tarafından kapsanmamaktadır.

Genellikle bir sarmalayıcı veya takma ad olan apropos komutuyla Whatis veritabanında anahtar sözcükler arayabilirsiniz. Cevap, bölüm numarası da dahil olmak üzere bulunan girişlerin bir listesidir ve tekrar aradığınızda argüman olarak aktarılabilir. man -kman

İnternet linkleri

• Ken Thompson , Dennis Ritchie : Unix Programcı El Kitabı. Lucent Technologies, 3 Kasım 1971, 10 Eylül 2017'de erişildi (Unix Programcı El Kitabının 3 Kasım 1971 tarihli ilk baskısı burada tarama, Postscript ve PDF dosya formatında mevcuttur). 
• BSD : man(1) -  OpenBSD Genel Komutlar Kılavuzu
• GNU : man(1) -  Debian GNU / Linux Yürütülebilir programlar veya kabuk komutları kılavuz sayfası
• POSIX : man -  Açık Grup Temel Özellikleri
• AIX , HP-UX , IRIX , Minix ,…, Xenix gibi diğer işletim sistemleri için daha fazla kılavuz sayfası

Bireysel kanıt

1. ↑ Açık Grubun ^{a b} man özelliği. Erişim tarihi: April 17, 2013 . 
2. ↑ freebsd.org
3. ↑ freebsd.org
4. ↑ Komutun adından sonra parantez içindeki sayı, on FreeBSD kılavuz bölümüne ("alanlar") bölünmeyi takip eder , bunlar: (1) genel komutlar, (2) sistem çağrıları, (3) alt programlar, (4) özel dosyalar , (5) dosya formatları, (6) oyunlar, (7) makrolar ve kurallar, (8) bakım komutları, (9) çekirdek arayüzü, (n) yeni komutlar.
5. ↑ ^{a b} Dosya Sistemi Hiyerarşi Standardı (FHS). Erişim tarihi: April 17, 2013 .