Module vibe.core.args

Parses and allows querying the command line arguments and configuration file.

The optional configuration file (vibe.conf) is a JSON file, containing an object with the keys corresponding to option names, and values corresponding to their values. It is searched for in the local directory, user's home directory, or /etc/vibe/ (POSIX only), whichever is found first.

Functions

Name Description
finalizeCommandLineOptions Checks for unrecognized command line options and display a help screen.
getOption Finds and reads an option from the configuration file or command line.
printCommandLineHelp Prints a help screen consisting of all options encountered in getOption calls.
processCommandLineArgs Deprecated. Removes any recognized arguments from args leaving any unrecognized options.

Authors

Sönke Ludwig, Vladimir Panteleev

Copyright

© 2012 RejectedSoftware e.K.

License

Subject to the terms of the MIT license, as written in the included LICENSE.txt file.