<?xml version="1.0" encoding="UTF-8" standalone="no"?>
<?xml-stylesheet type="text/css" href="../_sisu/css/xhtml.css"?>
<!-- Document processing information:
* Generated by: SiSU 0.59.1 of 2007w39/2 (2007-09-25)
* Ruby version: ruby 1.8.6 (2007-06-07 patchlevel 36) [i486-linux]
*
* Last Generated on: Tue Sep 25 02:52:57 +0100 2007
* SiSU http://www.jus.uio.no/sisu
-->
<document>
<head>
<meta http-equiv="Content-Type" content="text/html;charset=utf-8" />
<meta>Title:</meta>
<title class="dc">
SiSU - Help
</title>
<br />
<meta>Creator:</meta>
<creator class="dc">
Ralph Amissah
</creator>
<br />
<meta>Rights:</meta>
<rights class="dc">
Copyright (C) Ralph Amissah 2007, part of SiSU documentation, License GPL 3
</rights>
<br />
<meta>Type:</meta>
<type class="dc">
information
</type>
<br />
<meta>Subject:</meta>
<subject class="dc">
ebook, epublishing, electronic book, electronic publishing, electronic document, electronic citation, data structure, citation systems, search
</subject>
<br />
<meta>Date created:</meta>
<date_created class="extra">
2002-08-28
</date_created>
<br />
<meta>Date issued:</meta>
<date_issued class="extra">
2002-08-28
</date_issued>
<br />
<meta>Date available:</meta>
<date_available class="extra">
2002-08-28
</date_available>
<br />
<meta>Date modified:</meta>
<date_modified class="extra">
2007-08-30
</date_modified>
<br />
<meta>Date:</meta>
<date class="dc">
2007-08-30
</date>
<br />
</head>
<body>
<object id="1">
<text class="h1">
SiSU - Help,<br /> Ralph Amissah
</text>
<ocn>1</ocn>
</object>
<object id="2">
<text class="h2">
SiSU Help
</text>
<ocn>2</ocn>
</object>
<object id="3">
<text class="h4">
1. Help
</text>
<ocn>3</ocn>
</object>
<object id="4">
<text class="h5">
1.1 SiSU Manual
</text>
<ocn>4</ocn>
</object>
<object id="5">
<text class="norm">
The most up to date information on sisu should be contained in the
sisu_manual, available at:
</text>
<ocn>5</ocn>
</object>
<object id="6">
<text class="indent1">
<<link xmlns:xlink="http://www.w3.org/1999/xlink"
xlink:type="simple"
xlink:href="http://www.jus.uio.no/sisu/sisu_manual/">http://www.jus.uio.no/sisu/sisu_manual/</link>>
</text>
<ocn>6</ocn>
</object>
<object id="7">
<text class="norm">
and (from <b>SiSU</b> 0.59 onwards) installed locally at:
</text>
<ocn>7</ocn>
</object>
<object id="8">
<text class="indent1">
/usr/share/doc/sisu/sisu_manual/
</text>
<ocn>8</ocn>
</object>
<object id="9">
<text class="norm">
or equivalent directory
</text>
<ocn>9</ocn>
</object>
<object id="10">
<text class="norm">
Within the <b>SiSU</b> tarball at:
</text>
<ocn>10</ocn>
</object>
<object id="11">
<text class="indent1">
./data/doc/sisu/sisu_manual/
</text>
<ocn>11</ocn>
</object>
<object id="12">
<text class="h5">
1.2 SiSU man pages
</text>
<ocn>12</ocn>
</object>
<object id="13">
<text class="norm">
If <b>SiSU</b> is installed on your system usual man commands should be
available, try:
</text>
<ocn>13</ocn>
</object>
<object id="14">
<text class="indent1">
man sisu
</text>
<ocn>14</ocn>
</object>
<object id="15">
<text class="indent1">
man sisu_markup
</text>
<ocn>15</ocn>
</object>
<object id="16">
<text class="indent1">
man sisu_commands
</text>
<ocn>16</ocn>
</object>
<object id="17">
<text class="norm">
Most <b>SiSU</b> man pages are generated directly from sisu documents
that are used to prepare the sisu manual, the sources files for which
are located within the <b>SiSU</b> tarball at:
</text>
<ocn>17</ocn>
</object>
<object id="18">
<text class="indent1">
./data/doc/sisu/sisu_manual/
</text>
<ocn>18</ocn>
</object>
<object id="19">
<text class="norm">
Once installed, directory equivalent to:
</text>
<ocn>19</ocn>
</object>
<object id="20">
<text class="indent1">
/usr/share/doc/sisu/sisu_manual/
</text>
<ocn>20</ocn>
</object>
<object id="21">
<text class="norm">
Available man pages are converted back to html using man2html:
</text>
<ocn>21</ocn>
</object>
<object id="22">
<text class="indent1">
/usr/share/doc/sisu/html/
</text>
<ocn>22</ocn>
</object>
<object id="23">
<text class="indent1">
./data/doc/sisu/html/
</text>
<ocn>23</ocn>
</object>
<object id="24">
<text class="norm">
The <b>SiSU</b> man pages can be viewed online at:<en>1</en>
</text>
<endnote notenumber="1">
1. generated from source using rman<br /> <<link
xmlns:xlink="http://www.w3.org/1999/xlink" xlink:type="simple"
xlink:href="http://polyglotman.sourceforge.net/rman.html">http://polyglotman.sourceforge.net/rman.html</link>>
<br /> With regard to <b>SiSU</b> man pages the formatting generated
for markup syntax is not quite right, for that you might prefer the
links under:<br /> <<link xmlns:xlink="http://www.w3.org/1999/xlink"
xlink:type="simple"
xlink:href="http://www.jus.uio.no/sample">http://www.jus.uio.no/sample</link>>
</endnote>
<ocn>24</ocn>
</object>
<object id="25">
<text class="norm">
An online version of the sisu man page is available here:
</text>
<ocn>25</ocn>
</object>
<object id="26">
<text class="indent_bullet">
<link xmlns:xlink="http://www.w3.org/1999/xlink" xlink:type="simple"
xlink:href="http://www.jus.uio.no/sisu/man/"> various sisu man pages
</link> <en>2</en>
</text>
<endnote notenumber="2">
2. <<link xmlns:xlink="http://www.w3.org/1999/xlink"
xlink:type="simple"
xlink:href="http://www.jus.uio.no/sisu/man/">http://www.jus.uio.no/sisu/man/</link>>
</endnote>
<ocn>26</ocn>
</object>
<object id="27">
<text class="indent_bullet">
<link xmlns:xlink="http://www.w3.org/1999/xlink" xlink:type="simple"
xlink:href="http://www.jus.uio.no/sisu/man/sisu.1.html"> sisu.1 </link>
<en>3</en>
</text>
<endnote notenumber="3">
3. <<link xmlns:xlink="http://www.w3.org/1999/xlink"
xlink:type="simple"
xlink:href="http://www.jus.uio.no/sisu/man/sisu.1.html">http://www.jus.uio.no/sisu/man/sisu.1.html</link>>
</endnote>
<ocn>27</ocn>
</object>
<object id="28">
<text class="indent_bullet">
<link xmlns:xlink="http://www.w3.org/1999/xlink" xlink:type="simple"
xlink:href="http://www.jus.uio.no/sisu/man/sisu.8.html"> sisu.8 </link>
<en>4</en>
</text>
<endnote notenumber="4">
4. <<link xmlns:xlink="http://www.w3.org/1999/xlink"
xlink:type="simple"
xlink:href="http://www.jus.uio.no/sisu/man/sisu.8.html">http://www.jus.uio.no/sisu/man/sisu.8.html</link>>
</endnote>
<ocn>28</ocn>
</object>
<object id="29">
<text class="indent_bullet">
<link xmlns:xlink="http://www.w3.org/1999/xlink" xlink:type="simple"
xlink:href="http://www.jus.uio.no/sisu/man/sisu_examples.1.html">
sisu_examples.1 </link> <en>5</en>
</text>
<endnote notenumber="5">
5. <<link xmlns:xlink="http://www.w3.org/1999/xlink"
xlink:type="simple"
xlink:href="http://www.jus.uio.no/sisu/man/sisu_examples.1.html">http://www.jus.uio.no/sisu/man/sisu_examples.1.html</link>>
</endnote>
<ocn>29</ocn>
</object>
<object id="30">
<text class="indent_bullet">
<link xmlns:xlink="http://www.w3.org/1999/xlink" xlink:type="simple"
xlink:href="http://www.jus.uio.no/sisu/man/sisu_webrick.1.html">
sisu_webrick.1 </link> <en>6</en>
</text>
<endnote notenumber="6">
6. <<link xmlns:xlink="http://www.w3.org/1999/xlink"
xlink:type="simple"
xlink:href="http://www.jus.uio.no/sisu/man/sisu_webrick.1.html">http://www.jus.uio.no/sisu/man/sisu_webrick.1.html</link>>
</endnote>
<ocn>30</ocn>
</object>
<object id="31">
<text class="h5">
1.3 SiSU built-in interactive help
</text>
<ocn>31</ocn>
</object>
<object id="32">
<text class="norm">
This is particularly useful when current installation information is
obtained as the interactive help is able to provide information on your
sisu configuration and setup.
</text>
<ocn>32</ocn>
</object>
<object id="33">
<text class="indent1">
sisu --help
</text>
<ocn>33</ocn>
</object>
<object id="34">
<text class="indent1">
sisu --help [subject]
</text>
<ocn>34</ocn>
</object>
<object id="35">
<text class="indent2">
sisu --help env [for feedback on the way your system is setup
with regard to sisu]
</text>
<ocn>35</ocn>
</object>
<object id="36">
<text class="indent2">
sisu -V [same as above command]
</text>
<ocn>36</ocn>
</object>
<object id="37">
<text class="indent2">
sisu --help commands
</text>
<ocn>37</ocn>
</object>
<object id="38">
<text class="indent2">
sisu --help markup
</text>
<ocn>38</ocn>
</object>
<object id="39">
<text class="norm">
Apart from real-time information on your current configuration the
<b>SiSU</b> manual and man pages are likely to contain more up-to-date
information than the sisu interactive help (for example on commands and
markup).
</text>
<ocn>39</ocn>
</object>
<object id="40">
<text class="norm">
NOTE: Running the command sisu (alone without any flags, filenames or
wildcards) brings up the interactive help, as does any sisu command
that is not recognised. Enter to escape.
</text>
<ocn>40</ocn>
</object>
<object id="41">
<text class="h5">
1.4 Help Sources
</text>
<ocn>41</ocn>
</object>
<object id="42">
<text class="norm">
For lists of alternative help sources, see:
</text>
<ocn>42</ocn>
</object>
<object id="43">
<text class="norm">
<b>man page</b>
</text>
<ocn>43</ocn>
</object>
<object id="44">
<text class="indent1">
man sisu_help_sources
</text>
<ocn>44</ocn>
</object>
<object id="45">
<text class="norm">
<b>man2html</b>
</text>
<ocn>45</ocn>
</object>
<object id="46">
<text class="indent1">
/usr/share/doc/sisu/sisu_manual/sisu_help_sources/index.html
</text>
<ocn>46</ocn>
</object>
<object id="47">
<text class="norm">
<b>sisu generated html</b>
</text>
<ocn>47</ocn>
</object>
<object id="48">
<text class="indent1">
/usr/share/doc/sisu/html/sisu_help_sources/index.html
</text>
<ocn>48</ocn>
</object>
<object id="49">
<text class="indent1">
<<link xmlns:xlink="http://www.w3.org/1999/xlink"
xlink:type="simple"
xlink:href="http://sisudoc.org/sisu_manual/sisu_help_sources/index.html">http://sisudoc.org/sisu_manual/sisu_help_sources/index.html</link>>
</text>
<ocn>49</ocn>
</object>
<object id="50">
<text class="indent1">
<<link xmlns:xlink="http://www.w3.org/1999/xlink"
xlink:type="simple"
xlink:href="http://www.jus.uio.no/sisu/sisu_manual/sisu_help_sources/index.html">http://www.jus.uio.no/sisu/sisu_manual/sisu_help_sources/index.html</link>>
</text>
<ocn>50</ocn>
</object>
<object id="0">
<text class="h4">
Endnotes
</text>
<ocn>0</ocn>
</object>
</body>
</document>