File src/cmd_help.c

UBS help function. Prints known commands, and information about other UBS commands. This is only useful from the UBS shell.


Included Files


Preprocessor definitions

#define MAXHELP 32

Global Variable PROCNAME

char PROCNAME[128]
Included from include/ubs.h

Global Variable CUR_TIME

struct tm* CUR_TIME
Included from include/ubs.h

Global Variable GLOBAL

ubs_table GLOBAL
Included from include/ubs.h

Global Variable LOGLEVEL

int LOGLEVEL
Included from include/ubs.h

Global Function cmd_help()

UBS help function

int cmd_help ( int cmdc, char** cmdv )

int cmd_help
Returns OK on success, FAIL if the help configuration file cannot be opened.
int cmdc
Number of arguments
char** cmdv
Argument vector
Prototyped in: include/ubs-main.h
Calls: read_config()lib/read_config.c
  split_line()lib/parse_line.c
  sub_help_cmd()src/cmd_help.c
  ubs_table_data()lib/table.c
  ubs_table_init()lib/table.c
  calloc(), printf()

Global Function sub_help_cmd()

sub_help_cmd Returns OK on success, FAIL on any type of error

int sub_help_cmd ( char* command )

char* command
The name of the command to give help on
Prototyped in: include/ubs-main.h
Calls: read_config()lib/read_config.c
  split_line()lib/parse_line.c
  ubs_table_data()lib/table.c
  ubs_table_exists()lib/table.c
  ubs_table_init()lib/table.c
  calloc(), printf(), snprintf()
Called by: cmd_events()src/cmd_events.c
  cmd_help()src/cmd_help.c