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://sisudoc.org/sisu/sisu_manual/>

The manual can be generated from source, found respectively, either within the SiSU tarball or installed locally at:

./data/doc/sisu/sisu_markup_samples/sisu_manual/

/usr/share/doc/sisu/sisu_markup_samples/sisu_manual/

move to the respective directory and type e.g.:

sisu sisu_manual.ssm

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/

An online version of the sisu man page is available here:

1.3 SiSU built-in interactive help

This is particularly useful for getting the current sisu setup/environment information:

sisu --help

sisu --help [subject]

sisu --help commands

sisu --help markup

sisu --help env [for feedback on the way your system is setup with regard to sisu]

sisu -V [environment information, same as above command]

sisu (on its own provides version and some help information)

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/sisu_help_sources/index.html>

Document Information (metadata)

<http://www.sisudoc.org/sisu/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)= d787510a545fae2e2e655d51616ecbe8

Skin_Digest: MD5(skin_sisu_manual.rb)= 072b2584bedea82ea8a416587b9fa244

Generated

Document (metaverse) last generated: Mon Dec 08 15:49:01 -0500 2008

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]