pod2man - Online di Cloud

PROGRAM:

NAMA

pod2man - Konversikan data POD ke *input roff yang diformat

RINGKASAN

pod2man [--Tengah=string] [--tanggal=string] [--kesalahan=gaya]
[--tetap=fon] [--tetap berani=fon] [--huruf miring tetap=fon]
[--cetak miring tetap=fon] [--nama=nama] [--nourl]
[--resmi] [--kutipan=tanda kutip] [--melepaskan[=versi]]
[--bagian=selanjutnya] [--stderr] [--utf8] [--bertele-tele]
[memasukkan [keluaran] ...]

pod2man --membantu

DESKRIPSI

pod2man adalah front-end untuk Pod::Man, menggunakannya untuk menghasilkan input *roff dari sumber POD.
Kode *roff yang dihasilkan cocok untuk ditampilkan di terminal menggunakan tidak(1), biasanya
melalui pria(1), atau mencetak menggunakan troff(1).

memasukkan adalah file yang akan dibaca untuk sumber POD (POD dapat disematkan dalam kode). Jika memasukkan
tidak diberikan, defaultnya adalah "STDIN". keluaran, jika diberikan, adalah file untuk menulis
keluaran yang diformat. Jika keluaran tidak diberikan, output yang diformat ditulis ke "STDOUT".
Beberapa file POD dapat diproses di tempat yang sama pod2man doa (menghemat beban modul dan
waktu kompilasi) dengan menyediakan beberapa pasang memasukkan dan keluaran file pada baris perintah.

--bagian, --melepaskan, --Tengah, --tanggal, dan --resmi dapat digunakan untuk mengatur header dan
footer untuk digunakan; jika tidak diberikan, Pod::Man akan mengasumsikan berbagai default. Lihat di bawah atau
Pod::Man untuk detailnya.

pod2man mengasumsikan bahwa pemformat *roff Anda memiliki font lebar tetap bernama "CW". Jika milikmu
disebut sesuatu yang lain (seperti "CR"), gunakan --tetap untuk menentukannya. Ini umumnya hanya
penting untuk keluaran troff untuk pencetakan. Demikian pula, Anda dapat mengatur font yang digunakan untuk huruf tebal,
miring, dan output lebar tetap miring miring.

Selain konversi pod yang jelas, Pod::Man, dan oleh karena itu pod2man juga menangani
format fungsi(), func(n), dan referensi variabel sederhana seperti $foo atau @bar sehingga Anda tidak
harus menggunakan kode lolos untuk mereka; ekspresi kompleks seperti $fred{'stuff'} masih perlu
untuk melarikan diri, meskipun. Itu juga menerjemahkan tanda hubung yang tidak digunakan sebagai tanda hubung menjadi en
tanda hubung, buat tanda pisah panjang--seperti ini--menjadi tanda pisah em yang tepat, memperbaiki "tanda kutip berpasangan", dan
menangani beberapa tweak khusus troff lainnya. Lihat Pod::Man untuk informasi selengkapnya.

PILIHAN

-c string, --Tengah=string
Setel tajuk halaman tengah ke string. Standarnya adalah "User Contributed Perl
Dokumentasi", tetapi juga lihat --resmi di bawah.

-d string, --tanggal=string
Setel string footer kiri ke nilai ini. Secara default, tanggal modifikasi
file input akan digunakan, atau tanggal saat ini jika input berasal dari "STDIN", dan akan
didasarkan pada UTC (sehingga output akan dapat direproduksi terlepas dari waktu setempat
daerah).

-kesalahan=gaya
Atur gaya penanganan kesalahan. "die" mengatakan untuk memberikan pengecualian pada pemformatan POD apa pun
kesalahan. "stderr" mengatakan untuk melaporkan kesalahan pada kesalahan standar, tetapi tidak membuangnya
pengecualian. "pod" mengatakan untuk menyertakan bagian POD ERRORS dalam dokumentasi yang dihasilkan
meringkas kesalahan. "none" mengabaikan kesalahan POD sepenuhnya, sebanyak mungkin.

Standarnya adalah "mati".

--tetap=fon
Font dengan lebar tetap yang digunakan untuk teks dan kode verbatim. Default ke "CW". Beberapa
sistem mungkin menginginkan "CR" sebagai gantinya. Hanya penting untuk troff(1) keluaran.

--tetap berani=fon
Versi tebal dari font dengan lebar tetap. Default ke "CB". Hanya penting untuk troff(1)
output.

--huruf miring tetap=fon
Versi miring dari font lebar tetap (sebenarnya, sesuatu yang keliru, karena sebagian besar
font dengan lebar tetap hanya memiliki versi miring, bukan versi miring). Default untuk
"CI". Hanya penting untuk troff(1) keluaran.

--cetak miring tetap=fon
Tebal miring (mungkin sebenarnya miring) versi font lebar tetap. Pod::Man
tidak menganggap Anda memiliki ini, dan default ke "CB". Beberapa sistem (seperti Solaris)
memiliki font ini tersedia sebagai "CX". Hanya penting untuk troff(1) keluaran.

-h, --membantu
Cetak informasi penggunaan.

-l, --longgar
Tidak lagi digunakan. pod2man digunakan untuk memeriksa validitas inputnya sebagai halaman manual, tapi
ini sekarang harus dilakukan oleh pemeriksa pod(1) sebagai gantinya. Diterima untuk mundur
kesesuaian; opsi ini tidak lagi melakukan apa pun.

-n nama, --nama=nama
Atur nama halaman manual menjadi nama. Tanpa opsi ini, nama manual diatur
ke nama dasar huruf besar dari file yang sedang dikonversi kecuali bagian manual adalah
3, dalam hal ini jalur diurai untuk melihat apakah itu jalur modul Perl. Jika ya,
path seperti ".../lib/Pod/Man.pm" diubah menjadi nama seperti "Pod::Man". Pilihan ini,
jika diberikan, mengesampingkan penentuan nama secara otomatis.

Perhatikan bahwa opsi ini mungkin tidak berguna saat mengonversi beberapa file POD di
satu kali. Konvensi untuk halaman manual Unix untuk perintah adalah agar judul halaman manual menjadi
dalam huruf besar semua bahkan jika perintahnya tidak.

Saat mengonversi sumber POD dari input standar, opsi ini diperlukan, karena ada
jika tidak, tidak ada cara untuk mengetahui apa yang harus digunakan sebagai nama halaman manual.

--nourl
Biasanya, kode pemformatan L<> dengan URL tetapi teks jangkar diformat untuk menampilkan keduanya
teks jangkar dan URL. Dengan kata lain:

Lhttp://example.com/>

diformat sebagai:

foohttp://example.com/>

Bendera ini, jika diberikan, menekan URL saat teks jangkar diberikan, jadi contoh ini
akan diformat hanya sebagai "foo". Ini dapat menghasilkan output yang lebih sedikit berantakan
di mana URL tidak terlalu penting.

-o, --resmi
Setel tajuk default untuk menunjukkan bahwa halaman ini adalah bagian dari Perl . standar
lepaskan, jika --Tengah tidak juga diberikan.

-q tanda kutip, --kutipan=tanda kutip
Setel tanda kutip yang digunakan untuk mengelilingi teks C<> ke tanda kutip. Jika tanda kutip adalah satu
karakter, digunakan sebagai kutipan kiri dan kanan; jika tanda kutip adalah dua karakter,
karakter pertama digunakan sebagai kutipan kiri dan karakter kedua sebagai kutipan kanan; dan
if tanda kutip adalah empat karakter, dua yang pertama digunakan sebagai kutipan kiri dan yang kedua
dua sebagai kutipan yang tepat.

tanda kutip juga dapat diatur ke nilai khusus "tidak ada", dalam hal ini tidak ada tanda kutip
ditambahkan di sekitar teks C<> (tetapi font masih diubah untuk keluaran troff).

-r, --melepaskan
Atur footer di tengah. Secara default, ini adalah versi Perl yang Anda jalankan pod2man
dibawah. Perhatikan bahwa beberapa sistem set makro mengasumsikan bahwa footer tengah akan menjadi
tanggal modifikasi dan akan menambahkan sesuatu seperti "Terakhir diubah: "; jika ini adalah
kasus, Anda mungkin ingin mengatur --melepaskan ke tanggal modifikasi terakhir dan --tanggal ke
nomor versi.

-s, --bagian
Setel bagian untuk makro ".TH". Konvensi penomoran bagian standar adalah untuk
gunakan 1 untuk perintah pengguna, 2 untuk panggilan sistem, 3 untuk fungsi, 4 untuk perangkat, 5 untuk
format file, 6 untuk game, 7 untuk informasi lain-lain, dan 8 untuk administrator
perintah. Namun, ada banyak variasi di sini; beberapa sistem (seperti Solaris) digunakan
4 untuk format file, 5 untuk informasi lain-lain, dan 7 untuk perangkat. Masih yang lain
gunakan 1m bukannya 8, atau campuran keduanya. Tentang satu-satunya nomor bagian yang
konsisten andal adalah 1, 2, dan 3.

Secara default, bagian 1 akan digunakan kecuali file diakhiri dengan ".pm", dalam hal ini
bagian 3 akan dipilih.

--stderr
Secara default, pod2man mati jika ada kesalahan yang terdeteksi dalam input POD. Jika --stderr is
diberikan dan tidak --kesalahan bendera hadir, kesalahan dikirim ke kesalahan standar, tetapi pod2man
tidak menggugurkan. Ini setara dengan "--errors=stderr" dan didukung untuk mundur
kompatibilitas.

-u, --utf8
Secara default, pod2man menghasilkan keluaran *roff yang paling konservatif untuk dicoba
pastikan bahwa itu akan bekerja dengan sebanyak mungkin implementasi *roff yang berbeda.
Banyak *roff implementasi tidak dapat menangani karakter non-ASCII, jadi ini berarti semua non-
Karakter ASCII dikonversi menjadi *roff escape sequence yang mencoba membuat
karakter beraksen benar (setidaknya untuk keluaran troff) atau ke "X".

Opsi ini mengatakan untuk menampilkan karakter UTF-8 literal. Jika *roff . Anda
implementasi dapat mengatasinya, ini adalah format output terbaik untuk digunakan dan dihindari
korupsi dokumen yang mengandung karakter non-ASCII. Namun, berhati-hatilah bahwa
*sumber roff dengan karakter UTF-8 literal tidak didukung oleh banyak implementasi
dan bahkan dapat mengakibatkan kesalahan seg dan perilaku buruk lainnya.

Ketahuilah bahwa, saat menggunakan opsi ini, pengkodean input sumber POD Anda harus
dinyatakan dengan benar kecuali US-ASCII atau Latin-1. Masukan POD tanpa "= penyandian"
perintah akan diasumsikan dalam bahasa Latin-1, dan jika itu benar-benar dalam UTF-8, outputnya
akan dikodekan ganda. Lihat perlpod(1) untuk informasi lebih lanjut tentang "= encoding"
perintah.

-v, --bertele-tele
Cetak nama setiap file keluaran saat sedang dibuat.

EXIT STATUS

Selama semua dokumen yang diproses menghasilkan beberapa keluaran, bahkan jika keluaran itu termasuk
errata (bagian "POD ERRORS" yang dibuat dengan "--errors=pod"), pod2man akan keluar dengan
status 0. Jika ada dokumen yang sedang diproses tidak menghasilkan dokumen keluaran,
pod2man akan keluar dengan status 1. Jika ada kesalahan sintaks dalam dokumen POD sedang
diproses dan gaya penanganan kesalahan diatur ke default "mati", pod2man akan menggugurkan
segera dengan status keluar 255.

DIAGNOSTIK

If pod2man gagal dengan kesalahan, lihat Pod::Man dan Pod::Simple untuk informasi tentang apa
kesalahan itu mungkin berarti.

CONTOH

program pod2man > program.1
pod2man SomeModule.pm /usr/Perl/man/man3/SomeModule.3
pod2man --section=7 note.pod > note.7

Jika Anda ingin mencetak banyak halaman manual terus menerus, Anda mungkin ingin mengatur
register C dan D untuk mengatur penomoran halaman bersebelahan dan paging genap/ganjil, setidaknya pada
beberapa versi dari pria(7).

troff -man -rC1 -rD1 perl.1 perldata.1 perlsyn.1 ...

Untuk mendapatkan entri indeks pada "STDERR", nyalakan register F, seperti pada:

troff -man -rF1 perl.1

Pengindeksan hanya menampilkan pesan melalui ".tm" untuk setiap halaman utama, bagian, subbagian,
item, dan semua arahan "X<>". Lihat Pod::Man untuk lebih jelasnya.

Gunakan pod2man online menggunakan layanan onworks.net