File ModuleCmd_Help.c

 ** ** Module Header ******************************************************* **
 ** 									     **
 **   Modules Revision 3.0						     **
 **   Providing a flexible user environment				     **
 ** 									     **
 **   File:		ModuleCmd_Help.c				     **
 **   First Edition:	91/10/23					     **
 ** 									     **
 **   Authors:	John Furlan, jlf@behere.com				     **
 **		Jens Hamisch, jens@Strawberry.COM			     **
 ** 									     **
 **   Description:	Provides some general help by listing the different  **
 **			commands. It will also allow for a modulefile to     **
 **			provide some module-specific help by calling a Tcl   **
 **			procedure.					     **
 ** 									     **
 **   Exports:		ModuleCmd_Help					     **
 ** 									     **
 **   Notes:								     **
 ** 									     **
 ** ************************************************************************ **

Included Files

• #include ";modules_def.h";
  • #include <stdio.h>
  • #include <stdarg.h>
  • #include <tcl.h>
  • #include ";config.h";
  • #include <stdlib.h>
  • #include <string.h>
  • #include <unistd.h>
  • #include <sys/types.h>
  • #include <ctype.h>
  • #include <sys/stat.h>
  • #include <sys/termios.h>
  • #include <fcntl.h>
  • #include <sys/ioctl.h>
  • #include <dirent.h>
  • #include <errno.h>

Preprocessor definitions

#define __USER_LABEL_PREFIX__

#define __REGISTER_PREFIX__

#define __HAVE_BUILTIN_SETJMP__ 1

#define __SIZE_TYPE__

#define __PTRDIFF_TYPE__ int

#define __WCHAR_TYPE__

#define __WINT_TYPE__

#define __GNUC__ 2

#define __GNUC_MINOR__ 96

#define __GNUC_PATCHLEVEL__ 0

#define __ELF__ 1

#define unix 1

#define linux 1

#define __ELF__ 1

#define __unix__ 1

#define __linux__ 1

#define __unix 1

#define __linux 1

#define __NO_INLINE__ 1

#define i386 1

#define __i386 1

#define __i386__ 1

#define __tune_i386__ 1

Local Variables

UseId
static void* UseId[]

module_name
static char module_name[]

Used in:

PerModuleHelp()

Global Function ModuleCmd_Help()

 ** ** Function-Header ***************************************************** **
 ** 									     **
 **   Function:		ModuleCmd_Help					     **
 ** 									     **
 **   Description:	Execution of the module-command 'help'		     **
 **			Called w/o parameters it will print a list of avail- **
 **			able commands. If it is called with a parameter it   **
 **			will print module specific help.		     **
 ** 									     **
 **   First Edition:	91/10/23					     **
 ** 									     **
 **   Parameters:	Tcl_Interp	*interp		Attached Tcl Interp. **
 **			int		 argc		Number of arguments  **
 **			char 		*argv[]		Argument list	     **
 ** 									     **
 **   Result:		int	TCL_ERROR	Failure			     **
 **				TCL_OK		Successfull operation	     **
 ** 									     **
 **   Attached Globals:							     **
 ** 									     **
 ** ************************************************************************ **

Local Function PerModuleHelp()

 ** ** Function-Header ***************************************************** **
 ** 									     **
 **   Function:		PerModuleHelp					     **
 ** 									     **
 **   Description:	Print module specific help			     **
 ** 									     **
 **   First Edition:	91/10/23					     **
 ** 									     **
 **   Parameters:	Tcl_Interp	*interp		Attached Tcl Interp. **
 **			int		 argc		Number of arguments  **
 **			char 		*argv[]		Argument list	     **
 ** 									     **
 **   Result:		int	TCL_ERROR	Failure			     **
 **				TCL_OK		Successfull operation	     **
 ** 									     **
 **   Attached Globals:	g_flags		These are set up accordingly before  **
 **					this function is called in order to  **
 **					control everything		     **
 **			g_current_module	The module which is handled  **
 **						by the current command	     **
 ** 									     **
 ** ************************************************************************ **