fc_cmdhelp.h File Reference

Go to the source code of this file.

Functions
struct cmdhelp *	cmdhelp_new (const char *cmdname)
void	cmdhelp_destroy (struct cmdhelp *pcmdhelp)
void	cmdhelp_add (struct cmdhelp *pcmdhelp, const char *shortarg, const char *longarg, const char *helpstr,...) fc__attribute((__format__(__printf__
void void	cmdhelp_display (struct cmdhelp *pcmdhelp, bool sort, bool gui_options, bool report_bugs)

Function Documentation

cmdhelp_add()

void cmdhelp_add	(	struct cmdhelp *	pcmdhelp,
		const char *	shortarg,
		const char *	longarg,
		const char *	helpstr,
			...
	)

cmdhelp_destroy()

void cmdhelp_destroy

(

struct cmdhelp *

pcmdhelp

)

Destroy a command help struct.

Definition at line 70 of file fc_cmdhelp.c.

Referenced by client_main(), fcmp_parse_cmdline(), main(), main(), re_parse_cmdline(), and rup_parse_cmdline().

cmdhelp_display()

void void cmdhelp_display	(	struct cmdhelp *	pcmdhelp,
		bool	sort,
		bool	gui_options,
		bool	report_bugs
	)

Display the help for the command.

Definition at line 104 of file fc_cmdhelp.c.

Referenced by client_main(), fcmp_parse_cmdline(), main(), main(), re_parse_cmdline(), and rup_parse_cmdline().

cmdhelp_new()

struct cmdhelp * cmdhelp_new

(

const char *

cmdname

)

Create a new command help struct.

Definition at line 57 of file fc_cmdhelp.c.

Referenced by client_main(), fcmp_parse_cmdline(), main(), main(), re_parse_cmdline(), and rup_parse_cmdline().