libfossil
fcli_help_info Struct Reference

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

#include "cli.h"

Collaboration diagram for fcli_help_info:

Data Fields

char const * briefDescription
 Brief description of what the app does.
char const * briefUsage
 Brief usage text.
void(* callback )(void)
 If not 0 then this is called after outputing any flags' help.

Detailed Description

Structure for holding app-level –help info.

Definition at line 341 of file cli.h.

Field Documentation

◆ briefDescription

char const* fcli_help_info::briefDescription

Brief description of what the app does.

Definition at line 343 of file cli.h.

◆ briefUsage

char const* fcli_help_info::briefUsage

Brief usage text.

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

Definition at line 347 of file cli.h.

◆ callback

void(* fcli_help_info::callback) (void)

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 352 of file cli.h.


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