Files
modules/xref/cmdWhatis.c.html
2002-08-02 21:58:42 +00:00

354 lines
12 KiB
HTML

<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 3.2//EN">
<!-- This HTML file generated by cxref. -->
<!-- cxref program (c) Andrew M. Bishop 1995,96,97,98,99. -->
<!--
Cxref: cxref -block-comments -verbatim-comments -xref-all -index-all -html -Oxref cmdWhatis.c
CPP : gcc -E -C -dD -dI
-->
<HTML>
<HEAD>
<TITLE>Cross reference for cmdWhatis.c of cxref.</TITLE>
</HEAD>
<BODY>
<h1><a name="file">File cmdWhatis.c</a></h1>
<pre>
** ** Module Header ******************************************************* **
** **
** Modules Revision 3.0 **
** Providing a flexible user environment **
** **
** File: cmdWhatis.c **
** First Edition: 95/12/31 **
** **
** Authors: Jens Hamisch, jens@Strawberry.COM **
** **
** Description: The Tcl module-verbose routine allows switchin ver- **
** bosity on and off during module file execution **
** **
** Exports: cmdModuleWhatis **
** cmdModuleWhatisInit **
** cmdModuleWhatisShut **
** **
** Notes: **
** **
** ************************************************************************ **
</pre>
<table>
<tr><td>References Variables:
<td><a href="cmdWhatis.c.html#var-Id">Id</a><td><a href="cmdWhatis.c.html#var-Id">cmdWhatis.c</a>
</table>
<hr>
<h2>Included Files</h2>
<ul>
<li><tt><a href="modules_def.h.html#file">#include ";modules_def.h";</a></tt>
<ul>
<li><tt>#include &lt;stdio.h&gt;</tt>
<li><tt>#include &lt;stdarg.h&gt;</tt>
<li><tt>#include &lt;tcl.h&gt;</tt>
<li><tt><a href="config.h.html#file">#include ";config.h";</a></tt>
<li><tt>#include &lt;stdlib.h&gt;</tt>
<li><tt>#include &lt;string.h&gt;</tt>
<li><tt>#include &lt;unistd.h&gt;</tt>
<li><tt>#include &lt;sys/types.h&gt;</tt>
<li><tt>#include &lt;ctype.h&gt;</tt>
<li><tt>#include &lt;sys/stat.h&gt;</tt>
<li><tt>#include &lt;sys/termios.h&gt;</tt>
<li><tt>#include &lt;fcntl.h&gt;</tt>
<li><tt>#include &lt;sys/ioctl.h&gt;</tt>
<li><tt>#include &lt;dirent.h&gt;</tt>
<li><tt>#include &lt;errno.h&gt;</tt>
</ul>
</ul>
<hr>
<h2>Preprocessor definitions</h2>
<tt>#define __VERSION__ "2.96 20000731 (Red Hat Linux 7.1 2.96-98)"</tt><br>
<p>
<tt>#define __USER_LABEL_PREFIX__</tt><br>
<p>
<tt>#define __REGISTER_PREFIX__</tt><br>
<p>
<tt>#define __HAVE_BUILTIN_SETJMP__ 1</tt><br>
<p>
<tt>#define __SIZE_TYPE__</tt><br>
<p>
<tt>#define __PTRDIFF_TYPE__ int</tt><br>
<p>
<tt>#define __WCHAR_TYPE__</tt><br>
<p>
<tt>#define __WINT_TYPE__</tt><br>
<p>
<tt>#define __GNUC__ 2</tt><br>
<p>
<tt>#define __GNUC_MINOR__ 96</tt><br>
<p>
<tt>#define __GNUC_PATCHLEVEL__ 0</tt><br>
<p>
<tt>#define __ELF__ 1</tt><br>
<p>
<tt>#define unix 1</tt><br>
<p>
<tt>#define linux 1</tt><br>
<p>
<tt>#define __ELF__ 1</tt><br>
<p>
<tt>#define __unix__ 1</tt><br>
<p>
<tt>#define __linux__ 1</tt><br>
<p>
<tt>#define __unix 1</tt><br>
<p>
<tt>#define __linux 1</tt><br>
<p>
<tt>#define __NO_INLINE__ 1</tt><br>
<p>
<tt>#define i386 1</tt><br>
<p>
<tt>#define __i386 1</tt><br>
<p>
<tt>#define __i386__ 1</tt><br>
<p>
<tt>#define __tune_i386__ 1</tt><br>
<p>
<tt>#define WHATIS_FRAG 100</tt><br>
<hr>
<h2><a name="var-whatis">Global Variable whatis</a></h2>
<tt>char** whatis</tt><br>
<table>
<tr><td>Visible in:
<td>&nbsp;<td><a href="ModuleCmd_Avail.c.html#file">ModuleCmd_Avail.c</a>
<tr><td>&nbsp;
<td>&nbsp;<td><a href="ModuleCmd_Bootstrap.c.html#file">ModuleCmd_Bootstrap.c</a>
<tr><td>&nbsp;
<td>&nbsp;<td><a href="ModuleCmd_Clear.c.html#file">ModuleCmd_Clear.c</a>
<tr><td>&nbsp;
<td>&nbsp;<td><a href="ModuleCmd_Display.c.html#file">ModuleCmd_Display.c</a>
<tr><td>&nbsp;
<td>&nbsp;<td><a href="ModuleCmd_Help.c.html#file">ModuleCmd_Help.c</a>
<tr><td>&nbsp;
<td>&nbsp;<td><a href="ModuleCmd_Init.c.html#file">ModuleCmd_Init.c</a>
<tr><td>&nbsp;
<td>&nbsp;<td><a href="ModuleCmd_List.c.html#file">ModuleCmd_List.c</a>
<tr><td>&nbsp;
<td>&nbsp;<td><a href="ModuleCmd_Load.c.html#file">ModuleCmd_Load.c</a>
<tr><td>&nbsp;
<td>&nbsp;<td><a href="ModuleCmd_Purge.c.html#file">ModuleCmd_Purge.c</a>
<tr><td>&nbsp;
<td>&nbsp;<td><a href="ModuleCmd_Switch.c.html#file">ModuleCmd_Switch.c</a>
<tr><td>&nbsp;
<td>&nbsp;<td><a href="ModuleCmd_Update.c.html#file">ModuleCmd_Update.c</a>
<tr><td>&nbsp;
<td>&nbsp;<td><a href="ModuleCmd_Use.c.html#file">ModuleCmd_Use.c</a>
<tr><td>&nbsp;
<td>&nbsp;<td><a href="ModuleCmd_Whatis.c.html#file">ModuleCmd_Whatis.c</a>
<tr><td>&nbsp;
<td>&nbsp;<td><a href="cmdAlias.c.html#file">cmdAlias.c</a>
<tr><td>&nbsp;
<td>&nbsp;<td><a href="cmdConflict.c.html#file">cmdConflict.c</a>
<tr><td>&nbsp;
<td>&nbsp;<td><a href="cmdInfo.c.html#file">cmdInfo.c</a>
<tr><td>&nbsp;
<td>&nbsp;<td><a href="cmdIsLoaded.c.html#file">cmdIsLoaded.c</a>
<tr><td>&nbsp;
<td>&nbsp;<td><a href="cmdLog.c.html#file">cmdLog.c</a>
<tr><td>&nbsp;
<td>&nbsp;<td><a href="cmdMisc.c.html#file">cmdMisc.c</a>
<tr><td>&nbsp;
<td>&nbsp;<td><a href="cmdModule.c.html#file">cmdModule.c</a>
<tr><td>&nbsp;
<td>&nbsp;<td><a href="cmdPath.c.html#file">cmdPath.c</a>
<tr><td>&nbsp;
<td>&nbsp;<td><a href="cmdSetenv.c.html#file">cmdSetenv.c</a>
<tr><td>&nbsp;
<td>&nbsp;<td><a href="cmdTrace.c.html#file">cmdTrace.c</a>
<tr><td>&nbsp;
<td>&nbsp;<td><a href="cmdUlvl.c.html#file">cmdUlvl.c</a>
<tr><td>&nbsp;
<td>&nbsp;<td><a href="cmdUname.c.html#file">cmdUname.c</a>
<tr><td>&nbsp;
<td>&nbsp;<td><a href="cmdVerbose.c.html#file">cmdVerbose.c</a>
<tr><td>&nbsp;
<td>&nbsp;<td><a href="cmdVersion.c.html#file">cmdVersion.c</a>
<tr><td>&nbsp;
<td>&nbsp;<td><a href="cmdWhatis.c.html#file">cmdWhatis.c</a>
<tr><td>&nbsp;
<td>&nbsp;<td><a href="cmdXResource.c.html#file">cmdXResource.c</a>
<tr><td>&nbsp;
<td>&nbsp;<td><a href="error.c.html#file">error.c</a>
<tr><td>&nbsp;
<td>&nbsp;<td><a href="getopt.c.html#file">getopt.c</a>
<tr><td>&nbsp;
<td>&nbsp;<td><a href="init.c.html#file">init.c</a>
<tr><td>&nbsp;
<td>&nbsp;<td><a href="locate_module.c.html#file">locate_module.c</a>
<tr><td>&nbsp;
<td>&nbsp;<td><a href="main.c.html#file">main.c</a>
<tr><td>&nbsp;
<td>&nbsp;<td><a href="utility.c.html#file">utility.c</a>
<tr><td>Used in:
<td><a href="ModuleCmd_Whatis.c.html#func-ModuleCmd_Whatis">ModuleCmd_Whatis()</a><td><a href="ModuleCmd_Whatis.c.html#func-ModuleCmd_Whatis">ModuleCmd_Whatis.c</a>
<tr><td>&nbsp;
<td><a href="cmdWhatis.c.html#func-cmdModuleWhatis">cmdModuleWhatis()</a><td><a href="cmdWhatis.c.html#func-cmdModuleWhatis">cmdWhatis.c</a>
<tr><td>&nbsp;
<td><a href="cmdWhatis.c.html#func-cmdModuleWhatisShut">cmdModuleWhatisShut()</a><td><a href="cmdWhatis.c.html#func-cmdModuleWhatisShut">cmdWhatis.c</a>
<tr><td>&nbsp;
<td><a href="ModuleCmd_Whatis.c.html#func-whatis_dir">whatis_dir()</a><td><a href="ModuleCmd_Whatis.c.html#func-whatis_dir">ModuleCmd_Whatis.c</a>
</table>
<hr>
<h2>Local Variables</h2>
<b><a name="var-Id">Id</a></b><br>
<tt>static char Id[]</tt><br>
<table>
<tr><td>Used in:
<td>&nbsp;<td><a href="cmdWhatis.c.html#file">cmdWhatis.c</a>
</table>
<p>
<b><a name="var-UseId">UseId</a></b><br>
<tt>static void* UseId[]</tt><br>
<p>
<b><a name="var-module_name">module_name</a></b><br>
<tt>static char module_name[]</tt><br>
<table>
<tr><td>Used in:
<td><a href="#func-cmdModuleWhatis">cmdModuleWhatis()</a>
</table>
<p>
<b><a name="var-whatis_size">whatis_size</a></b><br>
<tt>static int whatis_size</tt><br>
<table>
<tr><td>Used in:
<td><a href="#func-cmdModuleWhatis">cmdModuleWhatis()</a>
</table>
<p>
<b><a name="var-whatis_ndx">whatis_ndx</a></b><br>
<tt>static int whatis_ndx</tt><br>
<table>
<tr><td>Used in:
<td><a href="#func-cmdModuleWhatis">cmdModuleWhatis()</a>
<tr><td>&nbsp;
<td><a href="#func-cmdModuleWhatisInit">cmdModuleWhatisInit()</a>
<tr><td>&nbsp;
<td><a href="#func-cmdModuleWhatisShut">cmdModuleWhatisShut()</a>
</table>
<hr>
<h2><a name="func-cmdModuleWhatis">Global Function cmdModuleWhatis()</a></h2>
<pre>
** ** Function-Header ***************************************************** **
** **
** Function: cmdModuleWhatis **
** **
** Description: Callback function for 'verbose' **
** **
** First Edition: 95/12/31 **
** **
** Parameters: ClientData client_data **
** Tcl_Interp *interp According Tcl interp.**
** int argc Number of arguments **
** char *argv[] Argument array **
** **
** Result: int TCL_OK Successfull completion **
** TCL_ERROR Any error **
** **
** Attached Globals: sw_verbose The verbose level selector **
** g_flags These are set up accordingly before **
** this function is called in order to **
** control everything **
** **
** ************************************************************************ **
</pre>
<tt>int cmdModuleWhatis ( ClientData client_data, Tcl_Interp* interp, int argc, char* argv[] )</tt><br>
<table>
<tr><td>Prototyped in:
<td colspan=2><a href="modules_def.h.html#file">modules_def.h</a>
<tr><td>Calls:
<td><a href="error.c.html#func-Module_Error">Module_Error()</a><td><a href="error.c.html#func-Module_Error">error.c</a>
<tr><td>&nbsp;
<td colspan=2>fprintf(), malloc(), realloc(), strdup()
<tr><td>Used in:
<td><a href="init.c.html#func-InitializeModuleCommands">InitializeModuleCommands()</a><td><a href="init.c.html#func-InitializeModuleCommands">init.c</a>
<tr><td>References Variables:
<td><a href="main.c.html#var-g_flags">g_flags</a><td><a href="main.c.html#var-g_flags">main.c</a>
<tr><td>&nbsp;
<td><a href="cmdWhatis.c.html#var-module_name">module_name</a><td><a href="cmdWhatis.c.html#var-module_name">cmdWhatis.c</a>
<tr><td>&nbsp;
<td><a href="cmdWhatis.c.html#var-whatis">whatis</a><td><a href="cmdWhatis.c.html#var-whatis">cmdWhatis.c</a>
<tr><td>&nbsp;
<td><a href="cmdWhatis.c.html#var-whatis_ndx">whatis_ndx</a><td><a href="cmdWhatis.c.html#var-whatis_ndx">cmdWhatis.c</a>
<tr><td>&nbsp;
<td><a href="cmdWhatis.c.html#var-whatis_size">whatis_size</a><td><a href="cmdWhatis.c.html#var-whatis_size">cmdWhatis.c</a>
</table>
<hr>
<h2><a name="func-cmdModuleWhatisInit">Global Function cmdModuleWhatisInit()</a></h2>
<pre>
** ** Function-Header ***************************************************** **
** **
** Function: cmdModuleWhatisInit **
** cmdModuleWhatisShut **
** **
** Description: Initialization of internat data structures for the **
** Module whatis command **
** **
** First Edition: 95/12/31 **
** **
** Parameters: - **
** **
** Result: - **
** **
** ************************************************************************ **
</pre>
<tt>void cmdModuleWhatisInit ( void )</tt><br>
<table>
<tr><td>Prototyped in:
<td colspan=2><a href="modules_def.h.html#file">modules_def.h</a>
<tr><td>Called by:
<td><a href="ModuleCmd_Whatis.c.html#func-ModuleCmd_Whatis">ModuleCmd_Whatis()</a><td><a href="ModuleCmd_Whatis.c.html#func-ModuleCmd_Whatis">ModuleCmd_Whatis.c</a>
<tr><td>&nbsp;
<td><a href="ModuleCmd_Whatis.c.html#func-whatis_dir">whatis_dir()</a><td><a href="ModuleCmd_Whatis.c.html#func-whatis_dir">ModuleCmd_Whatis.c</a>
<tr><td>References Variables:
<td><a href="cmdWhatis.c.html#var-whatis_ndx">whatis_ndx</a><td><a href="cmdWhatis.c.html#var-whatis_ndx">cmdWhatis.c</a>
</table>
<hr>
<h2><a name="func-cmdModuleWhatisShut">Global Function cmdModuleWhatisShut()</a></h2>
<tt>void cmdModuleWhatisShut ( void )</tt><br>
<table>
<tr><td>Prototyped in:
<td colspan=2><a href="modules_def.h.html#file">modules_def.h</a>
<tr><td>Called by:
<td><a href="ModuleCmd_Whatis.c.html#func-ModuleCmd_Whatis">ModuleCmd_Whatis()</a><td><a href="ModuleCmd_Whatis.c.html#func-ModuleCmd_Whatis">ModuleCmd_Whatis.c</a>
<tr><td>&nbsp;
<td><a href="ModuleCmd_Whatis.c.html#func-whatis_dir">whatis_dir()</a><td><a href="ModuleCmd_Whatis.c.html#func-whatis_dir">ModuleCmd_Whatis.c</a>
<tr><td>References Variables:
<td><a href="cmdWhatis.c.html#var-whatis">whatis</a><td><a href="cmdWhatis.c.html#var-whatis">cmdWhatis.c</a>
<tr><td>&nbsp;
<td><a href="cmdWhatis.c.html#var-whatis_ndx">whatis_ndx</a><td><a href="cmdWhatis.c.html#var-whatis_ndx">cmdWhatis.c</a>
</table>
</BODY>
</HTML>