Title:
SiSU - Help
Creator:
Amissah, Ralph
Rights:
Copyright (C) Ralph Amissah 2007, part of SiSU documentation, License GPL 3
Type:
information
Subject:
ebook, epublishing, electronic book, electronic publishing, electronic document, electronic citation, data structure, citation systems, search
Date created:
Date issued:
Date available:
Date modified:
Date:
2007-08-30
SiSU - Help, Ralph Amissah
1
SiSU Help
2
1. Help
3
1.1 SiSU Manual
4
The most up to date information on sisu should be contained in the
sisu_manual, available at:
5
< http://sisudoc.org/sisu/sisu_manual/>
6
The manual can be generated from source, found respectively, either
within the SiSU tarball or installed locally at:
7
./data/doc/sisu/sisu_markup_samples/sisu_manual/
8
/usr/share/doc/sisu/sisu_markup_samples/sisu_manual/
9
move to the respective directory and type e.g.:
10
sisu sisu_manual.ssm
11
1.2 SiSU man pages
12
If SiSU is installed on your system usual man commands should be
available, try:
13
man sisu
14
man sisu_markup
15
man sisu_commands
16
Most SiSU 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 SiSU tarball at:
17
./data/doc/sisu/sisu_manual/
18
Once installed, directory equivalent to:
19
/usr/share/doc/sisu/sisu_manual/
20
Available man pages are converted back to html using man2html:
21
/usr/share/doc/sisu/html/
22
./data/doc/sisu/html/
23
An online version of the sisu man page is available here:
24
various sisu man
pages 1
1. < http://www.jus.uio.no/sisu/man/>
25
sisu.1
2
2. < http://www.jus.uio.no/sisu/man/sisu.1.html>
26
1.3 SiSU built-in interactive help
27
This is particularly useful for getting the current sisu
setup/environment information:
28
sisu --help
29
sisu --help [subject]
30
sisu --help commands
31
sisu --help markup
32
sisu --help env [for feedback on the way your system is setup
with regard to sisu]
33
sisu -V [environment information, same as above command]
34
sisu (on its own provides version and some help information)
35
Apart from real-time information on your current configuration the
SiSU manual and man pages are likely to contain more up-to-date
information than the sisu interactive help (for example on commands and
markup).
36
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.
37
1.4 Help Sources
38
For lists of alternative help sources, see:
39
man page
40
man sisu_help_sources
41
man2html
42
/usr/share/doc/sisu/sisu_manual/sisu_help_sources/index.html
43
sisu generated html
44
/usr/share/doc/sisu/html/sisu_help_sources/index.html
45
< http://sisudoc.org/sisu/sisu_help_sources/index.html>
46
Endnotes
0