Linux 下安装中文版 man 手册 以及 C++ 帮助手册

man 手册页是在Unix或类Unix操作系统中常用的一种花在线软件文档形式,内容包括计算机程序(包括库和系统调用),正式的标准和惯例,甚至是抽象的概念。我们都可以通过执行man命令调用手册页。本文主要内容为:为 Linux 下的 man 手册安装中文版并设置别名 cman , 方便中英阅读对照;同时安装 C++ 的 man 手册文档,方便查阅库函数的使用细节。

安装 中文 man 手册

1
sudo apt-get install manpages-zh

查看man 手册安装到哪里

1
dpkg -L manpages-zh | less

由上图可见,安装位置为 /usr/share/man/zh_CN

注: 从dpkg命令下退出请按 键盘的 Q



为 bash 设置一个中文man的别名

为了不干扰原来 man 命令的使用,可以设置一个别名,比如 cman

​ 修改 ~/.bashrc 添加一个alias :

修改方法1:

1
2
3
4
5
6
vi ~/.bashrc
alias cman='man -M /usr/share/man/zh_CN'

# 使别名生效
source ~/.bashrc

修改方法2

1
2
3
4
5
echo "alias cman='man -M /usr/share/man/zh_CN'" >> ~/.bashrc

# 使别名生效
source ~/.bashrc

这样以后查看 英文 继续使用 man 就行,查看中文版 使用 cman 命令就行,当然开两个终端中英对照更加有助于英语水平的提高 . 😀



为 zsh 配置别名

若没有使用 zsh 可忽略这一步 , 有的话执行下面的命令,因为 zsh 读取的配置文件和 bash 的不一样.

1
2
3
4
echo "alias cman='man -M /usr/share/man/zh_CN'" >> ~/.zshrc

# 使别名生效
source ~/.zshrc



安装C++帮助手册

1
2
sudo apt-get install libstdc++-10-doc

这样就能查看一些 C++ 的东西了 ,比如

1
man std::map

C++ 的好多好像没中文的,只能 man 了 ,不能 cman


常用快捷键

手册内容

多数手册包含以下几部分内容:

  • NAME 功能的简单描述
  • SYNOPSIS 语法格式
  • DESCRIPTION 描述
  • OPTIONS 选项
  • ERRORS 描述出错场景,这在排查错误时很有帮助
  • NOTES 注意事项
  • FILES 相关文件,例如对于man命令的FILES部分内容显示了它的配置文件位置等信息
  • EXAMPLES 使用示例,会提供一些简单的示例
  • BUGS 存在的bug,当遇到奇怪的问题时,不妨看看当前命令是否有已知的bug

基本查看

手册的查看和less查看文本类似,可以参考《文本查看篇》或查看less命令的使用,这里介绍基本操作:

  • 空格 向下翻页
  • Home 回到第一页
  • End 跳到最后一页
  • /string 向前搜索string字符串
  • ?string 向后搜索string字符串
  • n 下一个匹配字符
  • N 上一个匹配字符
  • q 退出

附录1

对于 .bash_profile 和 .bashrc 区别 :

如果你想对bash的功能进行设置或者是定义一些别名,推荐你修改/.bashrc文件,这样无论你以何种方式打开shell,你的配置都会生效。

而如果你要更改一些环境变量,推荐你修改 ~/.bash_profile文件,因为考虑到shell的继承特性,这些更改确实只应该被执行一次(而不是多次)。针对所有用户进行全局设置,推荐你在/etc/profile.d目录下添加以.sh结尾的文件,而不是去修改全局startup文件。

摘录自 Charles Shih ,在此表示感谢

关于“.bash_profile”和“.bashrc”区别的总结_Charles Shih 技术博客


附录2

其它版本Linux安装命令为:

Debian/Ubuntu 安装

1
2
sudo apt update
sudo apt install manpages-zh

Arch Linux

1
2
pacman -Syu
pacman -S man-pages-zh_cn man-pages-zh_tw

Red Hat/CentOS

1
2
yum update
yum install man-pages-zh-CN

Fedora

1
2
dnf update
dnf install man-pages-zh-CN

附录3

man命令并非仅仅能查看命令或者函数的介绍,在linux中,有丰富的帮助手册信息,并且每一个手册都有一个编号。编号和对应内容如下:

编号 代表内容
1 可执行程序或shell命令,如ls
2 系统调用,如chdir
3 库函数,如printf
4 设备或特殊文件,如tty
5 配置文件格式或约定
6 游戏
7 杂项
8 管理命令,通常只有root用户可以使用
9 内核例程
n 内置命令,如cd

比如

man 3 sleep

image



参考文献

感谢以下参考文献 🍻

man page - Wikiwand

安装中文版 man 帮助命令 - SegmentFault 思否

关于“.bash_profile”和“.bashrc”区别的总结_Charles Shih 技术博客

.bashrc文件和.bash_profile文件的区别? - 知乎 (zhihu.com)

linux - Where are the man pages for C++? - Stack Overflow

Linux常用命令-man | 守望的个人博客 (yanbinghu.com)

linux 设置中文版man手册




山光忽西落,池月渐东上。
散发乘夕凉,开轩卧闲敞。
荷风送香气,竹露滴清响。
欲取鸣琴弹,恨无知音赏。
感此怀故人,中宵劳梦想。

– 孟浩然 《夏日南亭怀辛大