man/text
man · Metin İşleme

$ podchecker

Bölüm 1 · Metin İşleme

POD biçimindeki belgeleme dosyalarının söz dizimini kontrol eder

Özet

podchecker [-help] [-man] [-(no)warnings] [dosya ...]

Seçenekler ve Bağımsız Değişkenler

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

  • -man: Kılavuz sayfasını yazdırır ve çıkar.

  • -warnings, -nowarnings: Uyarıların yazdırılmasını açar veya kapatır. -warnings seçeneğinin tekrarlanması uyarı düzeyini artırır; yani daha fazla uyarı yazdırılır. Şu anda düzeyin ikiye yükseltilmesi, kaçış karakteri kullanılmamış < ve > karakterlerinin işaretlenmesine neden olur.

  • dosya: Söz dizimi kontrolü yapılacak POD dosyasının yol adıdır. Varsayılan olarak standart girdi kullanılır.

Açıklama

podchecker, POD belgelerindeki POD söz dizimi hatalarını aramak için verilen girdi dosyalarını okur ve bulduğu tüm hataları STDERR üzerine yazdırır. Sonunda bulunan hata sayısını belirten bir durum mesajı yazdırır.

Dizinler yoksayılır ve uygun bir uyarı mesajı yazdırılır.

podchecker, Pod::Checker tarafından dışa aktarılan podchecker() işlevini çağırır. Daha fazla ayrıntı için Pod::Checker içindeki podchecker() bölümüne bakın.

Çıkış Durumu

  • 0: Belirtilen tüm POD dosyaları sorunsuzdur.

  • 1: Verilen POD dosyalarından en az birinde söz dizimi hataları vardır.

  • 2: Belirtilen dosyalardan en az biri herhangi bir POD komutu içermiyordur.

Durum 1, durum 2yi geçersiz kılar. Belirsiz olmayan sonuçlar istiyorsanız podchecker komutunu yalnızca tek bir bağımsız değişkenle çağırın.

Ayrıca Bakınız

Pod::Simple, Pod::Checker

Yazarlar

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

Brad Appleton <bradapp@enteract.com>, Marek Rouchal <marekr@cpan.org>

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