/usr/share/doc/cppman/README.rst is in cppman 0.4.8-3.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 | .. image:: http://img.shields.io/travis/aitjcize/cppman.svg?style=flat
:target: https://travis-ci.org/aitjcize/cppman
.. image:: http://img.shields.io/pypi/v/cppman.svg?style=flat
:target: https://pypi.python.org/pypi/cppman
.. image:: http://img.shields.io/pypi/dm/cppman.svg?style=flat
:target: https://crate.io/packages/cppman
cppman
======
C++ 98/11/14 manual pages for Linux, with source from `cplusplus.com <http://cplusplus.com/>`_ and `cppreference.com <http://cppreference.com/>`_.
.. image:: https://raw.github.com/aitjcize/cppman/master/wiki/screenshot.png
Features
--------
* Supports two backends (switch it with ``cppman -s``):
+ `cplusplus.com <http://cplusplus.com/>`_
+ `cppreference.com <http://cppreference.com/>`_
* 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 <http://cplusplus.com/>`_.
Demo
----
Using vim as pager
.. image:: https://raw.github.com/aitjcize/cppman/master/wiki/demo.gif
Installation
------------
1. Install from PyPI:
.. code-block:: bash
$ 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.
2. Arch Linux users can find it on AUR or using `Yaourt <https://wiki.archlinux.org/index.php/Yaourt>`_:
.. code-block:: bash
$ yaourt -S cppman
or install the git version
.. code-block:: bash
$ yaourt -S cppman-git
3. Debian / Ubuntu: cppman is available in Debian sid/unstable and Ubuntu vivid.
.. code-block:: bash
$ sudo apt-get install cppman
Package Maintainers
-------------------
* Arch Linux: myself
* Debian: `czchen <https://github.com/czchen>`_
* Gentoo: `rindeal <https://github.com/rindeal>`_
* MacPorts: `eborisch <https://github.com/eborisch>`_
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``.
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
|