sisu(8) manual page

From f3aefadbed9795ef2d1c42bcb35c1962e4a3433e Mon Sep 17 00:00:00 2001 From: Ralph Amissah Date: Sat, 5 Mar 2011 15:09:03 -0500 Subject: sisu.8 manpage & html deleted, needs rewrite, unhelpful --- data/doc/sisu/html/sisu.8.html | 273 --------------------------------- man/man8/sisu.8 | 333 ----------------------------------------- 2 files changed, 606 deletions(-) delete mode 100644 data/doc/sisu/html/sisu.8.html delete mode 100644 man/man8/sisu.8 diff --git a/data/doc/sisu/html/sisu.8.html b/data/doc/sisu/html/sisu.8.html deleted file mode 100644 index 4c81d9c3..00000000 --- a/data/doc/sisu/html/sisu.8.html +++ /dev/null @@ -1,273 +0,0 @@ - - - - - -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 tagging of documents; 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; granular -search; a degree of future proofing ... for more see man 1 sisu or <http://www.jus.uio.no/sisu -> -

-SiSU is a way of preparing, publishing, managing and searching 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, see <http://www.jus.uio.no/sisu/SiSU/2.html -> -

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

-[this is not where you would normally work but provides sample documents -for testing, you may prefer instead to copy the contents of that directory -to a local directory before proceeding]

-and in that directory, initialise -the output directory with the command

-sisu -CC

-then 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 -

-for an overview of your current sisu setup, type:

-sisu --help env

-or

-sisu --V

-To generate a document from a remote url accessible location 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/gpl3.fsf/gpl3.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.2), libwebrick-ruby, unzip, zip -

-Conflicts: vim-sisu, sisu-vim, sisu-remote

-Replaces: vim-sisu, sisu-vim

-Recommends: -sisu-pdf, sisu-sqlite, sisu-postgresql, librmagick-ruby, trang, tidy, librexml-ruby, -openssl, rsync, openssh-client lsh-client, keychain, hyperestraier, kdissert -Suggests: rcs cvs, lv, texinfo, pinfo

-Package: sisu-complete

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

-Recommends: hyperestraier -

-Package: sisu-pdf

-Depends: sisu, texlive-latex-base, texlive-fonts-recommended, -texlive-latex-recommended, texlive-latex-extra

-Suggests: evince, xpdf

-Package: -sisu-postgresql

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

-Recommends: libfcgi-ruby

-Package: sisu-sqlite

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

-Recommends: libfcgi-ruby

-Package: sisu-markup-samples -

-Depends: sisu

- -

Package Description

-sisu

-Description: documents - structuring, -publishing in multiple formats and search

-SiSU is a lightweight markup -based, command line oriented, document structuring, publishing and search -framework for document collections.

-With minimal preparation of a plain-text, -(UTF-8) file, using its native markup syntax in your text editor of choice, -SiSU can generate various document formats (most of which share a common -object numbering system for locating content), including plain text, HTML, -XHTML, XML, OpenDocument text (ODF:ODT), LaTeX, PDF files, and populate -an SQL database with objects (roughly paragraph-sized chunks) so searches -may be performed and matches returned with that degree of granularity: -your search criteria is met by these documents and at these locations within -each document. Object numbering is particularly suitable for "published" -works (finalized texts as opposed to works that are frequently changed -or updated) for which it provides a fixed means of reference of content. -Document outputs also share semantic meta-data provided.

-SiSU also provides -concordance files, document content certificates and manifests of generated -output.

-A vim syntax highlighting file and an ftplugin with folds for sisu -markup is provided, as are syntax highlighting files for kate, kwrite, -gedit and diakonos. Vim 7 includes syntax highlighting for SiSU.

-man pages, -and interactive help are provided.

-Dependencies for various features are -taken care of in sisu related packages. The package sisu-complete installs -the whole of SiSU.

-Additional document markup samples are provided in the -package sisu-markup-samples which is found in the non-free archive the licenses -for the substantive content of the marked up documents provided is that -provided by the author or original publisher.

-Homepage: <http://www.jus.uio.no/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> -

- - diff --git a/man/man8/sisu.8 b/man/man8/sisu.8 deleted file mode 100644 index e3e676ae..00000000 --- a/man/man8/sisu.8 +++ /dev/null @@ -1,333 +0,0 @@ -.\" Name: SiSU information Structuring Universe -.\" Author: Ralph Amissah -.\" Description: sisu manpage -.\" License: GPL 3 or later -.\" Notes: Process this file with -.\" groff -man -Tascii sisu.1 -.\" nroff -man sisu.1 | most -.\" /[^\\][-'] -.\" :%s/\([^\\]\)\([-']\)/\1\\\2/c -.TH sisu 8 "October 26, 2006" "version 0.48" "CONFIGURATION and SETUP" -.SH NAME -.B SiSU -\- Structured information, Serialized Units \- a document publishing system -.SH SYNOPSIS -.B sisu -.B [\-mhwpxXv...] [ -.I filename/wildcard -.B ] -.\"%% Description -.SH 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 tagging of documents; 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; granular search; a degree of future -proofing ... for more see -.I man 1 sisu -or -.I -.PP -.B SiSU is a way of preparing, publishing, managing and searching documents. -.\"%% Installation -.SH INSTALLATION -.PP -Up to date information on SiSU downloads, and their installation should be -available from: -.I -or at: -.I -.PP -There you should find links to the latest source tarball, and instructions on -how to install SiSU. -.PP -Sample marked up documents are are available at -.I /usr/share/doc/sisu/sisu_markup_samples/dfsg -or equivalent directory, or online, see -.I -.PP -.I man 1 sisu -has a syntax table along with processing commands. -.PP -SiSU also provides some help via the command: -.I sisu \-\-help -and selecting an appropriate subject, e.g. -.PP -.I sisu \-\-help commands -.PP -.I sisu \-\-help markup -.PP -.I sisu \-\-help headers -.PP -.I sisu \-\-help env -.PP -The rest of this note is on post installation setup -.\"%% Post Installation Setup -.SH Post Installation Setup \- Quick start -.PP - -After installation of sisu\-complete, move to the document samples directory, -.PP - cd /usr/share/doc/sisu/sisu_markup_samples/dfsg -.PP -[this is not where you would normally work but provides sample documents for -testing, you may prefer instead to copy the contents of that directory to a local -directory before proceeding] -.PP -and in that directory, initialise the output directory with the command -.PP -.I sisu \-CC -.PP -then run: -.PP -.I sisu \-1 free_as_in_freedom.rms_and_free_software.sam_williams.sst -.PP -or the same: -.PP -.I sisu \-NhwpoabxXyv free_as_in_freedom.rms_and_free_software.sam_williams.sst -.PP -look at output results, see the "sisu_manifest" page created for the document -.PP -for an overview of your current sisu setup, type: -.PP -.I sisu \-\-help env -.PP -or -.PP -.I sisu \-V -.PP -To generate a document from a remote url accessible location move to a -writable directory, (create a work directory and cd into it) as the file will -be downloaded there and e.g. -.PP -.I sisu \-1 http://www.jus.uio.no/sisu/gpl3.fsf/gpl3.fsf.sst -.PP -.I sisu \-3 http://www.jus.uio.no/sisu/free_culture.lawrence_lessig/free_culture.lawrence_lessig.sst -.PP -examine source document, vim has syntax highlighting support -.PP -gvim free_as_in_freedom.rms_and_free_software.sam_williams.sst -.PP -additional markup samples in -.I -.PP -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. -.PP -.I sisu \-3 http://www.jus.uio.no/sisu/free_culture.lawrence_lessig/sisupod.zip -.PP -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: -.PP -.I sisu \-3 \-\-trust http://www.jus.uio.no/sisu/free_culture.lawrence_lessig/sisupod.zip -.PP -For help -.I man sisu -.PP -.I sisu \-\-help -.PP -.I sisu \-\-help env -for the way sisu "sees/maps" your system -.PP -.I sisu \-\-help commands -for list of commands and so on -.PP -.\"%% B. Generate a (local) document from a markup/work directory. -.B Document markup directory -.PP -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: -.I mkdir ~/sisu_test -.PP -.I cd ~/sisu_test -.PP -.I cp \-a /usr/share/doc/sisu/sisu_markup_samples/dfsg/* ~/sisu_test/. -.PP -.B \-\-\-\-\-\-\-\-\-\- -.PP -.B Tip: -the markup syntax examples may be of interest -.I -.PP -.B Tip: -.I sisu \-U [sisu markup filename] -should printout the different possible outputs and where sisu would place them. -.PP -.B Tip: -if you want to toggle ansi color add -.I c -to your flags. -.PP -.B \-\-\-\-\-\-\-\-\-\- -.PP -.\"%% configuration files -.B SiSU configuration file search path is: -.PP -.I ./_sisu/sisurc.yaml -.PP -.I ~/.sisu/sisurc.yaml -.PP -.I /etc/sisu/sisurc.yaml -.PP -.\"%% Debian Installation Note -.SH Debian INSTALLATION Note -.PP -It is best you see -.I -for up the most up to date information. -.PP -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): -.PP -Package: sisu -.PP -Depends: ruby (>= 1.8.2), libwebrick\-ruby, unzip, zip -.PP -Conflicts: vim\-sisu, sisu\-vim, sisu\-remote -.PP -Replaces: vim\-sisu, sisu\-vim -.PP -Recommends: sisu\-pdf, sisu\-sqlite, sisu\-postgresql, librmagick\-ruby, trang, -tidy, librexml\-ruby, openssl, rsync, openssh\-client \| lsh\-client, keychain, -hyperestraier, kdissert Suggests: rcs \| cvs, lv, texinfo, pinfo -.PP -Package: sisu\-complete -.PP -Depends: ruby (>= 1.8.2), sisu, sisu\-pdf, sisu\-postgresql, sisu\-sqlite -.PP -Recommends: hyperestraier -.PP -Package: sisu\-pdf -.PP -Depends: sisu, texlive\-latex\-base, texlive\-fonts\-recommended, -texlive\-latex\-recommended, texlive\-latex\-extra -.PP -Suggests: evince, xpdf -.PP -Package: sisu\-postgresql -.PP -Depends: sisu, libdbd\-pg\-ruby, libdbi\-ruby, libdbm\-ruby, postgresql -.PP -Recommends: libfcgi\-ruby -.PP -Package: sisu\-sqlite -.PP -Depends: sisu, sqlite, libdbd\-sqlite\-ruby, libdbi\-ruby, libdbm\-ruby -.PP -Recommends: libfcgi\-ruby -.PP -Package: sisu\-markup\-samples -.PP -Depends: sisu -.PP -.SH Package Description -.B sisu -.PP -Description: documents \- structuring, publishing in multiple formats and search -.PP -SiSU is a lightweight markup based, command line oriented, document -structuring, publishing and search framework for document collections. -.PP -With minimal preparation of a plain\-text, (UTF\-8) file, using its native markup -syntax in your text editor of choice, SiSU can generate various document -formats (most of which share a common object numbering system for locating -content), including plain text, HTML, XHTML, XML, OpenDocument text (ODF:ODT), -LaTeX, PDF files, and populate an SQL database with objects (roughly -paragraph\-sized chunks) so searches may be performed and matches returned with -that degree of granularity: your search criteria is met by these documents and -at these locations within each document. Object numbering is particularly -suitable for "published" works (finalized texts as opposed to works that are -frequently changed or updated) for which it provides a fixed means of reference -of content. Document outputs also share semantic meta\-data provided. -.PP -SiSU also provides concordance files, document content certificates and -manifests of generated output. -.PP -A vim syntax highlighting file and an ftplugin with folds for sisu markup is -provided, as are syntax highlighting files for kate, kwrite, gedit and -diakonos. Vim 7 includes syntax highlighting for SiSU. -.PP -man pages, and interactive help are provided. -.PP -Dependencies for various features are taken care of in sisu related packages. -The package sisu\-complete installs the whole of SiSU. -.PP -Additional document markup samples are provided in the package -sisu\-markup\-samples which is found in the non\-free archive the licenses for -the substantive content of the marked up documents provided is that provided -by the author or original publisher. -.PP -Homepage: -.fi -.\"%% Configuration Files -.SH DOCUMENT RESOURCE CONFIGURATION -.B sisu -resource configuration information is obtained from sources (where they exist): -.\" preformatted text follows -.nf -.I ~/.sisu/sisurc.yaml -.I /etc/sisu/[sisu version]/sisurc.yaml -.I sisu program defaults -.fi -.PP -.\"%% Skins -.B Skins -.PP -default document appearance may be modified using skins contained in -sub\-directories located at the following paths: -.\" preformatted text follows -.nf -.I ./_sisu/skin -.I ~/.sisu/skin -.I /etc/sisu/skin -.fi -.PP -more specifically, the following locations (or their /etc/sisu equivalent) -should be used: -.PP -.I ~/.sisu/skin/doc -skins for individual documents; -.PP -.I ~/.sisu/skin/dir -skins for directories of matching names; -.PP -.I ~/.sisu/skin/site -site\-wide skin -modifying the site\-wide appearance of documents. -.PP -Usually all skin files are placed in the document skin directory: -.I ~/.sisu/skin/doc -with softlinks being made to the skins contained there from other skin -directories as required. -.\"%% Further Information -.SH FURTHER INFORMATION -.PP -For more information on -.I SiSU -see: -.I -.PP -or -.I man sisu -.\"%% Author -.SH AUTHOR -Ralph Amissah -.I -or -.I -.SH SEE ALSO -.BR sisu(1), -.BR sisu_examples(1), -.BR sisu_webrick(1), -.BR sisu_pdf(1) -.BR sisu_sqlite(1) -.BR sisu_postgresql(1) -.BR sisu_termsheet(1), -- cgit v1.2.3