SISU - HELP, RALPH AMISSAH
SISU HELP
1. HELP
1.1 SISU MANUAL
The most up to date information on sisu should be contained in the sisu_manual, available at:
<http://www.jus.uio.no/sisu/sisu_manual/
>
and (from SiSU 0.59 onwards) installed locally at:
/usr/share/doc/sisu/sisu_manual/
or equivalent directory
Within the SiSU tarball at:
./data/doc/sisu/sisu_manual/
1.2 SISU MAN PAGES
If SiSU is installed on your system usual man commands should be available, try:
man sisu
man sisu_markup
man sisu_commands
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:
./data/doc/sisu/sisu_manual/
Once installed, directory equivalent to:
/usr/share/doc/sisu/sisu_manual/
Available man pages are converted back to html using man2html:
/usr/share/doc/sisu/html/
./data/doc/sisu/html/
The SiSU man pages can be viewed online at:[^1]
An online version of the sisu man page is available here:
* various sisu man pages <http://www.jus.uio.no/sisu/man/ > [^2]
* sisu.1 <http://www.jus.uio.no/sisu/man/sisu.1.html > [^3]
* sisu.8 <http://www.jus.uio.no/sisu/man/sisu.8.html > [^4]
* sisu_examples.1 <http://www.jus.uio.no/sisu/man/sisu_examples.1.html > [^5]
* sisu_webrick.1 <http://www.jus.uio.no/sisu/man/sisu_webrick.1.html > [^6]
1.3
SISU BUILT-IN INTERACTIVE HELP
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.
sisu --help
sisu --help [subject]
sisu --help env [for feedback on the way your system is
setup with regard to sisu]
sisu -V [same as above command]
sisu --help commands
sisu --help markup
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).
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.
1.4 HELP SOURCES
For lists of alternative help sources, see:
man page
man sisu_help_sources
man2html
/usr/share/doc/sisu/sisu_manual/sisu_help_sources/index.html
sisu generated html
/usr/share/doc/sisu/html/sisu_help_sources/index.html
<http://sisudoc.org/sisu_manual/sisu_help_sources/index.html
>
<http://www.jus.uio.no/sisu/sisu_manual/sisu_help_sources/index.html
>
DOCUMENT INFORMATION (METADATA)
METADATA
Document Manifest @ <http://www.jus.uio.no/sisu/sisu_manual/sisu_help/sisu_manifest.html >
Dublin Core (DC)
DC tags included with this document are provided here.
DC Title: SiSU - Help
DC Creator: Ralph Amissah
DC Rights: Copyright (C) Ralph Amissah 2007, part of SiSU documentation, License GPL 3
DC Type: information
DC Date created: 2002-08-28
DC Date issued: 2002-08-28
DC Date available: 2002-08-28
DC Date modified: 2007-08-30
DC Date: 2007-08-30
Version Information
Sourcefile: sisu_help.sst
Filetype: SiSU text
0.58
Sourcefile Digest, MD5(sisu_help.sst)= 66d04ba5f3dd4ede774ffa5549b3faba
Skin_Digest: MD5(/home/ralph/grotto/theatre/dbld/sisu-dev/sisu/data/doc/sisu/sisu_markup_samples/sisu_manual/_sisu/skin/doc/skin_sisu_manual.rb)=
20fc43cf3eb6590bc3399a1aef65c5a9
Generated
Document (metaverse) last generated: Mon Sep 24 15:36:13 +0100 2007
Generated by: SiSU 0.59.0 of 2007w38/0 (2007-09-23)
Ruby version: ruby 1.8.6 (2007-06-07 patchlevel 36) [i486-linux]