как создать запись вручную для пакета deb

Question

Где мне написать запись вручную при создании пакета deb?Есть ли какие-либо правила/рекомендации по форматированию, которые следует соблюдать?

Я новичок в создании пакетов deb.Следуя некоторым руководствам, я только что создал пакет, который прекрасно устанавливается и выполняется, поэтому теперь я хотел бы написать некоторую документацию, чтобы man myFancyPackage возвращает что-то вместо нет ручного ввода для myFancyPackage.

К сожалению, ни в одном из найденных мной руководств не говорится о создании вручную.

Answer 1

Существует множество способов сборки пакета Debian, но на данный момент «лучшей практикой» является использование инструментов, предоставляемых Debhelper.В случае с man-страницами есть инструмент под названием dh_installman (прочитайте его справочная страница), который вызывается автоматически dh.Если вы использовали dh_make или что-то подобное, чтобы создать шаблон для вашего пакета, а затем dh призыв будет в вашем debian/rules файл.

dh_installman работает, читая файл debian/manpages, или debian/nameofyourpackage.manpages.Этот файл содержит список путей, указывающих на справочные страницы вашего пакета.Пути указаны относительно корня вашего пакета.Здесь у вас есть пример реального пакета.Затем эта программа правильно установит ваши справочные страницы в правильный каталог.

Итак, подведем итог: вам нужно всего лишь создать debian/package.manpages и заполните его путями к вашим справочным страницам.Эти пути должны быть относительными к корню вашего пакета.Если вы, упаковщик, пишете man-страницы, то их необходимо поместить в каталог 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/

Я также упомяну POD-формат, который имеет долгую историю в сообществе 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.