Manual Page

CPPMAN(1)                        User Manuals                        CPPMAN(1)

NAME
       cppman - C++ manual page viewer / fetcher

SYNOPSIS
       cppman [ OPTIONS...  ] PAGE...

DESCRIPTION
       cppman  is part of the package manpages-cpp.  cppman generates C++ man‐
       ual pages from cplusplus.com and provide a man-like interface  to  view
       man pages.

       By default, cppman fetches man pages on demand, but by running the com‐
       mand 'cppman -c', all available manpages  are  cached,  making  offline
       browsing possible.

   Browsing man pages
       cppman uses Vi Improved as a pager.
       Press   'q'  to  leave  pager.   Press  'K'  on  an  entry  like  'vec‐
       tor::insert(3)' links you to the manual page of vector::insert, like  a
       hyperlink.

   man compatibility
       cppman  automatically  add '~/.local/share/man' to '~/.manpath', so the
       cached man pages can also be viewed with 'man' command.  Note  that  to
       view uncached man pages, you still need to run 'cppman'.

OPTIONS
       -c, --cache-all
              cache  all available man pages from cplusplus.com to enable off‐
              line browsing

       -C, --clear-cache
              clear all cached files

       -f KEYWORD, --find-page=KEYWORD
              find man page

       -o, --force-update
              force cppman to update  existing  cache  when  '--cache-all'  or
              browsing man pages that were already cached

       -m MANDB, --use-mandb=MANDB                                               
              Accepts  'true' or 'false'. If true, cppman adds manpage path to   
              mandb so that you can view C++ manpages with `man' command.  The   
              default value is 'false'.

       -p PAGER, --pager=PAGER                                                   
              Select  pager to use, accepts 'vim' or 'less'. The default value   
              is 'vim'.

       -r, --rebuild-index
              rebuild index database from cplusplus.com

       -v, --version
              show version information

       -h, --help
              show this help message and exit

NOTE
       All  contents  should be cached by the user, manpages-cpp does not con‐
       tain any pre-cached contents.

       Do not distribute the cached man pages without the permision of  cplus‐
       plus.com.

BUGS
       Although  I  spend  a  lot of time checking the format, there are still
       pages that won't display correctly.
       Feel free to report the bug at:

       http://github.com/Aitjcize/manpages-cpp/issues or
       mail://[email protected].

       Please include the page name in the bug report.

AUTHOR
       Wei-Ning Huang (AZ) <[email protected]>

Linux                              MAY 2010                          CPPMAN(1)