diff options
Diffstat (limited to 'man')
-rw-r--r-- | man/man1/sisu-concordance.1 | 32 | ||||
-rw-r--r-- | man/man1/sisu-epub.1 | 32 | ||||
-rw-r--r-- | man/man1/sisu-git.1 | 30 | ||||
-rw-r--r-- | man/man1/sisu-harvest.1 | 32 | ||||
-rw-r--r-- | man/man1/sisu-html.1 | 32 | ||||
-rw-r--r-- | man/man1/sisu-odf.1 | 32 | ||||
-rw-r--r-- | man/man1/sisu-pdf.1 | 32 | ||||
-rw-r--r-- | man/man1/sisu-pg.1 | 32 | ||||
-rw-r--r-- | man/man1/sisu-po.1 | 32 | ||||
-rw-r--r-- | man/man1/sisu-sqlite.1 | 32 | ||||
-rw-r--r-- | man/man1/sisu-txt.1 | 32 | ||||
-rw-r--r-- | man/man1/sisu.1 | 1561 | ||||
l---------[-rw-r--r--] | man/man1/sisu3.1 | 4807 | ||||
-rw-r--r-- | man/man1/sisu_termsheet.1 | 4 | ||||
-rw-r--r-- | man/man1/sisu_webrick.1 | 18 | ||||
-rw-r--r-- | man/man7/sisu_vim.7 | 129 | ||||
-rw-r--r-- | man/man8/sisu.8 | 333 |
17 files changed, 994 insertions, 6208 deletions
diff --git a/man/man1/sisu-concordance.1 b/man/man1/sisu-concordance.1 index d21c7a02..cccb57f5 100644 --- a/man/man1/sisu-concordance.1 +++ b/man/man1/sisu-concordance.1 @@ -1,41 +1,41 @@ -.TH SISU\-CONCORDANCE 1 2010\-07\-07 2.6.0 SiSU +.TH SISU-CONCORDANCE 1 "2011-03-05" "2.8.1" "SiSU" .SH NAME -\fBSiSU\fR \- Structured information, Serialized Units \- a document publishing system +\fBSiSU\fR - Structured information, Serialized Units - a document publishing system .SH SYNOPSIS -\fBsisu\-concordance\fR \fIsisu_document.sst\fR | \fIsisu_document.ssm\fR +\fBsisu-concordance\fR \fIsisu_document.sst\fR | \fIsisu_document.ssm\fR .SH DESCRIPTION \fBSiSU\fR is a lightweight markup based document structuring, publishing and search framework for document collections. .PP -The \fBsisu\-concordance\fR command is an alias for \fBsisu \-\-concordance\fR (or \fBsisu \-w\fR) which produces an HTML concordance file (wordlist) of a SiSU markup file. +The \fBsisu-concordance\fR command is an alias for \fBsisu --concordance\fR (or \fBsisu -w\fR) which produces an HTML concordance file (wordlist) of a SiSU markup file. .SH SEE ALSO \fIsisu\fR(1), .br -\fIsisu\-epub\fR(1), +\fIsisu-epub\fR(1), .br -\fIsisu\-git\fR(1), +\fIsisu-git\fR(1), .br -\fIsisu\-harvest\fR(1), +\fIsisu-harvest\fR(1), .br -\fIsisu\-html\fR(1), +\fIsisu-html\fR(1), .br -\fIsisu\-pdf\fR(1), +\fIsisu-pdf\fR(1), .br -\fIsisu\-odf\fR(1), +\fIsisu-odf\fR(1), .br -\fIsisu\-pg\fR(1), +\fIsisu-pg\fR(1), .br -\fIsisu\-po\fR(1), +\fIsisu-po\fR(1), .br -\fIsisu\-sqlite\fR(1), +\fIsisu-sqlite\fR(1), .br -\fIsisu\-txt\fR(1). +\fIsisu-txt\fR(1). .SH HOMEPAGE -More information about \fBSiSU\fR can be found at <\fIhttp://www.jus.uio.no/sisu/\fR>. +More information about \fBSiSU\fR can be found at <\fIhttp://www.sisudoc.org/\fR> or <\fIhttp://www.jus.uio.no/sisu/\fR>. .SH AUTHOR -\fBSiSU\fR was written by Ralph Amissah <\fIralph@amissah.com\fR>. +\fBSiSU\fR is written by Ralph Amissah <\fIralph@amissah.com\fR>. diff --git a/man/man1/sisu-epub.1 b/man/man1/sisu-epub.1 index 216ff352..ddc3e5f3 100644 --- a/man/man1/sisu-epub.1 +++ b/man/man1/sisu-epub.1 @@ -1,41 +1,41 @@ -.TH SISU\-EPUB 1 2010\-07\-07 2.6.0 SiSU +.TH SISU-EPUB 1 "2011-03-05" "2.8.1" "SiSU" .SH NAME -\fBSiSU\fR \- Structured information, Serialized Units \- a document publishing system +\fBSiSU\fR - Structured information, Serialized Units - a document publishing system .SH SYNOPSIS -\fBsisu\-epub\fR \fIsisu_document.sst\fR | \fIsisu_document.ssm\fR +\fBsisu-epub\fR \fIsisu_document.sst\fR | \fIsisu_document.ssm\fR .SH DESCRIPTION \fBSiSU\fR is a lightweight markup based document structuring, publishing and search framework for document collections. .PP -The \fBsisu\-epub\fR command is an alias for \fBsisu \-\-epub\fR (or \fBsisu \-e\fR) which produces EPUB output of a SiSU markup file. +The \fBsisu-epub\fR command is an alias for \fBsisu --epub\fR (or \fBsisu -e\fR) which produces EPUB output of a SiSU markup file. .SH SEE ALSO \fIsisu\fR(1), .br -\fIsisu\-concordance\fR(1), +\fIsisu-concordance\fR(1), .br -\fIsisu\-git\fR(1), +\fIsisu-git\fR(1), .br -\fIsisu\-harvest\fR(1), +\fIsisu-harvest\fR(1), .br -\fIsisu\-html\fR(1), +\fIsisu-html\fR(1), .br -\fIsisu\-pdf\fR(1), +\fIsisu-pdf\fR(1), .br -\fIsisu\-odf\fR(1), +\fIsisu-odf\fR(1), .br -\fIsisu\-pg\fR(1), +\fIsisu-pg\fR(1), .br -\fIsisu\-po\fR(1), +\fIsisu-po\fR(1), .br -\fIsisu\-sqlite\fR(1), +\fIsisu-sqlite\fR(1), .br -\fIsisu\-txt\fR(1). +\fIsisu-txt\fR(1). .SH HOMEPAGE -More information about \fBSiSU\fR can be found at <\fIhttp://www.jus.uio.no/sisu/\fR>. +More information about \fBSiSU\fR can be found at <\fIhttp://www.sisudoc.org/\fR> or <\fIhttp://www.jus.uio.no/sisu/\fR>. .SH AUTHOR -\fBSiSU\fR was written by Ralph Amissah <\fIralph@amissah.com\fR>. +\fBSiSU\fR is written by Ralph Amissah <\fIralph@amissah.com\fR>. diff --git a/man/man1/sisu-git.1 b/man/man1/sisu-git.1 index 21907f17..c0d8a229 100644 --- a/man/man1/sisu-git.1 +++ b/man/man1/sisu-git.1 @@ -1,39 +1,39 @@ -.TH SISU\-GIT 1 2010\-07\-27 2.6.0 SiSU +.TH SISU-GIT 1 "2011-03-05" "2.8.1" "SiSU" .SH NAME -\fBSiSU\fR \- Structured information, Serialized Units \- a document publishing system +\fBSiSU\fR - Structured information, Serialized Units - a document publishing system .SH SYNOPSIS -\fBsisu\-git\fR \fIsisu_document.sst\fR | \fIsisu_document.ssm\fR +\fBsisu-git\fR \fIsisu_document.sst\fR | \fIsisu_document.ssm\fR .SH DESCRIPTION \fBSiSU\fR is a lightweight markup based document structuring, publishing and search framework for document collections. .PP -The \fBsisu\-git\fR command is an alias for \fBsisu \-\-git\fR (or \fBsisu \-g\fR) which produces a git repository of the sisu source document and associated parts (images, ). +The \fBsisu-git\fR command is an alias for \fBsisu --git\fR (or \fBsisu -g\fR) which produces a git repository of the sisu source document and associated parts (images, ). .SH SEE ALSO \fIsisu\fR(1), .br -\fIsisu\-concordance\fR(1), +\fIsisu-concordance\fR(1), .br -\fIsisu\-epub\fR(1), +\fIsisu-epub\fR(1), .br -\fIsisu\-harvest\fR(1), +\fIsisu-harvest\fR(1), .br -\fIsisu\-html\fR(1), +\fIsisu-html\fR(1), .br -\fIsisu\-pdf\fR(1), +\fIsisu-pdf\fR(1), .br -\fIsisu\-pg\fR(1), +\fIsisu-pg\fR(1), .br -\fIsisu\-po\fR(1), +\fIsisu-po\fR(1), .br -\fIsisu\-sqlite\fR(1), +\fIsisu-sqlite\fR(1), .br -\fIsisu\-txt\fR(1). +\fIsisu-txt\fR(1). .SH HOMEPAGE -More information about \fBSiSU\fR can be found at <\fIhttp://www.jus.uio.no/sisu/\fR>. +More information about \fBSiSU\fR can be found at <\fIhttp://www.sisudoc.org/\fR> or <\fIhttp://www.jus.uio.no/sisu/\fR>. .SH AUTHOR -\fBSiSU\fR was written by Ralph Amissah <\fIralph@amissah.com\fR>. +\fBSiSU\fR is written by Ralph Amissah <\fIralph@amissah.com\fR>. diff --git a/man/man1/sisu-harvest.1 b/man/man1/sisu-harvest.1 index 6a521cee..79b1116c 100644 --- a/man/man1/sisu-harvest.1 +++ b/man/man1/sisu-harvest.1 @@ -1,41 +1,41 @@ -.TH SISU\-HARVEST 1 2010\-07\-12 2.6.0 SiSU +.TH SISU-HARVEST 1 "2011-03-05" "2.8.1" "SiSU" .SH NAME -\fBSiSU\fR \- Structured information, Serialized Units \- a document publishing system +\fBSiSU\fR - Structured information, Serialized Units - a document publishing system .SH SYNOPSIS -\fBsisu\-harvest\fR \fIsisu_document.sst\fR | \fIsisu_document.ssm\fR +\fBsisu-harvest\fR \fIsisu_document.sst\fR | \fIsisu_document.ssm\fR .SH DESCRIPTION \fBSiSU\fR is a lightweight markup based document structuring, publishing and search framework for document collections. .PP -The \fBsisu\-harvest\fR command is an alias for \fBsisu \-\-harvest\fR which based on the @classify: :topic_register: headers in each SiSU markup file, produces HTML output in the form of an index of authors and their texts and an index of topics and related texts. +The \fBsisu-harvest\fR command is an alias for \fBsisu --harvest\fR which based on the @classify: :topic_register: headers in each SiSU markup file, produces HTML output in the form of an index of authors and their texts and an index of topics and related texts. .SH SEE ALSO \fIsisu\fR(1), .br -\fIsisu\-concordance\fR(1), +\fIsisu-concordance\fR(1), .br -\fIsisu\-epub\fR(1), +\fIsisu-epub\fR(1), .br -\fIsisu\-git\fR(1), +\fIsisu-git\fR(1), .br -\fIsisu\-html\fR(1), +\fIsisu-html\fR(1), .br -\fIsisu\-pdf\fR(1), +\fIsisu-pdf\fR(1), .br -\fIsisu\-odf\fR(1), +\fIsisu-odf\fR(1), .br -\fIsisu\-pg\fR(1), +\fIsisu-pg\fR(1), .br -\fIsisu\-po\fR(1), +\fIsisu-po\fR(1), .br -\fIsisu\-sqlite\fR(1), +\fIsisu-sqlite\fR(1), .br -\fIsisu\-txt\fR(1). +\fIsisu-txt\fR(1). .SH HOMEPAGE -More information about \fBSiSU\fR can be found at <\fIhttp://www.jus.uio.no/sisu/\fR>. +More information about \fBSiSU\fR can be found at <\fIhttp://www.sisudoc.org/\fR> or <\fIhttp://www.jus.uio.no/sisu/\fR>. .SH AUTHOR -\fBSiSU\fR was written by Ralph Amissah <\fIralph@amissah.com\fR>. +\fBSiSU\fR is written by Ralph Amissah <\fIralph@amissah.com\fR>. diff --git a/man/man1/sisu-html.1 b/man/man1/sisu-html.1 index 9226016d..4b5e9888 100644 --- a/man/man1/sisu-html.1 +++ b/man/man1/sisu-html.1 @@ -1,41 +1,41 @@ -.TH SISU\-HTML 1 2010\-07\-07 2.6.0 SiSU +.TH SISU-HTML 1 "2011-03-05" "2.8.1" "SiSU" .SH NAME -\fBSiSU\fR \- Structured information, Serialized Units \- a document publishing system +\fBSiSU\fR - Structured information, Serialized Units - a document publishing system .SH SYNOPSIS -\fBsisu\-html\fR \fIsisu_document.sst\fR | \fIsisu_document.ssm\fR +\fBsisu-html\fR \fIsisu_document.sst\fR | \fIsisu_document.ssm\fR .SH DESCRIPTION \fBSiSU\fR is a lightweight markup based document structuring, publishing and search framework for document collections. .PP -The \fBsisu\-html\fR command is an alias for \fBsisu \-\-html\fR (or \fBsisu \-h\fR) which produces HTML output of a SiSU markup file. +The \fBsisu-html\fR command is an alias for \fBsisu --html\fR (or \fBsisu -h\fR) which produces HTML output of a SiSU markup file. .SH SEE ALSO \fIsisu\fR(1), .br -\fIsisu\-concordance\fR(1), +\fIsisu-concordance\fR(1), .br -\fIsisu\-epub\fR(1), +\fIsisu-epub\fR(1), .br -\fIsisu\-git\fR(1), +\fIsisu-git\fR(1), .br -\fIsisu\-harvest\fR(1), +\fIsisu-harvest\fR(1), .br -\fIsisu\-pdf\fR(1), +\fIsisu-pdf\fR(1), .br -\fIsisu\-odf\fR(1), +\fIsisu-odf\fR(1), .br -\fIsisu\-pg\fR(1), +\fIsisu-pg\fR(1), .br -\fIsisu\-po\fR(1), +\fIsisu-po\fR(1), .br -\fIsisu\-sqlite\fR(1), +\fIsisu-sqlite\fR(1), .br -\fIsisu\-txt\fR(1). +\fIsisu-txt\fR(1). .SH HOMEPAGE -More information about \fBSiSU\fR can be found at <\fIhttp://www.jus.uio.no/sisu/\fR>. +More information about \fBSiSU\fR can be found at <\fIhttp://www.sisudoc.org/\fR> or <\fIhttp://www.jus.uio.no/sisu/\fR>. .SH AUTHOR -\fBSiSU\fR was written by Ralph Amissah <\fIralph@amissah.com\fR>. +\fBSiSU\fR is written by Ralph Amissah <\fIralph@amissah.com\fR>. diff --git a/man/man1/sisu-odf.1 b/man/man1/sisu-odf.1 index 6573f7c8..8fe09344 100644 --- a/man/man1/sisu-odf.1 +++ b/man/man1/sisu-odf.1 @@ -1,41 +1,41 @@ -.TH SISU\-ODF 1 2010\-07\-07 2.6.0 SiSU +.TH SISU-ODF 1 "2011-03-05" "2.8.1" "SiSU" .SH NAME -\fBSiSU\fR \- Structured information, Serialized Units \- a document publishing system +\fBSiSU\fR - Structured information, Serialized Units - a document publishing system .SH SYNOPSIS -\fBsisu\-odf\fR \fIsisu_document.sst\fR | \fIsisu_document.ssm\fR +\fBsisu-odf\fR \fIsisu_document.sst\fR | \fIsisu_document.ssm\fR .SH DESCRIPTION \fBSiSU\fR is a lightweight markup based document structuring, publishing and search framework for document collections. .PP -The \fBsisu\-odf\fR command is an alias for \fBsisu \-\-odt\fR (or \fBsisu \-o\fR) which produces OpenDocument output of a SiSU markup file. +The \fBsisu-odf\fR command is an alias for \fBsisu --odt\fR (or \fBsisu -o\fR) which produces OpenDocument output of a SiSU markup file. .SH SEE ALSO \fIsisu\fR(1), .br -\fIsisu\-concordance\fR(1), +\fIsisu-concordance\fR(1), .br -\fIsisu\-epub\fR(1), +\fIsisu-epub\fR(1), .br -\fIsisu\-git\fR(1), +\fIsisu-git\fR(1), .br -\fIsisu\-harvest\fR(1), +\fIsisu-harvest\fR(1), .br -\fIsisu\-html\fR(1), +\fIsisu-html\fR(1), .br -\fIsisu\-pdf\fR(1), +\fIsisu-pdf\fR(1), .br -\fIsisu\-pg\fR(1), +\fIsisu-pg\fR(1), .br -\fIsisu\-po\fR(1), +\fIsisu-po\fR(1), .br -\fIsisu\-sqlite\fR(1), +\fIsisu-sqlite\fR(1), .br -\fIsisu\-txt\fR(1). +\fIsisu-txt\fR(1). .SH HOMEPAGE -More information about \fBSiSU\fR can be found at <\fIhttp://www.jus.uio.no/sisu/\fR>. +More information about \fBSiSU\fR can be found at <\fIhttp://www.sisudoc.org/\fR> or <\fIhttp://www.jus.uio.no/sisu/\fR>. .SH AUTHOR -\fBSiSU\fR was written by Ralph Amissah <\fIralph@amissah.com\fR>. +\fBSiSU\fR is written by Ralph Amissah <\fIralph@amissah.com\fR>. diff --git a/man/man1/sisu-pdf.1 b/man/man1/sisu-pdf.1 index 65309edb..28e9dff1 100644 --- a/man/man1/sisu-pdf.1 +++ b/man/man1/sisu-pdf.1 @@ -1,41 +1,41 @@ -.TH SISU\-PDF 1 2010\-07\-07 2.6.0 SiSU +.TH SISU-PDF 1 "2011-03-05" "2.8.1" "SiSU" .SH NAME -\fBSiSU\fR \- Structured information, Serialized Units \- a document publishing system +\fBSiSU\fR - Structured information, Serialized Units - a document publishing system .SH SYNOPSIS -\fBsisu\-pdf\fR \fIsisu_document.sst\fR | \fIsisu_document.ssm\fR +\fBsisu-pdf\fR \fIsisu_document.sst\fR | \fIsisu_document.ssm\fR .SH DESCRIPTION \fBSiSU\fR is a lightweight markup based document structuring, publishing and search framework for document collections. .PP -The \fBsisu\-pdf\fR command is an alias for \fBsisu \-\-pdf\fR (or \fBsisu \-p\fR) which produces PDF output of a SiSU markup file. +The \fBsisu-pdf\fR command is an alias for \fBsisu --pdf\fR (or \fBsisu -p\fR) which produces PDF output of a SiSU markup file. .SH SEE ALSO \fIsisu\fR(1), .br -\fIsisu\-concordance\fR(1), +\fIsisu-concordance\fR(1), .br -\fIsisu\-epub\fR(1), +\fIsisu-epub\fR(1), .br -\fIsisu\-git\fR(1), +\fIsisu-git\fR(1), .br -\fIsisu\-harvest\fR(1), +\fIsisu-harvest\fR(1), .br -\fIsisu\-html\fR(1), +\fIsisu-html\fR(1), .br -\fIsisu\-odf\fR(1), +\fIsisu-odf\fR(1), .br -\fIsisu\-pg\fR(1), +\fIsisu-pg\fR(1), .br -\fIsisu\-po\fR(1), +\fIsisu-po\fR(1), .br -\fIsisu\-sqlite\fR(1), +\fIsisu-sqlite\fR(1), .br -\fIsisu\-txt\fR(1). +\fIsisu-txt\fR(1). .SH HOMEPAGE -More information about \fBSiSU\fR can be found at <\fIhttp://www.jus.uio.no/sisu/\fR>. +More information about \fBSiSU\fR can be found at <\fIhttp://www.sisudoc.org/\fR> or <\fIhttp://www.jus.uio.no/sisu/\fR>. .SH AUTHOR -\fBSiSU\fR was written by Ralph Amissah <\fIralph@amissah.com\fR>. +\fBSiSU\fR is written by Ralph Amissah <\fIralph@amissah.com\fR>. diff --git a/man/man1/sisu-pg.1 b/man/man1/sisu-pg.1 index 4df0d792..55bac1b4 100644 --- a/man/man1/sisu-pg.1 +++ b/man/man1/sisu-pg.1 @@ -1,41 +1,41 @@ -.TH SISU\-PG 1 2010\-07\-07 2.6.0 SiSU +.TH SISU-PG 1 "2011-03-05" "2.8.1" "SiSU" .SH NAME -\fBSiSU\fR \- Structured information, Serialized Units \- a document publishing system +\fBSiSU\fR - Structured information, Serialized Units - a document publishing system .SH SYNOPSIS -\fBsisu\-pq\fR \fIsisu_document.sst\fR | \fIsisu_document.ssm\fR +\fBsisu-pq\fR \fIsisu_document.sst\fR | \fIsisu_document.ssm\fR .SH DESCRIPTION \fBSiSU\fR is a lightweight markup based document structuring, publishing and search framework for document collections. .PP -The \fBsisu\-pq\fR command is an alias for \fBsisu \-\-pg\fR (or \fBsisu \-D\fR) which populates a PostgreSQL database with SiSU content (for search) from a SiSU markup file. +The \fBsisu-pq\fR command is an alias for \fBsisu --pg\fR (or \fBsisu -D\fR) which populates a PostgreSQL database with SiSU content (for search) from a SiSU markup file. .SH SEE ALSO \fIsisu\fR(1), .br -\fIsisu\-concordance\fR(1), +\fIsisu-concordance\fR(1), .br -\fIsisu\-epub\fR(1), +\fIsisu-epub\fR(1), .br -\fIsisu\-git\fR(1), +\fIsisu-git\fR(1), .br -\fIsisu\-harvest\fR(1), +\fIsisu-harvest\fR(1), .br -\fIsisu\-html\fR(1), +\fIsisu-html\fR(1), .br -\fIsisu\-pdf\fR(1), +\fIsisu-pdf\fR(1), .br -\fIsisu\-po\fR(1), +\fIsisu-po\fR(1), .br -\fIsisu\-odf\fR(1), +\fIsisu-odf\fR(1), .br -\fIsisu\-sqlite\fR(1), +\fIsisu-sqlite\fR(1), .br -\fIsisu\-txt\fR(1). +\fIsisu-txt\fR(1). .SH HOMEPAGE -More information about \fBSiSU\fR can be found at <\fIhttp://www.jus.uio.no/sisu/\fR>. +More information about \fBSiSU\fR can be found at <\fIhttp://www.sisudoc.org/\fR> or <\fIhttp://www.jus.uio.no/sisu/\fR>. .SH AUTHOR -\fBSiSU\fR was written by Ralph Amissah <\fIralph@amissah.com\fR>. +\fBSiSU\fR is written by Ralph Amissah <\fIralph@amissah.com\fR>. diff --git a/man/man1/sisu-po.1 b/man/man1/sisu-po.1 index dc0460bf..e8da6c16 100644 --- a/man/man1/sisu-po.1 +++ b/man/man1/sisu-po.1 @@ -1,42 +1,42 @@ -.TH SISU\-ODF 1 2011\-02\-07 3.0.0 SiSU +.TH SISU-PO 1 "2011-03-05" "2.8.1" "SiSU" .SH NAME -\fBSiSU\fR \- Structured information, Serialized Units \- a document publishing system +\fBSiSU\fR - Structured information, Serialized Units - a document publishing system .SH SYNOPSIS -\fBsisu\-odf\fR \fIsisu_document.sst\fR | \fIsisu_document.ssm\fR +\fBsisu-po\fR \fIsisu_document.sst\fR | \fIsisu_document.ssm\fR .SH DESCRIPTION \fBSiSU\fR is a lightweight markup based document structuring, publishing and search framework for document collections. .PP -The \fBsisu\-po\fR command is an alias for \fBsisu \-\-po4a\fR (or \fBsisu \-o\fR) which provided two sisu markup files of the same document in different languages produces .pot and .po output of a SiSU markup file. Experimental, and under development. +The \fBsisu-po\fR command is an alias for \fBsisu --po4a\fR (or \fBsisu -o\fR) which provided two sisu markup files of the same document in different languages produces .pot and .po output of a SiSU markup file. Experimental, and under development. .SH SEE ALSO \fIsisu\fR(1), .br -\fIsisu\-concordance\fR(1), +\fIsisu-concordance\fR(1), .br -\fIsisu\-epub\fR(1), +\fIsisu-epub\fR(1), .br -\fIsisu\-git\fR(1), +\fIsisu-git\fR(1), .br -\fIsisu\-harvest\fR(1), +\fIsisu-harvest\fR(1), .br -\fIsisu\-html\fR(1), +\fIsisu-html\fR(1), .br -\fIsisu\-odf\fR(1), +\fIsisu-odf\fR(1), .br -\fIsisu\-pdf\fR(1), +\fIsisu-pdf\fR(1), .br -\fIsisu\-pg\fR(1), +\fIsisu-pg\fR(1), .br -\fIsisu\-sqlite\fR(1), +\fIsisu-sqlite\fR(1), .br -\fIsisu\-txt\fR(1). +\fIsisu-txt\fR(1). .SH HOMEPAGE -More information about \fBSiSU\fR can be found at <\fIhttp://www.jus.uio.no/sisu/\fR>. +More information about \fBSiSU\fR can be found at <\fIhttp://www.sisudoc.org/\fR> or <\fIhttp://www.jus.uio.no/sisu/\fR>. .SH AUTHOR -\fBSiSU\fR was written by Ralph Amissah <\fIralph@amissah.com\fR>. +\fBSiSU\fR is written by Ralph Amissah <\fIralph@amissah.com\fR>. diff --git a/man/man1/sisu-sqlite.1 b/man/man1/sisu-sqlite.1 index 2916cd8a..91041900 100644 --- a/man/man1/sisu-sqlite.1 +++ b/man/man1/sisu-sqlite.1 @@ -1,41 +1,41 @@ -.TH SISU\-SQLITE 1 2010\-07\-07 2.6.0 SiSU +.TH SISU-SQLITE 1 "2011-03-05" "2.8.1" "SiSU" .SH NAME -\fBSiSU\fR \- Structured information, Serialized Units \- a document publishing system +\fBSiSU\fR - Structured information, Serialized Units - a document publishing system .SH SYNOPSIS -\fBsisu\-sqlite\fR \fIsisu_document.sst\fR | \fIsisu_document.ssm\fR +\fBsisu-sqlite\fR \fIsisu_document.sst\fR | \fIsisu_document.ssm\fR .SH DESCRIPTION \fBSiSU\fR is a lightweight markup based document structuring, publishing and search framework for document collections. .PP -The \fBsisu\-sqlite\fR command is an alias for \fBsisu \-\-sqlite\fR (or \fBsisu \-d\fR) which populates a SQLite database with SiSU content (for search) from a SiSU markup file. +The \fBsisu-sqlite\fR command is an alias for \fBsisu --sqlite\fR (or \fBsisu -d\fR) which populates a SQLite database with SiSU content (for search) from a SiSU markup file. .SH SEE ALSO \fIsisu\fR(1), .br -\fIsisu\-concordance\fR(1), +\fIsisu-concordance\fR(1), .br -\fIsisu\-epub\fR(1), +\fIsisu-epub\fR(1), .br -\fIsisu\-git\fR(1), +\fIsisu-git\fR(1), .br -\fIsisu\-harvest\fR(1), +\fIsisu-harvest\fR(1), .br -\fIsisu\-html\fR(1), +\fIsisu-html\fR(1), .br -\fIsisu\-pdf\fR(1), +\fIsisu-pdf\fR(1), .br -\fIsisu\-odf\fR(1), +\fIsisu-odf\fR(1), .br -\fIsisu\-pg\fR(1), +\fIsisu-pg\fR(1), .br -\fIsisu\-po\fR(1), +\fIsisu-po\fR(1), .br -\fIsisu\-txt\fR(1). +\fIsisu-txt\fR(1). .SH HOMEPAGE -More information about \fBSiSU\fR can be found at <\fIhttp://www.jus.uio.no/sisu/\fR>. +More information about \fBSiSU\fR can be found at <\fIhttp://www.sisudoc.org/\fR> or <\fIhttp://www.jus.uio.no/sisu/\fR>. .SH AUTHOR -\fBSiSU\fR was written by Ralph Amissah <\fIralph@amissah.com\fR>. +\fBSiSU\fR is written by Ralph Amissah <\fIralph@amissah.com\fR>. diff --git a/man/man1/sisu-txt.1 b/man/man1/sisu-txt.1 index 79c36daf..e606123a 100644 --- a/man/man1/sisu-txt.1 +++ b/man/man1/sisu-txt.1 @@ -1,41 +1,41 @@ -.TH SISU\-TXT 1 2010\-07\-07 2.6.0 SiSU +.TH SISU-TXT 1 "2011-03-05" "2.8.1" "SiSU" .SH NAME -\fBSiSU\fR \- Structured information, Serialized Units \- a document publishing system +\fBSiSU\fR - Structured information, Serialized Units - a document publishing system .SH SYNOPSIS -\fBsisu\-txt\fR \fIsisu_document.sst\fR | \fIsisu_document.ssm\fR +\fBsisu-txt\fR \fIsisu_document.sst\fR | \fIsisu_document.ssm\fR .SH DESCRIPTION \fBSiSU\fR is a lightweight markup based document structuring, publishing and search framework for document collections. .PP -The \fBsisu\-txt\fR command is an alias for \fBsisu \-\-txt\fR (or \fBsisu \-t\fR) which produces plain text output of a SiSU markup file. +The \fBsisu-txt\fR command is an alias for \fBsisu --txt\fR (or \fBsisu -t\fR) which produces plain text output of a SiSU markup file. .SH SEE ALSO \fIsisu\fR(1), .br -\fIsisu\-concordance\fR(1), +\fIsisu-concordance\fR(1), .br -\fIsisu\-epub\fR(1), +\fIsisu-epub\fR(1), .br -\fIsisu\-git\fR(1), +\fIsisu-git\fR(1), .br -\fIsisu\-harvest\fR(1), +\fIsisu-harvest\fR(1), .br -\fIsisu\-html\fR(1), +\fIsisu-html\fR(1), .br -\fIsisu\-pdf\fR(1), +\fIsisu-pdf\fR(1), .br -\fIsisu\-odf\fR(1), +\fIsisu-odf\fR(1), .br -\fIsisu\-pg\fR(1), +\fIsisu-pg\fR(1), .br -\fIsisu\-po\fR(1), +\fIsisu-po\fR(1), .br -\fIsisu\-sqlite\fR(1). +\fIsisu-sqlite\fR(1). .SH HOMEPAGE -More information about \fBSiSU\fR can be found at <\fIhttp://www.jus.uio.no/sisu/\fR>. +More information about \fBSiSU\fR can be found at <\fIhttp://www.sisudoc.org/\fR> or <\fIhttp://www.jus.uio.no/sisu/\fR>. .SH AUTHOR -\fBSiSU\fR was written by Ralph Amissah <\fIralph@amissah.com\fR>. +\fBSiSU\fR is written by Ralph Amissah <\fIralph@amissah.com\fR>. diff --git a/man/man1/sisu.1 b/man/man1/sisu.1 index 3dd8f71a..e90d76c0 100644 --- a/man/man1/sisu.1 +++ b/man/man1/sisu.1 @@ -1,22 +1,25 @@ -.TH "sisu" "1" "2010-09-17" "2.6.3" "SiSU" +.TH "sisu" "1" "2011-03-05" "2.8.1" "SiSU" .SH NAME -sisu \- documents: markup, structuring, publishing in multiple standard formats, and search +sisu - documents: markup, structuring, publishing in multiple standard formats, and search .SH SYNOPSIS -sisu [\-abcDdFehIiMmNnopqRrSsTtUuVvwXxYyZz0\-9] [filename/wildcard] +sisu [-abcDdFehIiMmNnopqRrSsTtUuVvwXxYyZz0-9] [filename/wildcard] .BR -sisu [\-Ddcv] [instruction] [filename/wildcard] +sisu [-Ddcv] [instruction] [filename/wildcard] .BR -sisu [\-CcFLSVvW] +sisu [-CcFLSVvW] .BR -sisu \-\-v2 [operations] +sisu --v2 [operations] .BR -sisu \-\-v1 [operations] +sisu --v3 [operations] + +.BR +sisu3 [operations] .SH -SISU \- MANUAL, +SISU - MANUAL, RALPH AMISSAH .BR @@ -25,7 +28,7 @@ WHAT IS SISU? .BR .SH -1. INTRODUCTION \- WHAT IS SISU? +1. INTRODUCTION - WHAT IS SISU? .BR .BR @@ -45,7 +48,7 @@ case for development is work with medium to large document sets and cope with evolving document formats/ representation technologies. Documents are prepared once, and generated as need be to update the technical presentation or add additional output formats. Various output formats (including search related -output) share a common mechanism for cross\-output\-format citation. +output) share a common mechanism for cross-output-format citation. .BR .B SiSU @@ -71,21 +74,20 @@ Source document preparation and output generation is a two step process: (i) document source is prepared, that is, marked up in sisu markup syntax and (ii) the desired output subsequently generated by running the sisu engine against document source. Output representations if updated (in the sisu engine) can be -generated by re\-running the engine against the prepared source. Using +generated by re-running the engine against the prepared source. Using .B SiSU markup applied to a document, .B SiSU custom builds (to take advantage of the strengths of different ways of representing documents) various standard open output formats including plain text, HTML, XHTML, XML, EPUB, OpenDocument, LaTeX or PDF files, and populate an -SQL database with objects[^1] (equating generally to paragraph\-sized chunks) -so searches may be performed and matches returned with that degree of -granularity ( e.g. your search criteria is met by these documents and at these -locations within each document). Document output formats share a common object -numbering system for locating content. This 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. +SQL database with objects[^1] (equating generally to paragraph-sized chunks) so +searches may be performed and matches returned with that degree of granularity +( e.g. your search criteria is met by these documents and at these locations +within each document). Document output formats share a common object numbering +system for locating content. This 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. .BR In preparing a @@ -123,7 +125,7 @@ have that old proprietary formats will remain (or can be read without proprietary software/equipment) in 15 years time, or the way the way in which html has evolved over its relatively short span of existence. .B SiSU -provides the flexibility of producing documents in multiple non\-proprietary +provides the flexibility of producing documents in multiple non-proprietary open formats including html, pdf[^5] ODF,[^6] and EPUB.[^7] Whilst .B SiSU relies on software, the markup is uncomplicated and minimalistic which @@ -148,7 +150,7 @@ which is currently under development, the html module will again be updated allowing all existing documents to be regenerated as html 5). .BR -The document formats are written to the file\-system and available for indexing +The document formats are written to the file-system and available for indexing by independent indexing tools, whether off the web like Google and Yahoo or on the site like Lucene and Hyperestraier. @@ -174,6 +176,9 @@ content prepared in . .BR +<http://www.sisudoc.org/> + +.BR <http://www.jus.uio.no/sisu> .SH @@ -186,7 +191,7 @@ content prepared in .BR .B SiSU .B SiSU -is a document publishing system, that from a simple single marked\-up +is a document publishing system, that from a simple single marked-up document, produces multiple of output formats including: plaintext, html, xhtml, XML, epub, odt (odf text), LaTeX, pdf, info, and SQL (PostgreSQL and SQLite), which share numbered text objects ("object citation numbering") and @@ -197,104 +202,104 @@ the same document structure information. For more see: 2.2 DOCUMENT PROCESSING COMMAND FLAGS .TP -.B \-a [filename/wildcard] +.B -a [filename/wildcard] produces plaintext with Unix linefeeds and without markup, (object numbers -are omitted), has footnotes at end of each paragraph that contains them [ \ \-A -\ for \ equivalent \ dos \ (linefeed) \ output \ file] [see \ \-e \ for \ -endnotes]. (Options include: \-\-endnotes for endnotes \-\-footnotes for -footnotes at the end of each paragraph \-\-unix for unix linefeed (default) -\-\-msdos for msdos linefeed) +are omitted), has footnotes at end of each paragraph that contains them [ \ -A +\ for \ equivalent \ dos \ (linefeed) \ output \ file] [see \ -e \ for \ +endnotes]. (Options include: --endnotes for endnotes --footnotes for footnotes +at the end of each paragraph --unix for unix linefeed (default) --msdos for +msdos linefeed) .TP -.B \-b [filename/wildcard] -see \-\-xhtml +.B -b [filename/wildcard] +see --xhtml .TP -.B \-\-color\-toggle [filename/wildcard] +.B --color-toggle [filename/wildcard] screen toggle ansi screen colour on or off depending on default set (unless -\-c flag is used: if sisurc colour default is set to 'true', output to screen +-c flag is used: if sisurc colour default is set to 'true', output to screen will be with colour, if sisurc colour default is set to 'false' or is undefined -screen output will be without colour). Alias \-c +screen output will be without colour). Alias -c .TP -.B \-\-concordance [filename/wildcard] +.B --concordance [filename/wildcard] produces concordance (wordmap) a rudimentary index of all the words in a document. (Concordance files are not generated for documents of over 260,000 -words unless this limit is increased in the file sisurc.yml). Alias \-w +words unless this limit is increased in the file sisurc.yml). Alias -w .TP -.B \-C [\-\-init\-site] +.B -C [--init-site] configure/initialise shared output directory files initialize shared output directory (config files such as css and dtd files are not updated if they -already exist unless modifier is used). \-C \-\-init\-site configure/initialise -site more extensive than \-C on its own, shared output directory files/force +already exist unless modifier is used). -C --init-site configure/initialise +site more extensive than -C on its own, shared output directory files/force update, existing shared output config files such as css and dtd files are updated if this modifier is used. .TP -.B \-CC +.B -CC configure/initialise shared output directory files initialize shared output directory (config files such as css and dtd files are not updated if they -already exist unless modifier is used). The equivalent of: \-C \-\-init\-site -configure/initialise site, more extensive than \-C on its own, shared output +already exist unless modifier is used). The equivalent of: -C --init-site +configure/initialise site, more extensive than -C on its own, shared output directory files/force update, existing shared output config files such as css -and dtd files are updated if \-CC is used. +and dtd files are updated if -CC is used. .TP -.B \-c [filename/wildcard] -see \-\-color\-toggle +.B -c [filename/wildcard] +see --color-toggle .TP -.B \-\-dal [filename/wildcard/url] +.B --dal [filename/wildcard/url] assumed for most other flags, creates new intermediate files for processing (document abstraction) that is used in all subsequent processing of other -output. This step is assumed for most processing flags. To skip it see \-n. -Alias \-m +output. This step is assumed for most processing flags. To skip it see -n. +Alias -m .TP -.B \-\-delete [filename/wildcard] -see \-\-zap +.B --delete [filename/wildcard] +see --zap .TP -.B \-D [instruction] [filename] -see \-\-pg +.B -D [instruction] [filename] +see --pg .TP -.B \-d [\-\-db\-[database \ type \ (sqlite|pg)]] \-\-[instruction] [filename] -see \-\-sqlite +.B -d [--db-[database \ type \ (sqlite|pg)]] --[instruction] [filename] +see --sqlite .TP -.B \-\-epub [filename/wildcard] +.B --epub [filename/wildcard] produces an epub document, [sisu \ version \ 2 \ only] (filename.epub). Alias -\-e +-e .TP -.B \-e [filename/wildcard] -see \-\-epub +.B -e [filename/wildcard] +see --epub .TP -.B \-F [\-\-webserv=webrick] -see \-\-sample\-search\-form +.B -F [--webserv=webrick] +see --sample-search-form .TP -.B \-\-git [filename/wildcard] +.B --git [filename/wildcard] produces or updates markup source file structure in a git repo (experimental -and subject to change). Alias \-g +and subject to change). Alias -g .TP -.B \-g [filename/wildcard] -see \-\-git +.B -g [filename/wildcard] +see --git .TP -.B \-\-harvest *.ss[tm] +.B --harvest *.ss[tm] makes two lists of sisu output based on the sisu markup documents in a directory: list of author and authors works (year and titles), and; list by topic with titles and author. Makes use of header metadata fields (author, -title, date, topic_register). Can be used with maintenance (\-M) and remote -placement (\-R) flags. +title, date, topic_register). Can be used with maintenance (-M) and remote +placement (-R) flags. .TP -.B \-\-help [topic] +.B --help [topic] provides help on the selected topic, where topics (keywords) include: list, (com)mands, short(cuts), (mod)ifiers, (env)ironment, markup, syntax, headers, headings, endnotes, tables, example, customise, skin, (dir)ectories, path, @@ -302,160 +307,175 @@ headings, endnotes, tables, example, customise, skin, (dir)ectories, path, features, license .TP -.B \-\-html [filename/wildcard] +.B --html [filename/wildcard] produces html output, segmented text with table of contents (toc.html and -index.html) and the document in a single file (scroll.html). Alias \-h +index.html) and the document in a single file (scroll.html). Alias -h .TP -.B \-h [filename/wildcard] -see \-\-html +.B -h [filename/wildcard] +see --html .TP -.B \-I [filename/wildcard] -see \-\-texinfo +.B -I [filename/wildcard] +see --texinfo .TP -.B \-i [filename/wildcard] -see \-\-manpage +.B -i [filename/wildcard] +see --manpage .TP -.B \-L +.B -L prints license information. .TP -.B \-\-machine [filename/wildcard/url] -see \-\-dal (document abstraction level/layer) +.B --machine [filename/wildcard/url] +see --dal (document abstraction level/layer) .TP -.B \-\-maintenance [filename/wildcard/url] +.B --maintenance [filename/wildcard/url] maintenance mode files created for processing preserved and their locations -indicated. (also see \-V). Alias \-M +indicated. (also see -V). Alias -M .TP -.B \-\-manpage [filename/wildcard] -produces man page of file, not suitable for all outputs. Alias \-i +.B --manpage [filename/wildcard] +produces man page of file, not suitable for all outputs. Alias -i .TP -.B \-M [filename/wildcard/url] -see \-\-maintenance +.B -M [filename/wildcard/url] +see --maintenance .TP -.B \-m [filename/wildcard/url] -see \-\-dal (document abstraction level/layer) +.B -m [filename/wildcard/url] +see --dal (document abstraction level/layer) .TP -.B \-\-no\-ocn -[with \ \-\-html \ \-\-pdf \ or \ \-\-epub] switches off object citation -numbering. Produce output without identifying numbers in margins of html or -LaTeX/pdf output. +.B --no-ocn +[with \ --html \ --pdf \ or \ --epub] switches off object citation numbering. +Produce output without identifying numbers in margins of html or LaTeX/pdf +output. .TP -.B \-N [filename/wildcard/url] +.B -N [filename/wildcard/url] document digest or document content certificate ( DCC ) as md5 digest tree of the document: the digest for the document, and digests for each object contained within the document (together with information on software versions -that produced it) (digest.txt). \-NV for verbose digest output to screen. +that produced it) (digest.txt). -NV for verbose digest output to screen. .TP -.B \-n [filename/wildcard/url] +.B -n [filename/wildcard/url] skip the creation of intermediate processing files (document abstraction) if -they already exist, this skips the equivalent of \-m which is otherwise assumed +they already exist, this skips the equivalent of -m which is otherwise assumed by most processing flags. .TP -.B \-\-odf [filename/wildcard/url] -see \-\-odt +.B --odf [filename/wildcard/url] +see --odt .TP -.B \-\-odt [filename/wildcard/url] +.B --odt [filename/wildcard/url] |