File: slsh.sgml

package info (click to toggle)
slang2 2.2.4-15
  • links: PTS, VCS
  • area: main
  • in suites: wheezy
  • size: 9,420 kB
  • sloc: ansic: 89,879; sh: 3,061; makefile: 924; pascal: 143
file content (239 lines) | stat: -rw-r--r-- 7,172 bytes parent folder | download | duplicates (8)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
<!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:
-->