跳转到内容跳转到页面导航:上一页 [访问键 p]/下一页 [访问键 n]
适用于 openSUSE Leap 15.6

20 帮助和文档 编辑源文件

openSUSE® Leap 提供了多种信息和文档来源,可以在线获取或集成到您已安装的系统中。

产品文档

关于 openSUSE Leap 的大量文档可在 https://doc.opensuse.net.cn 获得。涵盖的主题范围从部署、升级和系统管理到虚拟化、系统调整和安全性等。

位于 /usr/share/doc 的文档

此目录包含您系统的发行说明(位于 release-notes 子目录中)。它还包含已安装软件包的信息(位于 packages 子目录中)。有关更多详细信息,请参阅 第 20.1 节,“文档目录”

Shell 命令的手册页和信息页

在使用 Shell 时,您不需要记住命令的选项。传统上,Shell 通过手册页和信息页提供集成的帮助。有关更多信息,请参阅 第 20.2 节,“手册页”第 20.3 节,“信息页”

桌面帮助中心

GNOME 桌面的帮助中心(帮助)提供对 GNOME 桌面文档的集中访问。

某些应用程序的独立帮助包

使用 YaST 安装新软件时,软件文档通常会自动安装并显示在您桌面的帮助中心中。但是,某些应用程序(例如 GIMP)可能有不同的在线帮助包,可以使用 YaST 单独安装,并且不会集成到帮助中心中。

20.1 文档目录 编辑源文件

在您已安装的 Linux 系统上查找文档的传统目录是 /usr/share/doc。该目录包含发行说明和有关您系统上安装的软件包的信息,以及手册等。

Note
注意:内容取决于已安装的软件包

在 Linux 世界中,手册和其他类型的文档以软件包的形式提供,就像软件一样。您在 /usr/share/doc 中找到的信息的数量和类型也取决于安装的(文档)软件包。如果您找不到此处提及的子目录,请检查您的系统上是否安装了相应的软件包,并在需要时使用 YaST 添加它们。

20.1.1 发行说明 编辑源文件

我们提供 openSUSE Leap 发行说明的 HTML、PDF、RTF 和文本版本。它们可在您已安装的系统上的 /usr/share/doc/release-notes/ 下获得,或在您产品特定的网页上获得,网址为 https://doc.opensuse.net.cn/release-notes/

20.1.2 软件包文档 编辑源文件

packages 下,找到包含在您系统上安装的软件软件包中包含的文档。对于每个软件包,都会创建一个子目录 /usr/share/doc/packages/PACKAGENAME。它通常包含软件包的 README 文件,有时还包含示例、配置文件或额外的脚本。以下列表介绍了在 /usr/share/doc/packages 下找到的典型文件。这些条目都不是必需的,许多软件包仅包含其中的几个。

AUTHORS

主要开发人员列表。

BUGS

已知错误或故障。还可能包含指向 Bugzilla 网页的链接,您可以在其中搜索所有错误。

CHANGES , ChangeLog

从版本到版本的更改摘要。它对开发人员来说很有趣,因为它很详细。

COPYING , LICENSE

许可信息。

FAQ

从邮件列表或新闻组收集的问题和答案。

INSTALL

如何在您的系统上安装此软件包。由于您在阅读此文件时软件包已经安装,因此可以安全地忽略此文件的内容。

README, README.*

关于软件的一般信息。例如,其用途和如何使用它。

TODO

未来计划的功能。

MANIFEST

带有简短摘要的文件列表。

NEWS

描述此版本中的新内容。

20.2 手册页 编辑源文件

手册页是任何 Linux 系统的基本组成部分。它们解释了命令的用法以及所有可用的选项和参数。可以使用 man 后跟命令的名称来访问手册页,例如,man ls

手册页直接在 Shell 中显示。要浏览它们,请使用 Page ↑Page ↓ 上下移动。使用 HomeEnd 在文档的开头和结尾之间移动。按 Q 结束查看模式。详细了解 man 命令本身,请使用 man man。手册页按类别排序,如 表 20.1,“手册页—类别和描述”(摘自 man 本身的手册页)所示。

表 20.1: 手册页—类别和描述

编号

描述

1

可执行程序或 Shell 命令

2

系统调用(内核提供的函数)

3

库调用(程序库中的函数)

4

特殊文件(通常位于 /dev 中)

5

文件格式和约定 (/etc/fstab)

6

游戏

7

杂项(包括宏包和约定),例如 man(7)、groff(7)

8

系统管理命令(通常仅供 root 使用)

9

内核例程(非标准)

每个手册页由几个标记为 NAMESYNOPSISDESCRIPTIONSEE ALSOLICENSINGAUTHOR 的部分组成。根据命令的类型,可能还有其他部分可用。

20.3 信息页 编辑源文件

信息页是您系统上的另一个重要信息来源。通常,它们比手册页更详细。它们包含的不仅仅是命令行选项,有时还包含完整的教程或参考文档。要查看某个命令的信息页,请输入 info 后跟命令的名称,例如,info ls。您可以使用直接在 Shell 中的查看器浏览信息页,并显示不同的部分,称为 节点。使用 Space 向前移动,使用 <— 向后移动。在节点内,您还可以使用 Page ↑Page ↓ 浏览,但只有 Space<— 才能将您带到上一个或下一个节点。按 Q 结束查看模式。并非每个命令都带有信息页,反之亦然。

20.4 在线资源 编辑源文件

要概述 openSUSE Leap 可用的所有文档,请查看产品特定的文档网页,网址为 https://doc.opensuse.net.cn/

如果您正在搜索其他与产品相关的信息,还可以参考以下网站

用户社区

openSUSE 论坛

GNOME 文档

GNOME 用户、管理员和开发人员的文档可在 https://help.gnome.org/ 获得。

Linux 文档项目

Linux 文档项目 (TLDP) 由一个志愿者团队运行,他们编写与 Linux 相关的文档(请参阅 https://tldp.cn/)。它是一个全面的 Linux 文档资源。文档集包含初学者的教程,但主要面向有经验的用户和专业系统管理员。TLDP 以免费许可发布 HOWTO、FAQ 和指南(手册)。TLDP 的部分文档也可用在 openSUSE Leap 上。

打印此页面