librnr  1.14.5
RoadNarrows Robotics Common Library 1
Public Attributes | List of all members
OptsPgmInfo_T Struct Reference

Program Description Strings Info Structure. More...

#include <opts.h>

Public Attributes

const char * usage_args
 Single line description string of non-option arguments. More...
 
const char * synopsis
 Simple program synopsis string. More...
 
const char * long_desc
 Program full description string. More...
 
const char * diagnostics
 Programs diagnostics subsection string. More...
 

Detailed Description

Program Description Strings Info Structure.

Strings may use the "%P" (program name) formatting directive, plus '\n' and '\t' spacing characters.

Set any string to NULL to ignore.

Note
The member naming convention is not RN Hungarian to accommodate readability of .name=val structure initialization.

Definition at line 226 of file opts.h.

Member Data Documentation

const char* OptsPgmInfo_T::diagnostics

Programs diagnostics subsection string.

Example:
"Exit statis is 0 if THING(s) are bad, 1 if captured."

Definition at line 254 of file opts.h.

Referenced by OptsHelp().

const char* OptsPgmInfo_T::long_desc

Program full description string.

Example:
"By actions of %P the Cat-In-The-Hat does things.\nBad things."

Definition at line 247 of file opts.h.

Referenced by OptsHelp().

const char* OptsPgmInfo_T::synopsis

Simple program synopsis string.

Example:
"Do THING1, maybe THING2 to FILE(s)"

Definition at line 240 of file opts.h.

Referenced by OptsHelp().

const char* OptsPgmInfo_T::usage_args

Single line description string of non-option arguments.

Example:
"THING1 [THING2] [FILE...]"

Definition at line 233 of file opts.h.

Referenced by OptsHelp().

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