From 6b0a64fd28c6c0ca9bc4189ba8f3c7e2e3589746 Mon Sep 17 00:00:00 2001 From: Ralph Amissah Date: Wed, 27 Apr 2011 20:47:53 -0400 Subject: v*: manpages escaped hyphens reinstated --- man/man1/sisu-concordance.1 | 28 +- man/man1/sisu-epub.1 | 28 +- man/man1/sisu-git.1 | 26 +- man/man1/sisu-harvest.1 | 28 +- man/man1/sisu-html.1 | 28 +- man/man1/sisu-odf.1 | 28 +- man/man1/sisu-pdf.1 | 28 +- man/man1/sisu-pg.1 | 28 +- man/man1/sisu-po.1 | 28 +- man/man1/sisu-sqlite.1 | 28 +- man/man1/sisu-txt.1 | 28 +- man/man1/sisu.1 | 1092 +++++++++++++++++++++---------------------- man/man7/sisu_vim.7 | 4 +- 13 files changed, 701 insertions(+), 701 deletions(-) (limited to 'man') diff --git a/man/man1/sisu-concordance.1 b/man/man1/sisu-concordance.1 index cccb57f5..2b5a981f 100644 --- a/man/man1/sisu-concordance.1 +++ b/man/man1/sisu-concordance.1 @@ -1,38 +1,38 @@ -.TH SISU-CONCORDANCE 1 "2011-03-05" "2.8.1" "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.sisudoc.org/\fR> or <\fIhttp://www.jus.uio.no/sisu/\fR>. diff --git a/man/man1/sisu-epub.1 b/man/man1/sisu-epub.1 index ddc3e5f3..ab6a4d6e 100644 --- a/man/man1/sisu-epub.1 +++ b/man/man1/sisu-epub.1 @@ -1,38 +1,38 @@ -.TH SISU-EPUB 1 "2011-03-05" "2.8.1" "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.sisudoc.org/\fR> or <\fIhttp://www.jus.uio.no/sisu/\fR>. diff --git a/man/man1/sisu-git.1 b/man/man1/sisu-git.1 index c0d8a229..c5c612eb 100644 --- a/man/man1/sisu-git.1 +++ b/man/man1/sisu-git.1 @@ -1,36 +1,36 @@ -.TH SISU-GIT 1 "2011-03-05" "2.8.1" "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.sisudoc.org/\fR> or <\fIhttp://www.jus.uio.no/sisu/\fR>. diff --git a/man/man1/sisu-harvest.1 b/man/man1/sisu-harvest.1 index 79b1116c..3967c18e 100644 --- a/man/man1/sisu-harvest.1 +++ b/man/man1/sisu-harvest.1 @@ -1,38 +1,38 @@ -.TH SISU-HARVEST 1 "2011-03-05" "2.8.1" "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.sisudoc.org/\fR> or <\fIhttp://www.jus.uio.no/sisu/\fR>. diff --git a/man/man1/sisu-html.1 b/man/man1/sisu-html.1 index 4b5e9888..7d80cb69 100644 --- a/man/man1/sisu-html.1 +++ b/man/man1/sisu-html.1 @@ -1,38 +1,38 @@ -.TH SISU-HTML 1 "2011-03-05" "2.8.1" "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.sisudoc.org/\fR> or <\fIhttp://www.jus.uio.no/sisu/\fR>. diff --git a/man/man1/sisu-odf.1 b/man/man1/sisu-odf.1 index 8fe09344..9e3bbbba 100644 --- a/man/man1/sisu-odf.1 +++ b/man/man1/sisu-odf.1 @@ -1,38 +1,38 @@ -.TH SISU-ODF 1 "2011-03-05" "2.8.1" "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.sisudoc.org/\fR> or <\fIhttp://www.jus.uio.no/sisu/\fR>. diff --git a/man/man1/sisu-pdf.1 b/man/man1/sisu-pdf.1 index 28e9dff1..49a86ef1 100644 --- a/man/man1/sisu-pdf.1 +++ b/man/man1/sisu-pdf.1 @@ -1,38 +1,38 @@ -.TH SISU-PDF 1 "2011-03-05" "2.8.1" "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.sisudoc.org/\fR> or <\fIhttp://www.jus.uio.no/sisu/\fR>. diff --git a/man/man1/sisu-pg.1 b/man/man1/sisu-pg.1 index 55bac1b4..81125ff2 100644 --- a/man/man1/sisu-pg.1 +++ b/man/man1/sisu-pg.1 @@ -1,38 +1,38 @@ -.TH SISU-PG 1 "2011-03-05" "2.8.1" "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.sisudoc.org/\fR> or <\fIhttp://www.jus.uio.no/sisu/\fR>. diff --git a/man/man1/sisu-po.1 b/man/man1/sisu-po.1 index e8da6c16..7581369d 100644 --- a/man/man1/sisu-po.1 +++ b/man/man1/sisu-po.1 @@ -1,38 +1,38 @@ -.TH SISU-PO 1 "2011-03-05" "2.8.1" "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-po\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.sisudoc.org/\fR> or <\fIhttp://www.jus.uio.no/sisu/\fR>. diff --git a/man/man1/sisu-sqlite.1 b/man/man1/sisu-sqlite.1 index 91041900..07b68619 100644 --- a/man/man1/sisu-sqlite.1 +++ b/man/man1/sisu-sqlite.1 @@ -1,38 +1,38 @@ -.TH SISU-SQLITE 1 "2011-03-05" "2.8.1" "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.sisudoc.org/\fR> or <\fIhttp://www.jus.uio.no/sisu/\fR>. diff --git a/man/man1/sisu-txt.1 b/man/man1/sisu-txt.1 index e606123a..68d1b080 100644 --- a/man/man1/sisu-txt.1 +++ b/man/man1/sisu-txt.1 @@ -1,38 +1,38 @@ -.TH SISU-TXT 1 "2011-03-05" "2.8.1" "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.sisudoc.org/\fR> or <\fIhttp://www.jus.uio.no/sisu/\fR>. diff --git a/man/man1/sisu.1 b/man/man1/sisu.1 index 255b21a1..9f77082d 100644 --- a/man/man1/sisu.1 +++ b/man/man1/sisu.1 @@ -1,35 +1,35 @@ -.TH "sisu" "1" "2011-04-17" "3.0.7-beta-rb1.9.2p180" "SiSU" +.TH "sisu" "1" "2011\-04\-17" "3.0.7\-beta\-rb1.9.2p180" "SiSU" .br .SH NAME .br -sisu - documents: markup, structuring, publishing in multiple standard formats, and search +sisu \- documents: markup, structuring, publishing in multiple standard formats, and search .br .SH SYNOPSIS .br -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 --v3 [operations] +sisu \-\-v3 [operations] .br sisu3 [operations] -.SH SISU - MANUAL, +.SH SISU \- MANUAL, RALPH AMISSAH .br .SH WHAT IS SISU? .br -.SH 1. INTRODUCTION - WHAT IS SISU? +.SH 1. INTRODUCTION \- WHAT IS SISU? .br .br @@ -49,7 +49,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 @@ -75,14 +75,14 @@ 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 +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 @@ -126,7 +126,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 @@ -151,7 +151,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. @@ -190,7 +190,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 @@ -200,104 +200,104 @@ the same document structure information. For more see: .SH 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 +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, @@ -305,102 +305,102 @@ 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 --keep-processing-files [filename/wildcard/url] -see --maintenance +.B \-\-keep\-processing\-files [filename/wildcard/url] +see \-\-maintenance .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, interim processing files are preserved and their locations -indicated. (also see -V). Aliases -M and --keep-processing-files +indicated. (also see \-V). Aliases \-M and \-\-keep\-processing\-files .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. +.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] output basic document in opendocument file format (opendocument.odt). Alias --o +\-o .TP -.B -o [filename/wildcard/url] -see --odt +.B \-o [filename/wildcard/url] +see \-\-odt .TP -.B --pdf [filename/wildcard] +.B \-\-pdf [filename/wildcard] produces LaTeX pdf (portrait.pdf & landscape.pdf). Default paper size is set in config file, or document header, or provided with additional command line -parameter, e.g. --papersize-a4 preset sizes include: 'A4', U.S. 'letter' and -'legal' and book sizes 'A5' and 'B5' (system defaults to A4). Alias -p +parameter, e.g. \-\-papersize\-a4 preset sizes include: 'A4', U.S. 'letter' and +'legal' and book sizes 'A5' and 'B5' (system defaults to A4). Alias \-p .TP -.B --pg [instruction] [filename] -database postgresql ( --pgsql may be used instead) possible instructions, -include: --createdb; --create; --dropall; --import [filename]; --update -[filename]; --remove [filename]; see database section below. Alias -D +.B \-\-pg [instruction] [filename] +database postgresql ( \-\-pgsql may be used instead) possible instructions, +include: \-\-createdb; \-\-create; \-\-dropall; \-\-import [filename]; \-\-update +[filename]; \-\-remove [filename]; see database section below. Alias \-D .TP -.B --po [language_directory/filename \ language_directory] -see --po4a +.B \-\-po [language_directory/filename \ language_directory] +see \-\-po4a .TP -.B --po4a [language_directory/filename \ language_directory] +.B \-\-po4a [language_directory/filename \ language_directory] produces \.pot and po files for the file in the languages specified by the language directory. .B SiSU @@ -409,75 +409,75 @@ es/. The sisu config file must set the output directory structure to multilingual. v3, experimental .TP -.B -P [language_directory/filename \ language_directory] -see --po4a +.B \-P [language_directory/filename \ language_directory] +see \-\-po4a .TP -.B -p [filename/wildcard] -see --pdf +.B \-p [filename/wildcard] +see \-\-pdf .TP -.B --quiet [filename/wildcard] +.B \-\-quiet [filename/wildcard] quiet less output to screen. .TP -.B -q [filename/wildcard] -see --quiet +.B \-q [filename/wildcard] +see \-\-quiet .TP -.B --rsync [filename/wildcard] +.B \-\-rsync [filename/wildcard] copies sisu output files to remote host using rsync. This requires that sisurc.yml has been provided with information on hostname and username, and that you have your "keys" and ssh agent in place. Note the behavior of rsync -different if -R is used with other flags from if used alone. Alone the rsync ---delete parameter is sent, useful for cleaning the remote directory (when -R -is used together with other flags, it is not). Also see --scp. Alias -R +different if \-R is used with other flags from if used alone. Alone the rsync +\-\-delete parameter is sent, useful for cleaning the remote directory (when \-R +is used together with other flags, it is not). Also see \-\-scp. Alias \-R .TP -.B -R [filename/wildcard] -see --rsync +.B \-R [filename/wildcard] +see \-\-rsync .TP -.B -r [filename/wildcard] -see --scp +.B \-r [filename/wildcard] +see \-\-scp .TP -.B --sample-search-form [--webserv=webrick] +.B \-\-sample\-search\-form [\-\-webserv=webrick] generate examples of (naive) cgi search form for sqlite and pgsql depends on your already having used sisu to populate an sqlite and/or pgsql database, (the sqlite version scans the output directories for existing sisu_sqlite databases, so it is first necessary to create them, before generating the search form) see --d -D and the database section below. If the optional parameter ---webserv=webrick is passed, the cgi examples created will be set up to use the +\-d \-D and the database section below. If the optional parameter +\-\-webserv=webrick is passed, the cgi examples created will be set up to use the default port set for use by the webrick server, (otherwise the port is left blank and the system setting used, usually 80). The samples are dumped in the present work directory which must be writable, (with screen instructions given -that they be copied to the cgi-bin directory). -Fv (in addition to the above) -provides some information on setting up hyperestraier for sisu. Alias -F +that they be copied to the cgi\-bin directory). \-Fv (in addition to the above) +provides some information on setting up hyperestraier for sisu. Alias \-F .TP -.B --scp [filename/wildcard] +.B \-\-scp [filename/wildcard] copies sisu output files to remote host using scp. This requires that sisurc.yml has been provided with information on hostname and username, and -that you have your "keys" and ssh agent in place. Also see --rsync. Alias -r +that you have your "keys" and ssh agent in place. Also see \-\-rsync. Alias \-r .TP -.B --sqlite --[instruction] [filename] -database type default set to sqlite, (for which --sqlite may be used instead) -or to specify another database --db-[pgsql, \ sqlite] (however see -D) possible -instructions include: --createdb; --create; --dropall; --import [filename]; ---update [filename]; --remove [filename]; see database section below. Alias -d +.B \-\-sqlite \-\-[instruction] [filename] +database type default set to sqlite, (for which \-\-sqlite may be used instead) +or to specify another database \-\-db\-[pgsql, \ sqlite] (however see \-D) possible +instructions include: \-\-createdb; \-\-create; \-\-dropall; \-\-import [filename]; +\-\-update [filename]; \-\-remove [filename]; see database section below. Alias \-d .TP -.B --sisupod +.B \-\-sisupod produces a sisupod a zipped sisu directory of markup files including sisu markup source files and the directories local configuration file, images and skins. Note: this only includes the configuration files or skins contained in - \./_sisu not those in ~/.sisu -S [filename/wildcard] option. Note: (this option -is tested only with zsh). Alias -S + \./_sisu not those in ~/.sisu \-S [filename/wildcard] option. Note: (this option +is tested only with zsh). Alias \-S .TP -.B --sisupod [filename/wildcard] +.B \-\-sisupod [filename/wildcard] produces a zipped file of the prepared document specified along with associated images, by default named sisupod.zip they may alternatively be named with the filename extension \.ssp This provides a quick way of gathering the @@ -489,289 +489,289 @@ images and skin. commands can be run directly against a sisupod contained in a local directory, or provided as a url on a remote site. As there is a security issue with skins provided by other users, they are not applied unless the flag ---trust or --trusted is added to the command instruction, it is recommended +\-\-trust or \-\-trusted is added to the command instruction, it is recommended that file that are not your own are treated as untrusted. The directory structure of the unzipped file is understood by sisu, and sisu commands can be run within it. Note: if you wish to send multiple files, it quickly becomes more space efficient to zip the sisu markup directory, rather than the -individual files for sending). See the -S option without [filename/wildcard]. -Alias -S +individual files for sending). See the \-S option without [filename/wildcard]. +Alias \-S .TP -.B --source [filename/wildcard] -copies sisu markup file to output directory. Alias -s +.B \-\-source [filename/wildcard] +copies sisu markup file to output directory. Alias \-s .TP -.B -S -see --sisupod +.B \-S +see \-\-sisupod .TP -.B -S [filename/wildcard] -see --sisupod +.B \-S [filename/wildcard] +see \-\-sisupod .TP -.B -s [filename/wildcard] -see --source +.B \-s [filename/wildcard] +see \-\-source .TP -.B --texinfo [filename/wildcard] -produces texinfo and info file, (view with pinfo). Alias -I +.B \-\-texinfo [filename/wildcard] +produces texinfo and info file, (view with pinfo). Alias \-I .TP -.B --txt [filename/wildcard] +.B \-\-txt [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). Alias -t +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). Alias \-t .TP -.B -T [filename/wildcard \ (*.termsheet.rb)] +.B \-T [filename/wildcard \ (*.termsheet.rb)] standard form document builder, preprocessing feature .TP -.B -t [filename/wildcard] -see --txt +.B \-t [filename/wildcard] +see \-\-txt .TP -.B --urls [filename/wildcard] +.B \-\-urls [filename/wildcard] prints url output list/map for the available processing flags options and resulting files that could be requested, (can be used to get a list of processing options in relation to a file, together with information on the -output that would be produced), -u provides url output mapping for those flags +output that would be produced), \-u provides url output mapping for those flags requested for processing. The default assumes sisu_webrick is running and provides webrick url mappings where appropriate, but these can be switched to -file system paths in sisurc.yml. Alias -U +file system paths in sisurc.yml. Alias \-U .TP -.B -U [filename/wildcard] -see --urls +.B \-U [filename/wildcard] +see \-\-urls .TP -.B -u [filename/wildcard] +.B \-u [filename/wildcard] provides url mapping of output files for the flags requested for processing, -also see -U +also see \-U .TP -.B --v2 [filename/wildcard] +.B \-\-v2 [filename/wildcard] invokes the sisu v2 document parser/generator. This is the default and is normally omitted. .TP -.B --v3 [filename/wildcard] +.B \-\-v3 [filename/wildcard] invokes the sisu v3 document parser/generator. Currently under development and incomplete, v3 requires >= ruby1.9.2p180. You may run sisu3 instead. .TP -.B --verbose [filename/wildcard] +.B \-\-verbose [filename/wildcard] provides verbose output of what is being generated, where output is placed -(and error messages if any), as with -u flag provides a url mapping of files -created for each of the processing flag requests. Alias -v +(and error messages if any), as with \-u flag provides a url mapping of files +created for each of the processing flag requests. Alias \-v .TP -.B -V +.B \-V on its own, provides .B SiSU -version and environment information (sisu --help env) +version and environment information (sisu \-\-help env) .TP -.B -V [filename/wildcard] -even more verbose than the -v flag. +.B \-V [filename/wildcard] +even more verbose than the \-v flag. .TP -.B -v +.B \-v on its own, provides .B SiSU version information .TP -.B -v [filename/wildcard] -see --verbose +.B \-v [filename/wildcard] +see \-\-verbose .TP -.B --webrick +.B \-\-webrick starts ruby's webrick webserver points at sisu output directories, the default port is set to 8081 and can be changed in the resource configuration files. [tip: \ the \ webrick \ server \ requires \ link \ suffixes, \ so \ html -\ output \ should \ be \ created \ using \ the \ -h \ option \ rather \ than \ --H \ ; \ also, \ note \ -F \ webrick \ ]. Alias -W +\ output \ should \ be \ created \ using \ the \ \-h \ option \ rather \ than \ +\-H \ ; \ also, \ note \ \-F \ webrick \ ]. Alias \-W .TP -.B -W -see --webrick +.B \-W +see \-\-webrick .TP -.B --wordmap [filename/wildcard] -see --concordance +.B \-\-wordmap [filename/wildcard] +see \-\-concordance .TP -.B -w [filename/wildcard] -see --concordance +.B \-w [filename/wildcard] +see \-\-concordance .TP -.B --xhtml [filename/wildcard] -produces xhtml/XML output for browser viewing (sax parsing). Alias -b +.B \-\-xhtml [filename/wildcard] +produces xhtml/XML output for browser viewing (sax parsing). Alias \-b .TP -.B --xml-dom [filename/wildcard] +.B \-\-xml\-dom [filename/wildcard] produces XML output with deep document structure, in the nature of dom. Alias --X +\-X .TP -.B --xml-sax [filename/wildcard] -produces XML output shallow structure (sax parsing). Alias -x +.B \-\-xml\-sax [filename/wildcard] +produces XML output shallow structure (sax parsing). Alias \-x .TP -.B -X [filename/wildcard] -see --xml-dom +.B \-X [filename/wildcard] +see \-\-xml\-dom .TP -.B -x [filename/wildcard] -see --xml-sax +.B \-x [filename/wildcard] +see \-\-xml\-sax .TP -.B -Y [filename/wildcard] +.B \-Y [filename/wildcard] produces a short sitemap entry for the document, based on html output and the -sisu_manifest. --sitemaps generates/updates the sitemap index of existing +sisu_manifest. \-\-sitemaps generates/updates the sitemap index of existing sitemaps. (Experimental, [g,y,m \ announcement \ this \ week]) .TP -.B -y [filename/wildcard] +.B \-y [filename/wildcard] produces an html summary of output generated (hyperlinked to content) and document specific metadata (sisu_manifest.html). This step is assumed for most processing flags. .TP -.B --zap [filename/wildcard] +.B \-\-zap [filename/wildcard] Zap, if used with other processing flags deletes output files of the type -about to be processed, prior to processing. If -Z is used as the lone -processing related flag (or in conjunction with a combination of -[mMvVq]), -will remove the related document output directory. Alias -Z +about to be processed, prior to processing. If \-Z is used as the lone +processing related flag (or in conjunction with a combination of \-[mMvVq]), +will remove the related document output directory. Alias \-Z .TP -.B -Z [filename/wildcard] -see --zap +.B \-Z [filename/wildcard] +see \-\-zap .SH 3. COMMAND LINE MODIFIERS .br .TP -.B --no-ocn -[with \ --html \ --pdf \ or \ --epub] switches off object citation numbering. +.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 --no-annotate +.B \-\-no\-annotate strips output text of editor endnotes[^*1] denoted by asterisk or dagger/plus sign .TP -.B --no-asterisk +.B \-\-no\-asterisk strips output text of editor endnotes[^*2] denoted by asterisk sign .TP -.B --no-dagger +.B \-\-no\-dagger strips output text of editor endnotes[^+1] denoted by dagger/plus sign .SH 4. DATABASE COMMANDS .br .br -dbi - database interface +dbi \- database interface .br --D or --pgsql set for postgresql -d or --sqlite default set for sqlite -d is -modifiable with --db=[database \ type \ (pgsql \ or \ sqlite)] +\-D or \-\-pgsql set for postgresql \-d or \-\-sqlite default set for sqlite \-d is +modifiable with \-\-db=[database \ type \ (pgsql \ or \ sqlite)] .TP -.B --pg -v --createall +.B \-\-pg \-v \-\-createall initial step, creates required relations (tables, indexes) in existing postgresql database (a database should be created manually and given the same -name as working directory, as requested) (rb.dbi) [ \ -dv \ --createall \ -sqlite \ equivalent] it may be necessary to run sisu -Dv --createdb initially +name as working directory, as requested) (rb.dbi) [ \ \-dv \ \-\-createall \ +sqlite \ equivalent] it may be necessary to run sisu \-Dv \-\-createdb initially NOTE: at the present time for postgresql it may be necessary to manually create the database. The command would be 'createdb [database \ name]' where database name would be SiSU_[present \ working \ directory \ name \ (without \ path)]. Please use only alphanumerics and underscores. .TP -.B --pg -v --import -[filename/wildcard] imports data specified to postgresql db (rb.dbi) [ \ -dv -\ --import \ sqlite \ equivalent] +.B \-\-pg \-v \-\-import +[filename/wildcard] imports data specified to postgresql db (rb.dbi) [ \ \-dv +\ \-\-import \ sqlite \ equivalent] .TP -.B --pg -v --update +.B \-\-pg \-v \-\-update [filename/wildcard] updates/imports specified data to postgresql db (rb.dbi) -[ \ -dv \ --update \ sqlite \ equivalent] +[ \ \-dv \ \-\-update \ sqlite \ equivalent] .TP -.B --pg --remove -[filename/wildcard] removes specified data to postgresql db (rb.dbi) [ \ -d \ ---remove \ sqlite \ equivalent] +.B \-\-pg \-\-remove +[filename/wildcard] removes specified data to postgresql db (rb.dbi) [ \ \-d \ +\-\-remove \ sqlite \ equivalent] .TP -.B --pg --dropall -kills data" and drops (postgresql or sqlite) db, tables & indexes [ \ -d \ ---dropall \ sqlite \ equivalent] +.B \-\-pg \-\-dropall +kills data" and drops (postgresql or sqlite) db, tables & indexes [ \ \-d \ +\-\-dropall \ sqlite \ equivalent] .br -The -v is for verbose output. +The \-v is for verbose output. .SH 5. SHORTCUTS, SHORTHAND FOR MULTIPLE FLAGS .br .TP -.B --update [filename/wildcard] +.B \-\-update [filename/wildcard] Checks existing file output and runs the flags required to update this output. This means that if only html and pdf output was requested on previous -runs, only the -hp files will be applied, and only these will be generated this +runs, only the \-hp files will be applied, and only these will be generated this time, together with the summary. This can be very convenient, if you offer different outputs of different files, and just want to do the same again. .TP -.B -0 to -5 [filename \ or \ wildcard] +.B \-0 to \-5 [filename \ or \ wildcard] Default shorthand mappings (note that the defaults can be changed/configured in the sisurc.yml file): .TP -.B -0 --mNhwpAobxXyYv [this \ is \ the \ default \ action \ run \ when \ no \ +.B \-0 +\-mNhwpAobxXyYv [this \ is \ the \ default \ action \ run \ when \ no \ options \ are \ give, \ i.e. \ on \ 'sisu \ [filename]'] .TP -.B -1 --mhewpy +.B \-1 +\-mhewpy .TP -.B -2 --mhewpaoy +.B \-2 +\-mhewpaoy .TP -.B -3 --mhewpAobxXyY +.B \-3 +\-mhewpAobxXyY .TP -.B -4 --mhewpAobxXDyY --import +.B \-4 +\-mhewpAobxXDyY \-\-import .TP -.B -5 --mhewpAobxXDyY --update +.B \-5 +\-mhewpAobxXDyY \-\-update .br -add -v for verbose mode and -c for color, e.g. sisu -2vc [filename \ or \ +add \-v for verbose mode and \-c for color, e.g. sisu \-2vc [filename \ or \ wildcard] .br -consider -u for appended url info or -v for verbose output +consider \-u for appended url info or \-v for verbose output -.SH 5.1 COMMAND LINE WITH FLAGS - BATCH PROCESSING +.SH 5.1 COMMAND LINE WITH FLAGS \- BATCH PROCESSING .br -In the data directory run sisu -mh filename or wildcard eg. "sisu -h cisg.sst" -or "sisu -h *.{sst,ssm}" to produce html version of all documents. +In the data directory run sisu \-mh filename or wildcard eg. "sisu \-h cisg.sst" +or "sisu \-h *.{sst,ssm}" to produce html version of all documents. .br Running sisu (alone without any flags, filenames or wildcards) brings up the @@ -796,10 +796,10 @@ The manual can be generated from source, found respectively, either within the tarball or installed locally at: .br - ./data/doc/sisu/markup-samples/sisu_manual + ./data/doc/sisu/markup\-samples/sisu_manual .br - /usr/share/doc/sisu/markup-samples/sisu_manual + /usr/share/doc/sisu/markup\-samples/sisu_manual .br move to the respective directory and type e.g.: @@ -826,13 +826,13 @@ the sisu manual, the sources files for which are located within the tarball at: .br - ./data/doc/sisu/markup-samples/sisu_manual + ./data/doc/sisu/markup\-samples/sisu_manual .br Once installed, directory equivalent to: .br - /usr/share/doc/sisu/markup-samples/sisu_manual + /usr/share/doc/sisu/markup\-samples/sisu_manual .br Available man pages are converted back to html using man2html: @@ -852,38 +852,38 @@ An online version of the sisu man page is available here: .br * sisu.1 [^9] -.SH 6.3 SISU BUILT-IN INTERACTIVE HELP +.SH 6.3 SISU BUILT\-IN INTERACTIVE HELP .br This is particularly useful for getting the current sisu setup/environment information: .br - sisu --help + sisu \-\-help .br - sisu --help [subject] + sisu \-\-help [subject] .br - sisu --help commands + sisu \-\-help commands .br - sisu --help markup + sisu \-\-help markup .br - sisu --help env [for \ feedback \ on \ the \ way \ your \ system \ is \ + sisu \-\-help env [for \ feedback \ on \ the \ way \ your \ system \ is \ setup \ with \ regard \ to \ sisu] .br - sisu -V [environment \ information, \ same \ as \ above \ command] + sisu \-V [environment \ information, \ same \ as \ above \ command] .br sisu (on its own provides version and some help information) .br -Apart from real-time information on your current configuration the +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 +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 @@ -898,7 +898,7 @@ recognised. Enter to escape. .br .B SiSU -source documents are plaintext (UTF-8)[^11] files +source documents are plaintext (UTF\-8)[^11] files .br All paragraphs are separated by an empty line. @@ -907,7 +907,7 @@ All paragraphs are separated by an empty line. Markup is comprised of: .br -* at the top of a document, the document header made up of semantic meta-data +* at the top of a document, the document header made up of semantic meta\-data about the document and if desired additional processing instructions (such an instruction to automatically number headings from a particular level down) @@ -933,29 +933,29 @@ primary outline of the document structure. Markup of substantive text includes: * linked text and images .br - * paragraph actions, such as indent, bulleted, numbered-lists, etc. + * paragraph actions, such as indent, bulleted, numbered\-lists, etc. .br Some interactive help on markup is available, by typing sisu and selecting -markup or sisu --help markup +markup or sisu \-\-help markup .br To check the markup in a file: .br - sisu --identify [filename].sst + sisu \-\-identify [filename].sst .br For brief descriptive summary of markup history .br - sisu --query-history + sisu \-\-query\-history .br or if for a particular version: .br - sisu --query-0.38 + sisu \-\-query\-0.38 .SH 7.2 MARKUP EXAMPLES @@ -980,15 +980,15 @@ an alternative presentation of markup syntax: .br With .B SiSU -installed sample skins may be found in: /usr/share/doc/sisu/markup-samples -(or equivalent directory) and if sisu-markup-samples is installed also under: -/usr/share/doc/sisu/markup-samples-non-free +installed sample skins may be found in: /usr/share/doc/sisu/markup\-samples +(or equivalent directory) and if sisu\-markup\-samples is installed also under: +/usr/share/doc/sisu/markup\-samples\-non\-free .SH 8. MARKUP OF HEADERS .br .br -Headers contain either: semantic meta-data about a document, which can be used +Headers contain either: semantic meta\-data about a document, which can be used by any output module of the program, or; processing instructions. .br @@ -1021,23 +1021,23 @@ to this one: citation systems, search % used_by: manual @date: - :published: 2008-05-22 - :created: 2002-08-28 - :issued: 2002-08-28 - :available: 2002-08-28 - :modified: 2010-03-03 + :published: 2008\-05\-22 + :created: 2002\-08\-28 + :issued: 2002\-08\-28 + :available: 2002\-08\-28 + :modified: 2010\-03\-03 @make: :num_top: 1 :breaks: new=C; break=1 :skin: skin_sisu_manual :bold: /Gnu|Debian|Ruby|SiSU/ - :manpage: name=sisu - documents: markup, structuring, publishing + :manpage: name=sisu \- documents: markup, structuring, publishing in multiple standard formats, and search; - synopsis=sisu \ [-abcDdeFhIiMmNnopqRrSsTtUuVvwXxYyZz0-9] \ [filename/wildcard \ ] - . sisu \ [-Ddcv] \ [instruction] - . sisu \ [-CcFLSVvW] - . sisu --v2 \ [operations] - . sisu --v3 \ [operations] + synopsis=sisu \ [\-abcDdeFhIiMmNnopqRrSsTtUuVvwXxYyZz0\-9] \ [filename/wildcard \ ] + . sisu \ [\-Ddcv] \ [instruction] + . sisu \ [\-CcFLSVvW] + . sisu \-\-v2 \ [operations] + . sisu \-\-v3 \ [operations] @links: { SiSU Homepage }http://www.sisudoc.org/ { SiSU Manual }http://www.sisudoc.org/sisu/sisu_manual/ @@ -1077,7 +1077,7 @@ structure, and can be useful to know. This is a sample header .nf - % SiSU 2.0 \ [declared \ file-type \ identifier \ with \ markup \ version] + % SiSU 2.0 \ [declared \ file\-type \ identifier \ with \ markup \ version] .fi .nf @@ -1096,14 +1096,14 @@ This is a sample header .nf @date: - :published: \ [year \ or \ yyyy-mm-dd] - :created: \ [year \ or \ yyyy-mm-dd] - :issued: \ [year \ or \ yyyy-mm-dd] - :available: \ [year \ or \ yyyy-mm-dd] - :modified: \ [year \ or \ yyyy-mm-dd] - :valid: \ [year \ or \ yyyy-mm-dd] - :added_to_site: \ [year \ or \ yyyy-mm-dd] - :translated: \ [year \ or \ yyyy-mm-dd] + :published: \ [year \ or \ yyyy\-mm\-dd] + :created: \ [year \ or \ yyyy\-mm\-dd] + :issued: \ [year \ or \ yyyy\-mm\-dd] + :available: \ [year \ or \ yyyy\-mm\-dd] + :modified: \ [year \ or \ yyyy\-mm\-dd] + :valid: \ [year \ or \ yyyy\-mm\-dd] + :added_to_site: \ [year \ or \ yyyy\-mm\-dd] + :translated: \ [year \ or \ yyyy\-mm\-dd] .fi .nf @@ -1165,10 +1165,10 @@ This is a sample header .SH 9.1 HEADING LEVELS .br -Heading levels are :A~ ,:B~ ,:C~ ,1~ ,2~ ,3~ \... :A - :C being part / section -headings, followed by other heading levels, and 1 -6 being headings followed by -substantive text or sub-headings. :A~ usually the title :A~? conditional level -1 heading (used where a stand-alone document may be imported into another) +Heading levels are :A~ ,:B~ ,:C~ ,1~ ,2~ ,3~ \... :A \- :C being part / section +headings, followed by other heading levels, and 1 \-6 being headings followed by +substantive text or sub\-headings. :A~ usually the title :A~? conditional level +1 heading (used where a stand\-alone document may be imported into another) .br .B :A~ [heading \ text] @@ -1186,7 +1186,7 @@ Third level heading [this \ is \ a \ heading \ level \ divider] .br .B 1~ [heading \ text] -Top level heading preceding substantive text of document or sub-heading 2, +Top level heading preceding substantive text of document or sub\-heading 2, the heading level that would normally be marked 1. or 2. or 3. etc. in a document, and the level on which sisu by default would break html output into named segments, names are provided automatically if none are given (a number), @@ -1194,7 +1194,7 @@ otherwise takes the form 1~my_filename_for_this_segment .br .B 2~ [heading \ text] -Second level heading preceding substantive text of document or sub-heading 3 +Second level heading preceding substantive text of document or sub\-heading 3 , the heading level that would normally be marked 1.1 or 1.2 or 1.3 or 2.1 etc. in a document. @@ -1217,7 +1217,7 @@ normally be marked 1.1.1 or 1.1.2 or 1.2.1 or 2.1.1 etc. in a document .nf normal text, *{emphasis}*, !{bold text}!, /{italics}/, _{underscore}_, "{citation}", - ^{superscript}^, ,{subscript},, +{inserted text}+, -{strikethrough}-, #{monospace}# + ^{superscript}^, ,{subscript},, +{inserted text}+, \-{strikethrough}\-, #{monospace}# normal text .br *{emphasis}* \ [note: \ can \ be \ configured \ to \ be \ represented \ by \ bold, \ italics \ or \ underscore] @@ -1236,7 +1236,7 @@ normally be marked 1.1.1 or 1.1.2 or 1.2.1 or 2.1.1 etc. in a document .br +{inserted text}+ .br - \-{strikethrough}\- + \\-{strikethrough}\\- .br #{monospace}# .fi @@ -1254,7 +1254,7 @@ normal text, , .I underscore , "citation", ^superscript^, [subscript], ++inserted text++, ---strikethrough--, monospace +\-\-strikethrough\-\-, monospace .br normal text @@ -1286,7 +1286,7 @@ normal text ++inserted text++ .br ---strikethrough-- +\-\-strikethrough\-\- .br monospace @@ -1470,7 +1470,7 @@ An escaped url without decoration .nf normal text _http://www.sisudoc.org/ continues - deb http://www.jus.uio.no/sisu/archive unstable main non-free + deb http://www.jus.uio.no/sisu/archive unstable main non\-free .fi .br @@ -1480,7 +1480,7 @@ An escaped url without decoration normal text <_http://www.sisudoc.org/> continues .br -deb <_http://www.jus.uio.no/sisu/archive> unstable main non-free +deb <_http://www.jus.uio.no/sisu/archive> unstable main non\-free .br where a code block is used there is neither decoration nor hyperlinking, code @@ -1490,9 +1490,9 @@ blocks are discussed later in this document .B resulting output: .nf - deb http://www.jus.uio.no/sisu/archive unstable main non-free + deb http://www.jus.uio.no/sisu/archive unstable main non\-free .br - deb-src http://www.jus.uio.no/sisu/archive unstable main non-free + deb\-src http://www.jus.uio.no/sisu/archive unstable main non\-free .fi .SH 9.5.2 LINKING TEXT @@ -1543,10 +1543,10 @@ about SiSU [^14] markup {tux.png 64x80 "a better way" }http://www.sisudoc.org/ .br .br - {GnuDebianLinuxRubyBetterWay.png 100x101 "Way Better - with Gnu/Linux, Debian and Ruby" }http://www.sisudoc.org/ + {GnuDebianLinuxRubyBetterWay.png 100x101 "Way Better \- with Gnu/Linux, Debian and Ruby" }http://www.sisudoc.org/ .br .br - {~^ ruby_logo.png "Ruby" }http://www.ruby-lang.org/en/ + {~^ ruby_logo.png "Ruby" }http://www.ruby\-lang.org/en/ .br .br .fi @@ -1558,13 +1558,13 @@ about SiSU [^14] markup [ tux.png ] .br -tux.png 64x80 "Gnu/Linux - a better way" +tux.png 64x80 "Gnu/Linux \- a better way" .br [ \ ruby_logo \ (png \ missing) \ ] [^15] .br -GnuDebianLinuxRubyBetterWay.png 100x101 "Way Better - with Gnu/Linux, Debian +GnuDebianLinuxRubyBetterWay.png 100x101 "Way Better \- with Gnu/Linux, Debian and Ruby" .br @@ -1573,7 +1573,7 @@ and Ruby" .nf {~^ \ [text \ to \ link] }http://url.org % maps to: { \ [text \ to \ link] }http://url.org ~{ http://url.org }~ - % which produces hyper-linked text within a document/paragraph, + % which produces hyper\-linked text within a document/paragraph, % with an endnote providing the url for the text location used in the hyperlink .fi @@ -1584,7 +1584,7 @@ and Ruby" .br note at a heading level the same is automatically achieved by providing names to headings 1, 2 and 3 i.e. 2~[name] and 3~[name] or in the case of -auto-heading numbering, without further intervention. +auto\-heading numbering, without further intervention. .SH 9.6 GROUPED TEXT @@ -1621,7 +1621,7 @@ information in each column [^16] .nf - !_ Table 3.1: Contributors to Wikipedia, January 2001 - June 2005 + !_ Table 3.1: Contributors to Wikipedia, January 2001 \- June 2005 {table~h 24; 12; 12; 12; 12; 12; 12;} |Jan. 2001|Jan. 2002|Jan. 2003|Jan. 2004|July 2004|June 2006 Contributors* | 10| 472| 2,188| 9,653| 25,011| 48,721 @@ -1636,7 +1636,7 @@ information in each column .B resulting output: .br -.B Table 3.1: Contributors to Wikipedia, January 2001 - June 2005 +.B Table 3.1: Contributors to Wikipedia, January 2001 \- June 2005 [table omitted, see other document formats] @@ -1669,7 +1669,7 @@ than 100 times in last month. both go to law: I will prosecute - YOU. --Come, + YOU. \-\-Come, I'll take no denial; We must have a @@ -1727,7 +1727,7 @@ than 100 times in last month. .br prosecute .br - YOU. --Come, + YOU. \-\-Come, .br I'll take no .br @@ -1829,7 +1829,7 @@ than 100 times in last month. both go to law: I will prosecute - YOU. --Come, + YOU. \-\-Come, I'll take no denial; We must have a @@ -1887,7 +1887,7 @@ than 100 times in last month. .br prosecute .br - YOU. --Come, + YOU. \-\-Come, .br I'll take no .br @@ -1971,7 +1971,7 @@ markup. You cannot however use code tags to escape code tags. They are however used in the same way as group or poem tags. .br -A code-block is treated as an object and given a single object number. [an \ +A code\-block is treated as an object and given a single object number. [an \ option \ to \ number \ each \ line \ of \ code \ may \ be \ considered \ at \ some \ later \ time] @@ -1987,7 +1987,7 @@ some \ later \ time] both go to law: I will prosecute - YOU. --Come, + YOU. \-\-Come, I'll take no denial; We must have a @@ -2040,7 +2040,7 @@ tag code{# as demonstrated here: 6 | both go to 7 | law: I will 8 | prosecute -9 | YOU. --Come, +9 | YOU. \-\-Come, 10 | I'll take no 11 | denial; We 12 | must have a @@ -2085,12 +2085,12 @@ To make an index append to paragraph the book index term relates to it, using an equal sign and curly braces. .br -Currently two levels are provided, a main term and if needed a sub-term. -Sub-terms are separated from the main term by a colon. +Currently two levels are provided, a main term and if needed a sub\-term. +Sub\-terms are separated from the main term by a colon. .nf - Paragraph containing main term and sub-term. - ={Main term:sub-term} + Paragraph containing main term and sub\-term. + ={Main term:sub\-term} .fi .br @@ -2102,7 +2102,7 @@ The structure of the resulting index would be: .nf Main term, 1 - sub-term, 1 + sub\-term, 1 .fi .br @@ -2110,8 +2110,8 @@ Several terms may relate to a paragraph, they are separated by a semicolon. If the term refers to more than one paragraph, indicate the number of paragraphs. .nf - Paragraph containing main term, second term and sub-term. - ={first term; second term: sub-term} + Paragraph containing main term, second term and sub\-term. + ={first term; second term: sub\-term} .fi .br @@ -2120,27 +2120,27 @@ The structure of the resulting index would be: .nf First term, 1, Second term, 1, - sub-term, 1 + sub\-term, 1 .fi .br -If multiple sub-terms appear under one paragraph, they are separated under the +If multiple sub\-terms appear under one paragraph, they are separated under the main term heading from each other by a pipe symbol. .nf - Paragraph containing main term, second term and sub-term. - ={Main term:sub-term+1|second sub-term - A paragraph that continues discussion of the first sub-term + Paragraph containing main term, second term and sub\-term. + ={Main term:sub\-term+1|second sub\-term + A paragraph that continues discussion of the first sub\-term .fi .br -The plus one in the example provided indicates the first sub-term spans one +The plus one in the example provided indicates the first sub\-term spans one additional paragraph. The logical structure of the resulting index would be: .nf Main term, 1, - sub-term, 1-3, - second sub-term, 1, + sub\-term, 1\-3, + second sub\-term, 1, .fi .SH 10. COMPOSITE DOCUMENTS MARKUP @@ -2189,7 +2189,7 @@ documents under consideration, and occasionally supported have been. .SH MARKUP SYNTAX HISTORY .br -.SH 11. NOTES RELATED TO FILES-TYPES AND MARKUP SYNTAX +.SH 11. NOTES RELATED TO FILES\-TYPES AND MARKUP SYNTAX .br 2.0 introduced new headers and is therefore incompatible with 1.0 though @@ -2202,7 +2202,7 @@ otherwise the same with the addition of a couple of tags (i.e. a superset) depreciated 0.16 supported, though file names were changed at 0.37 .br -* sisu --query=[sisu \ version \ [0.38] or 'history] +* sisu \-\-query=[sisu \ version \ [0.38] or 'history] .br provides a short history of changes to @@ -2211,7 +2211,7 @@ markup .br .B SiSU 2.0 -(2010-03-06:09/6) same as 1.0, apart from the changing of headers and the +(2010\-03\-06:09/6) same as 1.0, apart from the changing of headers and the addition of a monospace tag related headers now grouped, e.g. .nf @@ -2229,7 +2229,7 @@ addition of a monospace tag related headers now grouped, e.g. .fi .br -see document markup samples, and sisu --help headers +see document markup samples, and sisu \-\-help headers .br the monospace tag takes the form of a hash '#' @@ -2240,11 +2240,11 @@ the monospace tag takes the form of a hash '#' .br .B 1.0 -(2009-12-19:50/6) same as 0.69 +(2009\-12\-19:50/6) same as 0.69 .br .B 0.69 -(2008-09-16:37/2) (same as 1.0) and as previous (0.57) with the addition of +(2008\-09\-16:37/2) (same as 1.0) and as previous (0.57) with the addition of book index tags .nf @@ -2252,7 +2252,7 @@ book index tags .fi .br -e.g. appended to a paragraph, on a new-line (without a blank line in between) +e.g. appended to a paragraph, on a new\-line (without a blank line in between) logical structure produced assuming this is the first text "object" .nf @@ -2260,20 +2260,20 @@ logical structure produced assuming this is the first text "object" .fi .nf - Free Software Foundation, 1-6 + Free Software Foundation, 1\-6 GNU/Linux community distribution, 1 - Debian, 1-3 + Debian, 1\-3 Fedora, 1 Gentoo, .fi .br .B 0.66 -(2008-02-24:07/7) same as previous, adds semantic tags, [experimental \ and \ -not-used] +(2008\-02\-24:07/7) same as previous, adds semantic tags, [experimental \ and \ +not\-used] .nf - /[:;]{.+?}[:;][a-z+]/ + /[:;]{.+?}[:;][a\-z+]/ .fi .br @@ -2307,7 +2307,7 @@ or, backward compatible using the comment marker: .br variations include ' .B SiSU -(text|master|insert) [version]' and 'sisu-[version]' +(text|master|insert) [version]' and 'sisu\-[version]' .br .B 0.51 @@ -2379,8 +2379,8 @@ The internal document markup of .br .B SiSU -has in effect two sets of levels to be considered, using 0.38 notation A-C -headings/levels, pre-ordinary paragraphs /pre-substantive text, and 1-3 +has in effect two sets of levels to be considered, using 0.38 notation A\-C +headings/levels, pre\-ordinary paragraphs /pre\-substantive text, and 1\-3 headings/levels, levels which are followed by ordinary text. This may be conceptualised as levels A,B,C, 1,2,3, and using such letter number notation, in effect: A must exist, optional B and C may follow in sequence (not strict) 1 @@ -2424,7 +2424,7 @@ The internal document markup remains unchanged, from .br .B 0.23 -(2005w36/2) utf-8 for markup file +(2005w36/2) utf\-8 for markup file .br .B 0.22 @@ -2438,7 +2438,7 @@ relied upon .br .B 0.16 (2005w25/2) substantial changes introduced to make markup cleaner, header -0~title type, and headings [1-6]~ introduced, also percentage sign (%) at start +0~title type, and headings [1\-6]~ introduced, also percentage sign (%) at start of a text line as comment marker .br @@ -2467,7 +2467,7 @@ has plaintext and binary filetypes, and can process either type of document. .br .B SiSU -documents are prepared as plain-text (utf-8) files with +documents are prepared as plain\-text (utf\-8) files with .B SiSU markup. They may make reference to and contain images (for example), which are stored in the directory beneath them _sisu/image. @@ -2488,9 +2488,9 @@ located locally or on a remote server for which a url is provided. source markup can be shared with the command: .br - sisu -s [filename] + sisu \-s [filename] -.SH 12.1.1 SISU TEXT - REGULAR FILES (.SST) +.SH 12.1.1 SISU TEXT \- REGULAR FILES (.SST) .br The most common form of document in @@ -2558,13 +2558,13 @@ A sisupod is a zipped text file or set of .B SiSU text files and any associated images that they contain (this will be extended -to include sound and multimedia-files) +to include sound and multimedia\-files) .br .B SiSU plaintext files rely on a recognised directory structure to find contents such as images associated with documents, but all images for example for all -documents contained in a directory are located in the sub-directory +documents contained in a directory are located in the sub\-directory _sisu/image. Without the ability to create a sisupod it can be inconvenient to manually identify all other files associated with a document. A sisupod automatically bundles all associated files with the document that is turned @@ -2582,13 +2582,13 @@ documents. The command to create a sisupod is: .br - sisu -S [filename] + sisu \-S [filename] .br Alternatively, make a pod of the contents of a whole directory: .br - sisu -S + sisu \-S .br .B SiSU @@ -2616,25 +2616,25 @@ incomplete and should be handled with care. .B convert from sst to simple xml representations (sax, dom and node): .br - sisu --to-sax [filename/wildcard] or sisu --to-sxs [filename/wildcard] + sisu \-\-to\-sax [filename/wildcard] or sisu \-\-to\-sxs [filename/wildcard] .br - sisu --to-dom [filename/wildcard] or sisu --to-sxd [filename/wildcard] + sisu \-\-to\-dom [filename/wildcard] or sisu \-\-to\-sxd [filename/wildcard] .br - sisu --to-node [filename/wildcard] or sisu --to-sxn [filename/wildcard] + sisu \-\-to\-node [filename/wildcard] or sisu \-\-to\-sxn [filename/wildcard] .br .B convert to sst from any sisu xml representation (sax, dom and node): .br - sisu --from-xml2sst [filename/wildcard \ [.sxs.xml,.sxd.xml,sxn.xml]] + sisu \-\-from\-xml2sst [filename/wildcard \ [.sxs.xml,.sxd.xml,sxn.xml]] .br or the same: .br - sisu --from-sxml [filename/wildcard \ [.sxs.xml,.sxd.xml,sxn.xml]] + sisu \-\-from\-sxml [filename/wildcard \ [.sxs.xml,.sxd.xml,sxn.xml]] .SH 13.1.1 XML SAX REPRESENTATION @@ -2642,19 +2642,19 @@ or the same: To convert from sst to simple xml (sax) representation: .br - sisu --to-sax [filename/wildcard] or sisu --to-sxs [filename/wildcard] + sisu \-\-to\-sax [filename/wildcard] or sisu \-\-to\-sxs [filename/wildcard] .br To convert from any sisu xml representation back to sst .br - sisu --from-xml2sst [filename/wildcard \ [.sxs.xml,.sxd.xml,sxn.xml]] + sisu \-\-from\-xml2sst [filename/wildcard \ [.sxs.xml,.sxd.xml,sxn.xml]] .br or the same: .br - sisu --from-sxml [filename/wildcard \ [.sxs.xml,.sxd.xml,sxn.xml]] + sisu \-\-from\-sxml [filename/wildcard \ [.sxs.xml,.sxd.xml,sxn.xml]] .SH 13.1.2 XML DOM REPRESENTATION @@ -2662,19 +2662,19 @@ or the same: To convert from sst to simple xml (dom) representation: .br - sisu --to-dom [filename/wildcard] or sisu --to-sxd [filename/wildcard] + sisu \-\-to\-dom [filename/wildcard] or sisu \-\-to\-sxd [filename/wildcard] .br To convert from any sisu xml representation back to sst .br - sisu --from-xml2sst [filename/wildcard \ [.sxs.xml,.sxd.xml,sxn.xml]] + sisu \-\-from\-xml2sst [filename/wildcard \ [.sxs.xml,.sxd.xml,sxn.xml]] .br or the same: .br - sisu --from-sxml [filename/wildcard \ [.sxs.xml,.sxd.xml,sxn.xml]] + sisu \-\-from\-sxml [filename/wildcard \ [.sxs.xml,.sxd.xml,sxn.xml]] .SH 13.1.3 XML NODE REPRESENTATION @@ -2682,19 +2682,19 @@ or the same: To convert from sst to simple xml (node) representation: .br - sisu --to-node [filename/wildcard] or sisu --to-sxn [filename/wildcard] + sisu \-\-to\-node [filename/wildcard] or sisu \-\-to\-sxn [filename/wildcard] .br To convert from any sisu xml representation back to sst .br - sisu --from-xml2sst [filename/wildcard \ [.sxs.xml,.sxd.xml,sxn.xml]] + sisu \-\-from\-xml2sst [filename/wildcard \ [.sxs.xml,.sxd.xml,sxn.xml]] .br or the same: .br - sisu --from-sxml [filename/wildcard \ [.sxs.xml,.sxd.xml,sxn.xml]] + sisu \-\-from\-sxml [filename/wildcard \ [.sxs.xml,.sxd.xml,sxn.xml]] .SH 14. CONFIGURATION .br @@ -2707,13 +2707,13 @@ Information on the current configuration of should be available with the help command: .br - sisu -v + sisu \-v .br which is an alias for: .br - sisu --help env + sisu \-\-help env .br Either of these should be executed from within a directory that contains sisu @@ -2781,7 +2781,7 @@ directory, or site wide basis. Skins are looked for in the following locations: .br .B Within the skin directory -are the following the default sub-directories for document skins: +are the following the default sub\-directories for document skins: .br ./skin/doc @@ -2836,23 +2836,23 @@ installed sample skins may be found in: .br /etc/sisu/skin/doc and - /usr/share/doc/sisu/markup-samples/samples/_sisu/skin/doc + /usr/share/doc/sisu/markup\-samples/samples/_sisu/skin/doc .br -(or equivalent directory) and if sisu-markup-samples is installed also under: +(or equivalent directory) and if sisu\-markup\-samples is installed also under: .br - /usr/share/doc/sisu/markup-samples-non-free/samples/_sisu/skin/doc + /usr/share/doc/sisu/markup\-samples\-non\-free/samples/_sisu/skin/doc .br Samples of list.yml and promo.yml (which are used to create the right column list) may be found in: .br - /usr/share/doc/sisu/markup-samples-non-free/samples/_sisu/skin/yml (or + /usr/share/doc/sisu/markup\-samples\-non\-free/samples/_sisu/skin/yml (or equivalent directory) -.SH 16. CSS - CASCADING STYLE SHEETS (FOR HTML, XHTML AND XML) +.SH 16. CSS \- CASCADING STYLE SHEETS (FOR HTML, XHTML AND XML) .br .br @@ -2860,7 +2860,7 @@ CSS files to modify the appearance of .B SiSU html, XHTML or XML may be placed in the configuration directory: \./_sisu/css ; ~/.sisu/css or; /etc/sisu/css and these will be copied to the output -directories with the command sisu -CC. +directories with the command sisu \-CC. .br The basic CSS file for html output is html.css, placing a file of that name in @@ -2903,7 +2903,7 @@ subdirectory of the same name as the document with the filetype identifier stripped (.sst \.ssm) .br -The last part of a directory path, representing the sub-directory in which a +The last part of a directory path, representing the sub\-directory in which a document set resides, is the directory name that will be used for the output directory. This has implications for the organisation of document collections as it could make sense to place documents of a particular subject, or type @@ -2923,7 +2923,7 @@ appearance. .br .B SiSU -is about the ability to auto-generate documents. Home pages are regarded as +is about the ability to auto\-generate documents. Home pages are regarded as custom built items, and are not created by .B SiSU . More accurately, @@ -2945,7 +2945,7 @@ Document sets are contained in directories, usually organised by site or subject. Each directory can/should have its own homepage. See the section on directory structure and organisation of content. -.SH 18.1 HOME PAGE AND OTHER CUSTOM BUILT PAGES IN A SUB-DIRECTORY +.SH 18.1 HOME PAGE AND OTHER CUSTOM BUILT PAGES IN A SUB\-DIRECTORY .br Custom built pages, including the home page index.html may be placed within the @@ -2954,7 +2954,7 @@ for the configuration directory, namely \./_sisu ; ~/_sisu ; /etc/sisu From there they are copied to the root of the output directory with the command: .br - sisu -CC + sisu \-CC .SH 18.2 HOME PAGE WITHIN A SKIN @@ -3001,7 +3001,7 @@ For some documents hardly any markup at all is required at all, other than a header, and an indication that the levels to be taken into account by the program in generating its output are. -.SH 20. SISU SEARCH - INTRODUCTION +.SH 20. SISU SEARCH \- INTRODUCTION .br .br @@ -3047,14 +3047,14 @@ four tables: subject, (the Dublin Core...); .br - * another the substantive texts by individual "paragraph" (or object) - along + * another the substantive texts by individual "paragraph" (or object) \- along with structural information, each paragraph being identifiable by its paragraph number (if it has one which almost all of them do), and the substantive text of each paragraph quite naturally being searchable (both in formatted and clean text versions for searching); and .br - * a third containing endnotes cross-referenced back to the paragraph from + * a third containing endnotes cross\-referenced back to the paragraph from which they are referenced (both in formatted and clean text versions for searching). @@ -3097,7 +3097,7 @@ that as well). .br .B SiSU -- Structured information, Serialized Units - a document publishing system, +\- Structured information, Serialized Units \- a document publishing system, postgresql dependency package .SH 22.2 DESCRIPTION @@ -3109,67 +3109,67 @@ dependencies needed for .B SiSU to populate a postgresql database, this being part of .B SiSU -- man sisu). +\- man sisu). .SH 22.3 SYNOPSIS .br - sisu -D [instruction] [filename/wildcard \ if \ required] + sisu \-D [instruction] [filename/wildcard \ if \ required] .br - sisu -D --pg --[instruction] [filename/wildcard \ if \ required] + sisu \-D \-\-pg \-\-[instruction] [filename/wildcard \ if \ required] .SH 22.4 COMMANDS .br Mappings to two databases are provided by default, postgresql and sqlite, the same commands are used within sisu to construct and populate databases however --d (lowercase) denotes sqlite and -D (uppercase) denotes postgresql, -alternatively --sqlite or --pgsql may be used +\-d (lowercase) denotes sqlite and \-D (uppercase) denotes postgresql, +alternatively \-\-sqlite or \-\-pgsql may be used .br -.B -D or --pgsql +.B \-D or \-\-pgsql may be used interchangeably. .SH 22.4.1 CREATE AND DESTROY DATABASE .TP -.B --pgsql --createall +.B \-\-pgsql \-\-createall initial step, creates required relations (tables, indexes) in existing (postgresql) database (a database should be created manually and given the same name as working directory, as requested) (rb.dbi) .TP -.B sisu -D --createdb +.B sisu \-D \-\-createdb creates database where no database existed before .TP -.B sisu -D --create +.B sisu \-D \-\-create creates database tables where no database tables existed before .TP -.B sisu -D --Dropall +.B sisu \-D \-\-Dropall destroys database (including all its content)! kills data and drops tables, indexes and database associated with a given directory (and directories of the same name). .TP -.B sisu -D --recreate +.B sisu \-D \-\-recreate destroys existing database and builds a new empty database structure .SH 22.4.2 IMPORT AND REMOVE DOCUMENTS .TP -.B sisu -D --import -v [filename/wildcard] +.B sisu \-D \-\-import \-v [filename/wildcard] populates database with the contents of the file. Imports documents(s) specified to a postgresql database (at an object level). .TP -.B sisu -D --update -v [filename/wildcard] +.B sisu \-D \-\-update \-v [filename/wildcard] updates file contents in database .TP -.B sisu -D --remove -v [filename/wildcard] +.B sisu \-D \-\-remove \-v [filename/wildcard] removes specified document from postgresql database. .SH 23. SQLITE @@ -3179,7 +3179,7 @@ removes specified document from postgresql database. .br .B SiSU -- Structured information, Serialized Units - a document publishing system. +\- Structured information, Serialized Units \- a document publishing system. .SH 23.2 DESCRIPTION @@ -3189,78 +3189,78 @@ dependency package, which is a dummy package to install dependencies needed for .B SiSU to populate an sqlite database, this being part of .B SiSU -- man sisu). +\- man sisu). .SH 23.3 SYNOPSIS .br - sisu -d [instruction] [filename/wildcard \ if \ required] + sisu \-d [instruction] [filename/wildcard \ if \ required] .br - sisu -d --(sqlite|pg) --[instruction] [filename/wildcard \ if \ required] + sisu \-d \-\-(sqlite|pg) \-\-[instruction] [filename/wildcard \ if \ required] .SH 23.4 COMMANDS .br Mappings to two databases are provided by default, postgresql and sqlite, the same commands are used within sisu to construct and populate databases however --d (lowercase) denotes sqlite and -D (uppercase) denotes postgresql, -alternatively --sqlite or --pgsql may be used +\-d (lowercase) denotes sqlite and \-D (uppercase) denotes postgresql, +alternatively \-\-sqlite or \-\-pgsql may be used .br -.B -d or --sqlite +.B \-d or \-\-sqlite may be used interchangeably. .SH 23.4.1 CREATE AND DESTROY DATABASE .TP -.B --sqlite --createall +.B \-\-sqlite \-\-createall initial step, creates required relations (tables, indexes) in existing (sqlite) database (a database should be created manually and given the same name as working directory, as requested) (rb.dbi) .TP -.B sisu -d --createdb +.B sisu \-d \-\-createdb creates database where no database existed before .TP -.B sisu -d --create +.B sisu \-d \-\-create creates database tables where no database tables existed before .TP -.B sisu -d --dropall +.B sisu \-d \-\-dropall destroys database (including all its content)! kills data and drops tables, indexes and database associated with a given directory (and directories of the same name). .TP -.B sisu -d --recreate +.B sisu \-d \-\-recreate destroys existing database and builds a new empty database structure .SH 23.4.2 IMPORT AND REMOVE DOCUMENTS .TP -.B sisu -d --import -v [filename/wildcard] +.B sisu \-d \-\-import \-v [filename/wildcard] populates database with the contents of the file. Imports documents(s) specified to an sqlite database (at an object level). .TP -.B sisu -d --update -v [filename/wildcard] +.B sisu \-d \-\-update \-v [filename/wildcard] updates file contents in database .TP -.B sisu -d --remove -v [filename/wildcard] +.B sisu \-d \-\-remove \-v [filename/wildcard] removes specified document from sqlite database. .SH 24. INTRODUCTION .br -.SH 24.1 SEARCH - DATABASE FRONTEND SAMPLE, UTILISING DATABASE AND SISU FEATURES, +.SH 24.1 SEARCH \- DATABASE FRONTEND SAMPLE, UTILISING DATABASE AND SISU FEATURES, INCLUDING OBJECT CITATION NUMBERING (BACKEND CURRENTLY POSTGRESQL) .br Sample search frontend [^21] A small database and -sample query front-end (search from) that makes use of the citation system, +sample query front\-end (search from) that makes use of the citation system, .I object citation numbering to demonstrates functionality.[^22] @@ -3280,7 +3280,7 @@ the names of the documents matched along with the objects (paragraphs) that meet the search criteria.[^23] .TP -.B sisu -F --webserv-webrick +.B sisu \-F \-\-webserv\-webrick builds a cgi web search frontend for the database created .br @@ -3288,7 +3288,7 @@ The following is feedback on the setup on a machine provided by the help command: .br - sisu --help sql + sisu \-\-help sql .nf Postgresql @@ -3315,21 +3315,21 @@ necessary] .SH 24.2 SEARCH FORM .TP -.B sisu -F -generates a sample search form, which must be copied to the web-server cgi +.B sisu \-F +generates a sample search form, which must be copied to the web\-server cgi directory .TP -.B sisu -F --webserv-webrick +.B sisu \-F \-\-webserv\-webrick generates a sample search form for use with the webrick server, which must be -copied to the web-server cgi directory +copied to the web\-server cgi directory .TP -.B sisu -Fv +.B sisu \-Fv as above, and provides some information on setting up hyperestraier .TP -.B sisu -W +.B sisu \-W starts the webrick server which should be available wherever sisu is properly installed @@ -3360,7 +3360,7 @@ directory /home/ralph/sisu_www (A) to generate the index within the webserver directory to be indexed: .br - estcmd gather -sd [index \ name] [directory \ path \ to \ index] + estcmd gather \-sd [index \ name] [directory \ path \ to \ index] .br the following are examples that will need to be tailored according to your @@ -3370,15 +3370,15 @@ needs: cd /home/ralph/sisu_www .br - estcmd gather -sd casket /home/ralph/sisu_www + estcmd gather \-sd casket /home/ralph/sisu_www .br you may use the 'find' command together with 'egrep' to limit indexing to particular document collection directories within the web server directory: .br - find /home/ralph/sisu_www -type f | egrep - '/home/ralph/sisu_www/sisu/.+?.html$' |estcmd gather -sd casket - + find /home/ralph/sisu_www \-type f | egrep + '/home/ralph/sisu_www/sisu/.+?.html$' |estcmd gather \-sd casket \- .br Check which directories in the webserver/output directory (~/sisu_www or @@ -3391,20 +3391,20 @@ desirable to exclude files 'plain.txt', 'toc.html' and 'concordance.html', as these duplicate information held in other html output e.g. .br - find /home/ralph/sisu_www -type f | egrep - '/sisu_www/(sisu|bookmarks)/.+?.html$' | egrep -v '(doc|concordance).html$' - |estcmd gather -sd casket - + find /home/ralph/sisu_www \-type f | egrep + '/sisu_www/(sisu|bookmarks)/.+?.html$' | egrep \-v '(doc|concordance).html$' + |estcmd gather \-sd casket \- .br from your current document preparation/markup directory, you would construct a rune along the following lines: .br - find /home/ralph/sisu_www -type f | egrep '/home/ralph/sisu_www/([specify \ + find /home/ralph/sisu_www \-type f | egrep '/home/ralph/sisu_www/([specify \ first \ directory \ for \ inclusion]|[specify \ second \ directory \ for \ inclusion]|[another \ directory \ for \ inclusion? \ \...])/.+?.html$' | - egrep -v '(doc|concordance).html$' |estcmd gather -sd - /home/ralph/sisu_www/casket - + egrep \-v '(doc|concordance).html$' |estcmd gather \-sd + /home/ralph/sisu_www/casket \- .br (B) to set up the search form @@ -3413,13 +3413,13 @@ rune along the following lines: (i) copy estseek.cgi to your cgi directory and set file permissions to 755: .br - sudo cp -vi /usr/lib/estraier/estseek.cgi /usr/lib/cgi-bin + sudo cp \-vi /usr/lib/estraier/estseek.cgi /usr/lib/cgi\-bin .br - sudo chmod -v 755 /usr/lib/cgi-bin/estseek.cgi + sudo chmod \-v 755 /usr/lib/cgi\-bin/estseek.cgi .br - sudo cp -v /usr/share/hyperestraier/estseek.* /usr/lib/cgi-bin + sudo cp \-v /usr/share/hyperestraier/estseek.* /usr/lib/cgi\-bin .br [see \ estraier \ documentation \ for \ paths] @@ -3441,10 +3441,10 @@ rune along the following lines: (C) to test using webrick, start webrick: .br - sisu -W + sisu \-W .br -and try open the url: +and try open the url: .SH 26. SISU_WEBRICK .br @@ -3453,7 +3453,7 @@ and try open the url: .br .B SiSU -- Structured information, Serialized Units - a document publishing system +\- Structured information, Serialized Units \- a document publishing system .SH 26.2 SYNOPSIS @@ -3464,7 +3464,7 @@ sisu_webrick [port] or .br -sisu -W [port] +sisu \-W [port] .SH 26.3 DESCRIPTION @@ -3473,7 +3473,7 @@ sisu_webrick is part of .B SiSU (man sisu) sisu_webrick starts .B Ruby -' s Webrick web-server and points it to the directories to which +' s Webrick web\-server and points it to the directories to which .B SiSU output is written, providing a list of these directories (assuming .B SiSU @@ -3488,7 +3488,7 @@ yaml file: ~/.sisu/sisurc.yml a sample of which is provided as .br sisu_webrick, may be started on it's own with the command: sisu_webrick [port] -or using the sisu command with the -W flag: sisu -W [port] +or using the sisu command with the \-W flag: sisu \-W [port] .br where no port is given and settings are unchanged the default port is 8081 @@ -3496,9 +3496,9 @@ where no port is given and settings are unchanged the default port is 8081 .SH 26.5 DOCUMENT PROCESSING COMMAND FLAGS .br -sisu -W [port] starts +sisu \-W [port] starts .B Ruby -Webrick web-server, serving +Webrick web\-server, serving .B SiSU output directories, on the port provided, or if no port is provided and the defaults have not been changed in ~/.sisu/sisurc.yaml then on port 8081 @@ -3539,7 +3539,7 @@ documents can either be sisu marked up files in plaintext \.sst or \.ssm or; zipped sisu files, sisupod.zip or filename.ssp .br -.B \.sst / \.ssm - sisu text files +.B \.sst / \.ssm \- sisu text files .br .B SiSU @@ -3548,7 +3548,7 @@ processing instruction and the url. The source file and any associated parts (such as images) will be downloaded and generated locally. .nf - sisu -3 http://[provide \ url \ to \ valid \ \.sst \ or \ \.ssm \ file] + sisu \-3 http://[provide \ url \ to \ valid \ \.sst \ or \ \.ssm \ file] .fi .br @@ -3563,7 +3563,7 @@ documents in this way, images should be in the directory relative to the document source \../_sisu/image .br -.B sisupod - zipped sisu files +.B sisupod \- zipped sisu files .br A sisupod is the zipped content of a sisu marked up text or texts and any other @@ -3576,7 +3576,7 @@ processing instruction and the url, the sisupod will be downloaded and the documents it contains generated locally. .nf - sisu -3 http://[provide \ url \ to \ valid \ sisupod.zip \ or \ \.ssp \ file] + sisu \-3 http://[provide \ url \ to \ valid \ sisupod.zip \ or \ \.ssp \ file] .fi .br @@ -3599,34 +3599,34 @@ machine using either rsync, or scp. .br In order to do this some ssh authentication agent and keychain or similar tool will need to be configured. Once that is done the placement on a remote host -can be done seamlessly with the -r (for scp) or -R (for rsync) flag, which may +can be done seamlessly with the \-r (for scp) or \-R (for rsync) flag, which may be used in conjunction with other processing flags, e.g. .nf - sisu -3R sisu_remote.sst + sisu \-3R sisu_remote.sst .fi .SH 28.1 COMMANDS .TP -.B -R [filename/wildcard] +.B \-R [filename/wildcard] copies sisu output files to remote host using rsync. This requires that sisurc.yml has been provided with information on hostname and username, and that you have your "keys" and ssh agent in place. Note the behavior of rsync -different if -R is used with other flags from if used alone. Alone the rsync ---delete parameter is sent, useful for cleaning the remote directory (when -R -is used together with other flags, it is not). Also see -r +different if \-R is used with other flags from if used alone. Alone the rsync +\-\-delete parameter is sent, useful for cleaning the remote directory (when \-R +is used together with other flags, it is not). Also see \-r .TP -.B -r [filename/wildcard] +.B \-r [filename/wildcard] copies sisu output files to remote host using scp. This requires that sisurc.yml has been provided with information on hostname and username, and -that you have your "keys" and ssh agent in place. Also see -R +that you have your "keys" and ssh agent in place. Also see \-R .SH 28.2 CONFIGURATION .br -[expand \ on \ the \ setting \ up \ of \ an \ ssh-agent \ / \ keychain] +[expand \ on \ the \ setting \ up \ of \ an \ ssh\-agent \ / \ keychain] .SH 29. REMOTE SERVERS .br @@ -3641,7 +3641,7 @@ the program and all documents can just as easily be on a remote server, to which you are logged on using a terminal, and commands and operations would be pretty much the same as they would be on your local machine. -.SH 30. QUICKSTART - GETTING STARTED HOWTO +.SH 30. QUICKSTART \- GETTING STARTED HOWTO .br .SH 30.1 INSTALLATION @@ -3663,7 +3663,7 @@ Sid and testing archives (and possibly Ubuntu), assuming your .nf aptitude update - aptitude install sisu-complete + aptitude install sisu\-complete .fi .br @@ -3673,9 +3673,9 @@ markup samples: .nf #/etc/apt/sources.list .br - deb http://ftp.fi.debian.org/debian/ unstable main non-free contrib + deb http://ftp.fi.debian.org/debian/ unstable main non\-free contrib .br - deb-src http://ftp.fi.debian.org/debian/ unstable main non-free contrib + deb\-src http://ftp.fi.debian.org/debian/ unstable main non\-free contrib .br .fi @@ -3686,7 +3686,7 @@ The aptitude commands become: .nf aptitude update .br - aptitude install sisu-complete sisu-markup-samples + aptitude install sisu\-complete sisu\-markup\-samples .fi .br @@ -3699,8 +3699,8 @@ archives, they will be available by adding the following to your .nf #/etc/apt/sources.list - deb http://www.jus.uio.no/sisu/archive unstable main non-free - deb-src http://www.jus.uio.no/sisu/archive unstable main non-free + deb http://www.jus.uio.no/sisu/archive unstable main non\-free + deb\-src http://www.jus.uio.no/sisu/archive unstable main non\-free .fi .br @@ -3708,11 +3708,11 @@ repeat the aptitude commands .nf aptitude update - aptitude install sisu-complete sisu-markup-samples + aptitude install sisu\-complete sisu\-markup\-samples .fi .br -Note however that it is not necessary to install sisu-complete if not all +Note however that it is not necessary to install sisu\-complete if not all components of sisu are to be used. Installing just the package sisu will provide basic functionality. @@ -3732,7 +3732,7 @@ They may be downloaded from: as root type: .br - rpm -i [rpm \ package \ name] + rpm \-i [rpm \ package \ name] .SH 30.1.3 INSTALLATION FROM SOURCE @@ -3821,7 +3821,7 @@ or This makes use of Rant (by Stefan Lang) and the provided Rantfile. It has been configured to do post installation setup setup configuration and generation of first test file. Note however, that additional external package dependencies, -such as tetex-extra are not taken care of for you. +such as tetex\-extra are not taken care of for you. .br Further information on "rant" is available from: @@ -3839,7 +3839,7 @@ For a list of alternative actions you may type: ruby install help .br - ruby install -T + ruby install \-T .SH 30.2 TESTING SISU, GENERATING OUTPUT @@ -3847,7 +3847,7 @@ For a list of alternative actions you may type: To check which version of sisu is installed: .br -sisu -v +sisu \-v .br Depending on your mode of installation one or a number of markup sample files @@ -3866,7 +3866,7 @@ or change directory to the appropriate one: .br -cd /usr/share/doc/sisu/markup-samples/samples +cd /usr/share/doc/sisu/markup\-samples/samples .SH 30.2.1 BASIC TEXT, PLAINTEXT, HTML, XML, ODF, EPUB @@ -3875,7 +3875,7 @@ Having moved to the directory that contains the markup samples (see instructions above if necessary), choose a file and run sisu against it .br -sisu -NhwoabxXyv free_as_in_freedom.rms_and_free_software.sam_williams.sst +sisu \-NhwoabxXyv free_as_in_freedom.rms_and_free_software.sam_williams.sst .br this will generate html including a concordance file, opendocument text format, @@ -3885,7 +3885,7 @@ plaintext, XHTML and various forms of XML, and OpenDocument text .br Assuming a LaTeX engine such as tetex or texlive is installed with the required -modules (done automatically on selection of sisu-pdf in +modules (done automatically on selection of sisu\-pdf in .B Debian ) @@ -3894,37 +3894,37 @@ Having moved to the directory that contains the markup samples (see instructions above if necessary), choose a file and run sisu against it .br -sisu -pv free_as_in_freedom.rms_and_free_software.sam_williams.sst +sisu \-pv free_as_in_freedom.rms_and_free_software.sam_williams.sst .br -sisu -3 free_as_in_freedom.rms_and_free_software.sam_williams.sst +sisu \-3 free_as_in_freedom.rms_and_free_software.sam_williams.sst .br should generate most available output formats: html including a concordance file, opendocument text format, plaintext, XHTML and various forms of XML, and OpenDocument text and pdf -.SH 30.2.3 RELATIONAL DATABASE - POSTGRESQL, SQLITE +.SH 30.2.3 RELATIONAL DATABASE \- POSTGRESQL, SQLITE .br -Relational databases need some setting up - you must have permission to create +Relational databases need some setting up \- you must have permission to create the database and write to it when you run sisu. .br Assuming you have the database installed and the requisite permissions .br -sisu --sqlite --recreate +sisu \-\-sqlite \-\-recreate .br -sisu --sqlite -v --import +sisu \-\-sqlite \-v \-\-import free_as_in_freedom.rms_and_free_software.sam_williams.sst .br -sisu --pgsql --recreate +sisu \-\-pgsql \-\-recreate .br -sisu --pgsql -v --import +sisu \-\-pgsql \-v \-\-import free_as_in_freedom.rms_and_free_software.sam_williams.sst .SH 30.3 GETTING HELP @@ -3953,16 +3953,16 @@ as within the package itself: .SH 30.3.2 BUILT IN HELP .br -sisu --help +sisu \-\-help .br -sisu --help --env +sisu \-\-help \-\-env .br -sisu --help --commands +sisu \-\-help \-\-commands .br -sisu --help --markup +sisu \-\-help \-\-markup .SH 30.3.3 THE HOME PAGE @@ -3992,8 +3992,8 @@ Additional markup samples are packaged separately in the file: .br On .B Debian -they are available in non-free[^28] to include them it is necessary to -include non-free in your /etc/apt/source.list or obtain them from the sisu home +they are available in non\-free[^28] to include them it is necessary to +include non\-free in your /etc/apt/source.list or obtain them from the sisu home site. .SH 31. EDITOR FILES, SYNTAX HIGHLIGHTING @@ -4003,16 +4003,16 @@ site. The directory: .br - \./data/sisu/v2/conf/editor-syntax-etc/ + \./data/sisu/v2/conf/editor\-syntax\-etc/ .br - \./data/sisu/v3/conf/editor-syntax-etc/ + \./data/sisu/v3/conf/editor\-syntax\-etc/ .br - /usr/share/sisu/v2/conf/editor-syntax-etc + /usr/share/sisu/v2/conf/editor\-syntax\-etc .br - /usr/share/sisu/v3/conf/editor-syntax-etc + /usr/share/sisu/v3/conf/editor\-syntax\-etc .br contains rudimentary sisu syntax highlighting files for: @@ -4021,7 +4021,7 @@ contains rudimentary sisu syntax highlighting files for: * (g)vim .br - package: sisu-vim + package: sisu\-vim .br status: largely done @@ -4042,13 +4042,13 @@ status: largely done place in: .br - /usr/share/gtksourceview-1.0/language-specs + /usr/share/gtksourceview\-1.0/language\-specs .br or .br - ~/.gnome2/gtksourceview-1.0/language-specs + ~/.gnome2/gtksourceview\-1.0/language\-specs .br status: very basic syntax highlighting @@ -4057,7 +4057,7 @@ or comments: this editor features display line wrap and is used by Goby! .br -* nano +* nano .br file: nanorc @@ -4072,7 +4072,7 @@ save as: status: basic syntax highlighting .br - comments: assumes dark background; no display line-wrap; does line breaks + comments: assumes dark background; no display line\-wrap; does line breaks .br * diakonos (an editor written in ruby) @@ -4093,7 +4093,7 @@ includes: status: basic syntax highlighting .br -comments: assumes dark background; no display line-wrap +comments: assumes dark background; no display line\-wrap .br * kate & kwrite @@ -4126,7 +4126,7 @@ comments: assumes dark background; no display line-wrap file: sisu_nedit.pats .br - nedit -import sisu_nedit.pats + nedit \-import sisu_nedit.pats .br status: a very clumsy first attempt [not \ really \ done] @@ -4138,17 +4138,17 @@ comments: assumes dark background; no display line-wrap * emacs .br - files: sisu-mode.el + files: sisu\-mode.el .br to file ~/.emacs add the following 2 lines: .br - (add-to-list 'load-path - "/usr/share/sisu/v2/conf/editor-syntax-etc/emacs") + (add\-to\-list 'load\-path + "/usr/share/sisu/v2/conf/editor\-syntax\-etc/emacs") .br - (require 'sisu-mode.el) + (require 'sisu\-mode.el) .br [not \ done \ / \ not \ yet \ included] @@ -4175,7 +4175,7 @@ NOTE: .br [ \ .B \ SiSU \ parses \ files \ with \ long \ lines \ or \ line \ breaks, \ -but, \ display \ linewrap \ (without \ line-breaks) \ is \ a \ convenient \ +but, \ display \ linewrap \ (without \ line\-breaks) \ is \ a \ convenient \ editor \ feature \ to \ have \ for \ sisu \ markup] .SH 32. HOW DOES SISU WORK? @@ -4206,8 +4206,8 @@ ways of representing documents, (or indeed to create new ones). .br .br -* sparse/minimal markup (clean utf-8 source texts). Documents are prepared in a -single UTF-8 file using a minimalistic mnemonic syntax. Typical literature, +* sparse/minimal markup (clean utf\-8 source texts). Documents are prepared in a +single UTF\-8 file using a minimalistic mnemonic syntax. Typical literature, documents like "War and Peace" require almost no markup, and most of the headers are optional. @@ -4218,8 +4218,8 @@ and more sparse than the most basic HTML), [this \ may \ also \ be \ converted .br * markup defines document structure (this may be done once in a header -pattern-match description, or for heading levels individually); basic text -attributes (bold, italics, underscore, strike-through etc.) as required; and +pattern\-match description, or for heading levels individually); basic text +attributes (bold, italics, underscore, strike\-through etc.) as required; and semantic information related to the document (header information, extended beyond the Dublin core and easily further extended as required); the headers may also contain processing instructions. @@ -4237,7 +4237,7 @@ different strengths of various standard formats for representing documents, amongst the output formats currently supported are: .br - * html - both as a single scrollable text and a segmented document + * html \- both as a single scrollable text and a segmented document .br * xhtml @@ -4246,20 +4246,20 @@ amongst the output formats currently supported are: * epub .br - * XML - both in sax and dom style xml structures for further development as + * XML \- both in sax and dom style xml structures for further development as required .br - * ODF - open document format, the iso standard for document storage + * ODF \- open document format, the iso standard for document storage .br - * LaTeX - used to generate pdf + * LaTeX \- used to generate pdf .br * pdf (via LaTeX) .br - * sql - population of an sql database, (at the same object level that is used + * sql \- population of an sql database, (at the same object level that is used to cite text within a document) .br @@ -4293,8 +4293,8 @@ tools \ like \ hyperestraier]. .br * long term maintainability of document collections in a world of changing -formats, having a very sparsely marked-up source document base. there is a -considerable degree of future-proofing, output representations are +formats, having a very sparsely marked\-up source document base. there is a +considerable degree of future\-proofing, output representations are "upgradeable", and new document formats may be added. e.g. addition of odf (open document text) module in 2006, epub in 2009 and in future html5 output sometime in future, without modification of existing prepared texts @@ -4310,7 +4310,7 @@ to be done only once but may be repeated for various reasons as desired presentations/representations) .br -* document source (plaintext utf-8) if shared on the net may be used as input +* document source (plaintext utf\-8) if shared on the net may be used as input and processed locally to produce the different document outputs .br @@ -4371,37 +4371,37 @@ document. man sisu .br - man sisu-concordance + man sisu\-concordance .br - man sisu-epub + man sisu\-epub .br - man sisu-git + man sisu\-git .br - man sisu-harvest + man sisu\-harvest .br - man sisu-html + man sisu\-html .br - man sisu-odf + man sisu\-odf .br - man sisu-pdf + man sisu\-pdf .br - man sisu-pg + man sisu\-pg .br - man sisu-po + man sisu\-po .br - man sisu-sqlite + man sisu\-sqlite .br - man sisu-txt + man sisu\-txt .br man 7 sisu_complete @@ -4421,7 +4421,7 @@ document. .br man sisu_webrick -.SH 34.2 SISU GENERATED OUTPUT - LINKS TO HTML +.SH 34.2 SISU GENERATED OUTPUT \- LINKS TO HTML .br Note @@ -4498,18 +4498,18 @@ a saved version of the odf, or the pdf being a saved version of the html. .br 4. units of text, primarily paragraphs and headings, also any tables, poems, -code-blocks +code\-blocks .br 5. Specification submitted by Adobe to ISO to become a full open ISO specification - + .br 6. ISO standard ISO/IEC 26300:2006 .br -7. An open standard format for e-books +7. An open standard format for e\-books .br *1. square brackets @@ -4531,7 +4531,7 @@ specification markup using SiSU, which though not an original design goal is useful. .br -11. files should be prepared using UTF-8 character encoding +11. files should be prepared using UTF\-8 character encoding .br 12. a footnote or endnote @@ -4556,7 +4556,7 @@ required 14 .br -15. +15. .br 16. Table from the Wealth of Networks by Yochai Benkler @@ -4583,7 +4583,7 @@ subsequent processing. It may be however that when the resulting file is shared 21. .br -22. (which could be extended further with current back-end). As regards +22. (which could be extended further with current back\-end). As regards scaling of the database, it is as scalable as the database (here Postgresql) and hardware allow. @@ -4612,7 +4612,7 @@ matches are found. .B Debian Free Software guidelines require that everything distributed within .B Debian -can be changed - and the documents are authors' works that while freely +can be changed \- and the documents are authors' works that while freely distributable are not freely changeable. .br @@ -4623,21 +4623,21 @@ distributable are not freely changeable. .br \fIsisu\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-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). .br \fIsisu_vim\fR(7) diff --git a/man/man7/sisu_vim.7 b/man/man7/sisu_vim.7 index 9ea91846..7678f370 100644 --- a/man/man7/sisu_vim.7 +++ b/man/man7/sisu_vim.7 @@ -1,4 +1,4 @@ -.TH "sisu_vim" "1" "2008-02-12" "0.64.4" "SiSU" +.TH "sisu_vim" "1" "2008\-02\-12" "0.64.4" "SiSU" .SH NAME sisu_vim \- vim syntax and folds file for sisu: markup, structuring, publishing in multiple standard formats, and search .SH @@ -23,7 +23,7 @@ has syntax highlighting for a number of editors including vim which are documented under: .BR - /usr/share/doc/sisu/markup-samples/sisu_manual/sisu_syntax_highlighting.sst + /usr/share/doc/sisu/markup\-samples/sisu_manual/sisu_syntax_highlighting.sst .BR -- cgit v1.2.3