Skip to content

Latest commit

 

History

History
101 lines (68 loc) · 2.98 KB

README.rst

File metadata and controls

101 lines (68 loc) · 2.98 KB
Raw
http://img.shields.io/pypi/v/cppman.svg?style=flat

cppman

C++ 98/11/14/17/20 manual pages for Linux, with source from cplusplus.com and cppreference.com.

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

Features

  • Supports two backends (switch it with cppman -s):
  • Syntax highlighting support for sections and example source code.
  • Usage/Interface similar to the 'man' command
  • Hyperlink between manpages (only available when pager=vim)
    • Press Ctrl-] when cursor is on keyword to go forward and Ctrl-T to go backward.
    • You can also double-click on keyword to go forward and right-click to go backward.
  • Frequently update to support cplusplus.com.

Demo

Using vim as pager

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

Installation

  1. Install from PyPI:
$ pip install cppman

Note that cppman requires Python 3. Make sure that either pip is configured for Python 3 installation, your default Python interpreter is version 3 or just use pip3 instead.

  1. Arch Linux users can find it on AUR or using Trizen:
$ trizen -S cppman

or install the git version

$ trizen -S cppman-git
  1. Debian / Ubuntu: cppman is available in Debian sid/unstable and Ubuntu vivid.
$ sudo apt-get install cppman
  1. MacOS X: cppman is available in Homebrew and MacPorts.
$ brew install cppman

or

$ sudo port install cppman

Package Maintainers

FAQ

  • Q: Can I use the system man command instead of cppman?
  • A: Yes, just execute cppman -m true and all cached man pages are exposed to the system man command. Note: You may want to download all available man pages with cppman -c.
  • Q: Why is bash completion is not working properly with ::?
  • A: It is because bash treats : like a white space. To fix this add export COMP_WORDBREAKS=" /\"\'><;|&(" to your ~/.bashrc.

Bugs

  • Please report bugs / mis-formatted pages to the github issue tracker.

Contributing

  1. Fork it
  2. Create your feature branch (git checkout -b my-new-feature)
  3. Commit your changes (git commit -am 'Add some feature')
  4. Push to the branch (git push origin my-new-feature)
  5. Create new Pull Request

Notes

  • manpages-cpp is renamed to cppman since September 19, 2012