بيرلدوك - عبر الإنترنت في السحابة

برنامج:

اسم

perldoc - ابحث عن وثائق Perl بتنسيق Pod.

موجز

بيرلدوك [-h] [-D] [-t] [-u] [-m] [-l] [-F]
[-i] [-V] [-T] [-r]
[-d الوجهة_ملف]
[-اسم التنسيق]
[-M FormatterClassName]
[-w خيار التنسيق: القيمة]
[-ن نروف-استبدال]
[-X]
[-L language_code]
اسم الصفحة|اسم الوحدة|اسم البرنامج|عنوان URL

أمثلة:

perldoc -f وظيفة مدمجة

perldoc -L it -f وظيفة مدمجة

perldoc -q الكلمات الأساسية الشائعة

perldoc -L fr -q الأسئلة الشائعة الكلمة الأساسية

بيرلدوك -v بيرلVariable

perldoc -a PerlAPI

انظر أدناه للحصول على مزيد من الوصف للمفاتيح.

الوصف

بيردوك يبحث عن جزء من الوثائق بتنسيق .pod المضمن في ملف Perl
شجرة التثبيت أو في برنامج Perl النصي، ويعرضها عبر "groff -man | $PAGER". (في
بالإضافة إلى ذلك، في حالة التشغيل ضمن HP-UX، سيتم استخدام "col -x".) يستخدم هذا بشكل أساسي لـ
وثائق لوحدات مكتبة بيرل.

قد يحتوي نظامك أيضًا على صفحات دليل مثبتة لهذه الوحدات، وفي هذه الحالة يمكنك ذلك
ربما مجرد استخدام رجل(1) الأمر.

إذا كنت تبحث عن جدول محتويات لوثائق وحدات مكتبة Perl، فراجع
صفحة بيرلتوك.

OPTIONS

-h يطبع ملخصا hرسالة إلب.

-D Dيكتب البحث عن العنصر في detail.

-t عرض المستندات باستخدام عادي tمحول تحويلة، بدلا من nroff. قد يكون هذا أسرع، لكنه
ربما لن تبدو لطيفة.

-u تخطي تنسيق Pod الحقيقي، وقم فقط بإظهار مصدر Pod الأولي (Uغير منسق)

-m وحدة
اعرض الوحدة بأكملها: كلاً من التعليمات البرمجية ووثائق الكبسولة غير المنسقة. هذا قد يكون
يكون ذلك مفيدًا إذا لم تشرح المستندات الوظيفة بالتفاصيل التي تحتاجها وترغب في ذلك
فحص الكود مباشرة؛ سيجد perldoc الملف لك ويسلمه ببساطة
للعرض.

-l عرض علىly تم العثور على اسم ملف الوحدة النمطية.

-F النظر في الوسائط كأسماء ملفات؛ لن يتم إجراء أي بحث في الدلائل.

-f com.perlfunc
إنّ -f الخيار متبوعًا باسم وظيفة Perl المضمنة سوف يستخرج الملف
توثيق هذه الوظيفة من perlfunc.

على سبيل المثال:

بيرلدوك -f sprintf

-q perlfaq-search-regexp
إنّ -q يأخذ الخيار تعبيرًا عاديًا كوسيطة. سوف يقوم بالبحث في qسؤال
العناوين في perlfaq[1-9] وطباعة الإدخالات المطابقة للتعبير العادي.

على سبيل المثال:

بيرلدوك -q خلط ورق اللعب

-a com.perlapifunc
إنّ -a الخيار متبوعًا باسم وظيفة Perl API سيستخرج الملف
توثيق هذه الوظيفة من perlapi.

على سبيل المثال:

بيرلدوك -a newHV

-v com.perlvar
إنّ -v الخيار متبوعًا باسم متغير Perl المحدد مسبقًا سوف يستخرج الملف
توثيق هذا المتغير من perlvar.

أمثلة:

بيرلدوك -v '$"'
بيرلدوك -v @+
بيرلدوك -v البيانات

-T يحدد هذا أن الإخراج لا سيتم إرساله إلى جهاز النداء، ولكن سيتم إرساله
مباشرة إلى STDOUT.

-d اسم الملف الوجهة
يحدد هذا أن الإخراج لن يتم إرساله إلى جهاز النداء ولا إلى STDOUT، ولكنه كذلك
ليتم حفظها في اسم الملف المحدد. مثال: "perldoc -oLaTeX -dtextwrapdocs.tex
النص::التفاف"

-o اسم تنسيق الإخراج
يحدد هذا أنك تريد أن يحاول Perldoc استخدام فئة تنسيق Pod لـ
تنسيق الإخراج الذي تحدده. على سبيل المثال: "-عمان". هذا في الواقع مجرد
غلاف حول المفتاح "-M"؛ باستخدام "-oformatname " يبحث فقط عن فئة قابلة للتحميل
عن طريق إضافة اسم التنسيق هذا (بأحرف كبيرة مختلفة) إلى نهاية مختلفة
بادئات اسم الفئة.

على سبيل المثال، يحاول "-oLaTeX" حاليًا كافة الفئات التالية:
جراب::Perldoc::ToLaTeX جراب::Perldoc::Tolatex جراب::Perldoc::ToLatex
Pod::Perldoc::ToLATEX Pod::Simple::LaTeX Pod::Simple::latex Pod::Simple::Latex
Pod::Simple::LATEX Pod::LaTeX Pod::latex Pod::Latex Pod::LATEX.

-M اسم وحدة
يحدد هذا الوحدة التي تريد تجربة استخدامها لتنسيق الكبسولة. ال
يجب أن توفر الفئة على الأقل طريقة "parse_from_file". على سبيل المثال: "بيرلدوك
-MPod::Perldoc::ToChecker".

يمكنك تحديد عدة فئات لتجربتها من خلال ضمها بفواصل أو فواصل منقوطة، مثل
في "-MTk::SuperPod;Tk::Pod".

-w قيمة الخيار or -w خيار
يحدد هذا خيارًا لاستدعاء المنسق wإيث. على سبيل المثال، "-w textsize:15"
سوف يستدعي "$formatter->حجم الخط(15)" على كائن المنسق قبل استخدامه
تنسيق الكائن. لكي يكون هذا صالحًا، يجب أن توفر فئة المنسق مثل هذا
الطريقة، ويجب أن تكون القيمة التي تمررها صالحة. (لذلك إذا كان "textsize" يتوقع ملف
صحيحًا، وتفعل "-w textsize:big"، وتتوقع حدوث مشكلة.)

يمكنك استخدام "-w optionname" (بدون قيمة) كاختصار لـ "-w optionname:حقيقي".
من المفترض أن يكون هذا مفيدًا في حالات تشغيل/إيقاف الميزات مثل: "-w page_numbering".

يمكنك استخدام "=" بدلاً من "": كما في: "-w textsize=15". قد يكون هذا أكثر
(أو أقل) ملائمة، اعتمادًا على الصدفة التي تستخدمها.

-X استخدم الفهرس إذا كان موجودا. ال -X يبحث الخيار عن إدخال اسمه الأساسي
يطابق الاسم الوارد في سطر الأوامر في الملف "$Config{archlib}/pod.idx".
إنّ pod.idx يجب أن يحتوي الملف على أسماء ملفات مؤهلة بالكامل، واحد في كل سطر.

-L رمز اللغة
وهذا يسمح للمرء بتحديد لغة الكود لترجمة اللغة المطلوبة. لو
"POD2:: "الحزمة غير مثبتة في نظامك، المفتاح موجود
تم تجاهله. جميع حزم الترجمة المتاحة يمكن العثور عليها ضمن "POD2::"
مساحة الاسم. راجع POD2::IT (أو POD2::FR) لمعرفة كيفية إنشاء "POD2::*" مترجم جديد
حزم الوثائق ودمجها في Pod::Perldoc.

اسم الصفحة|اسم الوحدة|اسم البرنامج|عنوان URL
العنصر الذي تريد البحث عنه. الوحدات المتداخلة (مثل "File::Basename") هي
المحدد إما باسم "File::Basename" أو "File/Basename". يمكنك أيضًا إعطاء أ
اسم وصفي للصفحة، مثل "perlfunc". بالنسبة لعناوين URL، يعتبر HTTP وHTTPS هما
النوع الوحيد المعتمد حاليًا.

بالنسبة للأسماء البسيطة مثل "foo"، عندما يفشل البحث العادي في العثور على صفحة مطابقة، أ
تمت تجربة البحث باستخدام البادئة "Perl" أيضًا. لذا فإن "مقدمة perldoc" كافية لذلك
ابحث عن/عرض "perlintro.pod".

-n بعض المنسق
حدد بديلاً لـ Groff

-r البحث العودي.

-i تجاهل الحالة.

-V يعرض إصدار perldoc الذي تقوم بتشغيله.

الأمن

لأن بيردوك لا يعمل بشكل صحيح ملوث، ومن المعروف أن لديه مشاكل أمنية، عندما
إذا قمت بتشغيله كمستخدم متميز، فسوف يحاول إسقاط الامتيازات من خلال تعيين الامتيازات الفعالة والحقيقية
المعرفات الخاصة بحساب أي شخص أو مستخدم، أو -2 إذا لم تكن متوفرة. إذا لم يتمكن من التخلي عن
الامتيازات، فإنه لن يتم تشغيله.

البيئة

سيتم استخدام أية مفاتيح تبديل في متغير البيئة "PERLDOC" قبل سطر الأوامر
الحجج.

تتضمن القيم المفيدة لـ "PERLDOC" "-oterm"، و"-otext"، و"-ortf"، و"-oxml"، وما إلى ذلك،
اعتمادًا على الوحدات المتوفرة لديك؛ أو يمكن تحديد فئة المنسق
تمامًا مع "-MPod::Perldoc::ToTerm" أو ما شابه.

يبحث "perldoc" أيضًا في الدلائل المحددة بواسطة "PERL5LIB" (أو "PERLLIB" إذا
لم يتم تعريف "PERL5LIB" ومتغيرات البيئة "PATH". (الأخير هو ذلك
تتوفر الكبسولات المضمنة للملفات التنفيذية، مثل "perldoc" نفسها.)

في الدلائل التي يوجد بها إما "Makefile.PL" أو "Build.PL"، ستضيف "perldoc" "." و
"lib" أولاً إلى مسار البحث الخاص به، وطالما أنك لست المستخدم المتميز فسوف يضيف "blib"
أيضاً. يعد هذا مفيدًا حقًا إذا كنت تعمل داخل دليل البناء وتريد ذلك
قم بقراءة المستندات حتى لو كان لديك إصدار من الوحدة المثبتة مسبقًا.

سيستخدم "perldoc"، حسب ترتيب التفضيل، جهاز النداء المحدد في "PERLDOC_PAGER"،
"MANPAGER" أو "PAGER" قبل محاولة العثور على جهاز النداء بمفرده. ("MANPAGER" غير مستخدم
إذا طُلب من "perldoc" عرض نص عادي أو حجرة غير منسقة.)

عند استخدام perldoc في الوضع "-m" الخاص به (عرض كود مصدر وحدة العرض)، سيحاول "perldoc"
لاستخدام مجموعة النداء في "PERLDOC_SRC_PAGER". الإعداد المفيد لهذا الأمر هو الخاص بك
المحرر المفضل كما في "/usr/bin/nano". (لا تحكموا.)

إحدى القيم المفيدة لـ "PERLDOC_PAGER" هي "less -+C -E".

إن تعيين PERLDOCDEBUG على عدد صحيح موجب سيجعل إصدار perldoc أكثر وصفًا
الإخراج مما يفعله المفتاح "-D" ؛ كلما زاد الرقم، كلما زاد انبعاثه.

التغيرات

ما يصل إلى 3.14_05، التبديل -v تم استخدامه لإنتاج رسائل مطولة بيردوك عملية،
والذي تم تمكينه الآن بواسطة -D.

استخدم perldoc عبر الإنترنت باستخدام خدمات onworks.net