help.c File Reference

Include dependency graph for help.c:

Defines
#define	ShowConsole()   (void)0
#define	PauseConsole()   (void)0
#define	COL(x)   "\033[" #x ";1m"
#define	RED   COL(31)
#define	GREEN   COL(32)
#define	YELLOW   COL(33)
#define	BLUE   COL(34)
#define	MAGENTA   COL(35)
#define	CYAN   COL(36)
#define	WHITE   COL(0)
#define	GRAY   "\033[0m"
#define	FORMAT_STRING   " %s --%s%s%s%s%s%s%s "
#define	COLOR_FORMAT_STRING   (WHITE" %s --%s"YELLOW"%s%s%s%s%s%s "GRAY)
#define	COLOR_FORMAT_STRING_BOOL   (WHITE" %s --%s%s%s%s%s%s%s "GRAY)
#define	LINE_START   8
#define	PADDING_SPACES   25
#define	OPTION_VALUE_SEP   " "
Functions
static void	Help (vlc_object_t *, const char *)
static void	Usage (vlc_object_t *, const char *)
static void	Version (void)
static void	ListModules (vlc_object_t *, bool)
static int	ConsoleWidth (void)
bool	config_PrintHelp (vlc_object_t *obj)
	Checks for help command line options such as --help or --version.
static void	print_help_on_full_help (void)
static void	print_help_section (const module_t *m, const module_config_t *p_item, bool b_color, bool b_description)
Variables
static const char	vlc_usage []

---

Define Documentation

#define BLUE   COL(34)

Referenced by Usage().

#define COL

(

x

)

"\033[" #x ";1m"

#define COLOR_FORMAT_STRING   (WHITE" %s --%s"YELLOW"%s%s%s%s%s%s "GRAY)

Referenced by Usage().

#define COLOR_FORMAT_STRING_BOOL   (WHITE" %s --%s%s%s%s%s%s%s "GRAY)

Referenced by Usage().

#define CYAN   COL(36)

Referenced by ListModules(), and Usage().

#define FORMAT_STRING   " %s --%s%s%s%s%s%s%s "

Referenced by Usage().

#define GRAY   "\033[0m"

Referenced by ListModules(), print_help_section(), and Usage().

#define GREEN   COL(32)

Referenced by ListModules(), and Usage().

#define LINE_START   8

Referenced by Usage().

#define MAGENTA   COL(35)

Referenced by ListModules(), and print_help_section().

#define OPTION_VALUE_SEP   " "

Referenced by Usage().

#define PADDING_SPACES   25

Referenced by Usage().

#define PauseConsole

(

)

(void)0

Referenced by Help(), ListModules(), and Version().

#define RED   COL(31)

Referenced by print_help_section().

#define ShowConsole

(

)

(void)0

Referenced by Help(), ListModules(), and Version().

#define WHITE   COL(0)

Referenced by ListModules(), and Usage().

#define YELLOW   COL(33)

---

Function Documentation

bool config_PrintHelp

(

vlc_object_t *

obj

)

Checks for help command line options such as --help or --version.

If one is found, print the corresponding text.

Returns:

true if a command line options caused some help message to be printed, false otherwise.

References Help(), ListModules(), var_Create, var_InheritBool, var_InheritString, var_SetBool, Version(), and VLC_VAR_BOOL.

Referenced by libvlc_InternalInit().

static int ConsoleWidth

(

void

)

[static]

Referenced by Usage().

static void Help	(	vlc_object_t *	p_this,
		const char *	psz_help_name
	)			[static]

References PauseConsole, print_help_on_full_help(), ShowConsole, Usage(), utf8_fprintf(), and vlc_usage.

Referenced by config_PrintHelp().

static void ListModules	(	vlc_object_t *	p_this,
		bool	b_verbose
	)			[static]

References CYAN, GRAY, GREEN, module_t::i_score, module_t::i_shortcuts, list, MAGENTA, module_get_object(), module_gettext(), module_list_free(), module_list_get(), PauseConsole, module_t::pp_shortcuts, module_t::psz_capability, module_t::psz_longname, ShowConsole, utf8_fprintf(), var_InheritBool, and WHITE.

Referenced by config_PrintHelp().

static void print_help_on_full_help

(

void

)

[inline, static]

References _, and utf8_fprintf().

Referenced by Help().

static void print_help_section	(	const module_t *	m,
		const module_config_t *	p_item,
		bool	b_color,
		bool	b_description
	)			[static]

References GRAY, MAGENTA, module_gettext(), module_config_t::psz_longtext, module_config_t::psz_text, RED, and utf8_fprintf().

Referenced by Usage().

static void Usage	(	vlc_object_t *	p_this,
		const char *	psz_search
	)			[static]

References _, module_config_t::b_advanced, module_config_t::b_removed, BLUE, COLOR_FORMAT_STRING, COLOR_FORMAT_STRING_BOOL, CONFIG_CLASS, CONFIG_HINT_CATEGORY, CONFIG_HINT_SUBCATEGORY, CONFIG_HINT_USAGE, CONFIG_ITEM, CONFIG_ITEM_BOOL, CONFIG_ITEM_FLOAT, CONFIG_ITEM_INTEGER, CONFIG_ITEM_STRING, CONFIG_SECTION, module_t::confsize, ConsoleWidth(), CYAN, description, module_value_t::f, FORMAT_STRING, GRAY, GREEN, module_value_t::i, module_t::i_config_items, module_config_t::i_list, module_config_t::i_short, module_t::i_shortcuts, module_config_t::i_type, LINE_START, list, module_config_t::max, module_config_t::min, module_get_object(), module_gettext(), module_list_free(), module_list_get(), OPTION_VALUE_SEP, module_t::p_config, PADDING_SPACES, module_config_t::pi_list, module_t::pp_shortcuts, module_config_t::ppsz_list, module_config_t::ppsz_list_text, print_help_section(), module_t::psz_help, module_t::psz_longname, module_config_t::psz_longtext, module_config_t::psz_name, module_config_t::psz_text, utf8_fprintf(), module_config_t::value, var_InheritBool, vlc_ngettext(), and WHITE.

Referenced by Help().

static void Version

(

void

)

[static]

References _, LICENSE_MSG, PauseConsole, psz_vlc_changeset, ShowConsole, utf8_fprintf(), VLC_CompileBy(), VLC_CompileHost(), and VLC_Compiler().

Referenced by config_PrintHelp().

---

Variable Documentation

const char vlc_usage[] [static]

Referenced by Help().