Linux Lexicon — Bir Adam Sayfasının Anatomisi
Yayınlanan: 2016-11-01
Kısa Bayt: Yazılım kılavuz sayfaları ve belgeleri, her tür parantez ve parantez ile bağlanmış şifreli kurallar olmadan yeni başlayanlar için yeterince kalın ve zor olabilir. Burada, Linux kılavuz sayfalarının karmaşıklığını azaltmaya ve anlaşılmasını kolaylaştırmaya çalışacağız.
İSİM
Birincisi isim başlığıdır ve bu onu özetler. Bu bölüm, yardımcı programın adını ve kısa bir açıklamayı içerir.
ÖZET
Kılavuz sayfasından kılavuz sayfasına değişen derecelerde okunabilirlik vardır, ancak bir şey kesindir, en zor kısım tipik olarak uzun bir özetin şifresini çözmektir. Herhangi bir komut için gerekli bilgi parçalarını belirtmek için çeşitli kurallar vardır. Bu kurallar, farklı parantez ve parantezlerin yanı sıra diğer gösterim biçimlerinden oluşur. Tüm bu farklı gelenekler, yeni başlayanlar için son derece kafa karıştırıcı olabilir ve deneyimli ancak kılavuz sanatında bilgili olmayan biri için hala göz korkutucu olabilir. Aşağıda anlamsız kelimeleri sindirilebilir kurallara ayıracağız.
| cesaretlenmiş | Tam olarak gösterildiği gibi yazın. |
| italik veya altı çizili | Uygun argümanla değiştirin. |
| [-abcxyz] | Köşeli parantez içindeki tüm bayraklar isteğe bağlıdır. |
| -a | -B | Boru ile ayrılmış seçenekler bir arada kullanılamaz. |
| <zorunlu> | Zorunlu argüman, genellikle seçenek açıklamalarında bulunur. |
| {Evet Hayır} | Sınırlı seçenekler, yalnızca belirtilenler çalışacaktır. |
| … | Bir elips tarafından takip edilen argümanlar tekrarlanabilir. |
Bu kurallar oldukça basittir, ancak uzun işlev tanımlarında kullanıldıklarında, özellikle iç içe olduklarında daha zor ve hatta göz korkutucu hale gelirler. Bu yüzden, bozduklarımızı oluşturmak için aşağıdaki yuvalamaya bir göz atacağız.
tar {A|c|d|r|t|u|x}[GnSkUWOmpsMBiajJzZhPlRvwo] [ ARG …]
tar komutunun birçok seçeneği vardır. Tar komutunun adını kalın olarak görüyoruz çünkü gösterildiği gibi yazılmalıdır. Daha sonra, bunlarla sınırlı olduğumuzu ve sadece birini seçmemiz gerektiğini belirten borulu seçeneklerle açık olan parantezleri görüyoruz. Sırada isteğe bağlı bayraklar var, herhangi bir sayıyı kullanabiliriz, ancak hepsi birlikte çalışmayabilirler, kılavuz sayfasını daha fazla okumak, olası seçenek çatışmalarına ışık tutacaktır. Ve son olarak, üzerinde çalıştığınız dosya(lar) için tar olması durumunda tekrarlanabilir argümanımız var.
su [seçenekler] [-] [ kullanıcı [ bağımsız değişken …]]
Yine, komutun adı olduğu için su kalın görüyoruz. İkincisi, gerçekte hiçbir bayrağın belirtilmediğini, yalnızca isteğe bağlı olduklarını görüyoruz. Üçüncüsü, belirtilen tek bir bayrak vardır, ancak o da isteğe bağlıdır. Son olarak, isteğe bağlı bir bağımsız değişken içinde tekrarlanabilir isteğe bağlı bir bağımsız değişken görüyoruz. Eskiden çok gizemli görünen şey şimdi daha mantıklı geliyor.
whois [{-h|–host } SUNUCU ] [{-p|–port} PORT ] [-abBcdGHKlLmMrRx] [-g KAYNAK:İLK-SON ] [-i ATTR [, ATTR ]…] [-s KAYNAK [, KAYNAK ]…] [-T TİPİ [, TÜRÜ ]…] [–ayrıntılı] NESNE
Bu özellikle yoğun bir tanesidir. Favori metin düzenleyicinize kopyalayın ve okumanıza yardımcı olacaksa, oraya fazladan boşluk ekleyin. Bunu taradıktan sonra, birkaç desen görmeye başlamalısınız. Ana bilgisayar ve bağlantı noktası bölümleri, her ikisi de isteğe bağlıyken, seçeneğin kısa ve uzun biçimi için aynı biçimlendirmeyi ve ardından bu seçeneğin argümanını kullanır. Sonra isteğe bağlı bayrak dizisini görüyoruz. İlkinden sonuncusuna kadar kaynaklarla ilgili bir sonraki bit, daha sonra kılavuz sayfasında açıklanacak olan whois tarafından beklenen sözdizimidir. Şimdi, ya tek bir argüman ya da isteğe bağlı yinelenen argümanlar alan bu isteğe bağlı bayrak üçlüsünü görüyoruz, bu, ilk başta tam olarak kavraması çok zor olabilen sözleşmelerin birleştirilmesi türüdür. Son olarak ayrıntılı seçenek ve nesne (ana bilgisayar/etki alanı) vardır.
Ve bu, bir man sayfası özetinin nasıl okunacağıdır. Birkaç başka sözleşme daha var, ancak bu makalede ele alınamayacak kadar belirsizler.
TANIM
Bu genellikle programın veya yardımcı programın amaçlanan kullanımının ana hatlarıyla belirtildiği yerdir. Bazı kılavuzlar bu başlık altında diğerlerinden çok daha ayrıntılı olacaktır.
SEÇENEKLER
İsteğe bağlı veya zorunlu olabilecek tüm bu bayrakları ve farklı argümanları hatırlıyor musunuz? Hepsinin anlatıldığı yer burası. Burada genellikle iyi bilgiler bulunur ve belirli bir bayrağın karşılık gelen bir argüman gerektirdiğini belirten <argument> kuralını burada bulabilirsiniz. Bazen seçeneklerin açıklama bölümünde olduğunu göreceksiniz çünkü kılavuz sayfalarını tanımlayan katı bir kural yoktur, yalnızca sözleşmeler ve standartlara uyma isteği vardır.
ÖRNEKLER
Bu, ne yazık ki tüm kılavuzlarda yer almayan en kullanışlı parçalardan biridir. Ayrıca, bilgi miktarının ve örnek sayısının önemli ölçüde değiştiğini ve tüm örneklerin komutun kullanılmasına gerçekten yardımcı olmadığını göreceksiniz.
Ek olarak, düzenli olarak yazar, telif hakkı bilgileri, hata bildirimi için bölümler bulacaksınız ve ayrıca bkz. (apropos).
Bunun ötesinde, aşağıda tanımlandığı gibi, kılavuz sayfalarının resmi olarak tanımlanmış bölümleri vardır.
| 1 | Yürütülebilir programlar veya kabuk komutları |
| 2 | Sistem çağrıları (çekirdek tarafından sağlanan işlevler) |
| 3 | Kütüphane çağrıları (program kütüphanelerindeki fonksiyonlar) |
| 4 | Özel dosyalar (genellikle /dev içinde bulunur) |
| 5 | Dosya biçimleri ve kuralları, örneğin /etc/passwd |
| 6 | Oyunlar |
| 7 | Çeşitli (makro paketleri ve kuralları dahil), örneğin man(7), groff(7) |
| 8 | Sistem yönetimi komutları (genellikle yalnızca kök için) |
| 9 | Çekirdek rutinleri (normalde Linux'ta bulunmaz) |
Birçok komutun birden fazla bölümde kılavuzları yoktur, ancak olanlar veya belirsiz olarak adlandırılabilecek bazıları için aşağıdaki örnekteki gibi bölümü belirtebilirsiniz.
Mevcut bölümlerden de görebileceğiniz gibi, kılavuzları olan tek şey komutlar değildir. Sistem çağrıları, yapılandırma dosyaları ve özel cihazlar, büyük olasılıkla ilgili bir kılavuz sayfasına sahip olabilir. Tipik bir Linux kurulumuyla ilgili sadece kılavuz sayfalarındaki bilgi miktarı şaşırtıcıdır ve aynısı diğer açık kaynaklı UNIX benzeri işletim sistemleri için de geçerlidir.
Man sayfasının yeterli olmadığını fark ederseniz ve yine de bir komutu anlamadıysanız, her zaman çevrimiçi olarak kontrol edin çünkü birçok kişi belirli araçlar hakkında daha kapsamlı açıklamalar sunar, ancak aynı zamanda birçok dağıtımın farklı yazılım paketleri için kendi kılavuz sayfaları vardır. Bir yazılım parçasından memnun olduğunuzu fark ettiğinizde, ancak yine de kılavuzun eksik olduğunu hissettiğinizde, kendinizinkini yazıp ilgili projeye göndererek her zaman katkıda bulunabilirsiniz. Belgeleme genellikle yazılım projelerinin en ihmal edilen kısmıdır, bu nedenle kod yazamasanız bile başkalarına yardımcı olmak için kılavuzlar, Wiki makaleleri ve öğreticiler yazabilirsiniz.
Artık bir man sayfasının anatomisini bildiğinize göre, RTFM'den başka bir mazeretiniz yok (ve bu, 18 yaşın altındakiler için ücretsiz kılavuzu okuyor);)
Ayrıca Okuyun: Linux Lexicon: Her X Saniyede Bir Komut Çalıştırmak İçin İzleme Komutunu Kullanın