Arch manual pages

LEXGROG(1) Kılavuz sayfası yardımcıları LEXGROG(1)

lexgrog - man sayfalarında başlık bilgisini ayıkla

lexgrog [-m|-c] [-dfw?V] [-E kodlama] dosya ...

lexgrog, lex'de geleneksel “groff guess” yardımcı programının bir uygulamasıdır. Komut satırında kılavuz sayfası kaynak dosyaları ya da önceden biçimlendirilmiş “cat” sayfaları olarak dosyaların listesini okur ve adını ve açıklamasını apropos ve whatis tarafından kullanılan biçimde görüntüler, kılavuz sayfası tarafından gerekli önişleme filtrelerinin listesi nroff veya troff ya da her ikisine geçmeden önce.

Eğer girişi kötü biçimlendirilmişse, lexgrog “ayrıştırma başarısız” yazdıracaktır; bu, kılavuz sayfalarının doğru olup olmadığını kontrol etmeniz gereken harici programlar için yararlı olabilir. lexgrog'un girdi dosyalardan biri “-” ise, standart girdiden okunur; herhangi bir giriş dosyası sıkıştırılırsa, sıkıştırılmış bir sürüm otomatik olarak okunacaktır.

-d, --debug
Hata ayıklama bilgisini göster.
-m, --man
Girdiyi kılavuz sayfası kaynak dosyaları olarak ayrıştır. Ne --man ne de --cat verilmezse bu öntanımlıdır.
-c, --cat
Girişi önceden biçimlendirilmiş kılavuz sayfaları (“cat sayfaları”) olarak ayrıştır. --man ve --cat aynı anda verilemez.
-w, --whatis
apropos ve whatis tarafından kullanılan kılavuz sayfasındaki başlıktan gelen adı ve açıklamayı görüntüle. Ne --whatis ne de --filters verilmezse bu öntanımlıdır.
-f, --filters
nroff veya troff ile biçimlendirmeden önce kılavuz sayfasını ön işleme koymak için gerekli süzgeçlerin listesini görüntüleyin.
-E encoding, --encoding encoding
Sayfa için tahmin edilen karakter kümesini encoding olarak değiştirin.
-?, --help
Bir yardım iletisi göster ve çık.
--usage
Kısa kullanım iletisini göster ve çık.
-V, --version
Sürüm bilgisini göster.

0
Başarılı program çalıştırma.
1
Kullanım hatası.
2
lexgrog, bir veya daha fazla girdi dosyasını ayrıştıramadı.

  $ lexgrog man.1
  man.1: "man - an interface to the system reference manuals"
  $ lexgrog -fw man.1
  man.1 (t): "man - an interface to the system reference manuals"
  $ lexgrog -c whatis.cat1
  whatis.cat1: "whatis - display manual page descriptions"
  $ lexgrog broken.1
  broken.1: parse failed

mandb (lexgrog ile aynı kodu kullanır) her bir kılavuz sayfanın üstündeki NAME bölümünü, belgelenen özelliklerin adlarını ve açıklamalarını ayrıştırır. Ayrıştırıcı oldukça toleranslı olsa da, tarihsel olarak kullanılan çeşitli formlarla baş etmek zorundaysa, bazen gerekli bilgileri elde etmek başarısız olabilir.

Geleneksel man makro setini kullanırken, doğru bir NAME bölümü şu şekilde görünür:

.SH NAME
foo \- bişeyler yapacak program

Bazı kılavuz sayfalayıcıları, ‘\-’'nin tam olarak gösterildiği gibi olmasını gerektirir; mandb daha hoşgörülüdür, ancak diğer sistemlerle uyumluluk için ters eğik çizgiyi korumak iyi bir fikirdir.

Sol tarafta virgülle ayrılmış birkaç isim olabilir. Boş alan içeren isimler, bazı kötü biçimli NAME bölümlerinde patolojik davranışlardan kaçınmak için göz ardı edilir. Sağdaki metin serbest formdadır ve birden fazla satıra yayılabilir. Aynı kılavuz sayfasında farklı açıklamalara sahip çeşitli özellikler belgeleniyorsa, aşağıdaki form kullanılır:

.SH NAME
foo, bar \- bişeyler yapacak programlar
.br
baz \- hiçbir şey yapmayacak program

(.PP gibi yeni bir paragraf başlatan bir makro, .br kesme makrosu yerine kullanılabilir.)

BSD türevi mdoc makro setini kullanırken, doğru bir NAME bölümü şu şekilde görünür:

.Sh NAME
.Nm foo
.Nd bişeyler yapan program 

Ayrıştırmanın başarısız olmasının birkaç ortak nedeni vardır. Bazen kılavuz sayfalarının yazarları, ‘.SH NAME’'yi ‘.SH MYPROGRAM’ ile değiştirir ve mandb, ihtiyaç duyduğu bilgiyi çıkaracağı bölümü bulamaz. Bazen yazarlar bir NAME bölümü ekliyor ancak ‘isim \- açıklama’ yerine, serbest formlu metin yerleştiriyorlar. Bununla birlikte, yukarıdaki gibi herhangi bir sözdizimi kabul edilmelidir.

apropos(1), man(1), whatis(1), mandb(8)

lexgrog, .so isteklerini içeren dosyaları ayrıştırmaya çalışır, ancak yalnızca dosyalar el ile bir sayfa hiyerarşisinde düzgün bir şekilde yüklenirse bu işlemi doğru yapabilir.

lexgrog tarafından klavuz sayfalarını taramak için kullanılan kod şu tarafından yazılmıştır:

Wilf. (G.Wilford@ee.surrey.ac.uk).
Fabrizio Polacco (fpolacco@debian.org).
Colin Watson (cjwatson@debian.org).

Colin Watson, bu kılavuz sayfasının yanı sıra komut satırı ön ucunun mevcut canlı örneğini yazdı.

2019-10-23 2.9.0