<?xml version='1.0'?>

<!-- ====================================================================== -->
<!-- = synopsis.xml                                                       = -->
<!-- = afnix cross interpreter - synopsis                                 = -->
<!-- ====================================================================== -->
<!-- = This  program  is  free  software; you  can redistribute it and/or = -->
<!-- = modify it provided that this copyright notice is kept intact.      = -->
<!-- = This program is distributed in the hope that it will be useful but = -->
<!-- = without  any  warranty;  without  even  the  implied  warranty  of = -->
<!-- = merchantability or fitness for  a  particular purpose. In no event = -->
<!-- = shall  the  copyright  holder be liable for any  direct, indirect, = -->
<!-- = incidental  or special  damages arising  in any way out of the use = -->
<!-- = of this software.                                                  = -->
<!-- ====================================================================== -->
<!-- = copyright (c) 2005-2007 - amaury darsch                            = -->
<!-- ====================================================================== -->

<synopsis>
  <!-- client description -->
  <client>
    <name>axi</name>
    <p>
    The <afnix/> interpreter
    </p>

    <!-- options -->
    <opts>
      <name>-h</name>
      <p>
      prints the help message
      </p>
    </opts>

    <opts>
      <name>-v</name>
      <p>
      prints the program version
      </p>
    </opts>

    <opts>
      <name>-i path|librarian</name>
      <p>
      add a directory or librarian to the resolver path
      </p>
    </opts>

    <opts>
      <name>-f assert</name>
      <p>
      enable assertion checking
      </p>
    </opts>

    <opts>
      <name>-f nopath</name>
      <p>
      do no set initial path
      </p>
    </opts>
  </client>

  <!-- description -->
  <remark>
    <title>Description</title>
    
    <p>
    <product>axi</product> invokes the afnix command line
    interpreter. Without arguments, the interpreter is invoked
    interactively. With one or several arguments, the first argument
    is taken as the file to execute. The rest of the command line is
    the arguments for the file being executed. With the help of the
    file resolver, a file does not have to have the <extn>.als</extn>
    or <extn>.axc</extn> extensions.
    </p>
  </remark>

  <!-- version -->
  <remark>
    <title>Version</title>
    
    <p>
    The current version is the <major/>.<minor/>.<patch/> release.
    </p>
  </remark>

  <!-- see also -->
  <remark>
    <title>See also</title>

    <p>
    <link url="axc.htm">axc</link>,
    <link url="axd.htm">axd</link>,
    <link url="axl.htm">axl</link>,
    <link url="axs.htm">axs</link>
    </p>
  </remark>

  <!-- notes -->
  <remark>
    <title>Notes</title>

    <p>
    <afnix/> comes with an extensive documentation. The documentation
    is available <link url="http://www.afnix.org">online</link>
    or in the <path>doc</path> directory in
    the form of formated xhtml documents.
    </p>
  </remark>

  <!-- author -->
  <remark>
    <title>Author</title>
    
    <p>
    The <afnix/> programming language has been devised and implemented by
    <mail address="amaury@ethernix.org">Amaury Darsch</mail>.
    </p>
  </remark>

  <!-- history -->
  <remark>
    <title>History</title>
    
    <p>
    The <afnix/> programming language was originally called the
    <em>Aleph programming language</em> which has been discontinued on
    January 2005 when the 1.0.0 version was released.
    </p>
  </remark>
</synopsis>
