% SiSU 0.58

@title: SiSU

@subtitle: Help

@creator: Ralph Amissah

@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: 2002-08-28

@date.issued: 2002-08-28

@date.available: 2002-08-28

@date.modified: 2007-08-30

@date: 2007-08-30

@level: new=C; break=1; num_top=1

@skin: skin_sisu_manual

@bold: /Gnu|Debian|Ruby|SiSU/

@links: { SiSU Manual }http://www.jus.uio.no/sisu/sisu_manual/
{ Book Samples and Markup Examples }http://www.jus.uio.no/sisu/SiSU/2.html
{ SiSU @ Wikipedia }http://en.wikipedia.org/wiki/SiSU
{ SiSU @ Freshmeat }http://freshmeat.net/projects/sisu/
{ SiSU @ Ruby Application Archive }http://raa.ruby-lang.org/project/sisu/
{ SiSU @ Debian }http://packages.qa.debian.org/s/sisu.html
{ SiSU Download }http://www.jus.uio.no/sisu/SiSU/download.html
{ SiSU Changelog }http://www.jus.uio.no/sisu/SiSU/changelog.html
{ SiSU help }http://www.jus.uio.no/sisu/sisu_manual/sisu_help/
{ SiSU help sources }http://www.jus.uio.no/sisu/sisu_manual/sisu_help_sources/

:A~? @title @creator

:B~? SiSU Help

1~help Help

2~ SiSU Manual

The most up to date information on sisu should be contained in the sisu_manual, available at:

_1 http://www.jus.uio.no/sisu/sisu_manual/

and (from SiSU 0.59 onwards) installed locally at:

_1 /usr/share/doc/sisu/sisu_manual/

or equivalent directory

Within the SiSU tarball at:

_1 ./data/doc/sisu/sisu_manual/

% The manual pages provided with SiSU are also available online, and there is an interactive help, which is being superseded by the man page, and possibly some document which contains this component.

2~ SiSU man pages *~man

If SiSU is installed on your system usual man commands should be available, try:

_1 man sisu

_1 man sisu_markup

_1 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:

_1 ./data/doc/sisu/sisu_manual/

Once installed, directory equivalent to:

_1 /usr/share/doc/sisu/sisu_manual/

Available man pages are converted back to html using man2html:

_1 /usr/share/doc/sisu/html/

_1 ./data/doc/sisu/html/

The SiSU man pages can be viewed online at:~{ generated from source using rman<br> http://polyglotman.sourceforge.net/rman.html <br>With regard to SiSU man pages the formatting generated for markup syntax is not quite right, for that you might prefer the links under:<br> http://www.jus.uio.no/sample }~

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

_* {~^ various sisu man pages }http://www.jus.uio.no/sisu/man/

_* {~^ sisu.1 }http://www.jus.uio.no/sisu/man/sisu.1.html

_* {~^ sisu.8 }http://www.jus.uio.no/sisu/man/sisu.8.html

_* {~^ sisu_examples.1 }http://www.jus.uio.no/sisu/man/sisu_examples.1.html

_* {~^ sisu_webrick.1 }http://www.jus.uio.no/sisu/man/sisu_webrick.1.html

2~ 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.

_1 sisu --help

_1 sisu --help [subject]

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

_2 sisu -V [same as above command]

_2 sisu --help commands

_2 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.

2~ Help Sources

For lists of alternative help sources, see:

!_ man page

_1 man sisu_help_sources

!_ man2html

_1 /usr/share/doc/sisu/sisu_manual/sisu_help_sources/index.html

!_ sisu generated html

_1 /usr/share/doc/sisu/html/sisu_help_sources/index.html

_1 http://sisudoc.org/sisu_manual/sisu_help_sources/index.html

_1 http://www.jus.uio.no/sisu/sisu_manual/sisu_help_sources/index.html