Neden erkek sayfalarının örnekleri yoktur?


52

Erkek sayfalarının çoğunun birkaç ortak örnek içermemesinin bir nedeni var mı? Genellikle tüm olası seçenekleri açıklarlar, ancak bu yeni başlayanların "genellikle" nasıl kullanıldığını anlamalarını zorlaştırır.


1
Tahminime göre, CR'den kurtulmak gibi, değerli disk alanı kazanmak istiyorlardı. Krş Beckett, Watt , s.8: "Çok değerli uzay sonra pletorik dönüşlü zamir yer bırakmamak tarafından [...] kaydedildi söz hakkından ."
Peter - Monica

3
Bu sorun için denenen bir geçici çözüm tldr-pages.github.io olsa da, çevrimdışı erişim için her şeyi önden indirmeyi neden kolaylaştırdıklarını anlamıyorum.
Nathan Long,

man jq1000'den fazla örnek satırı var (Ubuntu
16.04'te

Yanıtlar:


49

Yani Geleneksel olarak, onlar ... adam sayfalarında bağlıdır var örneklerle bir bölüm ekledik - ama nedense genellikle Linux altında adam sayfalarından eksik olduğunu (ve GNU komutlarını kullanarak diğer varsayalım - En bugünlerde olan). Solaris'te ise hemen hemen her man sayfasında, genellikle birkaç örnekle birlikte Örnek bölümü bulunur.

Tahmin edersem, FSF / GNU uzun bir süre mansayfaları kullanmamaya cesaret edemez ve bunun yerine kullanıcıların bilgi için belgeyi kullanmasını tercih eder. infosayfalar genellikle man sayfalarından daha kapsamlı olma eğilimindedir ve do örnekler içermektedir. infosayfalar ayrıca daha "topikal" dir - yani ilgili komutlar (örneğin dosya bulma komutları) sıklıkla birlikte bulunabilir.

Diğer bir sebep de GNU ve mansayfalarının birbirinden farklı birçok farklı işletim sistemlerinde kullanılması olabilir (farklı Linux dağıtımları arasında çok fazla fark var.). Amaç, yayıncının belirli bir işletim sistemi / dağıtım ile ilgili - daha az nadiren yapıldığı belli örnekler eklemiş olması olabilirdi.

Ayrıca mansayfaların asla "yeni başlayanlara öğretme" amaçlı olmadığını da eklerdim. UNIX bilgisayar uzmanları tarafından geliştirilmiştir (eski terim "bilgisayar korsanları") ve bilgisayar uzmanları tarafından kullanılması amaçlanmıştır. Bu nedenle, man sayfaları bir acemi öğretmek için değil, bazı belirsiz bir seçenek veya garip bir dosya formatı için bir hatırlatıcıya ihtiyaç duyan bir bilgisayar uzmanına hızlı bir şekilde yardımcı olmak için yapılmıştır - ve bu bir man sayfasının nasıl bölümlendiğine de yansımaktadır.

man-sayfaları bu nedenle amaçlanmıştır

  • Hafızanızı yenilemek için hızlı bir referans; komutun nasıl çağrılması gerektiğini ve mevcut seçeneklerin listelenmesini gösterir.
  • Komutun tüm yönlerinin derin ve kapsamlı - ve genellikle çok teknik - açıklaması . Diğer bilgisayar uzmanları için bilgisayar uzmanları tarafından yazılmıştır.
  • Komut tarafından kullanılan ortam değişkenleri ve dosyaların (yani config dosyaları) listesi.
  • Diğer belgelere (örneğin, kitaplar) ve diğer mansayfalara referans - örn. config dosyaları ve ilgili / benzer komutların formatı için.

Bununla birlikte, mansayfaların örneklere sahip olması gerektiğine katılıyorum , çünkü kullanımı man sayfasının içinde dolaşmaktan daha iyi açıklayabilirler. Çok kötü örnekler genellikle Linux mansayfalarında bulunmaz ...

Solaris kılavuz sayfasının Örnek kısmının örneği - zfs (1M):

(...)
ÖRNEKLER
     Örnek 1 ZFS Dosya Sistemi Hiyerarşisi Oluşturma

     Aşağıdaki komutlar, pool / home adında bir dosya sistemi oluşturur.
     ve pool / home / bob adlı bir dosya sistemi. Bağlama noktası
     / export / home, ana dosya sistemi için ayarlanmıştır ve
     alt dosya sistemi tarafından otomatik olarak miras alınır.

       # zfs havuz / ev oluştur
       # zfs mountpoint = set / ihracat / ev havuzu / ev
       # zfs pool / home / bob oluştur

     Örnek 2 ZFS Anlık Görüntüsü Oluşturma

     Aşağıdaki komut dün adlı bir anlık görüntü oluşturur.
     Bu anlık görüntü, istek üzerine .zfs / anlık görüntüye monte edilir
     pool / home / bob dosya sisteminin kök dizininde.

       # zfs snapshot pool / home / bob @ dün

     Örnek 3 Birden Çok Anlık Görüntü Oluşturma ve Yok Etme

     Aşağıdaki komut, dün adında anlık görüntüler oluşturur
     havuz / ev ve tüm azalan dosya sistemleri. Her biri
     anlık görüntü .zfs / snapshot dizininde isteğe bağlı monte edilir
     dosya sisteminin temelinde. İkinci komut yok eder
     yeni oluşturulan anlık görüntüler.

       # zfs anlık görüntüsü -r pool / home @ dün
       # zfs destroy -r pool / home @ dün

SunOS 5.11 Son değişiklik: 23 Tem 2012 51

Sistem Yönetimi Komutları zfs (1M)

     Örnek 4 Dosya Sistemi Sıkıştırmasını Devre Dışı Bırakma ve Etkinleştirme

     Aşağıdaki komut, için sıkıştırma özelliğini devre dışı bırakır.
(...)

Bu özel sayfa, 16 (!) Örnekle birlikte geliyor.
(Ayrıca bu komut için tüm man sayfasını okumak yerine, kendimi çoğunlukla bu örnekleri takip ettiğimi itiraf edeceğim ...)


2
Bu son cümle , el kitaplarında örneklerle bir sorunu vurgulamaktadır . Biri, aracın özel uygulamasının etkilerini tam olarak anlamadan kişinin ihtiyaçlarına en uygun örnekleri alır. Ve sonra, bir kişi "Ben böyle yaptım" diyebilir, fakat gerçekte neden veya ne anlama geldiğini söyleyemez.
Kusalananda

6
@Kusalananda Savunma olarak ben var çeşitli seçenekler hakkında ve aslında ettik alt komutlar hakkında okumak gerekli (henüz) değil sadece her şey -. Kullanım hatalarına tehlikesine rağmen, örnekler ... sadece benim kullanım için uygun değil mi bir amaca hizmet - ve ihtiyacınız olan tüm tüm çan okuyan bir komut sadece en temel kullanımı, ve eğer ıslık pek gereklidir.
Baard Kopperud

@Kusalananda Ayrıca komutlara da bağlı olabilir. Bildiğim çoğu Unix ve GNU yardımcı programı iyi belgelenmiştir, ancak mantıklı bir şey yapmak için belgelere ihtiyacınız vardır . Daha yeni Solaris komutları (özellikle zfs) oldukça doğal bir şekilde tasarlanmıştır. Örneğin zfs destroy pool/filesystem, temel kullanım ve kullanım durumlarının% 90'ı için para cezası. Gibi kısa seçenekler -riçin recursivedaha özel ve onlar istenmeyen yan etkileri olabilir, çünkü kullanımdan önce danışma gerekir.
user121391 11

26

Buna iyi bir cevap olduğunu sanmıyorum. Bu bir kültür meselesi. Bazı man sayfalarında örnek kullanım var. Örn man rsync. Man sayfası yazarına yazıp kültürünü değiştirmeyi deneyebilir, ondan bazı örnek kullanımları eklemesini isteyebilir veya (çok daha iyi) bazı örnek kullanım örneklerini kendiniz önerebilirsiniz. Özgür bir yazılım yazarı yaması, özellikle de bir dokümantasyon yaması sunarsanız, istenen sonucu elde etmek için basit bir istekten yaklaşık on bin kat daha fazladır.


7

Değişir:

  • İlginç bulacağınız programların çoğu, başlangıçta bir sorunu çözmek ve daha sonra çözümü geliştirmek için belirli bir süre boyunca geliştirilir. Programların geliştiricileri, bilmenin önemli olduğunu düşündüklerini açıklar (ve dokümantasyon çözdükleri sorun değildi).
  • Bazı programlar için geliştiriciler, belirli bir programın (veya kütüphanenin) nasıl kullanılacağını gösteren örnek programlar veya komut dosyaları sunmayı tercih eder . Yine, bu bir sorunu çözmek için yapılır: programın test edilmesini kolaylaştırmak.

    Örneklerden bazıları, kullanıcılardan gelen hata raporlarına ve kılavuzda kısa bir yer bulduğunda olabilir. Uzun örnekler, el kitaplarında nadiren verilmektedir ve kısa örnekler, önemsiz, tekrarlayıcı olmaları ve kullanıcıya gerçekten bir programın çalışma şeklinin iyi organize edilmiş bir açıklaması kadar içgörü sağlamaması eğilimindedir.

  • Bazı durumlarda , geliştirme sürecine dahil olmayan diğer kişilerin sağladığı belgeleri bulacaksınız . Diğer bir deyişle, geliştiriciler dokümantasyonun gözden geçirilmesi dışında katılmadılar. Bu tür bir çaba göz ardı edilebilir.

5
“Bu tür bir çaba göz ardı edilebilir.” Bunun ne anlama geldiğinden emin değilim.
Faheem Mitha

Belgeler, deneyime dayanmadığında faydalı bir şey yapmaz.
Thomas Dickey 18

Aslında tecrübeye dayanmayan dokümantasyon olumsuz bir katkı sağlayabilir - yani sadece yanlış.
alephzero

Tabii - Ben bahsetmiştim, çünkü OP'nin hiç şüphesiz akılda tuttuğu bazı örnekler bu kategoriye giriyor (bu forumda bir liste yapmaktan kaçınacağım).
Thomas Dickey,

2
@ThomasDickey. Bu değerlendirmeye tamamen katılmıyorum. Bir yardımcı program yazma yeteneği, mutlaka bir son kullanıcıya API'yi açıklamakla gelmez. T
chiggsy

6

Man sayfalarına bir alternatif arıyorsanız, her zaman yalnızca bir komuta çeşitli örnekler gösteren, sonradan topluluğun gönderdiği örnekler arasında oy verebileceğiniz bir bro sayfası deneyebilirsiniz . Örneğin, komut bro tarsize verecektir:görüntü tanımını buraya girin

Sitemizi kullandığınızda şunları okuyup anladığınızı kabul etmiş olursunuz: Çerez Politikası ve Gizlilik Politikası.
Licensed under cc by-sa 3.0 with attribution required.