perldoc - Online di Cloud

PROGRAM:

NAMA

perldoc - Cari dokumentasi Perl dalam format Pod.

RINGKASAN

perldoc [-h] [-D] [-t] [-u] [-m] [-l] [-F]
[-i] [-V] [-T] [-r]
[-d file_tujuan]
[-o nama format]
[-M FormatterClassName]
[-w formatteroption:nilai]
[-n nroff-penggantian]
[-X]
[-L kode_bahasa]
NamaLaman|NamaModul|NamaProgram|URL

contoh:

perldoc -f Fungsi bawaan

perldoc -L it -f Fungsi bawaan

perldoc -q FAQ Kata Kunci

perldoc -L fr -q FAQ Kata Kunci

perldoc -v PerlVariable

perldoc -a PerlAPI

Lihat di bawah untuk deskripsi lebih lanjut tentang sakelar.

DESKRIPSI

perldoc mencari sepotong dokumentasi dalam format .pod yang disematkan di perl
pohon instalasi atau dalam skrip Perl, dan menampilkannya melalui "groff -man | $PAGER". (Di dalam
Selain itu, jika berjalan di bawah HP-UX, "col -x" akan digunakan.) Ini terutama digunakan untuk
dokumentasi untuk modul perpustakaan Perl.

Sistem Anda mungkin juga memiliki halaman manual yang diinstal untuk modul tersebut, dalam hal ini Anda dapat
mungkin hanya menggunakan pria(1) perintah.

Jika Anda mencari daftar isi ke dokumentasi modul perpustakaan Perl, lihat
halaman perltoc.

PILIHAN

-h Mencetak ringkasan hpesan elp.

-D Dmenjelaskan pencarian item di dekor.

-t Tampilkan dokumen menggunakan plain tkonverter ext, bukan nroff. Ini mungkin lebih cepat, tapi itu
mungkin tidak akan terlihat bagus.

-u Lewati pemformatan Pod yang sebenarnya, dan cukup tunjukkan sumber Pod mentah (Udiformat)

-m modul
Tampilkan seluruh modul: dokumentasi kode dan pod yang belum diformat. Ini mungkin
berguna jika dokumen tidak menjelaskan fungsi secara detail yang Anda butuhkan, dan Anda ingin
memeriksa kode secara langsung; perldoc akan menemukan file untuk Anda dan hanya menyerahkannya
untuk tampilan.

-l Tampilan aktifly nama file modul yang ditemukan.

-F Pertimbangkan argumen sebagai nama file; tidak ada pencarian di direktori yang akan dilakukan.

-f fungsi
-f opsi diikuti dengan nama fungsi bawaan Perl akan mengekstrak
dokumentasi fungsi ini dari perlfunc.

Contoh:

perldoc -f sprintf

-q perlfaq-search-regexp
-q opsi mengambil ekspresi reguler sebagai argumen. Ini akan mencari qpertanyaan
heading di perlfaq[1-9] dan cetak entri yang cocok dengan ekspresi reguler.

Contoh:

perldoc -q acak

-a perlapifunc
-a opsi diikuti dengan nama fungsi api perl akan mengekstrak
dokumentasi fungsi ini dari perlapi.

Contoh:

perldoc -a HV baru

-v perlvar
-v opsi diikuti dengan nama variabel yang telah ditentukan Perl akan mengekstrak
dokumentasi variabel ini dari perlvar.

contoh:

perldoc -v '$"'
perldoc -v @+
perldoc -v DATA

-T Ini menentukan bahwa output tidak akan dikirim ke pager, tetapi dikirim
langsung ke STDOUT.

-d nama-file tujuan
Ini menentukan bahwa output tidak akan dikirim ke pager atau ke STDOUT, tetapi adalah
untuk disimpan ke nama file yang ditentukan. Contoh: "perldoc -oLaTeX -dtextwrapdocs.tex
Teks::Bungkus"

-o nama-format keluaran
Ini menentukan bahwa Anda ingin Perldoc mencoba menggunakan kelas pemformatan Pod untuk
format keluaran yang Anda tentukan. Misalnya: "-oman". Ini sebenarnya hanya
bungkus di sekitar sakelar "-M"; menggunakan "-onama format" hanya mencari kelas yang dapat dimuat
dengan menambahkan nama format itu (dengan huruf besar yang berbeda) di akhir yang berbeda
awalan nama kelas.

Misalnya, "-oLaTeX" saat ini mencoba semua kelas berikut:
Pod::Perldoc::ToLaTeX Pod::Perldoc::Tolatex Pod::Perldoc::ToLatex
Pod::Perldoc::ToLATEX Pod::Sederhana::LaTeX Pod::Sederhana::lateks Pod::Sederhana::Latex
Pod::Sederhana::LATEX Pod::LaTeX Pod::lateks Pod::Latex Pod::LATEX.

-M nama-modul
Ini menentukan modul yang ingin Anda coba gunakan untuk memformat pod. NS
kelas setidaknya harus menyediakan metode "parse_from_file". Misalnya: "perldoc
-MPod::Perldoc::ToChecker".

Anda dapat menentukan beberapa kelas untuk dicoba dengan menggabungkannya dengan koma atau titik koma, sebagai
di "-MTk::SuperPod;Tk::Pod".

-w pilihan: nilai or -w Option
Ini menentukan opsi untuk memanggil formatter wengan. Misalnya, "-w ​​textsize:15"
akan memanggil "$formatter->ukuran teks(15)" pada objek formatter sebelum digunakan untuk
memformat objek. Agar ini valid, kelas formatter harus menyediakan:
metode, dan nilai yang Anda berikan harus valid. (Jadi jika "textsize" mengharapkan
integer, dan Anda melakukan "-w textsize:big", mengharapkan masalah.)

Anda dapat menggunakan "-w optionname" (tanpa nilai) sebagai singkatan untuk "-w optionname:BENAR".
Ini mungkin berguna dalam kasus fitur hidup/mati seperti: "-w page_numbering".

Anda dapat menggunakan "=" alih-alih ":", seperti pada: "-w textsize=15". Ini mungkin lebih
(atau kurang) nyaman, tergantung pada shell apa yang Anda gunakan.

-X Gunakan indeks jika ada. NS -X opsi mencari entri yang nama dasarnya
cocok dengan nama yang diberikan pada baris perintah di file "$Config{archlib}/pod.idx".
pod.idx file harus berisi nama file yang sepenuhnya memenuhi syarat, satu per baris.

-L Language_code
Ini memungkinkan seseorang untuk menentukan bahasa kode untuk terjemahan bahasa yang diinginkan. Jika
"POD2:: " paket tidak diinstal di sistem Anda, sakelarnya
diabaikan. Semua paket terjemahan yang tersedia dapat ditemukan di bawah "POD2::"
ruang nama. Lihat POD2::IT (atau POD2::FR) untuk melihat cara membuat "POD2::*" baru yang dilokalkan
paket dokumentasi dan mengintegrasikannya ke dalam Pod::Perldoc.

NamaLaman|NamaModul|NamaProgram|URL
Item yang ingin Anda cari. Modul bersarang (seperti "File:: Basename") adalah
ditentukan baik sebagai "File::Basename" atau "File/Basename". Anda juga dapat memberikan
nama deskriptif halaman, seperti "perlfunc". Untuk URL, HTTP dan HTTPS adalah
hanya jenis yang saat ini didukung.

Untuk nama sederhana seperti 'foo', ketika pencarian normal gagal menemukan halaman yang cocok, a
pencarian dengan awalan "perl" juga dicoba. Jadi "perldoc intro" sudah cukup untuk
temukan/render "perlintro.pod".

-n beberapa formatter
Tentukan pengganti groff

-r Pencarian rekursif.

-i Abaikan kasus.

-V Menampilkan versi perldoc yang Anda jalankan.

KEAMANAN

Karena perldoc tidak berjalan dengan baik, dan diketahui memiliki masalah keamanan, ketika
dijalankan sebagai superuser itu akan mencoba untuk menjatuhkan hak istimewa dengan mengatur yang efektif dan nyata
ID ke akun siapa pun atau nouser, atau -2 jika tidak tersedia. Jika tidak bisa melepaskannya
hak istimewa, itu tidak akan berjalan.

LINGKUNGAN

Setiap sakelar dalam variabel lingkungan "PERLDOC" akan digunakan sebelum baris perintah
argumen.

Nilai yang berguna untuk "PERLDOC" termasuk "-oterm", "-otext", "-ortf", "-oxml", dan seterusnya,
tergantung pada modul apa yang Anda miliki; atau kelas formatter dapat ditentukan
persis dengan "-MPod::Perldoc::ToTerm" atau sejenisnya.

"perldoc" juga mencari direktori yang ditentukan oleh "PERL5LIB" (atau "PERLLIB" jika
"PERL5LIB" tidak didefinisikan) dan variabel lingkungan "PATH". (Yang terakhir adalah agar
pod tertanam untuk executable, seperti "perldoc" itu sendiri, tersedia.)

Di direktori di mana ada "Makefile.PL" atau "Build.PL", "perldoc" akan menambahkan "." dan
"lib" terlebih dahulu ke jalur pencariannya, dan selama Anda bukan pengguna super akan menambahkan "blib"
juga. Ini sangat membantu jika Anda bekerja di dalam direktori build dan ingin
baca dokumen bahkan jika Anda memiliki versi modul yang diinstal sebelumnya.

"perldoc" akan menggunakan, dalam urutan preferensi, pager yang didefinisikan dalam "PERLDOC_PAGER",
"MANPAGER", atau "PAGER" sebelum mencoba mencari pager sendiri. ("MANPAGER" tidak digunakan
jika "perldoc" diperintahkan untuk menampilkan teks biasa atau pod yang tidak diformat.)

Saat menggunakan perldoc dalam mode "-m" (menampilkan kode sumber modul), "perldoc" akan mencoba
untuk menggunakan set pager di "PERLDOC_SRC_PAGER". Pengaturan yang berguna untuk perintah ini adalah
editor favorit seperti pada "/usr/bin/nano". (Jangan menilai saya.)

Satu nilai yang berguna untuk "PERLDOC_PAGER" adalah "kurang -+C -E".

Memiliki PERLDOCDEBUG yang disetel ke bilangan bulat positif akan membuat perldoc memancarkan lebih deskriptif
output daripada sakelar "-D"; semakin tinggi angkanya, semakin banyak yang dipancarkannya.

PERUBAHAN

Hingga 3.14_05, sakelar -v digunakan untuk menghasilkan pesan verbose dari perldoc operasi,
yang sekarang diaktifkan oleh -D.

Gunakan perldoc online menggunakan layanan onworks.net