Initial revision

darcs-hash:20050920132639-ac50b-fa3b476891e1f5f67207cf4cc7bf623834cc5edc.gz

builtin_help.h

@@ -0,0 +1,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();
+