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

<!--#set var="isip_page_title" value="isip_ci" -->
<!--#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/rcs/isip_ci.sh">isip_ci</a>,
<a href="/perl/ifc_document.pl?file=$isip/util/misc/rcs/isip_co.sh">isip_co</a>

</b>

<br><br>

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

<blockquote>
<pre>
isip_ci [options] files
isip_co [options] files
</pre>
</blockquote>

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

<blockquote>
<pre>
isip_ci */*.cc;
isip_co */*.cc;
</pre>
</blockquote>

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

<ul>
  These utilities provide simple wrappers to make the
  Revision Control System (RCS) extremely easy to use.
  New or existing files can be checked in or checked out
  using the commands shown above. All relevant options are
  set within these scripts.
  
  <br><br>
  
  In the early days, we used RCS religiously for all software and
  documentation. RCS was subsequently replaced by the Concurrent Versions
  System (CVS), which uses a much more complicated interface. (As an aside,
  we tried providing wrappers for CVS by realized quickly this was a mistake.)
  RCS is still used to maintain our web site, and individual configuration
  files within a user's account. It is a nice tool for managing data
  that does not need concurrent access by many users.
  
  <br><br>
  
  All standard RCS options are passed to RCS by this wrapper. The wrappers
  implement file locking, set file protections, and make sure a viewable
  version of the file is always available. Once we started using
  CVS, we had to also add code to prevent RCS from overwriting CVS-controlled
  directories.
</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>
  <li> This example shows how to check in a file:

<pre>
isip_ci foo.dat</pre>

       If this is the first time the file is being checked in, the user
       will be prompted for an initial message describing the file.
       Otherwise, the user will be prompted for a description of the
       changes being checked in. Once the check in is completed, a read-only
       version of the file is made available to users.

       <br><br>

  <li> This example shows how to check out a file:

<pre>
isip_co foo.dat</pre>

       This will create a version of the file that is writeable only by
       the user checking the file out.
</ul>

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

<ul>
  Detailed manuals for RCS are available in the RCS software distribution.
</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" -->
