diff options
author | Ralph Amissah <ralph@amissah.com> | 2007-09-23 05:16:53 +0100 |
---|---|---|
committer | Ralph Amissah <ralph@amissah.com> | 2007-09-23 05:16:53 +0100 |
commit | bcd7f88ba20b1dbc956522d90fca4f1982dddcef (patch) | |
tree | fea6227b42001b2949635b36daaf30da864e53ce /man/man1/sisu_help.1 | |
parent | Merge branch 'upstream' into debian/sid (diff) | |
parent | primarily todo with sisu documentation, changelog reproduced below: (diff) |
Merge branch 'upstream' into debian/sid
Diffstat (limited to 'man/man1/sisu_help.1')
-rw-r--r-- | man/man1/sisu_help.1 | 318 |
1 files changed, 318 insertions, 0 deletions
diff --git a/man/man1/sisu_help.1 b/man/man1/sisu_help.1 new file mode 100644 index 00000000..bb6d470b --- /dev/null +++ b/man/man1/sisu_help.1 @@ -0,0 +1,318 @@ +.TH "sisu_help" "1" "2007-08-30" "0.58.3" "SiSU - SiSU information Structuring Universe" +.SH +SISU \- SISU INFORMATION STRUCTURING UNIVERSE \- MANUAL \ [0.58], +RALPH AMISSAH +.BR + +.SH +SISU HELP +.BR + +.SH +1. HELP +.BR + +.SH +1.1 SISU MANUAL + +.BR +The most up to date information on sisu should be contained in the sisu_manual, +available at: + +.BR + <http://www.jus.uio.no/sisu/sisu_manual/> + +.BR +and (from +.B SiSU +0.59 onwards) installed locally at: + +.BR + /usr/share/doc/sisu/sisu_manual/ + +.BR +or equivalent directory + +.BR +Within the +.B SiSU +tarball at: + +.BR + ./data/doc/sisu/sisu_manual/ + +.SH +1.2 SISU MAN PAGES + +.BR +If +.B SiSU +is installed on your system usual man commands should be available, try: + +.BR + man sisu + +.BR + man sisu_markup + +.BR + man sisu_commands + +.BR +Most +.B 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 +.B SiSU +tarball at: + +.BR + ./data/doc/sisu/sisu_manual/ + +.BR +Once installed, directory equivalent to: + +.BR + /usr/share/doc/sisu/sisu_manual/ + +.BR +Available man pages are converted back to html using man2html: + +.BR + /usr/share/doc/sisu/html/ + +.BR + ./data/doc/sisu/html/ + +.BR +The +.B SiSU +man pages can be viewed online at:[^1] + +.BR +An online version of the sisu man page is available here: + +.BR +* various sisu man pages <http://www.jus.uio.no/sisu/man/> \ [^2] + +.BR +* sisu.1 <http://www.jus.uio.no/sisu/man/sisu.1.html> \ [^3] + +.BR +* sisu.8 <http://www.jus.uio.no/sisu/man/sisu.8.html> \ [^4] + +.BR +* sisu_examples.1 <http://www.jus.uio.no/sisu/man/sisu_examples.1.html> \ [^5] + +.BR +* sisu_webrick.1 <http://www.jus.uio.no/sisu/man/sisu_webrick.1.html> \ [^6] + +.SH +1.3 SISU BUILT\-IN INTERACTIVE HELP + +.BR +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. + +.BR + sisu \-\-help + +.BR + sisu \-\-help \ [subject] + +.BR + sisu \-\-help env \ [for \ feedback \ on \ the \ way \ your \ system \ is \ + setup \ with \ regard \ to \ sisu] + +.BR + sisu \-V \ [same \ as \ above \ command] + +.BR + sisu \-\-help commands + +.BR + sisu \-\-help markup + +.BR +Apart from real\-time information on your current configuration the +.B 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). + +.BR +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. + +.SH +1.4 HELP SOURCES + +.BR +For lists of alternative help sources, see: + +.BR +.B man page + +.BR + man sisu_help_sources + +.BR +.B man2html + +.BR + /usr/share/doc/sisu/sisu_manual/sisu_help_sources/index.html + +.BR +.B sisu generated html + +.BR + /usr/share/doc/sisu/html/sisu_help_sources/index.html + +.BR + <http://sisudoc.org/sisu_manual/sisu_help_sources/index.html> + +.BR + <http://www.jus.uio.no/sisu/sisu_manual/sisu_help_sources/index.html> + +.SH +DOCUMENT INFORMATION (METADATA) +.BR + +.SH +METADATA +.BR + +.BR +Document Manifest @ +<http://www.jus.uio.no/sisu/sisu_manual/sisu_help/sisu_manifest.html> + +.BR +.B Dublin Core +(DC) + +.BR +.I DC tags included with this document are provided here. + +.BR +DC Title: +.I SiSU \- SiSU information Structuring Universe \- Manual \ [0.58] + +.BR +DC Creator: +.I Ralph Amissah + +.BR +DC Rights: +.I Copyright (C) Ralph Amissah 2007, part of SiSU documentation, License GPL +3 + +.BR +DC Type: +.I information + +.BR +DC Date created: +.I 2002\-08\-28 + +.BR +DC Date issued: +.I 2002\-08\-28 + +.BR +DC Date available: +.I 2002\-08\-28 + +.BR +DC Date modified: +.I 2007\-08\-30 + +.BR +DC Date: +.I 2007\-08\-30 + +.BR +.B Version Information + +.BR +Sourcefile: +.I sisu_help.sst + +.BR +Filetype: +.I SiSU text 0.58 + +.BR +Sourcefile Digest, MD5(sisu_help.sst)= +.I 387208846e53080b55b39cf92b70aaa9 + +.BR +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)= +.I 20fc43cf3eb6590bc3399a1aef65c5a9 + +.BR +.B Generated + +.BR +Document (metaverse) last generated: +.I Sun Sep 23 01:13:57 +0100 2007 + +.BR +Generated by: +.I SiSU +.I 0.58.3 +of 2007w36/4 (2007\-09\-06) + +.BR +Ruby version: +.I ruby 1.8.6 (2007\-06\-07 patchlevel 36) \ [i486\-linux] + +.TP +.BI 1. +generated from source using rman + <http://polyglotman.sourceforge.net/rman.html> + With regard to +.B 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> +.TP +.BI 2. +<http://www.jus.uio.no/sisu/man/> +.TP +.BI 3. +<http://www.jus.uio.no/sisu/man/sisu.1.html> +.TP +.BI 4. +<http://www.jus.uio.no/sisu/man/sisu.8.html> +.TP +.BI 5. +<http://www.jus.uio.no/sisu/man/sisu_examples.1.html> +.TP +.BI 6. +<http://www.jus.uio.no/sisu/man/sisu_webrick.1.html> + +.TP +Other versions of this document: +.TP +manifest: <http://www.jus.uio.no/sisu/sisu_help/sisu_manifest.html> +.TP +html: <http://www.jus.uio.no/sisu/sisu_help/toc.html> +.TP +pdf: <http://www.jus.uio.no/sisu/sisu_help/portrait.pdf> +.TP +pdf: <http://www.jus.uio.no/sisu/sisu_help/landscape.pdf> +." .TP +." manpage: http://www.jus.uio.no/sisu/sisu_help/sisu_help.1 +.TP +at: <http://www.jus.uio.no/sisu> +.TP +.TP +* Generated by: SiSU 0.58.3 of 2007w36/4 (2007-09-06) +.TP +* Ruby version: ruby 1.8.6 (2007-06-07 patchlevel 36) [i486-linux] +.TP +* Last Generated on: Sun Sep 23 01:14:05 +0100 2007 +.TP +* SiSU http://www.jus.uio.no/sisu |