HTML Tidy  5.8.0
The HTACG Tidy HTML Project
Provide the -help Service

Detailed Description

Functions

static ctmbstr get_final_name (ctmbstr prog)
 Returns the final name of the tidy executable by eliminating the path name components from the executable name. More...
 
static tmbstr get_option_names (const CmdOptDesc *pos)
 Retrieve the option's name(s) from the structure as a single string, localizing the field values if application. More...
 
static void help (TidyDoc tdoc, ctmbstr prog)
 Handles the -help service. More...
 
static void print_help_options (TidyDoc tdoc)
 Outputs all of the complete help options (text). More...
 

Function Documentation

◆ get_final_name()

static ctmbstr get_final_name ( ctmbstr  prog)
static

Returns the final name of the tidy executable by eliminating the path name components from the executable name.

Parameters
progThe path of the current executable.

◆ get_option_names()

static tmbstr get_option_names ( const CmdOptDesc pos)
static

Retrieve the option's name(s) from the structure as a single string, localizing the field values if application.

For example, this might return -output <file>, -o <file>.

Parameters
posA CmdOptDesc array item for which to get the names.
Returns
Returns the name(s) for the option as a single string.

◆ help()

static void help ( TidyDoc  tdoc,
ctmbstr  prog 
)
static

Handles the -help service.

Parameters
tdocThe tidy document for which help is showing.
progThe path of the current executable.

◆ print_help_options()

static void print_help_options ( TidyDoc  tdoc)
static

Outputs all of the complete help options (text).

Parameters
tdocThe Tidydoc whose options are being printed.