<?php $isip_window_title = "ISIP Homepage"; ?>
<?php include("/data/isip/www/templates/documentation/header/header.html"); ?>

<!--#set var="isip_page_title" value="isip_xterm" -->
<!--#include virtual="/hse/ies/templates/documentation/body/index_utility.html" -->
<?php include("/data/isip/www/templates/documentation/body/bar.html"); ?>

<a name="name">
<b>
name:
<a href="/perl/ifc_document.pl?file=$isip/util/misc/shell_functions/isip_function_help_0.sh">isip_function_help_0</a>,
<a href="/perl/ifc_document.pl?file=$isip/util/misc/shell_functions/isip_function_window_name_0.sh">isip_window_name_0</a>
</b>

<br><br>

<a name="synopsis">
<b>synopsis:</b>
<br><br>

<blockquote>
See below.
</blockquote>

<a name="quick_start">
<b>quick start:</b>
<br><br>

<blockquote>
<pre>
# execute a generic help function:
#  force the shellscript to exit if a help option is encountered.
set -e;
isip_function_help_0 $*;
set +e;

# append the window name option (must be last)
#
if (test "$DISPLAY") then
    OPTIONS=$OPTIONS" $OPTION_WINDOW_NAME";

    # create a new window name
    #
    WINDOW_NAME=`isip_function_window_name_0 $TOOL_NAME`;

else
    WINDOW_NAME="";
fi</pre>
</blockquote>

<a name="description"> 
<b>description:</b>
<br><br>

<ul>
  This directory contains some useful shellscript code for
  command line parsing, window name generation, etc.
  Several miscellaneous utilities that are written
  in shell use this code. Perl scripts also have similar
  centralized functions.
</ul>

<a name="options">
<b>options:</b>
<br><br>

<ul>
  None.
</ul>       

<a name="operands">
<b>operands:</b>
<br><br>

<ul>
  None.
</ul>

<a name="examples">
<b>examples:</b>
<br><br>

<ul>
  The code shown above in the quick start section demonstrates
  how these functions are typically used. See

  <a href="/perl/ifc_document.pl?file=$isip/util/misc/isip_xterm/isip_xterm.sh">isip_xterm</a>

  for a good example of real code.
</ul>

<a name="manuals">
<b>manuals:</b>
<br><br>

<ul>
  None.
</ul>
       
<a name="languages">
<b>languages:</b>
<br><br>

<ul>
  shell (sh).
</ul>
       
<a name="variables">
<b>environment variables:</b>
<br><br>

<ul>
  None.
</ul>

<a name="files">
<b>files:</b>
<br><br>

<ul>
  None.
</ul>
       
<a name="see_also">
<b>see also:</b>
<br><br>

<ul>
  None.
</ul>

<a name="notes">
<b>notes:</b>
<br><br>

<ul>
  None.
</ul>

<!--#include virtual="/hse/ies/templates/documentation/footer/footer.html" -->
