Title: SiSU - 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
1 SiSU - Help,
Ralph Amissah 2 SiSU Help 3 1. Help 4 1.1 SiSU Manual 5 The most up to date information on sisu should be contained in the sisu_manual, available at: 6 <http://www.jus.uio.no/sisu/sisu_manual/> 7 and (from SiSU 0.59 onwards) installed locally at: 8 /usr/share/doc/sisu/sisu_manual/ 9 or equivalent directory 10 Within the SiSU tarball at: 11 ./data/doc/sisu/sisu_manual/ 12 1.2 SiSU man pages 13 If SiSU is installed on your system usual man commands should be available, try: 14 man sisu 15 man sisu_markup 16 man sisu_commands 17 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: 18 ./data/doc/sisu/sisu_manual/ 19 Once installed, directory equivalent to: 20 /usr/share/doc/sisu/sisu_manual/ 21 Available man pages are converted back to html using man2html: 22 /usr/share/doc/sisu/html/ 23 ./data/doc/sisu/html/ 24 The SiSU man pages can be viewed online at:1 1 generated from source using rman
<http://polyglotman.sourceforge.net/rman.html>
With regard to SiSU man pages the formatting generated for markup syntax is not quite right, for that you might prefer the links under:
<http://www.jus.uio.no/sample> 25 An online version of the sisu man page is available here: 26 various sisu man pages 2 2 <http://www.jus.uio.no/sisu/man/> 27 sisu.1 3 3 <http://www.jus.uio.no/sisu/man/sisu.1.html> 28 sisu.8 4 4 <http://www.jus.uio.no/sisu/man/sisu.8.html> 29 sisu_examples.1 5 5 <http://www.jus.uio.no/sisu/man/sisu_examples.1.html> 30 sisu_webrick.1 6 6 <http://www.jus.uio.no/sisu/man/sisu_webrick.1.html> 31 1.3 SiSU built-in interactive help 32 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. 33 sisu --help 34 sisu --help [subject] 35 sisu --help env [for feedback on the way your system is setup with regard to sisu] 36 sisu -V [same as above command] 37 sisu --help commands 38 sisu --help markup 39 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). 40 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. 41 1.4 Help Sources 42 For lists of alternative help sources, see: 43 man page 44 man sisu_help_sources 45 man2html 46 /usr/share/doc/sisu/sisu_manual/sisu_help_sources/index.html 47 sisu generated html 48 /usr/share/doc/sisu/html/sisu_help_sources/index.html 49 <http://sisudoc.org/sisu_manual/sisu_help_sources/index.html> 50 <http://www.jus.uio.no/sisu/sisu_manual/sisu_help_sources/index.html> 0 Endnotes