Question

创建deb包时，我在哪里编写手册？是否有任何格式规则/最佳实践要尊重？

我对deb包创建非常陌生。在一些教程之后，我刚刚创建了一个可以很好地安装/执行的软件包，所以现在我想编写一些文档，以便man myFancyPackage返回一些内容，而不是 myFancyPackage 的手动输入。< / p>

不幸的是，我发现的所有教程都没有提到手动创建。

Answer 1

有很多方法可以构建Debian软件包，但目前的“最佳实践”是使用Debhelper提供的工具。对于手册页，有一个名为dh_installman的工具（读取其manpage），由dh自动调用。如果您使用dh_make或类似内容为您的软件包创建模板，那么dh调用将位于您的debian/rules文件中。

dh_installman的工作原理是阅读文件debian/manpages或debian/nameofyourpackage.manpages。此文件包含指向程序包手册页的路径列表。路径相对于包的根目录。这里有一个example的真实包裹。然后，该程序将正确安装您的手册页在正确的目录中。

因此，总而言之，您只需要创建debian/package.manpages并将其填充到手册页的路径中。这些路径必须相对于包的根目录。如果您（打包者）正在编写手册页，则必须将它们放在Debian/目录中。

Answer 2

传统上，手册页使用名为roff的排版语言组成，使用名为an的宏包（因此命令行为roff -man，sic）但很少有人写原始{{1}不再。

有各种SGML和XML文档格式可以生成roff页面源，但在这个时代，Markdown可能正在成为事实上的新文档的标准。谷歌的热门话题是https://github.com/remarkjs/remark-man，但我绝对建议您查看man。

pandoc

我还会提到POD format，它在Perl社区中有很长的历史，并且有许多与流行的，更新的轻量级格式相同的功能。除非你有其他理由喜欢它，否则我不会选择它用于新的文档，但它曾经在Perl世界之外的中等受欢迎，因为它是具有简单的人类可读源格式的唯一选项之一，显而易见语义学，以及一个多功能，维护良好的工具链和支持生态系统。有些人可能会说它仍然存在。

# 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/

如何为deb包创建手动输入

2 个答案: