libfossil
fcli_help_t Struct Reference

Structure for holding app-level –help info. More...

#include "fossil-cli.h"

Data Fields

char const * briefDescription
 Brief description of what the app does. More...
 
char const * briefUsage
 Brief usage text. More...
 
void(* callback )()
 If not 0 then this is called after outputing any flags' help. More...
 
fcli_help_arg_t const * flags
 If not NULL, it must include a sentry entry at the end of the list with a NULL for both flagShort and flagLong pointer values. More...
 

Detailed Description

Structure for holding app-level –help info.

Definition at line 132 of file fossil-cli.h.

Field Documentation

char const* fcli_help_t::briefDescription

Brief description of what the app does.

Definition at line 134 of file fossil-cli.h.

char const* fcli_help_t::briefUsage

Brief usage text.

It will be prefixed by the app's name. e.g. "options file1 ... fileN".

Definition at line 138 of file fossil-cli.h.

void(* fcli_help_t::callback) ()

If not 0 then this is called after outputing any flags' help.

It should output any additional help text using f_out().

Definition at line 149 of file fossil-cli.h.

fcli_help_arg_t const* fcli_help_t::flags

If not NULL, it must include a sentry entry at the end of the list with a NULL for both flagShort and flagLong pointer values.

Definition at line 144 of file fossil-cli.h.


The documentation for this struct was generated from the following file: