كيفية إنشاء إدخال يدوي لحزمة deb

Question

أين أكتب إدخالاً يدويًا عند إنشاء حزمة deb؟هل هناك أي قاعدة تنسيق/أفضل ممارسة يجب احترامها؟

أنا جديد جدًا في إنشاء حزم deb.باتباع بعض البرامج التعليمية، قمت للتو بإنشاء حزمة يتم تثبيتها/تنفيذها بشكل جيد، لذا أود الآن أن أكتب بعض الوثائق بحيث man myFancyPackage إرجاع شيء بدلا من لا يوجد إدخال يدوي لـ myFancyPackage.

لسوء الحظ، لم تتحدث أي من البرامج التعليمية التي وجدتها عن الإنشاء اليدوي.

Answer 1

هناك الكثير من الطرق لبناء حزمة دبيان، لكن "أفضل الممارسات" الحالية هي استخدام الأدوات التي توفرها Debhelper.في حالة صفحات الرجل، هناك أداة اسمها dh_installman (اقرأها com.manpage) الذي يتم استدعاؤه تلقائيًا بواسطة dh.إذا كنت تستخدم dh_make أو ما شابه ذلك لإنشاء قالب لحزمتك، ثم أ dh سيكون الدعاء في الخاص بك debian/rules ملف.

dh_installman يعمل من خلال قراءة الملف debian/manpages, ، أو debian/nameofyourpackage.manpages.يحتوي هذا الملف على قائمة بالمسارات التي تشير إلى صفحات الدليل الخاصة بحزمتك.ترتبط المسارات بجذر الحزمة الخاصة بك.هنا لديك مثال من الحزمة الحقيقية.بعد ذلك، سيقوم هذا البرنامج بتثبيت صفحات الدليل الخاصة بك بشكل صحيح في الدليل الصحيح.

لذا، خلاصة القول، ما عليك سوى إنشاء debian/package.manpages واملأها بالمسارات المؤدية إلى صفحات الرجل الخاصة بك.يجب أن تكون هذه المسارات مرتبطة بجذر الحزمة الخاصة بك.إذا كنت، المعبئ، تقوم بكتابة صفحات الدليل، فيجب وضعها في ملف Debian/ الدليل.

Answer 2

كانت صفحات الرجل تتكون تقليديًا بلغة تنضيد تسمى roff باستخدام حزمة ماكرو تسمى an (هكذا كان سطر الأوامر roff -man, ، كذا) ولكن قلة من الناس يكتبون الخام roff أي أكثر من ذلك.

هناك العديد من تنسيقات وثائق SGML وXML التي لديها القدرة على الإنشاء man مصادر الصفحة، رغم أنه في هذا اليوم وهذا العصر، تخفيض السعر من المحتمل أن تكتسب الأرض مثل بحكم الأمر الواقع معيار التوثيق الجديدأفضل ما حققته Google بالنسبة لي هو https://github.com/remarkjs/remark-man على الرغم من أنني بالتأكيد أقترح عليك أيضًا إلقاء نظرة على pandoc.

# NAME

Markdown - popular text markup language

# SYNOPSIS

man markdown

# DESCRIPTION

This is a popular lightweight syntax
to generate styled text from an
editor-friendly text source.
It is used on [Stack Overflow][1],
[Github][2], and increasingly on
blogging and authoring platforms.

  [1]: https://stackoverflow.com/
  [2]: https://github.com/

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

=head1 NAME

Pod::Example - Example POD document

=head1 SYNOPSIS

pod2man thisdoc.pod >thisdoc.1

=head1 DESCRIPTION

Lightweight syntax for subheads,
hyperlinks, indented lists,
and not much else.
Natively supported in Perl source files
to facilitate a crude form of
literate programming.