man/text
man · Metin İşleme

$ pod2text

Bölüm 1 · Metin İşleme

POD verilerini biçimlendirilmiş ASCII metnine dönüştürür

Özet

pod2text [-aclostu] [--code] [--errors=stil] [-i girinti]
         [-q tırnaklar] [--nourls] [--stderr] [-w genişlik]
         [girdi [çıktı ...]]

pod2text -h

Açıklama

pod2text, Pod::Text ve onun alt sınıfları için bir ön uçtur. POD kaynağından biçimlendirilmiş ASCII metni üretmek için bunları kullanır. İsteğe bağlı olarak metni biçimlendirmek için termcap dizilerini veya ANSI renk kaçış dizilerini kullanabilir.

girdi, POD kaynağı olarak okunacak dosyadır; POD kodun içine gömülü de olabilir. girdi belirtilmezse varsayılan olarak STDIN kabul edilir. çıktı verilirse biçimlendirilmiş çıktının yazılacağı dosyadır. çıktı belirtilmezse biçimlendirilmiş çıktı STDOUT üzerine yazılır. Komut satırında birden fazla girdi ve çıktı dosyası çifti verilerek tek bir pod2text çağrısında birkaç POD dosyası işlenebilir.

Seçenekler

  • -a, --alt: Farklı bir başlık stili kullanan ve sol kenar boşluğunda =item girdilerini iki nokta üst üste ile işaretleyen alternatif bir çıktı biçimi kullanır.

  • --code: Girdi dosyasındaki POD dışı tüm metinleri de çıktıya dahil eder. POD bloklarıyla belgelenmiş kodları, POD kısımları işlenmiş ve kod kısımları bozulmadan kalmış şekilde görüntülemek için kullanışlıdır.

  • -c, --color: Çıktıyı ANSI renk kaçış dizileriyle biçimlendirir. Bu seçeneğin kullanılması için sisteminizde Term::ANSIColor modülünün kurulu olması gerekir.

  • --errors=stil: Hata işleme stilini ayarlar. die, herhangi bir POD biçimlendirme hatasında istisna fırlatılacağını belirtir. stderr, hataların standart hata akışında raporlanacağını ancak istisna fırlatılmayacağını belirtir. pod, elde edilen belgede hataları özetleyen bir POD ERRORS bölümünün dahil edileceğini belirtir. none, POD hatalarını mümkün olduğunca yoksayar. Varsayılan değer diedır.

  • -i girinti, --indent=girinti: Normal metnin girintileneceği boşluk sayısını ve =over blokları için varsayılan girintiyi ayarlar. Bu seçenek belirtilmezse varsayılan değer 4 boşluktur.

  • -h, --help: Kullanım bilgisini yazdırır ve çıkar.

  • -l, --loose: =head1 başlığından sonra boş bir satır yazdırır. Normalde, kılavuz sayfaları için beklenen biçimlendirme bu olduğundan =head2 sonrasında boş satır yazdırılmasına rağmen =head1 sonrasında yazdırılmaz. Serbest metin belgelerini biçimlendiriyorsanız bu seçeneği kullanmanız önerilir.

  • -m genişlik, --left-margin=genişlik, --margin=genişlik: Boşluk cinsinden sol kenar boşluğunun genişliğini ayarlar. Varsayılan değer 0'dır. Bu, normal metnin girintilenme miktarı değil, başlıklar da dahil olmak üzere tüm metinler için kenar boşluğudur. Normal metin girintisi için -i seçeneğine bakın.

  • --nourls: Normalde, URL içeren ve bağlantı metni olan L<> biçimlendirme kodları hem bağlantı metnini hem de URL'yi gösterecek şekilde biçimlendirilir.

Örneğin:

L<foo|http://example.com/>

şöyle biçimlendirilir:

foo <http://example.com/>

Bu bayrak belirtilirse, bağlantı metni verildiğinde URL gizlenir; bu örnek yalnızca foo olarak biçimlendirilir. URL'lerin özellikle önemli olmadığı durumlarda daha sade çıktı üretebilir.

  • -o, --overstrike: Çıktıyı üst üste yazma (overstrike) baskısıyla biçimlendirir. Kalın metin karakter, geri alma (backspace), karakter olarak işlenir. İtalik ve dosya adları alt çizgi, geri alma, karakter olarak işlenir. less gibi birçok sayfalayıcı bunu kalın veya altı çizili metne dönüştürebilir.

  • -q tırnaklar, --quotes=tırnaklar: C<> metnini çevrelemek için kullanılan tırnak işaretlerini ayarlar. Değer tek bir karakterden oluşuyorsa hem sol hem sağ tırnak olarak kullanılır. Aksi takdirde değer ikiye bölünür; dizgenin ilk yarısı sol tırnak, ikinci yarısı sağ tırnak olarak kullanılır.

tırnaklar özel none değerine de ayarlanabilir. Bu durumda C<> metninin etrafına tırnak işareti eklenmez.

  • -s, --sentence: Her cümlenin iki boşlukla bittiğini varsayar ve bu boşluğu korumaya çalışır. Bu seçenek olmadan, aynen aktarılan paragraflar dışındaki tüm ardışık boşluklar tek bir boşluğa sıkıştırılır.

  • --stderr: Varsayılan olarak POD girdisinde herhangi bir hata tespit edilirse pod2text sonlanır. --stderr belirtilir ve --errors bayrağı verilmezse, hatalar standart hataya gönderilir ancak pod2text durdurulmaz. Bu, --errors=stderr ile eşdeğerdir ve geriye dönük uyumluluk için desteklenir.

  • -t, --termcap: termcap üzerinden ekran genişliğini ve terminal için kalın/altı çizili dizileri belirlemeye çalışır; bu bilgiyi çıktıyı biçimlendirmede kullanır. Çıktı, terminal aygıtınızın genişliğinden iki sütun daha az olacak şekilde satır sarma işlemine tabi tutulur. Bu seçeneğin kullanılması için sisteminizde Term::Cap tarafından bulunabilen bir termcap dosyası olmalı ve sisteminiz termios desteklemelidir. Bu seçenekle pod2text çıktısı, geçerli terminal tipiniz için terminal kontrol dizileri içerir.

  • -u, --utf8: Varsayılan olarak pod2text, geriye dönük uyumluluk için girdi kodlamasıyla aynı çıktı kodlamasını kullanmaya çalışır. Bu seçenek, çıktı kodlamasını UTF-8 olmaya zorlar.

Bu seçeneği kullanırken, US-ASCII olmadığı sürece POD kaynağınızın girdi kodlamasının düzgün biçimde bildirilmesi gerekir. Pod::Simple kodlamayı tahmin etmeye çalışır ve Latin-1 veya UTF-8 ise başarılı olabilir, ancak bir uyarı verir; bu da varsayılan olarak pod2text hatasıyla sonuçlanır. Kodlamayı bildirmek için =encoding komutunu kullanın. Daha fazla bilgi için perlpod(1) belgesine bakın.

  • -w genişlik, --width=genişlik, -width: Metnin sağ tarafta sarılacağı sütunu ayarlar. -t verilmediği sürece varsayılan değer 76'dır; -t verilirse terminal aygıtınızın genişliğinden iki sütun daha azdır.

Çıkış Durumu

İşlenen tüm belgeler çıktı ürettiği sürece, çıktı hatalar içerse bile pod2text 0 çıkış koduyla sonlanır. Buna --errors=pod ile üretilmiş bir POD ERRORS bölümü de dahildir.

İşlenen belgelerden herhangi biri çıktı belgesiyle sonuçlanmazsa pod2text 1 çıkış koduyla sonlanır.

İşlenen bir POD belgesinde söz dizimi hataları varsa ve hata işleme stili varsayılan die olarak ayarlanmışsa, pod2text hemen sonlandırılır ve 255 çıkış koduyla çıkar.

Tanılama

pod2text hatalarla başarısız olursa, bu hataların ne anlama gelebileceği hakkında bilgi için Pod::Text ve Pod::Simple belgelerine bakın. Dahili olarak aşağıdaki tanılamaları da üretebilir:

  • -c (--color) requires Term::ANSIColor be installed: -c veya --color verildi, ancak Term::ANSIColor yüklenemedi.

  • Unknown option: %s: Bilinmeyen bir komut satırı seçeneği verildi.

Geçersiz komut satırı seçeneklerinden dolayı başka Getopt::Long hata mesajları da ortaya çıkabilir.

Ortam

  • COLUMNS: -t verilirse pod2text, ekranınızın geçerli genişliğini varsa bu ortam değişkeninden alır. Bu değişken, TERMCAP içindeki terminal genişliği bilgisini geçersiz kılar.

  • TERMCAP: -t verilirse pod2text, geçerli terminal aygıtınız için doğru biçimlendirme dizilerini belirlemek üzere varsa bu ortam değişkeninin içeriğini kullanır.

Yazar

Russ Allbery <rra@cpan.org>.

Telif Hakkı ve Lisans

Telif Hakkı 1999-2001, 2004, 2006, 2008, 2010, 2012-2019 Russ Allbery <rra@cpan.org>

Bu program özgür yazılımdır; Perl'ün kendisiyle aynı koşullar altında yeniden dağıtabilir ve/veya değiştirebilirsiniz.

Ayrıca Bakınız

Pod::Text, Pod::Text::Color, Pod::Text::Overstrike, Pod::Text::Termcap, Pod::Simple, perlpod(1)

Bu betiğin güncel sürümüne her zaman https://www.eyrie.org/~eagle/software/podlators/ adresinden ulaşılabilir. Ayrıca 5.6.0 sürümünden itibaren Perl çekirdek dağıtımının bir parçasıdır.