Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/aitjcize/cppman
C++ 98/11/14 manual pages for Linux/MacOS
https://github.com/aitjcize/cppman
Last synced: 25 days ago
JSON representation
C++ 98/11/14 manual pages for Linux/MacOS
- Host: GitHub
- URL: https://github.com/aitjcize/cppman
- Owner: aitjcize
- License: gpl-3.0
- Created: 2010-07-03T15:58:20.000Z (over 14 years ago)
- Default Branch: master
- Last Pushed: 2024-06-28T04:14:28.000Z (4 months ago)
- Last Synced: 2024-09-30T16:40:51.513Z (about 1 month ago)
- Language: Python
- Homepage:
- Size: 8.71 MB
- Stars: 1,292
- Watchers: 24
- Forks: 81
- Open Issues: 25
-
Metadata Files:
- Readme: README.rst
- Changelog: ChangeLog
- License: COPYING
- Authors: AUTHORS
Awesome Lists containing this project
- awesome-list - cppman - C++ 98/11/14 manual pages for Linux/MacOS. (Containers & Language Extentions & Linting / For C++/C)
README
.. 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
======
C++ 98/11/14/17/20 manual pages for Linux, with source from `cplusplus.com `_ and `cppreference.com `_.
.. image:: https://raw.github.com/aitjcize/cppman/master/wiki/screenshot.png
Features
--------
* Supports two backends (switch it with ``cppman -s``):
+ `cplusplus.com `_
+ `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 `_.
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 `Trizen `_:
.. code-block:: bash
$ trizen -S cppman
or install the git version
.. code-block:: bash
$ trizen -S cppman-git
3. Debian / Ubuntu: cppman is available in Debian sid/unstable and Ubuntu vivid.
.. code-block:: bash
$ sudo apt-get install cppman
4. MacOS X: cppman is available in Homebrew and MacPorts.
.. code-block:: bash
$ brew install cppman
or
.. code-block:: bash
$ sudo port install cppman
Package Maintainers
-------------------
* Arch Linux: myself
* Debian: `czchen `_
* MacPorts: `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``.
* 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