envmodules/modules
1
0
Fork 0
mirror of https://github.com/envmodules/modules.git synced 2026-06-10 00:56:30 +08:00
Code Issues Actions Packages Projects Releases Wiki Activity
Files
a3a5564d7d5b09642e2beeebeabb57716e9e84fa
modules/xref/ModuleCmd_Help.c.html
rkowen a77d63f1e1 Updated the cxref docs to 3.2.0rc4
2006-01-12 19:30:05 +00:00

232 lines
10 KiB
HTML
Raw Blame History

<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!-- This HTML file generated by cxref (version 1.6a). -->
<!-- cxref program (c) Andrew M. Bishop 1995,96,97,98,99,2000,01,02,03,04,05. -->
<!--
Cxref: cxref -block-comments -verbatim-comments -xref-all -index-all -html-src -Oxref ModuleCmd_Help.c
CPP : cxref-cpp -lang-c -C -dD -dI
-->
<HTML>
<HEAD>
<TITLE>Cross reference for ModuleCmd_Help.c of cxref.</TITLE>
<LINK rel="stylesheet" href="cxref.css" type="text/css">
</HEAD>
<BODY>
<h1><a name="file" href="ModuleCmd_Help.c.src.html">File ModuleCmd_Help.c</a></h1>
<pre>
** ** Module Header ******************************************************* **
** **
** Modules Revision 3.0 **
** Providing a flexible user environment **
** **
** File: ModuleCmd_Help.c **
** First Edition: 1991/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: **
** **
** ************************************************************************ **
</pre>
<table>
<tr>
<td>References Variables:
<td><a href="ModuleCmd_Help.c.html#var-Id">Id</a>
<td><a href="ModuleCmd_Help.c.html#var-Id">ModuleCmd_Help.c</a>
</tr>
</table>
<hr>
<h2>Included Files</h2>
<ul class="cxref-include">
<li class="cxref-include-local"><tt><span class="cxref-include-local"><a href="modules_def.h.html#file">#include "modules_def.h"</a></span></tt>
<ul class="cxref-include">
<li class="cxref-include-system"><tt><span class="cxref-include-system">#include &lt;stdio.h&gt;</span></tt>
<li class="cxref-include-system"><tt><span class="cxref-include-system">#include &lt;stdarg.h&gt;</span></tt>
<li class="cxref-include-system"><tt><span class="cxref-include-system">#include &lt;tcl.h&gt;</span></tt>
<li class="cxref-include-local"><tt><span class="cxref-include-local"><a href="config.h.html#file">#include "config.h"</a></span></tt>
<li class="cxref-include-system"><tt><span class="cxref-include-system">#include &lt;stdlib.h&gt;</span></tt>
<li class="cxref-include-system"><tt><span class="cxref-include-system">#include &lt;string.h&gt;</span></tt>
<li class="cxref-include-system"><tt><span class="cxref-include-system">#include &lt;unistd.h&gt;</span></tt>
<li class="cxref-include-system"><tt><span class="cxref-include-system">#include &lt;sys/types.h&gt;</span></tt>
<li class="cxref-include-system"><tt><span class="cxref-include-system">#include &lt;ctype.h&gt;</span></tt>
<li class="cxref-include-system"><tt><span class="cxref-include-system">#include &lt;sys/stat.h&gt;</span></tt>
<li class="cxref-include-system"><tt><span class="cxref-include-system">#include &lt;sys/termios.h&gt;</span></tt>
<li class="cxref-include-system"><tt><span class="cxref-include-system">#include &lt;fcntl.h&gt;</span></tt>
<li class="cxref-include-system"><tt><span class="cxref-include-system">#include &lt;sys/ioctl.h&gt;</span></tt>
<li class="cxref-include-system"><tt><span class="cxref-include-system">#include &lt;dirent.h&gt;</span></tt>
<li class="cxref-include-system"><tt><span class="cxref-include-system">#include &lt;errno.h&gt;</span></tt>
</ul>
</ul>
<hr>
<h2>Local Variables</h2>
<b><a name="var-Id">Id</a></b><br>
<tt><span class="cxref-variable"><a href="ModuleCmd_Help.c.src.html#line32">static char Id[]</a></span></tt><br>
<table>
<tr>
<td>Used in:
<td>&nbsp; <td><span class="cxref-reference-local"><a href="ModuleCmd_Help.c.html#file">ModuleCmd_Help.c</a></span>
</tr>
</table>
<p>
<b><a name="var-UseId">UseId</a></b><br>
<tt><span class="cxref-variable"><a href="ModuleCmd_Help.c.src.html#line33">static void* UseId[]</a></span></tt><br>
<p>
<b><a name="var-module_name">module_name</a></b><br>
<tt><span class="cxref-variable"><a href="ModuleCmd_Help.c.src.html#line63">static char module_name[]</a></span></tt><br>
<table>
<tr>
<td>Used in:
<td><a href="#func-PerModuleHelp">PerModuleHelp()</a>
<td>&nbsp;
</tr>
</table>
<hr>
<h2><a name="func-ModuleCmd_Help">Global Function ModuleCmd_Help()</a></h2>
<pre>
** ** 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: 1991/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: **
** **
** ************************************************************************ **
</pre>
<tt><span class="cxref-function"><a href="ModuleCmd_Help.c.src.html#line103">int ModuleCmd_Help ( Tcl_Interp* interp, int argc, char* argv[] )</a></span></tt><br>
<table>
<tr>
<td>Prototyped in:
<td colspan=2><span class="cxref-reference-local"><a href="modules_def.h.html#file">modules_def.h</a></span>
</tr>
<tr>
<td>Calls:
<td><span class="cxref-reference-local"><a href="ModuleCmd_Help.c.html#func-PerModuleHelp">PerModuleHelp()</a></span>
<td><span class="cxref-reference-local"><a href="ModuleCmd_Help.c.html#func-PerModuleHelp">ModuleCmd_Help.c</a></span>
</tr>
<tr>
<td>&nbsp;
<td><span class="cxref-reference-local"><a href="main.c.html#func-module_usage">module_usage()</a></span>
<td><span class="cxref-reference-local"><a href="main.c.html#func-module_usage">main.c</a></span>
</tr>
<tr>
<td>Called by:
<td><span class="cxref-reference-local"><a href="cmdModule.c.html#func-cmdModule">cmdModule()</a></span>
<td><span class="cxref-reference-local"><a href="cmdModule.c.html#func-cmdModule">cmdModule.c</a></span>
</tr>
</table>
<hr>
<h2><a name="func-PerModuleHelp">Local Function PerModuleHelp()</a></h2>
<pre>
** ** Function-Header ***************************************************** **
** **
** Function: PerModuleHelp **
** **
** Description: Print module specific help **
** **
** First Edition: 1991/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 **
** **
** ************************************************************************ **
</pre>
<tt><span class="cxref-function"><a href="ModuleCmd_Help.c.src.html#line159">static int PerModuleHelp ( Tcl_Interp* interp, int argc, char* argv[] )</a></span></tt><br>
<table>
<tr>
<td>Prototyped in:
<td colspan=2><span class="cxref-reference-local"><a href="ModuleCmd_Help.c.html#file">ModuleCmd_Help.c</a></span>
</tr>
<tr>
<td>Calls:
<td><span class="cxref-reference-local"><a href="cmdModule.c.html#func-CallModuleProcedure">CallModuleProcedure()</a></span>
<td><span class="cxref-reference-local"><a href="cmdModule.c.html#func-CallModuleProcedure">cmdModule.c</a></span>
</tr>
<tr>
<td>&nbsp;
<td><span class="cxref-reference-local"><a href="init.c.html#func-InitializeModuleCommands">InitializeModuleCommands()</a></span>
<td><span class="cxref-reference-local"><a href="init.c.html#func-InitializeModuleCommands">init.c</a></span>
</tr>
<tr>
<td>&nbsp;
<td><span class="cxref-reference-local"><a href="locate_module.c.html#func-Locate_ModuleFile">Locate_ModuleFile()</a></span>
<td><span class="cxref-reference-local"><a href="locate_module.c.html#func-Locate_ModuleFile">locate_module.c</a></span>
</tr>
<tr>
<td>&nbsp;
<td><span class="cxref-reference-local"><a href="error.c.html#func-Module_Error">Module_Error()</a></span>
<td><span class="cxref-reference-local"><a href="error.c.html#func-Module_Error">error.c</a></span>
</tr>
<tr>
<td>&nbsp;
<td colspan=2><span class="cxref-reference-system">Tcl_CreateInterp(), Tcl_DStringFree(), Tcl_DStringInit(), Tcl_DeleteInterp(), fprintf(), strlen()</span>
</tr>
<tr>
<td>Called by:
<td><span class="cxref-reference-local"><a href="ModuleCmd_Help.c.html#func-ModuleCmd_Help">ModuleCmd_Help()</a></span>
<td><span class="cxref-reference-local"><a href="ModuleCmd_Help.c.html#func-ModuleCmd_Help">ModuleCmd_Help.c</a></span>
</tr>
<tr>
<td>References Variables:
<td><span class="cxref-reference-local"><a href="main.c.html#var-g_current_module">g_current_module</a></span>
<td><span class="cxref-reference-local"><a href="main.c.html#var-g_current_module">main.c</a></span>
</tr>
<tr>
<td>&nbsp;
<td><span class="cxref-reference-local"><a href="main.c.html#var-g_flags">g_flags</a></span>
<td><span class="cxref-reference-local"><a href="main.c.html#var-g_flags">main.c</a></span>
</tr>
<tr>
<td>&nbsp;
<td><span class="cxref-reference-local"><a href="ModuleCmd_Help.c.html#var-module_name">module_name</a></span>
<td><span class="cxref-reference-local"><a href="ModuleCmd_Help.c.html#var-module_name">ModuleCmd_Help.c</a></span>
</tr>
</table>
</BODY>
</HTML>
Reference in New Issue View Git Blame Copy Permalink