builtin_help.h


1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25

/** \file builtin_help.h 

    Prototypes for functions for printing usage information of builtin commands. The
	corresponding .c file is automatically generated by combining the
	builtin_help.hdr file with doxygen output.
*/
/**
   Return the help text for the specified builtin command. Use
   non-wide characters since wide characters have some issues with
   string formating escape sequences sometimes.

   \param cmd The command for which to obtain help text
*/
char *builtin_help_get( wchar_t *cmd );

/**
   Initialize builtin help data
*/
void builtin_help_init();

/**
   Destory builtin help data
*/
void builtin_help_destroy();