كيفية إنشاء صفحة Linux Man

الامر رجل على Linux مضمن في الذاكرة العضلية لكل مطور ومستخدم Linux. يتم استخدامه من قبل الجميع حرفيا ؛ من المطورين الهواة والمبتدئين إلى المتخصصين والخبراء في Linux.

يتم استخدامه لقراءة صفحة دليل سطر الأوامر لأمر Linux أو ملف التكوين أو أي ميزة أخرى. عادةً ما يتم تثبيت صفحات الدليل جنبًا إلى جنب مع تثبيت برنامج في Linux. هناك بناء جملة محدد لصفحات الدليل ، والذي يتم تحليله بواسطة الأمر.

دعونا ننشئ صفحة رجل لسيناريو bash التالي الذي كتبته:

#! / bin / bash إذا ["$ 1" == "h"]؛ ثم صدى "مرحبا" فاي إذا ["$ 1" = "ب"]؛ ثم صدى "وداعا" فاي

يقوم هذا البرنامج النصي بعمل شيئين فقط: يطبع "Hello" إذا تم تحديد الخيار "h" كوسيطة ، ويطبع "Bye" إذا تم تحديد الخيار "b" كوسيطة.

دعونا ننشئ صفحة رجل لهذا البرنامج. يستخدم همة أو أي محرر من اختيارك لإنشاء ملف نصي.

اختبار vim.1

يشير الامتداد ".1" إلى أن صفحة الرجل هذه مخصصة لأمر قابل للتنفيذ. إنه ليس إكراهًا ولكنه اتفاقية متبعة على نطاق واسع أثناء كتابة صفحات الرجل. صفحة الدليل للرجل (رجل رجل !) يسرد الفئات:

 1 البرامج القابلة للتنفيذ أو أوامر shell 2 استدعاءات النظام (الوظائف التي توفرها kernel) 3 استدعاءات المكتبة (الوظائف داخل مكتبات البرامج) 4 ملفات خاصة (توجد عادةً في / dev) 5 تنسيقات ومصطلحات الملفات مثل / etc / passwd 6 Games 7 Miscellaneous ( بما في ذلك حزم الماكرو والمصطلحات) ، على سبيل المثال man (7)، groff (7) 8 أوامر إدارة النظام (عادةً فقط للجذر) 9 إجراءات Kernel [غير قياسي]

يتم إنشاء صفحة دليل باستخدام لغة الترميز القديمة جدًا. يحتوي على أوامر (علامات قراءة) لعناوين وأقسام مختلفة.

  • - يجب أن يكون هذا هو الأمر الأول في ملف man. يتم استخدامه لتحديد عنوان العنوان لصفحة الدليل.
  • - عنوان القسم.
  • - يستخدم لعرض النص بجانبه بخط عريض.
  • .TP - يتم استخدامه لعرض معلومات حول الوسيطة (العلم) للأمر.
  • .BR - يستخدم لعرض النص بالخط العريض وبالخط الروماني العادي.

فيما يلي صفحة الرجل الخاصة ببرنامجي التي تم إنشاؤها باستخدام أوامر roff أعلاه (البسيطة) فقط.

.TH test.sh 1 .SH NAME test.sh \ - طباعة مرحبًا أو وداعا .SH SYNOPSIS .B test.sh [h] [b] .SH DESCRIPTION .B test.sh هذا نموذج نصي يقوم بعمل شيئين فقط . إما أن تطبع "Hello" إذا كانت الوسيطة 'h' أو تطبع "Bye" إذا كانت الوسيطة 'b' .SH OPTIONS .TP .BR h Print Hello .TP .BR b Print Bye

حفظ الملف بالضغط أولاً على ملف خروج مفتاح ، ثم اكتب : wq لحفظ الملف والخروج من وحدة التحكم vim.

اختبر صفحة الدليل التي أنشأناها للتو باستخدام الأمر أدناه:

الرجل. / الاختبار 1

لمزيد من المعلومات حول رجل الاستخدام ، تشغيل رجل صفحات الأمر في المحطة الخاصة بك.

? نصيحة

هذا هو التركيب الأساسي لكتابة صفحات الرجل. لتسهيل الأمور ، يمكنك استخدام أدوات مثل txt2man لتحويل ملف في بعض تنسيق لغة الترميز إلى تنسيق roff.