Skip to main content

CMake Interactive Help System

Project description

CMake is a great build system and it has comprehensive reference documentation, but if you have used the documentation (either online or build into cmake) after a while of searching for help becomes tiresome especially if you wan’t to find what you are looking for fast.

That’s why I created this small utility that enables you to quickly search and read CMake’s documentation.

The utility is a interactive command line where you can Tab your way to the documentation you wan.

The following commands are available to you

command   -  Print help for a single command
module    -  Print help for a single module
property  -  Print help for a single property
variable  -  Print help for a single variable

To get a list of available elments use Tab completetion

[CMake Help] command fi<TAB>
file          find_file     find_library

Compatibility

This utility was developed on a Linux based system, so it most likely will work on most Unix based systems where CMake is available. There are only two requirements apart from python that this utility requires. You need the cmake executable available on you system path and the less pasger.

Testing

Currently there is no unit tests and the amount of testing done was very minimal so there might be some bugs.

If command completion does not work there might be 2 causes, either you don’t have readline or there was a problem while getting keywords from cmake. No error is printed if cmake was executed incorectly(all exceptions are caught during command completion)…

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Filename, size & hash SHA256 hash help File type Python version Upload date
CMakeHelp-0.1dev-py2.6.egg (6.0 kB) Copy SHA256 hash SHA256 Egg 2.6
CMakeHelp-0.1dev.tar.gz (3.2 kB) Copy SHA256 hash SHA256 Source None

Supported by

Elastic Elastic Search Pingdom Pingdom Monitoring Google Google BigQuery Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN SignalFx SignalFx Supporter DigiCert DigiCert EV certificate StatusPage StatusPage Status page