man - واجهة لكتيبات النظام المرجعية
الملخص
man [خيارات man] [[القسم] الصفحة ...] ...
man -k [خيارات apropos] تعبير عادي ...
man -K [خيارات man] [القسم] المصطلح ...
man -f [خيارات whatis] الصفحة ...
man -l [خيارات man] ملف ...
man -w|-W [خيارات man] الصفحة ...
الوصف
man هو برنامج عرض صفحات الدليل في النظام. كل وسيطة "صفحة" معطاة لـ man تكون عادةً اسم برنامج أو أداة أو وظيفة. ثم يتم العثور على صفحة الدليل المرتبطة بكل من هذه الوسائط وعرضها. إذا تم توفير قسم، فسيقوم man بالبحث فقط في هذا القسم من الدليل. الإجراء الافتراضي هو البحث في جميع الأقسام المتاحة باتباع ترتيب محدد مسبقًا (انظر الافتراضيات)، وعرض الصفحة الأولى التي تم العثور عليها فقط، حتى لو كانت الصفحة موجودة في أقسام متعددة.
يوضح الجدول أدناه أرقام أقسام الدليل متبوعة بأنواع الصفحات التي تحتوي عليها.
1 البرامج القابلة للتنفيذ أو أوامر shell
2 استدعاءات النظام (الوظائف التي يوفرها النواة)
3 استدعاءات المكتبة (الوظائف الموجودة في مكتبات البرامج)
4 الملفات الخاصة (عادةً ما توجد في /dev)
5 تنسيقات الملفات والاصطلاحات، على سبيل المثال /etc/passwd
6 الألعاب
7 متنوع (بما في ذلك حزم الماكرو والاصطلاحات)، على سبيل المثال man(7)، [groff]({filename}../../groff)(7)، man-pages(7)
8 أوامر إدارة النظام (عادةً فقط للمستخدم root)
9 روتينات النواة [غير قياسي]
تتكون صفحة الدليل من عدة أقسام.
تشمل أسماء الأقسام الشائعة NAME و SYNOPSIS و CONFIGURATION و DESCRIPTION و OPTIONS و EXIT STATUS و RETURN VALUE و ERRORS و ENVIRONMENT و FILES و VERSIONS و STANDARDS و NOTES و BUGS و EXAMPLE و AUTHORS و SEE ALSO.
تنطبق المصطلحات التالية على قسم SYNOPSIS ويمكن استخدامها كدليل في أقسام أخرى.
نص غامق اكتبه تمامًا كما هو موضح.
نص مائل استبدله بالوسيطة المناسبة.
[-abc] أي أو كل الوسائط الموجودة داخل [ ] اختيارية.
-a|-b لا يمكن استخدام الخيارات المحددة بواسطة | معًا.
الوسيطة ... الوسيطة قابلة للتكرار.
[تعبير] ... التعبير بأكمله الموجود داخل [ ] قابل للتكرار.
قد يختلف العرض الدقيق اعتمادًا على جهاز الإخراج. على سبيل المثال، لن يتمكن man عادةً من عرض النص المائل عند التشغيل في الوحدة الطرفية، وسيستخدم عادةً نصًا مسطرًا أو ملونًا بدلاً من ذلك.
تعد وسيطة الأمر أو الوظيفة نمطًا يجب أن يطابق جميع الاستدعاءات المحتملة. في بعض الحالات، يُنصح بتوضيح عدة استدعاءات حصرية كما هو موضح في قسم SYNOPSIS من صفحة الدليل هذه.
أمثلة
man ls
اعرض صفحة الدليل للعنصر (البرنامج) ls.
man man.7
عرض صفحة الدليل الخاصة بحزمة الماكرو man من القسم 7. (هذا تهجئة بديلة لـ "man 7 man".)
man 'man(7)'
عرض صفحة الدليل الخاصة بحزمة الماكرو man من القسم 7. (هذه تهجئة بديلة أخرى لـ "man 7 man". قد يكون هذا أكثر ملاءمة عند نسخ ولصق مراجع لصفحات الدليل.)
man -a intro
عرض، بالتتابع، جميع صفحات الدليل intro المتاحة الموجودة داخل الدليل. من الممكن الخروج بين العروض المتتالية أو تخطي أي منها.
man -t bash | lpr -Pps
تنسيق صفحة الدليل الخاصة بـ bash إلى تنسيق troff أو groff الافتراضي وإرسالها إلى الطابعة المسماة ps. عادةً ما يكون الإخراج الافتراضي لـ groff هو PostScript. يجب أن يوضح الأمر man --help ما هو المعالج المرتبط بالخيار -t.
man -l -Tdvi ./foo.1x.gz > ./foo.1x.dvi
سيقوم هذا الأمر بفك الضغط وتنسيق صفحة الدليل nroff المصدر ./foo.1x.gz إلى ملف مستقل عن الجهاز (dvi). إعادة التوجيه ضرورية لأن الخيار -T يتسبب في توجيه الإخراج إلى stdout بدون برنامج عرض صفحات. يمكن عرض الإخراج باستخدام برنامج مثل xdvi أو معالجته بشكل أكبر إلى PostScript باستخدام برنامج مثل dvips.
man -k printf
ابحث في الأوصاف القصيرة وأسماء صفحات الدليل عن الكلمة الرئيسية printf كتعبير عادي. اطبع أي نتائج. يعادل الأمر apropos printf.
man -f smail
ابحث عن صفحات الدليل التي تشير إليها smail واطبع الأوصاف القصيرة لأي منها. يعادل الأمر whatis smail.
نظرة عامة
تتوفر العديد من الخيارات لـ man من أجل إعطاء أكبر قدر ممكن من المرونة للمستخدم. يمكن إجراء تغييرات على مسار البحث وترتيب الأقسام ومعالج الإخراج والعمليات الأخرى المفصلة أدناه.
إذا تم تعيينها، يتم فحص العديد من متغيرات البيئة لتحديد كيفية عمل man. من الممكن تعيين المتغير الشامل "$MANOPT" إلى أي سلسلة بتنسيق سطر الأوامر، مع استثناء أن أي مسافات مستخدمة كجزء من وسيطة الخيار يجب أن يتم تجاهلها (تسبق بشرطة مائلة للخلف). ستقوم man بتحليل $MANOPT قبل تحليل سطر الأوامر الخاص بها. سيتم تجاوز تلك الخيارات التي تتطلب وسيطة بواسطة نفس الخيارات الموجودة في سطر الأوامر. لإعادة تعيين جميع الخيارات المحددة في $MANOPT، يمكن تحديد -D كخيار سطر الأوامر الأولي. سيسمح هذا لـ man "بنسيان" الخيارات المحددة في $MANOPT، على الرغم من أنها يجب أن تكون صالحة.
عادةً ما يتم تخزين صفحات الدليل بتنسيق nroff(1) في دليل مثل /usr/share/man. في بعض التثبيتات، قد تكون هناك أيضًا صفحات cat مُعدة مسبقًا لتحسين الأداء. انظر إلى manpath(5) للحصول على تفاصيل حول مكان تخزين هذه الملفات.
تدعم هذه الحزمة صفحات الدليل بلغات متعددة، والتي يتم التحكم فيها بواسطة اللغة الخاصة بك. إذا لم تقم نظامك بإعداد هذا تلقائيًا، فقد تحتاج إلى تعيين $LC_MESSAGES أو $LANG أو متغير بيئة آخر خاص بالنظام للإشارة إلى اللغة المفضلة لديك، وعادةً ما يتم تحديدها بتنسيق POSIX:
<language>[_<territory>[.<character-set>[,<version>]]]
إذا كانت الصفحة المطلوبة متاحة بلغتك، فسيتم عرضها بدلاً من الصفحة القياسية (عادةً ما تكون باللغة الإنجليزية الأمريكية).
إذا وجدت أن الترجمات المرفقة بهذه الحزمة غير متاحة بلغتك الأم وكنت ترغب في توفيرها، فيرجى الاتصال بالمطور الذي سيقوم بتنسيق هذا النشاط.
يتم عادةً كتابة صفحات الدليل الفردية وصيانتها بواسطة مطوري البرنامج أو الوظيفة أو الموضوع الآخر الذي يوثقونه، ولا يتم تضمينها في هذه الحزمة. إذا وجدت أن صفحة دليل مفقودة أو غير كافية، فيرجى إبلاغ مطوري الحزمة المعنية بذلك.
للحصول على معلومات حول الميزات والإضافات الأخرى المتاحة مع قارئ هذا الدليل، يرجى قراءة المستندات المرفقة بالحزمة.
الافتراضيات
يمكن تجاوز ترتيب الأقسام التي سيتم البحث فيها بواسطة متغير البيئة $MANSECT أو بواسطة توجيه SECTION في /etc/manpath.config. افتراضيًا، يكون كالتالي:
1n l 8 3 0 2 3type 3posix 3pm 3perl 3am 5 4 9 6 7
يتم عرض صفحة الدليل المنسقة باستخدام قارئ. يمكن تحديد ذلك بعدة طرق، أو سيتم العودة إلى القيمة الافتراضية (راجع الخيار -P للحصول على التفاصيل).
يتم فك تشفير المرشحات بعدة طرق. أولاً، يتم فحص خيار سطر الأوامر -p أو متغير البيئة $MANROFFSEQ. إذا لم يتم استخدام -p ولم يتم تعيين متغير البيئة، يتم تحليل السطر الأول من ملف nroff بحثًا عن سلسلة معالج مسبق. لاحتواء سلسلة معالج مسبق صالحة، يجب أن يشبه السطر الأول:
\' <string>
حيث يمكن أن تكون `string` أي مجموعة من الأحرف الموصوفة بواسطة الخيار `-p` أدناه.
إذا لم توفر أي من الطرق المذكورة أعلاه أي معلومات عن المرشح، يتم استخدام مجموعة افتراضية.
يتم تشكيل مسار تنسيق من المرشحات والمُنسِّق الأساسي (nroff أو [tg]roff
مع `-t`) ويتم تنفيذه. بدلاً من ذلك، إذا كان برنامج قابل للتنفيذ `mandb_nfmt` (أو `mandb_tfmt` مع
`-t`) موجودًا في جذر شجرة الدليل، فسيتم تنفيذه بدلاً من ذلك. يتم تمرير ملف مصدر الدليل والسلسلة الخاصة بالمعالج المسبق وخيارًا الجهاز المحدد بواسطة `-T` أو `-E` كوسائط إليه.
الخيارات
الخيارات غير الحرفية التي يتم تكرارها إما في سطر الأوامر أو في $MANOPT أو كليهما، ليست ضارة. بالنسبة للخيارات التي تتطلب وسيطة، سيتجاوز كل تكرار قيمة الوسيطة السابقة.
الخيارات العامة
-C file, --config-file=file
استخدم ملف التكوين الخاص بالمستخدم هذا بدلاً من القيمة الافتراضية ~/.manpath.
-d, --debug
اطبع معلومات التصحيح.
-D, --default
عادةً ما يتم إصدار هذا الخيار كأول خيار ويقوم بإعادة تعيين سلوك man إلى
الافتراضي. يستخدم لإعادة تعيين الخيارات التي قد تكون قد تم تعيينها في $MANOPT. أي خيارات تتبع -D سيكون لها تأثيرها المعتاد.
--warnings[=warnings]
يُفعّل التحذيرات من groff. يمكن استخدامه لإجراء فحوصات للسلامة على النص المصدر لصفحات الدليل. `warnings` هي قائمة مفصولة بفواصل بأسماء التحذيرات؛ إذا لم يتم توفيرها، فإن القيمة الافتراضية هي "mac". لتعطيل تحذير groff، ضعه بادئة بعلامة "!": على سبيل المثال،
`--warnings=mac,!break` يُفعّل التحذيرات في فئة "mac" ويعطّل التحذيرات في فئة "break". راجع العقدة "التحذيرات" في دليل groff للحصول على قائمة بالأسماء المتاحة للتحذيرات.
أوضاع التشغيل الرئيسية
-f، --whatis
يعادل تقريبًا أمر `whatis`. يعرض وصفًا موجزًا من صفحة الدليل، إذا كان متاحًا. راجع `whatis(1)` للحصول على التفاصيل.
-k، --apropos
يعادل تقريبًا أمر `apropos`. يبحث في أوصاف صفحات الدليل الموجزة عن الكلمات الرئيسية ويعرض أي نتائج مطابقة. راجع `apropos(1)` للحصول على التفاصيل.
-K، --global-apropos
يبحث في جميع صفحات الدليل. هذا بحث شامل، ومن المحتمل أن يستغرق بعض الوقت؛ إذا أمكن، يجب عليك تحديد قسم لتقليل عدد الصفحات التي يجب البحث فيها. يمكن أن تكون مصطلحات البحث سلاسل بسيطة (افتراضيًا)، أو تعبيرات منتظمة إذا تم استخدام الخيار `--regex`.
لاحظ أن هذا يبحث في مصادر صفحات الدليل، وليس النص المُصَدَّر، لذلك قد يتضمن نتائج إيجابية خاطئة بسبب أشياء مثل التعليقات في ملفات المصدر، أو نتائج سلبية خاطئة بسبب أشياء مثل استخدام الشرطة كـ `\-"` في ملفات المصدر. سيكون البحث في النص المُصَدَّر أبطأ بكثير.
-l، --local-file
يُفعّل الوضع "المحلي". يقوم بتنسيق وعرض ملفات الدليل المحلية بدلاً من البحث في مجموعة الدليل الخاصة بالنظام. سيتم تفسير كل وسيطة لصفحة الدليل على أنها ملف مصدر nroff بالتنسيق الصحيح. لا يتم إنشاء ملف cat. إذا تم إدراج "-" كأحد الوسائط، فسيتم أخذ الإدخال من stdin.
إذا لم يتم استخدام هذا الخيار، فسوف يعود `man` أيضًا إلى تفسير وسائط صفحة الدليل كملفات محلية إذا كانت الوسيطة تحتوي على حرف "/"، نظرًا لأن هذا مؤشر جيد على أن الوسيطة تشير إلى مسار في نظام الملفات.
-w، --where، --path، --location
لا يعرض صفحة الدليل، ولكنه يطبع موقع ملف مصدر nroff الذي سيتم تنسيقه. إذا تم استخدام الخيار `-a` أيضًا، فسيتم طباعة مواقع جميع الملفات المصدر التي تطابق معايير البحث.
-W، --where-cat، --location-cat
لا يعرض صفحة الدليل، ولكنه يطبع موقع ملف cat المُصَدَّر مسبقًا الذي سيتم عرضه. إذا تم استخدام الخيار `-a` أيضًا، فسيتم طباعة مواقع جميع ملفات cat المُصَدَّرة مسبقًا التي تطابق معايير البحث.
إذا تم استخدام كل من `-w` و `-W`، فسيتم طباعة كل من ملف المصدر وملف cat مفصولين بمسافة. إذا تم استخدام جميع الخيارات `-w` و `-W` و `-a`، فسيتم ذلك لكل تطابق ممكن.
-c، --catman
هذا الخيار ليس للاستخدام العام ويجب استخدامه فقط بواسطة برنامج `catman`.
-R encoding، --recode=encoding
بدلاً من تنسيق صفحة الدليل بالطريقة المعتادة، قم بإخراج مصدرها مُحوَّلاً إلى الترميز المحدد. إذا كنت تعرف بالفعل ترميز ملف المصدر، يمكنك أيضًا استخدام `manconv(1)` مباشرةً. ومع ذلك، يسمح لك هذا الخيار بتحويل عدة صفحات دليل إلى ترميز واحد دون الحاجة إلى تحديد ترميز كل منها على وجه التحديد، بشرط أن يتم تثبيتها بالفعل في هيكل مشابه لهيكل صفحة الدليل.
يرجى التفكير في استخدام الأمر man-recode(1) بدلاً من ذلك لتحويل صفحات الدليل المتعددة، حيث يتميز بواجهة مصممة للتحويل المجمع، وبالتالي يمكن أن يكون أسرع بكثير.
العثور على صفحات الدليل
-L locale, --locale=locale
عادةً ما يحدد الأمر `man` الإعدادات المحلية الحالية عن طريق استدعاء الدالة `C` المسماة `setlocale(3)`، والتي تستعلم عن متغيرات البيئة المختلفة، بما في ذلك ربما `$LC_MESSAGES` و `$LANG`. لتجاوز القيمة المحددة مؤقتًا، استخدم هذا الخيار لتزويد الأمر `man` بسلسلة الإعدادات المحلية مباشرةً. لاحظ أنه لن يتم تفعيله حتى يبدأ البحث عن الصفحات. سيتم دائمًا عرض الإخراج، مثل رسالة المساعدة، بالإعدادات المحلية المحددة في البداية.
-m system[,...], --systems=system[,...]
إذا كان هذا النظام لديه حق الوصول إلى صفحات الدليل الخاصة بأنظمة تشغيل أخرى، فيمكن الوصول إليها باستخدام هذا الخيار. للبحث عن صفحة دليل من مجموعة صفحات دليل نظام التشغيل NewOS، استخدم الخيار `-m NewOS`.
يمكن أن يكون النظام المحدد عبارة عن مجموعة من أسماء أنظمة التشغيل مفصولة بفواصل. لتضمين البحث في صفحات الدليل الخاصة بنظام التشغيل الأصلي، قم بتضمين اسم النظام `man` في سلسلة الوسائط. سيؤدي هذا الخيار إلى إلغاء قيمة متغير البيئة `$SYSTEM`.
-M path, --manpath=path
حدد مسارًا بديلاً لـ `manpath` لاستخدامه. بشكل افتراضي، يستخدم الأمر `man` كودًا مشتقًا من `manpath` لتحديد المسار الذي سيتم البحث فيه. يؤدي هذا الخيار إلى إلغاء قيمة متغير البيئة `$MANPATH` ويتسبب في تجاهل الخيار `-m`.
يجب أن يكون المسار المحدد كـ `manpath` هو جذر تسلسل هرمي لصفحة الدليل المنظمة في أقسام كما هو موضح في دليل `man-db` (تحت "نظام صفحة الدليل"). لعرض صفحات الدليل خارج هذه التسلسلات الهرمية، انظر الخيار `-l`.
-S list, -s list, --sections=list
القائمة المعطاة هي قائمة مفصولة بنقطتين أو فواصل من الأقسام، والتي تُستخدم لتحديد أقسام الدليل التي سيتم البحث فيها وبالترتيب الذي سيتم البحث فيها. يؤدي هذا الخيار إلى إلغاء قيمة متغير البيئة `$MANSECT`. (تم توفير التهجئة `-s` للتوافق مع نظام System V).
-e sub-extension, --extension=sub-extension
تتضمن بعض الأنظمة مجموعات كبيرة من صفحات الدليل، مثل تلك التي تأتي مع حزمة Tcl، في التسلسل الهرمي الرئيسي لصفحة الدليل. للتغلب على مشكلة وجود صفحتين للدليل لهما نفس الاسم، مثل `exit(3)`، تم تعيين جميع صفحات Tcl عادةً إلى القسم `l`. نظرًا لأن هذا غير مرغوب فيه، فمن الممكن الآن وضع الصفحات في القسم الصحيح وتعيين "امتداد" معين لها، في هذه الحالة، `exit(3tcl)`. في التشغيل العادي، سيعرض الأمر `man` صفحة `exit(3)` بدلاً من `exit(3tcl)`. للتغلب على هذا الموقف وتجنب الاضطرار إلى معرفة القسم الذي توجد فيه الصفحة التي تحتاجها، من الممكن الآن تزويد الأمر `man` بسلسلة امتداد فرعي تشير إلى الحزمة التي يجب أن تنتمي إليها الصفحة. باستخدام المثال أعلاه، سيؤدي تزويد الأمر `man` بالخيار `-e tcl` إلى تقييد البحث بالصفحات التي تحتوي على امتداد `*tcl`.
-i، --ignore-case
تجاهل حالة الأحرف عند البحث عن صفحات الدليل. هذا هو الوضع الافتراضي.
-I، --match-case
البحث عن صفحات الدليل مع مراعاة حالة الأحرف.
--regex
عرض جميع الصفحات التي يتطابق فيها أي جزء من أسمائها أو أوصافها مع كل وسيطة صفحة كتعبير عادي، كما هو الحال في apropos(1). نظرًا لأنه لا توجد عادةً طريقة معقولة لاختيار "أفضل" صفحة عند البحث عن تعبير عادي، فإن هذا الخيار يعني -a.
--wildcard
عرض جميع الصفحات التي يتطابق فيها أي جزء من أسمائها أو أوصافها مع كل وسيطة صفحة باستخدام أحرف البدل على نمط shell، كما هو الحال في apropos(1) --wildcard. يجب أن يتطابق وسيطة الصفحة مع الاسم أو الوصف بأكمله، أو يتطابق على حدود الكلمات في الوصف. نظرًا لأنه لا توجد عادةً طريقة معقولة لاختيار "أفضل" صفحة عند البحث عن حرف بدل، فإن هذا الخيار يعني -a.
--names-only
إذا تم استخدام خيار --regex أو --wildcard، فقم بالمطابقة فقط مع أسماء الصفحات، وليس أوصاف الصفحات، كما هو الحال في whatis(1). خلاف ذلك، لا يوجد تأثير.
-a، --all
افتراضيًا، سيقوم man بالخروج بعد عرض الصفحة اليدوية الأكثر ملاءمة التي يجدها. باستخدام هذا الخيار، يتم إجبار man على عرض جميع صفحات الدليل التي تتطابق أسماؤها مع معايير البحث.
-u، --update
يتسبب هذا الخيار في قيام man بتحديث ذاكرات التخزين المؤقت لقاعدة البيانات الخاصة به لصفحات الدليل المثبتة. هذا مطلوب فقط في حالات نادرة، وعادة ما يكون من الأفضل تشغيل mandb(8) بدلاً من ذلك.
--no-subpages
افتراضيًا، سيحاول man تفسير أزواج أسماء صفحات الدليل المقدمة في سطر الأوامر على أنها تعادل اسم صفحة دليل واحد يحتوي على شرطة أو شرطة سفلية. يدعم هذا النمط الشائع للبرامج التي تنفذ عددًا من الأوامر الفرعية، مما يسمح لها بتوفير صفحات دليل لكل منها يمكن الوصول إليها باستخدام بناء جملة مماثلة لما سيتم استخدامه لاستدعاء الأوامر الفرعية نفسها. على سبيل المثال:
$ man -aw git diff
/usr/share/man/man1/git-diff.1.gz
لت تعطيل هذا السلوك، استخدم الخيار --no-subpages.
$ man -aw --no-subpages git diff
/usr/share/man/man1/git.1.gz
/usr/share/man/man3/Git.3pm.gz
/usr/share/man/man1/diff.1.gz
التحكم في الإخراج المنسق
-P pager، --pager=pager
حدد برنامج عرض الإخراج المراد استخدامه. افتراضيًا، يستخدم man برنامج pager، ويعود إلى cat إذا لم يتم العثور على برنامج pager أو لم يكن قابلاً للتنفيذ. يتجاوز هذا الخيار متغير البيئة $MANPAGER، والذي بدوره يتجاوز متغير البيئة $PAGER. لا يتم استخدامه مع -f أو -k.
قد تكون القيمة اسم أمر بسيط أو أمر مع وسيطات، وقد تستخدم علامات الاقتباس (علامات الشرطة المائلة للخلف أو علامات الاقتباس المفردة أو المزدوجة). لا يمكن أن تستخدم الأنابيب لربط أوامر متعددة؛ إذا كنت بحاجة إلى ذلك، فاستخدم برنامجًا نصيًا، والذي يمكن أن يأخذ الملف المراد عرضه إما كوسيطة أو على الإدخال القياسي.
-r prompt، --prompt=prompt
إذا تم استخدام إصدار حديث من الأمر `less` كبرنامج عرض الصفحات، فسوف يحاول الأمر `man` تعيين موجه وخيارات معقولة له. يبدو الموجه الافتراضي كالتالي:
اسم صفحة الدليل (القسم) السطر س
حيث يشير `name` إلى اسم صفحة الدليل، و `sec` إلى القسم الذي تم العثور عليها فيه، و `x` إلى رقم السطر الحالي. يتم تحقيق ذلك باستخدام متغير البيئة `$LESS`.
سيؤدي تزويد الخيار `-r` بسلسلة إلى تجاوز هذا الإعداد الافتراضي. قد تحتوي السلسلة على النص `$MAN_PN` الذي سيتم توسيعه إلى اسم صفحة الدليل الحالية واسم قسمها، محاطين بأقواس. يمكن التعبير عن السلسلة المستخدمة لإنتاج الإعداد الافتراضي على النحو التالي:
\ دليل الصفحة \$MAN_PN ?ltline %lt?L/%L.:
byte %bB?s/%s..?\ (END):?pB %pB\\%..
(اضغط على h للحصول على مساعدة أو q للخروج)
تم تقسيمه إلى ثلاثة أسطر هنا من أجل سهولة القراءة فقط. لمعرفة معناه، راجع صفحة الدليل [less]({filename}../../less)(1). يتم أولاً تقييم سلسلة الموجه بواسطة shell. يجب إلغاء جميع علامات الاقتباس المزدوجة وعلامات الباك تيك والشرطات المائلة الخلفية في سلسلة الموجه باستخدام شرطة مائلة خلفية بادئة. يمكن أن تنتهي سلسلة الموجه بعلامة `$` مهربة، والتي يمكن أن تتبعها خيارات أخرى لـ `less`. بشكل افتراضي، يقوم الأمر `man` بتعيين الخيارات `-ix8`.
يمكن استخدام متغير البيئة `$MANLESS` الموصوف أدناه لتعيين سلسلة موجه افتراضية إذا لم يتم توفيرها في سطر الأوامر.
-7، --ascii
عند عرض صفحة دليل ASCII خالصة على طرفية 7 بت أو محاكي طرفية، قد لا يتم عرض بعض الأحرف بشكل صحيح عند استخدام وصف الجهاز latin1(7) مع GNU nroff. يسمح هذا الخيار بعرض صفحات دليل ASCII الخالصة بتنسيق ASCII باستخدام جهاز latin1. لن يقوم بترجمة أي نص latin1. يوضح الجدول التالي عمليات الترجمة التي يتم إجراؤها: قد يتم عرض بعض أجزائها بشكل صحيح فقط عند استخدام جهاز latin1 في GNU nroff(7).
الوصف Octal latin1 ascii
واصلة 255 ‐ نقطة منتصف (•) 267 • o
علامة التشكيل 264 ´ '
علامة الضرب 327 × x
إذا تم عرض عمود latin1 بشكل صحيح، فقد تم إعداد طرفيتك لتكون متوافقة مع أحرف latin1، وبالتالي فإن هذا الخيار غير ضروري. إذا كانت أعمدة latin1 و ASCII متطابقة، فأنت تقرأ هذه الصفحة باستخدام هذا الخيار، أو لم يقم الأمر `man` بتنسيق هذه الصفحة باستخدام وصف جهاز latin1. إذا كان عمود latin1 مفقودًا أو تالفًا، فقد تحتاج إلى عرض صفحات الدليل باستخدام هذا الخيار.
يتم تجاهل هذا الخيار عند استخدام الخيارات -t، أو -H، أو -T، أو -Z، وقد يكون غير مفيد بالنسبة لـ nroff بخلاف GNU.
-E encoding، --encoding=encoding
قم بإنشاء إخراج لترميز أحرف مختلف عن الإعداد الافتراضي. من أجل التوافق مع الإصدارات السابقة، يمكن أن يكون الترميز جهاز nroff مثل ascii أو latin1 أو utf8 بالإضافة إلى ترميز أحرف حقيقي مثل UTF-8.
--no-hyphenation, --nh
بشكل افتراضي، سيقوم برنامج nroff تلقائيًا بوضع واصلات في النص عند فواصل الأسطر حتى في الكلمات التي لا تحتوي على واصلات، إذا كان ذلك ضروريًا لوضع الكلمات في سطر دون ترك مسافات كبيرة. يعطل هذا الخيار وضع الواصلات التلقائي، بحيث يتم وضع الواصلات فقط إذا كانت الكلمة تحتوي بالفعل على واصلات.
إذا كنت تكتب صفحة دليل وتريد ببساطة منع برنامج nroff من وضع واصلة في كلمة في نقطة غير مناسبة، فلا تستخدم هذا الخيار، ولكن راجع وثائق برنامج nroff بدلاً من ذلك؛ على سبيل المثال، يمكنك وضع "\%" داخل كلمة للإشارة إلى أنه يمكن وضع واصلة فيها، أو ضع "\%" في بداية الكلمة لمنع وضع واصلة فيها.
--no-justification, --nj
بشكل افتراضي، سيقوم برنامج nroff تلقائيًا بتبرير النص على كلا الهامشين. يعطل هذا الخيار التبرير الكامل، مما يترك النص مبررًا فقط على الهامش الأيسر، وهو ما يسمى أحيانًا نص "غير مبرر".
إذا كنت تكتب صفحة دليل وتريد ببساطة منع برنامج nroff من تبرير فقرات معينة، فلا تستخدم هذا الخيار، ولكن راجع وثائق برنامج nroff بدلاً من ذلك؛ على سبيل المثال، يمكنك استخدام الطلبات ".na" و ".nf" و ".fi" و ".ad" لتعطيل التعديل والتعبئة مؤقتًا.
-p string, --preprocessor=string
حدد تسلسل المعالجات المسبقة التي سيتم تشغيلها قبل برنامج nroff أو troff/groff. لن يكون لدى جميع التثبيتات مجموعة كاملة من المعالجات المسبقة. بعض المعالجات المسبقة والحروف المستخدمة لتحديدها هي: eqn (e) و grap (g) و pic (p) و tbl (t) و vgrind (v) و refer (r). يعطل هذا الخيار متغير البيئة $MANROFFSEQ. يتم دائمًا تشغيل zsoelim كأول معالج مسبق.
-t, --troff
استخدم groff -mandoc لتنسيق صفحة الدليل وإخراجها إلى stdout. هذا الخيار غير مطلوب بالاشتراك مع -H أو -T أو -Z.
-T[device], --troff-device[=device]
يستخدم هذا الخيار لتغيير إخراج برنامج groff (أو ربما troff) ليناسب جهازًا آخر غير الجهاز الافتراضي. فإنه يقتضي استخدام الخيار -t. تتضمن الأمثلة (اعتبارًا من groff 1.23.0) dvi و latin1 و pdf و ps و utf8 و X75 و X100.
-H[browser], --html[=browser]
سيؤدي هذا الخيار إلى قيام برنامج groff بإنتاج إخراج HTML، وسيعرض هذا الإخراج في متصفح ويب. يتم تحديد اختيار المتصفح بواسطة وسيطة المتصفح الاختيارية إذا تم توفيرها، أو بواسطة متغير البيئة $BROWSER، أو بواسطة قيمة افتراضية في وقت التجميع إذا لم يتم تعيين ذلك (عادةً lynx). يقتضي هذا الخيار استخدام الخيار -t، ولن يعمل إلا مع GNU troff.
-X[dpi], --gxditview[=dpi]
يعرض هذا الخيار إخراج برنامج groff في نافذة رسومية باستخدام برنامج gxditview. قد تكون قيمة dpi (نقاط في البوصة) هي 75 أو 75-12 أو 100 أو 100-12، والقيمة الافتراضية هي 75؛ تستخدم المتغيرات "-12" خطًا أساسيًا بحجم 12 نقطة. يقتضي هذا الخيار استخدام الخيار -T مع الجهاز X75 أو X75-12 أو X100 أو X100-12 على التوالي.
-Z, --ditroff
سيقوم برنامج groff بتشغيل troff ثم استخدام معالج لاحق مناسب لإنتاج إخراج مناسب للجهاز المحدد. إذا كان groff -mandoc هو groff، فسيتم تمرير هذا الخيار إلى groff وسيؤدي إلى منع استخدام معالج لاحق. يقتضي هذا الخيار استخدام الخيار -t.
الحصول على المساعدة
-؟، --help
اطبع رسالة مساعدة واخرج.
--usage
اطبع رسالة استخدام موجزة واخرج.
-V، --version
اعرض معلومات الإصدار.
حالة الخروج
0 تنفيذ البرنامج بنجاح.
1 خطأ في الاستخدام أو بناء الجملة أو ملف التهيئة.
2 خطأ تشغيلي.
3 أرجعت إحدى العمليات الفرعية حالة خروج غير صفرية.
16 لم تكن إحدى الصفحات/الملفات/الكلمات المفتاحية موجودة أو لم يتم العثور عليها.
البيئة
MANPATH
إذا تم تعيين $MANPATH، فسيتم استخدام قيمته كمسار للبحث عن صفحات الدليل.
راجع قسم "مسار البحث" في manpath(5) للحصول على السلوك الافتراضي والتفاصيل حول كيفية
معالجة متغير البيئة هذا.
MANROFFOPT
في كل مرة يستدعي فيها الأمر man المُنسِّق (nroff أو troff أو groff)، فإنه يضيف محتويات
$MANROFFOPT إلى سطر أوامر المُنسِّق.
على سبيل المثال، يخبر MANROFFOPT=-P-i المُنسِّق باستخدام نص مائل (وهو ما تدعمه بعض المحطات الطرفية فقط) بدلاً من النص المسطر.
MANROFFSEQ
إذا تم تعيين $MANROFFSEQ، فسيتم استخدام قيمته لتحديد مجموعة المعالجات المسبقة التي سيتم تمرير كل صفحة دليل من خلالها. تكون قائمة المعالجات المسبقة الافتراضية خاصة بالنظام.
MANSECT
إذا تم تعيين $MANSECT، فستكون قيمته قائمة مفصولة بنقطتين من الأقسام، ويتم استخدامها لتحديد الأقسام اليدوية التي سيتم البحث فيها وبأي ترتيب. الإعداد الافتراضي هو "1 n l 8 3 0 2
3ype 3posix 3pm 3perl 3am 5 4 9 6 7"، ما لم يتم استبداله بالتوجيه SECTION في
/etc/manpath.config.
MANPAGER، PAGER
إذا تم تعيين $MANPAGER أو $PAGER ($MANPAGER له الأسبقية)، فسيتم استخدام قيمته كاسم البرنامج المستخدم لعرض صفحة الدليل. افتراضيًا، يتم استخدام برنامج pager، مع العودة إلى cat إذا لم يتم العثور على برنامج pager أو لم يكن قابلاً للتنفيذ.
يمكن أن تكون القيمة اسم أمر بسيط أو أمر مع وسيطات، ويمكن أن تستخدم علامات اقتباس shell (علامات الخط المائل العكسي أو علامات الاقتباس المفردة أو علامات الاقتباس المزدوجة). لا يمكن استخدام الأنابيب لتوصيل أوامر متعددة؛ إذا كنت بحاجة إلى ذلك، فاستخدم برنامجًا مساعدًا، والذي يمكن أن يأخذ الملف المراد عرضه إما كوسيطة أو على الإدخال القياسي.
MANLESS
إذا تم تعيين $MANLESS، فسيتم استخدام قيمته كسلسلة المطالبة الافتراضية لبرنامج less، كما لو تم تمريرها باستخدام الخيار -r (وبالتالي، سيتم توسيع أي حالات من النص $MAN_PN بنفس الطريقة). على سبيل المثال، إذا كنت تريد تعيين سلسلة المطالبة بشكل غير مشروط إلى "سلسلة مطالبتي"، فاضبط $MANLESS على '-Psلسلة مطالبتي'. يؤدي استخدام الخيار -r إلى إلغاء هذا متغير البيئة.
BROWSER
إذا تم تعيين $BROWSER، فستكون قيمته قائمة مفصولة بنقطتين من الأوامر، ويتم استخدام كل منها بدوره لمحاولة بدء متصفح ويب لـ man --html. في كل أمر، يتم استبدال %s باسم ملف يحتوي على إخراج HTML من groff، ويتم استبدال %% بعلامة مئوية واحدة (%)، ويتم استبدال %c بنقطتين (:).
SYSTEM إذا تم تعيين `$SYSTEM`، فسيكون له نفس تأثير تحديده كوسيطة لخيار `-m`.
MANOPT إذا تم تعيين `$MANOPT`، فسيتم تحليله قبل سطر أوامر `man`، ومن المتوقع أن يكون بتنسيق مماثل. نظرًا لأنه يمكن التعبير عن جميع متغيرات البيئة الخاصة بـ `man` الأخرى كخيارات سطر أوامر، وبالتالي فهي مرشحة لتضمينها في `$MANOPT`، فمن المتوقع أن تصبح قديمة. ملاحظة: يجب إلغاء أي مسافات يجب تفسيرها كجزء من وسيطة الخيار.
MANWIDTH
إذا تم تعيين $MANWIDTH، فسيتم استخدام قيمته كطول السطر الذي يجب تنسيق صفحات الدليل من أجله. إذا لم يتم تعيينها، فسيتم تنسيق صفحات الدليل بطول سطر مناسب لمحطة العرض الحالية (باستخدام قيمة $COLUMNS، و ioctl(2) إذا كان متاحًا، أو بالرجوع إلى 80 حرفًا إذا لم يكن أحدهما متاحًا). سيتم حفظ صفحات "cat" فقط عندما يمكن استخدام التنسيق الافتراضي، أي عندما يكون طول سطر المحطة بين 66 و 80 حرفًا.
MAN_KEEP_FORMATTING
عادةً، عندما لا يتم توجيه الإخراج إلى محطة عرض (مثل ملف أو قناة)، يتم تجاهل أحرف التنسيق لتسهيل قراءة النتيجة بدون أدوات خاصة. ومع ذلك، إذا تم تعيين $MAN_KEEP_FORMATTING إلى أي قيمة غير فارغة، فسيتم الاحتفاظ بأحرف التنسيق هذه. قد يكون هذا مفيدًا للأغلفة حول man التي يمكنها تفسير أحرف التنسيق.
MAN_KEEP_STDERR
عادةً، عند توجيه الإخراج إلى محطة عرض (عادةً إلى برنامج عرض الصفحات)، يتم تجاهل أي إخراج للأخطاء من الأمر المستخدم لإنتاج إصدارات منسقة من صفحات الدليل لتجنب التدخل في عرض برنامج عرض الصفحات. غالبًا ما تنتج البرامج مثل groff رسائل أخطاء طفيفة نسبيًا حول المشكلات الكتابية مثل المحاذاة الضعيفة، والتي تكون قبيحة ومربكة بشكل عام عند عرضها جنبًا إلى جنب مع صفحة الدليل. ومع ذلك، يريد بعض المستخدمين رؤيتها على أي حال، لذلك، إذا تم تعيين $MAN_KEEP_STDERR إلى أي قيمة غير فارغة، فسيتم عرض إخراج الأخطاء كالمعتاد.
MAN_DISABLE_SECCOMP
على نظام Linux، عادةً ما يقوم man بتقييد العمليات الفرعية التي تتعامل مع البيانات غير الموثوق بها باستخدام صندوق الحماية seccomp(2). هذا يجعل تشغيل التعليمات البرمجية المعقدة للتحليل على صفحات الدليل عشوائية أكثر أمانًا. إذا حدث خطأ ما لسبب ما غير متعلق بمحتوى الصفحة المعروضة، فيمكنك تعيين $MAN_DISABLE_SECCOMP إلى أي قيمة غير فارغة لتعطيل صندوق الحماية.
PIPELINE_DEBUG
إذا تم تعيين متغير البيئة $PIPELINE_DEBUG على "1"، فستطبع man رسائل تصحيح الأخطاء إلى الخطأ القياسي (standard error) تصف كل عملية فرعية تقوم بتشغيلها.
LANG, LC_MESSAGES
اعتمادًا على النظام والتنفيذ، سيتم استجواب إما أو كل من $LANG و $LC_MESSAGES للحصول على موقع الرسائل الحالي. سيعرض man رسائله بهذا الموقع (إذا كان متاحًا). راجع setlocale(3) للحصول على التفاصيل الدقيقة.
الملفات
/etc/manpath.config
ملف تكوين `man-db`.
/usr/share/man
تسلسل هرمي عالمي لصفحات الدليل.
المعايير
POSIX.1-2001، POSIX.1-2008، POSIX.1-2017.
انظر أيضًا
apropos(1)، groff(1)، less(1)، manpath(1)، nroff(1)، troff(1)، whatis(1)، zsoelim(1)، manpath(5)، man(7)، catman(8)، mandb(8)
قد تتوفر وثائق لبعض الحزم بتنسيقات أخرى، مثل info(1) أو HTML.
التاريخ
1990 1991 – كتبها في الأصل جون دبليو. إيتون (_).
23 ديسمبر 1992: قام ريك فيث (\_) بتطبيق إصلاحات للأخطاء قدمها ويلم كاسدورب (_).
30 أبريل 1994 – 23 فبراير 2000: قام ولف (_) بتطوير وصيانة هذه الحزمة بمساعدة عدد قليل من الأشخاص المتفانين.
30 أكتوبر 1996 – 30 مارس 2001: قام فابريزيو بولاكو <_> بصيانة هذه الحزمة وتوسيعها لمشروع دبيان، بمساعدة المجتمع بأكمله.
31 مارس 2001 – حتى الآن: يقوم كولين واتسون <_> الآن بتطوير وصيانة man-db.
الأخطاء
https://gitlab.com/man-db/man-db/-/issues
https://savannah.nongnu.org/bugs/?group=man-db