.. image:: http://img.shields.io/pypi/v/cppman.svg?style=flat :target: https://pypi.python.org/pypi/cppman .. image:: https://img.shields.io/github/downloads/aitjcize/cppman/total.svg :target: https://pypi.python.org/pypi/cppman#downloads

cppman

适用于Linux的C++ 98/11/14/17/20手册页，内容来源于cplusplus.com <http://cplusplus.com/>和cppreference.com <https://cppreference.com/>。

.. image:: https://raw.github.com/aitjcize/cppman/master/wiki/screenshot.png

特性

• 支持两个后端（使用cppman -s切换）：

  • cplusplus.com <http://cplusplus.com/>_
  • cppreference.com <http://cppreference.com/>_

• 支持章节和示例源代码的语法高亮。

• 使用方式/界面类似于'man'命令。

• 手册页之间的超链接（仅在pager=vim时可用）

  • 当光标在关键词上时，按Ctrl-]前进，按Ctrl-T后退。
  • 也可以双击关键词前进，右键单击后退。

• 经常更新以支持cplusplus.com <http://cplusplus.com/>_。

演示

使用vim作为分页器

.. image:: https://raw.github.com/aitjcize/cppman/master/wiki/demo.gif

安装

1. 从PyPI安装：

.. code-block:: bash

$ pip install cppman

注意cppman需要Python 3。确保pip已配置为Python 3安装，或者你的默认Python解释器是版本3，或者直接使用pip3。

2. Arch Linux用户可以在AUR上找到它或使用Trizen <https://wiki.archlinux.org/title/Trizen>_：

.. code-block:: bash

$ trizen -S cppman

或安装git版本

.. code-block:: bash

$ trizen -S cppman-git

3. Debian / Ubuntu：cppman在Debian sid/unstable和Ubuntu vivid中可用。

.. code-block:: bash

$ sudo apt-get install cppman

4. MacOS X：cppman在Homebrew和MacPorts中可用。

.. code-block:: bash

$ brew install cppman

或

.. code-block:: bash

$ sudo port install cppman

包维护者

• Arch Linux：我自己
• Debian：czchen <https://github.com/czchen>_
• MacPorts：eborisch <https://github.com/eborisch>_

常见问题

• 问：我可以使用系统的man命令而不是cppman吗？
• 答：可以，只需执行cppman -m true，所有缓存的手册页就会对系统的man命令可见。注意：你可能想用cppman -c下载所有可用的手册页。
• 问：为什么bash补全在使用::时不能正常工作？
• 答：这是因为bash将:视为空格。要解决这个问题，请在你的~/.bashrc中添加export COMP_WORDBREAKS=" /\"\'><;|&("。

错误

• 请在github问题追踪器上报告错误/格式不正确的页面。

贡献

1. Fork项目
2. 创建你的特性分支（git checkout -b my-new-feature）
3. 提交你的更改（git commit -am 'Add some feature'）
4. 推送到分支（git push origin my-new-feature）
5. 创建新的Pull Request

注意

• manpages-cpp自2012年9月19日起更名为cppman