<?xml version="1.0" encoding="UTF-8" standalone="no"?>
<?xml-stylesheet type="text/css" href="../_sisu/css/sax.css"?>
<!-- Document processing information:
     * Generated by: SiSU 0.70.0 of 2008w48/3 (2008-12-03)
     * Ruby version: ruby 1.8.7 (2008-08-11 patchlevel 72) [i486-linux]
     * 
     * Last Generated on: Mon Dec 08 15:49:02 -0500 2008
     * SiSU http://www.jus.uio.no/sisu
-->

<document>
<head>
	<meta>Title:</meta>
	<title class="dc">
		SiSU - Help
	</title>
	<br />
	<meta>Creator:</meta>
	<creator class="dc">
		Amissah, Ralph
	</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">
	<ocn>1</ocn>
	<text class="h1">
		SiSU - Help,<br />Ralph Amissah
	</text>
</object>
<object id="2">
	<ocn>2</ocn>
	<text class="h2">
		SiSU Help
	</text>
</object>
<object id="3">
	<ocn>3</ocn>
	<text class="h4">
		1. Help
	</text>
</object>
<object id="4">
	<ocn>4</ocn>
	<text class="h5">
		1.1 SiSU Manual
	</text>
</object>
<object id="5">
	<ocn>5</ocn>
	<text class="norm">
		The most up to date information on sisu should be contained in the
sisu_manual, available at:
	</text>
</object>
<object id="6">
	<ocn>6</ocn>
	<text class="indent1">
		&lt;<link xmlns:xlink="http://www.w3.org/1999/xlink"
xlink:type="simple"
xlink:href="http://sisudoc.org/sisu/sisu_manual/">http://sisudoc.org/sisu/sisu_manual/</link>&gt;
	</text>
</object>
<object id="7">
	<ocn>7</ocn>
	<text class="norm">
		The manual can be generated from source, found respectively, either
within the <b>SiSU</b> tarball or installed locally at:
	</text>
</object>
<object id="8">
	<ocn>8</ocn>
	<text class="indent1">
		./data/doc/sisu/sisu_markup_samples/sisu_manual/
	</text>
</object>
<object id="9">
	<ocn>9</ocn>
	<text class="indent1">
		/usr/share/doc/sisu/sisu_markup_samples/sisu_manual/
	</text>
</object>
<object id="10">
	<ocn>10</ocn>
	<text class="norm">
		move to the respective directory and type e.g.:
	</text>
</object>
<object id="11">
	<ocn>11</ocn>
	<text class="indent1">
		sisu sisu_manual.ssm
	</text>
</object>
<object id="12">
	<ocn>12</ocn>
	<text class="h5">
		1.2 SiSU man pages
	</text>
</object>
<object id="13">
	<ocn>13</ocn>
	<text class="norm">
		If <b>SiSU</b> is installed on your system usual man commands should be
available, try:
	</text>
</object>
<object id="14">
	<ocn>14</ocn>
	<text class="indent1">
		man sisu
	</text>
</object>
<object id="15">
	<ocn>15</ocn>
	<text class="indent1">
		man sisu_markup
	</text>
</object>
<object id="16">
	<ocn>16</ocn>
	<text class="indent1">
		man sisu_commands
	</text>
</object>
<object id="17">
	<ocn>17</ocn>
	<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>
</object>
<object id="18">
	<ocn>18</ocn>
	<text class="indent1">
		./data/doc/sisu/sisu_manual/
	</text>
</object>
<object id="19">
	<ocn>19</ocn>
	<text class="norm">
		Once installed, directory equivalent to:
	</text>
</object>
<object id="20">
	<ocn>20</ocn>
	<text class="indent1">
		/usr/share/doc/sisu/sisu_manual/
	</text>
</object>
<object id="21">
	<ocn>21</ocn>
	<text class="norm">
		Available man pages are converted back to html using man2html:
	</text>
</object>
<object id="22">
	<ocn>22</ocn>
	<text class="indent1">
		/usr/share/doc/sisu/html/
	</text>
</object>
<object id="23">
	<ocn>23</ocn>
	<text class="indent1">
		./data/doc/sisu/html/
	</text>
</object>
<object id="24">
	<ocn>24</ocn>
	<text class="norm">
		An online version of the sisu man page is available here:
	</text>
</object>
<object id="25">
	<ocn>25</ocn>
	<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>1</en>
	</text>
	<endnote notenumber="1">
		<number>1</number>
		<note>
			&lt;<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>&gt;
		</note>
	</endnote>
</object>
<object id="26">
	<ocn>26</ocn>
	<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>2</en>
	</text>
	<endnote notenumber="2">
		<number>2</number>
		<note>
			&lt;<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>&gt;
		</note>
	</endnote>
</object>
<object id="27">
	<ocn>27</ocn>
	<text class="h5">
		1.3 SiSU built-in interactive help
	</text>
</object>
<object id="28">
	<ocn>28</ocn>
	<text class="norm">
		This is particularly useful for getting the current sisu
setup/environment information:
	</text>
</object>
<object id="29">
	<ocn>29</ocn>
	<text class="indent1">
		sisu --help
	</text>
</object>
<object id="30">
	<ocn>30</ocn>
	<text class="indent1">
		sisu --help [subject]
	</text>
</object>
<object id="31">
	<ocn>31</ocn>
	<text class="indent2">
		sisu --help commands
	</text>
</object>
<object id="32">
	<ocn>32</ocn>
	<text class="indent2">
		sisu --help markup
	</text>
</object>
<object id="33">
	<ocn>33</ocn>
	<text class="indent2">
		sisu --help env [for feedback on the way your system is setup
with regard to sisu]
	</text>
</object>
<object id="34">
	<ocn>34</ocn>
	<text class="indent1">
		sisu -V [environment information, same as above command]
	</text>
</object>
<object id="35">
	<ocn>35</ocn>
	<text class="indent1">
		sisu (on its own provides version and some help information)
	</text>
</object>
<object id="36">
	<ocn>36</ocn>
	<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>
</object>
<object id="37">
	<ocn>37</ocn>
	<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>
</object>
<object id="38">
	<ocn>38</ocn>
	<text class="h5">
		1.4 Help Sources
	</text>
</object>
<object id="39">
	<ocn>39</ocn>
	<text class="norm">
		For lists of alternative help sources, see:
	</text>
</object>
<object id="40">
	<ocn>40</ocn>
	<text class="norm">
		<b>man page</b>
	</text>
</object>
<object id="41">
	<ocn>41</ocn>
	<text class="indent1">
		man sisu_help_sources
	</text>
</object>
<object id="42">
	<ocn>42</ocn>
	<text class="norm">
		<b>man2html</b>
	</text>
</object>
<object id="43">
	<ocn>43</ocn>
	<text class="indent1">
		/usr/share/doc/sisu/sisu_manual/sisu_help_sources/index.html
	</text>
</object>
<object id="44">
	<ocn>44</ocn>
	<text class="norm">
		<b>sisu generated html</b>
	</text>
</object>
<object id="45">
	<ocn>45</ocn>
	<text class="indent1">
		/usr/share/doc/sisu/html/sisu_help_sources/index.html
	</text>
</object>
<object id="46">
	<ocn>46</ocn>
	<text class="indent1">
		&lt;<link xmlns:xlink="http://www.w3.org/1999/xlink"
xlink:type="simple"
xlink:href="http://sisudoc.org/sisu/sisu_help_sources/index.html">http://sisudoc.org/sisu/sisu_help_sources/index.html</link>&gt;
	</text>
</object>
</body>
</document>

