man/files
man · Dosyalar

$ pod2readme

Bölüm 1 · Dosyalar

POD (Plain Old Documentation) belgelerinden akıllıca README dosyaları oluşturur

Özet

pod2readme [-cfho] [uzun_seçenekler...] girdi_dosyası [çıktı_dosyası] [hedef]

Açıklama

pod2readme yardımcı programı, bir Perl POD belgesinden (genellikle bir .pm modülü veya .pl betiği) bir README dosyası ayıklamak için Pod::Readme modülünü kullanır.

Bu araç, POD içeriğini ayıklayıp belirli kurallara göre filtreledikten sonra, POD belgesini istenen yeni çıktı formatına dönüştürmek için uygun filtre programlarını çağırır.

Seçenekler

Aşağıdaki seçenekler mevcuttur:

  • -t, --target: Filtrenin hedefini belirtir (varsayılan: readme).
  • -f, --format: Çıktı dosyasının formatını/biçimini belirler (varsayılan: text). Desteklenen biçimler şunlardır:
    • text (düz metin - varsayılan)
    • markdown / md (Markdown formatı; örneğin README.md)
    • github / gfm (GitHub Flavored Markdown)
    • html / xhtml (HTML web sayfası)
    • latex (LaTeX dizgi formatı)
    • man (Unix kılavuz sayfası formatı)
    • pod (Ham POD çıktısı)
    • rtf (Zengin metin biçimi)
  • -b, --backup: Mevcut çıktı dosyasını üzerine yazmadan önce yedekler (varsayılan davranış budur). Yedeği devre dışı bırakmak için --no-backup seçeneği kullanılabilir.
  • -o, --output: Çıktı dosya adını belirtir. Belirtilmezse, komuttaki ikinci argüman kullanılır; o da yoksa --target değeri ile --format seçeneğine karşılık gelen uzantının birleşimi (örneğin README.md) varsayılan dosya adı olarak atanır.
  • -c, --stdout: Çıktıyı dosyaya yazmak yerine doğrudan standart çıktıya (konsol ekranına) yazdırır.
  • -F, --force: Kaynak dosyalar değişmemiş olsa bile çıktı dosyasının güncellenmesini zorunlu kılar (varsayılan olarak yalnızca kaynak dosyalar değiştiğinde güncellenir; ancak POD formatındaki dosyalar her koşulda güncellenir).
  • -h, --help: Kullanım özetini görüntüler ve programdan çıkar.

Örnekler

Aşağıdaki örnekler kabukta (shell) çalıştırılabilecek şekilde gösterilmiştir:

  1. lib/MyApp.pm modülündeki POD belgelerinden README.md adında bir Markdown dosyası oluşturma:

    pod2readme -f markdown lib/MyApp.pm

  2. Dönüştürülen README metnini doğrudan konsol ekranına düz metin olarak yazdırma:

    pod2readme -c lib/MyApp.pm

  3. Otomatik yedeği devre dışı bırakarak HTML formatında KILAVUZ.html dosyası üretme:

    pod2readme -f html -o KILAVUZ.html --no-backup lib/MyApp.pm

Ayrıca Bakınız

pod2text, pod2markdown, Pod::Readme