Man page (简体中文) - ArchWiki

# Man page (简体中文)

From ArchWiki

相关文章

- Color output in console#man

man手册页（manual pages，“手册”），是类UNIX系统最重要的手册工具。多数类UNIX都预装了它，这也包括Arch。使用man手册页的命令是：`man`。

man手册页被设计成“自足”的文档库，即论述相关问题时无法通过类似超链接的东西引向其他手册页。GNU正努力改变原始的man手册页格式。

## 阅读手册页

通过以下命令阅读man手册页：

    $ man 手册名

man手册页分为下面几个部分：

1. 普通命令
2. 内核提供的系统调用
3. 库调用（C库函数）
4. 特殊文件（大多在/dev目录下）和设备
5. 文件格式规范
6. 游戏
7. 杂项（及其规范）
8. 系统管理命令（通常需要root权限）和守护进程

man手册页通过名称和所属分类标识。有些不同分类的man手册页名字可能相同，比如 man(1) 和 man(7)，这时需要额外指明分类以访问需要的手册。例如：

    $ man 5 passwd

会显示有关文件`/etc/passwd`，而非命令 `passwd`，的内容。

通过`whatis`命令，可以只显示需要的man手册页的简要信息。如果只是想获取对命令 ls 的简要说明，使用以下命令：

    $ whatis ls

然后会得到输出：“list directory contents.”（“列目录内容”）。

## 格式

所有man手册页都按照以下标准格式组织：

- NAME - 手册叙述对象名称，及简要描述。
- SYNOPSIS - 命令参数格式，或者函数调用格式等。
- DESCRIPTION - 对叙述对象更加详细的描述。
- EXAMPLES - 由浅入深的使用示例。
- OPTIONS - 命令行或者函数调用参数的意义。
- EXIT STATUS - 不同返回（退出）代码的含义。
- FILES - 与叙述对象相关的文件。
- BUGS - 已知的bug。
- SEE ALSO - 相关内容列表。
- AUTHOR, HISTORY, COPYRIGHT, LICENSE, WARRANTY - 历史、版权、编者信息。

## 搜索手册页

如果用户压根儿不知道要查阅的手册的名称，该怎么办呢？没事，通过 `-k` 或者 `--apropos` 参数就可以按给定关键词搜索相关手册。例如，要查阅有关密码的手册（“password”）：

关键词搜索特性是从一个专用的缓存生成的。默认情况下你没有这个缓存，所以无论你搜什么，都会提示你nothing appropriate。你可以通过下面的命令来生成这个缓存：

    # mandb

每当你安装新的manpage之后都需要运行这个命令，缓存才会更新。

现在你可以开始搜索了。 例如，要查阅有关密码的手册（“password”）：

    $ man -k password

或者：

    $ man --apropos password

还可以直接使用 `apropos` 命令：

    $ apropos password

关键字可以使用正则表达式。

如果你想全文搜索的话，你可以用`-K`选项：

    $ man -K password

## 使用浏览器阅读手册页

还可以通过Lynx或Firefox之类的浏览器阅读man手册页。由于使用浏览器，手册页可以支持超链接。

此外，KDE用户可以直接在Konqueror使用以下地址访问man手册：

    man:<name>

### 使用本地手册页

首先，从官方软件仓库安装软件包man2html。

然后使用它转换man手册页：

    $ man free | man2html -compress -cgiurl man$section/$title.$section$subsection.html > ~/man/free.html

此外，`man2html`还可以把man页转换为便于打印的文本文件：

    $ man free | man2html -bare > ~/free.txt

Arch提供的man也具有浏览器阅读功能：

    $ man -H free

由`BROWSER`环境变量决定使用的浏览器。也可以使用 `man -Hlynx`（H后无空格）这样的形式手动设置浏览器。

### 使用在线手册页

许多网站提供在线man手册页，详细列表参见：Wikipedia:Man_page#Repositories_of_manual_pages。

- Man7.org. Upstream for Arch Linux's man-pages.
- Debian GNU/Linux man pages
- DragonFlyBSD manual pages
- FreeBSD Hypertext Man Pages
- Linux and Solaris 10 Man Pages
- Linux/FreeBSD Man Pages with user comments
- Linux man pages at die.net
- The Linux man-pages project at kernel.org
- NetBSD manual pages
- Mac OS X Manual Pages
- On-line UNIX manual pages
- OpenBSD manual pages
- Plan 9 Manual — Volume 1
- Inferno Manual — Volume 1
- Storage Foundation Man Pages
- The Missing Man Project [dead link as of 9 July 2010]
- Gobuntu Manual Pages [dead link as of 9 July 2010]
- The UNIX and Linux Forums Man Page Repository
- Ubuntu Manpage Repository

Category:

- Software (简体中文)