man/text
man · Metin İşleme

$ pod2usage

Bölüm 1 · Metin İşleme

dosyalara gömülü POD belgelerinden kullanım mesajları yazdırır

Özet

pod2usage [-help] [-man] [-exit çıkış_değeri] [-output çıktı_dosyası]
          [-verbose düzey] [-pathlist dizin_listesi] [-formatter modül]
          [-utf8] dosya

Seçenekler ve Argümanlar

  • -help: Kısa bir yardım mesajı yazdırır ve çıkar.

  • -man: Bu komutun kılavuz sayfasını yazdırır ve çıkar.

  • -exit çıkış_değeri: Döndürülecek çıkış durumu değerini belirtir.

  • -output çıktı_dosyası: Yazdırılacak çıktı dosyasını belirtir. Özel -, >&1 veya >&STDOUT adları kullanılırsa standart çıktı kullanılır. >&2 veya >&STDERR kullanılırsa standart hata kullanılır.

  • -verbose düzey: Kullanılacak ayrıntı düzeyini belirtir. 1 yalnızca ÖZET (SYNOPSIS) bölümünü yazdırır. 2, ÖZET bölümlerini ve tüm SEÇENEKLER/ARGÜMANLAR (OPTIONS/ARGUMENTS) bölümlerini yazdırır. 3, kılavuz sayfasının tamamını yazdırır; pod2text çalıştırmaya benzer.

  • -pathlist dizin_listesi: Girdi dosyası mutlak bir yol ile belirtilmemişse, aranacağı bir veya daha fazla dizini belirtir. Verilen listedeki her dizin yolu Unix üzerinde : ile, MSWin32 ve DOS üzerinde ; ile ayrılmalıdır.

  • -formatter modül: Kullanılacak metin biçimlendiriciyi belirtir. Varsayılan Pod::Texttir; çok eski Perl sürümleri için Pod::PlainText olabilir. Alternatif olarak örneğin Pod::Text::Termcap kullanılabilir.

  • -utf8: Biçimlendiricinin utf8 seçeneğini anladığını varsayar ve UTF-8 çıktısını etkinleştirir.

  • dosya: Kullanım mesajı biçiminde çıktı olarak verilecek POD belgelerini içeren dosyanın yol adıdır. Belirtilmezse standart girdi okunur. Ancak bu durumda -formatter ile belirli bir biçimlendirici belirtilmediği sürece çıktı yalnızca Pod::Text ile biçimlendirilir.

Açıklama

pod2usage, verilen girdi dosyasını okuyarak POD belgelerini arar ve ilgili kullanım mesajını yazdırır. Girdi dosyası belirtilmezse standart girdi okunur.

pod2usage, Pod::Usage modülündeki pod2usage() işlevini çağırır. Ayrıntılar için Pod::Usage içindeki pod2usage() bölümüne bakın.

Ayrıca Bakınız

Pod::Usage, pod2text, Pod::Text, Pod::Text::Termcap, perldoc

Yazar

Lütfen hataları http://rt.cpan.org adresini kullanarak bildirin.

Brad Appleton <bradapp@enteract.com>

Tom Christiansen <tchrist@mox.perl.com> tarafından yazılan pod2text(1) koduna dayanmaktadır.