Kullanım
pod2readme [-cfho] [long options...] input-file [output-file] [target]
POD'dan akıllıca bir README dosyası oluşturur
-t --target: hedef türü (varsayılan: 'readme')-f --format: çıktı formatı (varsayılan: 'text')-b --backup: çıktı dosyasını yedekler-o --output: çıktı dosya adı (hedefe göre varsayılan)-c --stdout: standart çıktıya (konsol) yazdırır-F --force: yalnızca dosyalar değişmişse günceller-h --help: kullanım bilgisini yazdırır ve çıkar
Sinopsis
pod2readme -f markdown lib/MyApp.pm
Açıklama
Bu yardımcı program, bir POD belgesinden bir README dosyası ayıklamak için Pod::Readme modülünü kullanır.
POD'u ayıklayıp filtreleyerek çalışır ve ardından POD'u başka bir formata dönüştürmek için uygun filtre programını çağırır.
Seçenekler
"--backup" Varsayılan olarak "pod2readme", çıktı dosyasını yedekleyecektir. Bunu devre dışı bırakmak için "--no-backup" seçeneğini kullanın.
"--output" Çıktı dosyasının adını belirtir. Belirtilmezse, ikinci komut satırı argümanı kullanılır veya varsayılan olarak "--target" değeri ile "--format" seçeneğine karşılık gelen uzantının birleşimi kullanılır.
Tüm niyetler için varsayılan değer README'dir.
"text" dışında bir format seçilirse, uygun uzantı eklenecektir; örneğin "markdown" için varsayılan çıktı dosyası README.md olacaktır.
"--target" Filtrenin hedefidir; varsayılan değeri "readme"dir.
"--format" Çıktı formatıdır; varsayılan değeri "text"tir.
Desteklenen diğer formatlar "github", "html", "latex", "man", "markdown", "pod", "rtf" ve "xhtml"dir. "github" yerine "gfm" de kullanabilirsiniz. Benzer şekilde "markdown" yerine "md" kullanabilirsiniz.
"--stdout" Etkinleştirilirse, çıktı "--output" dosyası yerine konsola yazdırılır.
"--force" Varsayılan olarak, kaynak dosyalar değiştiyse README dosyası oluşturulacaktır. "--force" seçeneğini kullanmak, dosyanın güncellenmesini zorunlu kılacaktır.
Not: POD formatındaki dosyalar her zaman güncellenecektir.
"--help" Kullanım bilgisini yazdırır ve çıkar.
Ayrıca Bakınız
pod2text, pod2markdown.
perl v5.34.0 2018-10-31 POD2README(1)