☰

配置文件的联机帮助页

tag-icon • tag-icon files configuration man
配置文件的联机帮助页

我经常发现自己需要查找计算机上某个程序的配置文件的语法和逻辑。虽然我可以这样做man mosquitto，但这不一定会产生文件 /etc/mosquitto.conf 的帮助部分。

man /etc/mosquitto.conf我正在寻找类似or 的东西man ./mosquitto.conf，它应该打开给定文件所需的确切帮助。不仅仅是蚊子，这只是一个例子。

某处有这样的映射吗？是否有一个程序可以用来查找有关特定配置文件的帮助，而不必在互联网上搜索？

答案1

手册页分为不同的部分。

来自基于 RedHat (Centos/Rocky) 的系统

       1   Executable programs or shell commands
       2   System calls (functions provided by the kernel)
       3   Library calls (functions within program libraries)
       4   Special files (usually found in /dev)
       5   File formats and conventions eg /etc/passwd
       6   Games
       7   Miscellaneous  (including  macro  packages  and  conventions), e.g.
           man(7), groff(7)
       8   System administration commands (usually only for root)
       9   Kernel routines [Non standard]

因此从理论上讲，手册页mosquitto.conf应该位于第 5 节中。事实上，确实man 5 mosquitto.conf提供了详细信息。

然而，这需要包提供手册页。有据可查的应用程序可以执行此操作（例如，man sshd_config将返回第 5 节手册页）。

但这完全取决于包和应用程序来提供此信息。

并非每个配置文件都有与其关联的联机帮助页。

答案2

TL/DR：没有集中的信息存储库。应用程序/工具/等的最新信息来源位于其文档中。除此之外还有手册页、信息页、tldr 页、html 文档、文献、互联网...

手册页只是软件文档的一种形式。找出手册页是否存在的最快方法就是发出命令man foo。命令apropos foo输出包含有关foo.

man7.org主机Linux 手册页项目，一个手册页的网络存储库。它包含手册页列表按部分,按字母顺序和按项目。在终端上可以通过 just man foo（例如man hosts）、neverman /path/foo或man ./foo（例如man /etc/hosts）查看手册页。发行版还可以在线托管自己的手册页。

并非所有内容都有手册页。没有 的手册页.bashrc，但有关它的一些信息可以在man bash- 中找到，但不是其内容的具体信息。xattr有手册页，xattr.conf没有；man xattr.conf输出No manual entry for xattr.conf。 Xattr 的手册页也没有提及conf 文件。有关它的一些信息可以通过以下方式查看cat /etc/xattr.conf：

# Format:
# <pattern> <action>
#
# Actions:
#   permissions - copy when trying to preserve permissions.
#   skip - do not copy.

其他文件.bashrc也包含注释形式的文档。

与手册页类似的项目有GNU 信息和总长DR。虽然手册页包含对其他手册页的引用，但它们是静态的；因此，以下参考文献需要打开另一个页面。 GNU Info 有内部超链接。 TLDR 页面有点像备忘单，是社区为简化手册页所做的努力。它还提供了实际示例。它们的用法就像man- ieinfo xattr和tldr xattr。

GUI 应用程序（例如 GNOME 和 KDE）不使用上述任何内容。他们的最终用户文档是使用 HTML 提供的，并且可以包含像 GNOME 那样的查看器喊叫。

最终提供文档完全取决于开发人员。他们可以自由选择以何种形式提供——或者根本不提供。其中有很多。因此，特定信息的质量和可用性差异很大，并且创建单个存储库根本不可能。如今，查找信息最快、最简单的方法是互联网。

答案3

不幸的是，并非所有程序都以相同的方式组织其手册页。在您的示例中，检查末尾的“另请参阅”部分；您可能会发现类似mosquitto.conf(7)或mosquittod(8)意味着您可以做的事情man 7 mosquitto.conf或man 8 mosquittod。

中的文件格式/etc/应属于手册类别 5。通常它是主文件的名称，此处man 5 mosquitto.conf（或man 5 sshd_config用于/etc/ssh/sshd_config。）有时它可能是程序的名称（例如，man 5 passwd适用于/etc/master.passwd太）或其他名称。

您可以尝试apropos或whatis来查询手册页索引。这里，apropos mosquitto.conf

相关内容