SharedMeatAxe
1.0
|
Application information structure. More...
#include <meataxe.h>
Data Fields | |
const char * | Name |
Program name. More... | |
const char * | Description |
One-line description of the program. More... | |
const char * | Help |
Help text. More... | |
Application information structure.
This data structure is used to store information about the application. It is used by the command line parser, e.g., to display the help text.
Name is the program name,
Description is a one-line description of the program.
Help is a help text that is to be displayed when the user invokes the program with '–help'. Here is an example:
MtxApplicationInfo_t AppInfo = { "sample", "MeatAxe sample", "\nSYNTAX\n" " sample [-a] [-l <level>] <input> <ouput>\n" "\nOPTIONS\n" " -a, --all ........ Output all data\n" " -l, --level ...... Set output level (default: 42)\n" };
const char* MtxApplicationInfo_t::Description |
One-line description of the program.
const char* MtxApplicationInfo_t::Help |
Help text.
const char* MtxApplicationInfo_t::Name |
Program name.