Go backward to Adding user interface commands.
Go up to I/O.
Adding Help screens
===================
Once you've added a new user interface command, be a good sport and add a
help screen for it too. Help screens should be installed at system startup
time via calls to add_help(). To add a help screen, add a line to
system_startup_hook() in file hooks.c like this:
add_help ("my-command-or-topic-name", help_on_my_command);
where help_on_my_command is an array of pointers to strings, with the last
pointer in the array being 0 (NULL). For example, here's a help screen from
Soar:
char *help_on_exit[] = {
"Commands: exit, quit",
"",
"Syntax: (exit) or (quit)",
"",
"These two commands are synonymous; they cause Soar to terminate and return",
"control to the shell.",
0 };