<!doctype refentry PUBLIC "-//OASIS//DTD DocBook V4.1//EN" [

<!-- Process this file with docbook-to-man to generate an nroff manual
     page: `docbook-to-man manpage.sgml > manpage.1'.  You may view
     the manual page with: `docbook-to-man manpage.sgml | nroff -man |
     less'.  A typical entry in a Makefile or Makefile.am is:

manpage.1: manpage.sgml
	docbook-to-man $< > $@


	The docbook-to-man binary is found in the docbook-to-man package.
	Please remember that if you create the nroff version in one of the
	debian/rules file targets (such as build), you will need to include
	docbook-to-man in your Build-Depends control field.

  -->

  <!-- Fill in your name for FIRSTNAME and SURNAME. -->
  <!ENTITY dhfirstname "<firstname>Rafael</firstname>">
  <!ENTITY dhsurname   "<surname>Laboissiere</surname>">
  <!-- Please adjust the date whenever revising the manpage. -->
  <!ENTITY dhdate      "<date>2003-10-20</date>">
  <!-- SECTION should be 1-8, maybe w/ subsection other parameters are
       allowed: see man(7), man(1). -->
  <!ENTITY dhsection   "<manvolnum>1</manvolnum>">
  <!ENTITY dhemail     "&lt;<email>rafael@debian.org</email>&gt;">
  <!ENTITY dhusername  "Rafael Laboissiere">
  <!ENTITY dhucpackage "<refentrytitle>slsh</refentrytitle>">
  <!ENTITY dhpackage   "slsh">

  <!ENTITY debian      "<productname>Debian</productname>">
  <!ENTITY gnu         "<acronym>GNU</acronym>">
  <!ENTITY gpl         "&gnu; <acronym>GPL</acronym>">
]>

<refentry>
  <refentryinfo>
    <address>
      &dhemail;
    </address>
    <author>
      &dhfirstname;
      &dhsurname;
    </author>
    <copyright>
      <year>2003</year>
      <holder>&dhusername;</holder>
    </copyright>
    &dhdate;
  </refentryinfo>
  <refmeta>
    &dhucpackage;

    &dhsection;
  </refmeta>
  <refnamediv>
    <refname>&dhpackage;</refname>

    <refpurpose>interperter for S-Lang scripts</refpurpose>
  </refnamediv>
  <refsynopsisdiv>
    <cmdsynopsis>
      <command>&dhpackage;</command>

      <arg><option>-i <replaceable>init-file</replaceable></option></arg>
      <arg><option>-g</option></arg>
      <arg><option>-n</option></arg>
      <arg><option>-v</option></arg>
      <arg><option>--help</option></arg>
      <arg><option>--version</option></arg>
      <arg>-|<replaceable>file</replaceable>
        <replaceable>args</replaceable></arg>

    </cmdsynopsis>
  </refsynopsisdiv>
  <refsect1>
    <title>DESCRIPTION</title>

    <para>This manual page documents briefly the
    <command>&dhpackage;</command> command.  This manual page was written
    for the &debian; distribution because the original program does not
    have a manual page.
    </para>

    <para><command>&dhpackage;</command> is an interpreter for scripts
      written in the S-Lang language.</para>

  </refsect1>
  <refsect1>
    <title>OPTIONS</title>

    <variablelist>

      <varlistentry>
        <term><option>--help</option></term>
        <listitem>
          <para>Show summary of options</para>
        </listitem>
      </varlistentry>

      <varlistentry>
        <term><option>--version</option></term>
        <listitem>
          <para>Show slsh version information</para>
        </listitem>
      </varlistentry>

      <varlistentry>
        <term><option>-g</option></term>
        <listitem>
          <para>Compile with debugging code, tracebacks, etc</para>
        </listitem>
      </varlistentry>

      <varlistentry>
        <term><option>-n</option></term>
        <listitem>
          <para>Don't load personal init file</para>
        </listitem>
      </varlistentry>

      <varlistentry>
        <term><option>-i <replaceable>init-file</replaceable></option></term>
        <listitem>
          <para>Use this file instead of default</para>
        </listitem>
      </varlistentry>

      <varlistentry>
        <term><option>-v</option></term>
        <listitem>
          <para>Show verbose loading messages</para>
        </listitem>
      </varlistentry>

    </variablelist>
  </refsect1>

  <refsect1>
    <title>ENVIRONMENT VARIABLES</title>

    <para>Upon startup, the program will try to load
    <filename>slsh.rc</filename> as follows:
    </para>

    <para>
      If either <literal>SLSH_CONF_DIR</literal> or
      <literal>SLSH_LIB_DIR</literal> environment variables exist, then
      look in the corresponding directories for
      <filename>slsh.rc</filename>.  Otherwise look in:
      <simplelist>
        <member><literal>$(prefix)/etc</literal> (specified in
        <filename>Makefile</filename>)</member>
        <member><filename>/usr/local/etc/</filename></member>
        <member><filename>/usr/local/etc/slsh/</filename></member>
        <member><filename>/etc/</filename></member>
        <member><filename>/etc/slsh/</filename></member>
      </simplelist>
    </para>

    <para>
      The <filename>slsh.rc</filename> file may load other files from
      slsh's library directory in the manner described below.
    </para>

    <para>
      Once <filename>slsh.rc</filename> is loaded, slsh will load
      <literal>$HOME/.slshrc</literal> if present.  Finally, it will load
      the script specified on the command line.  If the name of the script
      is <quote>-</quote>, then it will be read from stdin.
    </para>

    <para>
      When a script loads a file via the built-in
      <quote><literal>evalfile</literal></quote> function or the
      <quote><literal>require</literal></quote> function (autoloaded by
      <filename>slsh.rc</filename>), the file is searched for along the
      <literal>SLSH_PATH</literal> as specified in the Makefile.  An
      alternate path may be specified by the <literal>SLSH_PATH</literal>
      environment variable.
    </para>

    <para>
      The search path may be queried and set during run time via set the
      <literal>get_lib_path</literal> and <literal>set_lib_path</literal>
      functions, e.g.,
      <programlisting>
        set_lib_path ("/home/bill/lib/slsh:/usr/share/slsh");
      </programlisting>
    </para>

  </refsect1>

  <refsect1>
    <title>SEE ALSO</title>

    <para>Examples of S-Lang scripts can be found in
      <filename>/usr/share/doc/slsh/examples/.</filename></para>

  </refsect1>
  <refsect1>
    <title>AUTHOR</title>

    <para>
      This manual page was written by &dhusername; &dhemail; for the
      &debian; system (but may be used by others).  Permission is granted
      to copy, distribute and/or modify this document under the terms of
      the &gnu; General Public License, Version 2 any later version
      published by the Free Software Foundation.
    </para>

    <para>
      On Debian systems, the complete text of the GNU General Public
      License can be found in
      <filename>/usr/share/common-licenses/GPL</filename>.
    </para>

  </refsect1>
</refentry>

<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
sgml-omittag:t
sgml-shorttag:t
sgml-minimize-attributes:nil
sgml-always-quote-attributes:t
sgml-indent-step:2
sgml-indent-data:t
sgml-parent-document:nil
sgml-default-dtd-file:nil
sgml-exposed-tags:nil
sgml-local-catalogs:nil
sgml-local-ecat-files:nil
End:
-->


