sisu(8) manual page

From 65477054fd798728bf186aa2938727ddddbe86a5 Mon Sep 17 00:00:00 2001 From: Ralph Amissah Date: Tue, 22 May 2007 02:06:46 +0100 Subject: Imported upstream version 0.52.7 --- data/doc/sisu/html/sisu.8.html | 229 +++++++++++++++++++++++++++++++++++++++++ 1 file changed, 229 insertions(+) create mode 100644 data/doc/sisu/html/sisu.8.html (limited to 'data/doc/sisu/html/sisu.8.html') diff --git a/data/doc/sisu/html/sisu.8.html b/data/doc/sisu/html/sisu.8.html new file mode 100644 index 00000000..755d1d32 --- /dev/null +++ b/data/doc/sisu/html/sisu.8.html @@ -0,0 +1,229 @@ + + + + + +sisu(8) manual page + + +Table of Contents

+ +

Name

+SiSU - Structured information, Serialized Units - a document +publishing system +

Synopsis

+sisu [-mhwpxXv...] [ filename/wildcard ] +

Description

+A +document publishing system, that from a simple single marked-up document, +produces a multitude of output formats including: html, latex, pdf, info, +and sql output, which can be cross referenced as having the same document +structure and text object numbering, "object citation numbering". Features +include its’ simple syntax; the semantic identification of documents using +the Dublin Core; document management; built to be associated with a revision +control system; text object numbering for the identification of a texts +location in any of the output formats, easy skinning on a site wide, or +per document basis, ... for more see man 1 sisu or <http://www.jus.uio.no/sisu +> +

+SiSU is an alternative way of publishing and managing documents. +

Installation

+Up +to date information on SiSU downloads, and their installation should be +available from: <http://www.jus.uio.no/sisu/SiSU/download.html +> or at: <http://www.jus.uio.no/sisu/sisu_download/download.html +> +

+There you should find links to the latest source tarball, and instructions +on how to install SiSU.

+Sample marked up documents are are available at +/usr/share/doc/sisu/sisu_markup_samples/dfsg or equivalent directory, or +online at <http://www.jus.uio.no/sisu/sample/markup.html +> or for viewing in html +with syntax highlighting from <http://www.jus.uio.no/sisu/sample/syntax +>

+A syntax +table is provided at /usr/share/doc/sisu/on_markup.txt or equivalent, and +online at <http://www.jus.uio.no/sisu/sample/on_markup.txt +>

+man 1 sisu has a +syntax table along with processing commands.

+SiSU also provides some help +via the command: sisu --help and selecting an appropriate subject, e.g.

+sisu +--help commands

+sisu --help markup

+sisu --help headers

+sisu --help env

+The rest +of this note is on post installation setup +

Post Installation Setup - Quick +start

+After installation of sisu-complete, move to the document samples directory +

+ cd /usr/share/doc/sisu/sisu_markup_samples/dfsg
+

+and run

+ sisu -1 free_as_in_freedom.rms_and_free_software.sam_williams.sst
+

+or the same:

+ sisu -NhwpoabxXyv free_as_in_freedom.rms_and_free_software.sam_williams.sst
+

+look at output results, see the "sisu_manifest" page created for the document +

+To generate an online document move to a writable directory, (create a +work directory and cd into it) as the file will be downloaded there and +e.g.

+sisu -1 http://www.jus.uio.no/sisu/gpl2.fsf/gpl2.fsf.sst +

+sisu -3 http://www.jus.uio.no/sisu/free_culture.lawrence_lessig/free_culture.lawrence_lessig.sst + +

+examine source document, vim has syntax highlighting support

+gvim free_as_in_freedom.rms_and_free_software.sam_williams.sst +

+additional markup samples in <http://www.jus.uio.no/sisu/SiSU/2.html +>

+it should +also be possible to run sisu against sisupods (prepared zip files, created +by running the command sisu -S [filename]), whether stored locally or remotely. +

+sisu -3 http://www.jus.uio.no/sisu/free_culture.lawrence_lessig/sisupod.zip +

+there +is a security issue associated with the running of document skins that +are not your own, so these are turned of by default, and the use of the +following command, which switches on the associated skin is not recommended: +

+sisu -3 --trust http://www.jus.uio.no/sisu/free_culture.lawrence_lessig/sisupod.zip + +

+For help man sisu

+sisu --help

+sisu --help env for the way sisu "sees/maps" +your system

+sisu --help commands for list of commands and so on

+ Document +markup directory

+Perhaps the easiest way to begin is to create a directory +for sisu marked up documents within your home directory, and copy the file +structure (and document samples) provided in the document sample directory: +mkdir ~/sisu_test

+cd ~/sisu_test

+cp -a /usr/share/doc/sisu/sisu_markup_samples/dfsg/* +~/sisu_test/.

+----------

+Tip: the markup syntax examples may be of interest <http://www.jus.uio.no/sisu/sample/ +> +

+Tip: sisu -U [sisu markup filename] should printout the different possible +outputs and where sisu would place them.

+Tip: if you want to toggle ansi +color add c to your flags.

+----------

+ SiSU configuration file search path is:

+./_sisu/sisurc.yaml +

+~/.sisu/sisurc.yaml

+/etc/sisu/sisurc.yaml

+ +

Debian INSTALLATION Note

+It is best +you see <http://www.jus.uio.no/sisu/SiSU/download.html#debian +> for up the most +up to date information.

+notes taken from the Debian control file (end edited), +gives an idea of additional packages that SiSU can make use of if available, +(the use/requirement of some of which are interdependent for specific actions +by SiSU):

+Package: sisu

+Depends: ruby (>= 1.8.4), libwebrick-ruby

+Recommends: +sisu-pdf, sisu-sqlite, sisu-postgresql, librmagick-ruby, trang, tidy, librexml-ruby, +zip, unzip, openssl, rsync, openssh-client lsh-client,
+ keychain, hyperestraier, kdissert
+

+Suggests: libfcgi-ruby1.8, rcs cvs, lv, texinfo, pinfo, rename

+Package: +sisu-complete

+Depends: ruby (>= 1.8.4), sisu, sisu-pdf, sisu-postgresql, sisu-sqlite +

+Recommends: hyperestraier

+Package: sisu-pdf

+Depends: sisu, tetex-bin texlive-base-bin, +tetex-extra texlive-latex-extra, texlive-latex-extra, latex-ucs
+

+Suggests: evince, xpdf

+Package: sisu-postgresql

+Depends: sisu, postgresql-8.1, +libdbi-ruby, libdbm-ruby, libdbd-pg-ruby

+Suggests: pgaccess, libdbd-pgsql, postgresql-contrib-8.1 +

+Package: sisu-sqlite

+Depends: sisu, sqlite, libdbi-ruby, libdbm-ruby, libdbd-sqlite-ruby +

+Suggests: libdbd-sqlite

+Package: sisu-markup-samples

+Depends: sisu

+ +

Document +Resource Configuration

+sisu resource configuration information is obtained +from sources (where they exist):
+

~/.sisu/sisurc.yaml/etc/sisu/[sisu version]/sisurc.yamlsisu program defaults

+ +Skins

+default document appearance may be modified using skins contained +in sub-directories located at the following paths:
+

./_sisu/skin~/.sisu/skin/etc/sisu/skin

+more specifically, the following locations +(or their /etc/sisu equivalent) should be used:

+~/.sisu/skin/doc skins for +individual documents;

+~/.sisu/skin/dir skins for directories of matching +names;

+~/.sisu/skin/site site-wide skin modifying the site-wide appearance +of documents.

+Usually all skin files are placed in the document skin directory: +~/.sisu/skin/doc with softlinks being made to the skins contained there +from other skin directories as required. +

Further Information

+For more information +on SiSU see: <http://www.jus.uio.no/sisu +>

+or man sisu +

Author

+Ralph Amissah +<ralph@amissah.com> or <ralph.amissah@gmail.com> +