From 0aa81605e6314917562843bf00bc0845b3fc62a3 Mon Sep 17 00:00:00 2001 From: Daniel Baumann Date: Sat, 19 Jun 2010 16:22:39 +0200 Subject: Renewing debian specific manpages. --- debian/manpages/sisu_complete.7 | 67 +++++----- debian/manpages/sisu_pdf.7 | 238 +++++------------------------------- debian/manpages/sisu_postgresql.7 | 249 +++++--------------------------------- debian/manpages/sisu_sqlite.7 | 248 +++++-------------------------------- 4 files changed, 125 insertions(+), 677 deletions(-) (limited to 'debian/manpages') diff --git a/debian/manpages/sisu_complete.7 b/debian/manpages/sisu_complete.7 index f41a4154..b08ce23b 100644 --- a/debian/manpages/sisu_complete.7 +++ b/debian/manpages/sisu_complete.7 @@ -1,43 +1,32 @@ -.\" Name: SiSU information Structuring Universe -.\" Author: Ralph Amissah -.\" Description: sisu dummy package to install all the whole of sisu, apart from sisu-examples -.\" arch-tag: sisu manpage -.\" License: GPL 2 or later -.\" Notes: Process this file with -.\" groff -man -Tascii sisu.1 -.\" nroff -man sisu.1 | most -.\" |sisu.1|@|^| -.TH sisu_complete 7 "December 17, 2005" "version 0.34" "sisu \-I" +.TH SISU_COMPLETE 7 2010\-06\-19 2.5.1 SiSU + .SH NAME -.B SiSU -\- Structured information, Serialized Units \- a document publishing system, complete dependency package +\fBSiSU\fR \- Structured information, Serialized Units \- a document publishing system, complete dependency package + +.SH DESCRIPTION +\fBSiSU\fR is a lightweight markup based document structuring, publishing and search framework for document collections. .PP -.SH SYNOPSIS -Dummy package installs the whole of SiSU, excluding sisu-examples +The sisu_complete package installs \fBSiSU\fR and related packages that enable sisu to produce pdf and to populate PostgreSQL and sqlite databases. + +.SH SEE ALSO +\fIsisu\fR(1), +.br +\fIsisu\fR(8). +.br +\fIsisu_termsheet\fR(1). +.br +\fIsisu_vim\fR(7), +.br +\fIsisu_webrick\fR(1), .PP -sisu\-complete together with sisu\-examples is the whole of sisu -.\"%% Further Information -.SH FURTHER INFORMATION -.PP -For more information on -.I SiSU -see: -.I -.PP -or -.I man sisu +\fIsisu_pdf\fR(7), +.br +\fIsisu_postgresql\fR(7), +.br +\fIsisu_sqlite\fR(7). + +.SH HOMEPAGE +More information about \fBSiSU\fR can be found at <\fIhttp://www.jus.uio.no/sisu/\fR>. + .SH AUTHOR -Ralph Amissah -.I -or -.I -.SH SEE -.BR sisu(1), -.BR sisu(8), -.SH ALSO -.BR sisu_webrick(1), -.BR sisu_pdf(7) -.BR sisu_sqlite(7) -.BR sisu_postgresql(7) -.BR sisu_vim(7) -.BR sisu_termsheet(1), +\fBSiSU\fR was written by Ralph Amissah <\fIralph@amissah.com\fR>. diff --git a/debian/manpages/sisu_pdf.7 b/debian/manpages/sisu_pdf.7 index 7149f340..ed43ee32 100644 --- a/debian/manpages/sisu_pdf.7 +++ b/debian/manpages/sisu_pdf.7 @@ -1,208 +1,32 @@ -.TH "sisu_pdf" "1" "2007-09-16" "0.59.1" "SiSU" -.SH NAME -sisu \- package to install what sisu needs to generate pdf (latex to pdf dependency component) -.SH SYNOPSIS -sisu \-pv [filename/wildcard ] -.SH -SISU \- PDF, -RALPH AMISSAH -.BR - -.SH -1. SISU PDF -.BR - -.SH -1.1 NAME - -.BR -.B SiSU -\- Structured information, Serialized Units \- a document publishing system. - -.SH -1.2 DESCRIPTION - -.BR -Information creating pdf output with sisu (and related to the sisu_pdf -dependency package, which is a dummy package to install dependencies needed for -.B SiSU -to generate pdfs (primarily related to LaTeX), sisu_pdf being part of -.B SiSU -\- man sisu). - -.BR -.B SiSU -generates LaTeX which is converted by LaTeX tools to pdf. - -.SH -1.3 SYNOPSIS - -.BR - sisu \-pv \ [filename/wildcard] - -.SH -1.4 COMMANDS - -.TP -.B \ sisu \ \-pv \ \ [filename/wildcard] -creates two pdf documents: vertical (portrait.pdf) and; horizontal -(landscape.pdf). -.B SiSU -generates LaTeX output which is converted to pdf if the appropriate LaTeX -dependencies are met on the system. - -.TP -.B \ sisu \ \-pv \ \-\-papersize\-a4 \ \ [filename/wildcard] -overrides the default papersize set to A4. Preset alternative sizes include: -\'A4\', U.S. \'letter\' and \'legal\' and book sizes \'A5\' and \'B5\' (system -defaults to A4). - -.SH -1.5 SETTING PAPER SIZE - -.BR -The paper\-size may be set to any of the following sizes: \'A4\', U.S. -\'letter\' and \'legal\' and book sizes: \'A5\' and \'B5\' - -.BR -1. The preset default if not otherwise given in the configuration file or -elsewhere is A4. - -.BR -2. The default paper size may be set in the configuration file sisurc.yml. See -sisu_configuration: - - -.nf - #% papersize, (LaTeX/pdf) current values A4, US_letter, book_b5, book_a5, US_legal - default: - papersize: \'A4\' -.fi - -.BR -3. Paper size may be set in a document header: - - -.nf - @papersize: (A4|US_letter|book_B5|book_A5|US_legal) -.fi - -.BR -4. or provided with additional command line parameter, e.g. - -.BR - sisu \-pv \-\-papersize\-a4 \ [filename/wildcard] - -.SH -DOCUMENT INFORMATION (METADATA) -.BR +.TH SISU_PDF 7 2010\-06\-19 2.5.1 SiSU -.SH -METADATA -.BR - -.BR -Document Manifest @ - - -.BR -.B Dublin Core -(DC) - -.BR -.I DC tags included with this document are provided here. - -.BR -DC Title: -.I SiSU \- PDF - -.BR -DC Creator: -.I Ralph Amissah - -.BR -DC Rights: -.I Copyright (C) Ralph Amissah 2007, part of SiSU documentation, License GPL -3 - -.BR -DC Type: -.I information - -.BR -DC Date created: -.I 2002\-08\-28 - -.BR -DC Date issued: -.I 2002\-08\-28 - -.BR -DC Date available: -.I 2002\-08\-28 - -.BR -DC Date modified: -.I 2007\-09\-16 - -.BR -DC Date: -.I 2007\-09\-16 - -.BR -.B Version Information - -.BR -Sourcefile: -.I sisu_pdf.sst - -.BR -Filetype: -.I SiSU text 0.58 - -.BR -Sourcefile Digest, MD5(sisu_pdf.sst)= -.I bed13854370b5daf1b1541527e8946b7 - -.BR -Skin_Digest: MD5(skin_sisu_manual.rb)= -.I 20fc43cf3eb6590bc3399a1aef65c5a9 - -.BR -.B Generated - -.BR -Document (metaverse) last generated: -.I Sat Sep 29 17:05:37 +0100 2007 - -.BR -Generated by: -.I SiSU -.I 0.59.1 -of 2007w39/2 (2007\-09\-25) - -.BR -Ruby version: -.I ruby 1.8.6 (2007\-06\-07 patchlevel 36) \ [i486\-linux] - - -.TP -Other versions of this document: -.TP -manifest: -.TP -html: -.TP -pdf: -.TP -pdf: -.TP -at: -.TP -* Generated by: SiSU 0.59.1 of 2007w39/2 (2007-09-25) -.TP -* Ruby version: ruby 1.8.6 (2007-06-07 patchlevel 36) [i486-linux] -.TP -* Last Generated on: Sat Sep 29 17:05:39 +0100 2007 -.TP -* SiSU http://www.jus.uio.no/sisu +.SH NAME +\fBSiSU\fR \- Structured information, Serialized Units \- a document publishing system, complete dependency package + +.SH DESCRIPTION +\fBSiSU\fR is a lightweight markup based document structuring, publishing and search framework for document collections. +.PP +The sisu_pdf package enables the conversion of \fBSiSU\fR LaTeX output to pdf. + +.SH SEE ALSO +\fIsisu\fR(1), +.br +\fIsisu\fR(8). +.br +\fIsisu_termsheet\fR(1). +.br +\fIsisu_vim\fR(7), +.br +\fIsisu_webrick\fR(1), +.PP +\fIsisu_complete\fR(7), +.br +\fIsisu_postgresql\fR(7), +.br +\fIsisu_sqlite\fR(7). + +.SH HOMEPAGE +More information about \fBSiSU\fR can be found at <\fIhttp://www.jus.uio.no/sisu/\fR>. + +.SH AUTHOR +\fBSiSU\fR was written by Ralph Amissah <\fIralph@amissah.com\fR>. diff --git a/debian/manpages/sisu_postgresql.7 b/debian/manpages/sisu_postgresql.7 index 0c780e79..ab40b2a8 100644 --- a/debian/manpages/sisu_postgresql.7 +++ b/debian/manpages/sisu_postgresql.7 @@ -1,217 +1,34 @@ -.TH "sisu_postgresql" "1" "2007-09-16" "0.59.1" "SiSU" -.SH NAME -sisu \- package to install what sisu needs to to populate a postgresql database (postgresql dependency component) -.SH SYNOPSIS -sisu \-Dv [filename/wildcard ] -.BR -sisu \-Dv [instruction] -.SH -SISU \- SEARCH, -RALPH AMISSAH -.BR - -.SH -1. POSTGRESQL -.BR - -.SH -1.1 NAME - -.BR -.B SiSU -\- Structured information, Serialized Units \- a document publishing system, -postgresql dependency package - -.SH -1.2 DESCRIPTION - -.BR -Information related to using postgresql with sisu (and related to the -sisu_postgresql dependency package, which is a dummy package to install -dependencies needed for -.B SiSU -to populate a postgresql database, this being part of -.B SiSU -\- man sisu). - -.SH -1.3 SYNOPSIS - -.BR - sisu \-D \ [instruction] \ [filename/wildcard \ if \ required] - -.BR - sisu \-D \-\-pg \-\-[instruction] \ [filename/wildcard \ if \ required] - -.SH -1.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 - -.BR -.B \-D or \-\-pgsql -may be used interchangeably. - -.SH -1.4.1 CREATE AND DESTROY DATABASE - -.TP -.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 -\ creates \ database \ where \ no \ database \ existed \ before \ - -.TP -.B \ sisu \ \-D \ \-\-create -\ creates \ database \ tables \ where \ no \ database \ tables \ existed \ -before \ - -.TP -.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 -\ destroys \ existing \ database \ and \ builds \ a \ new \ empty \ database -\ structure \ - -.SH -1.4.2 IMPORT AND REMOVE DOCUMENTS - -.TP -.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] -updates file contents in database - -.TP -.B \ sisu \ \-D \ \-\-remove \ \-v \ \ [filename/wildcard] -removes specified document from postgresql database. - -.SH -DOCUMENT INFORMATION (METADATA) -.BR - -.SH -METADATA -.BR +.TH SISU_POSTGRESQL 7 2010\-06\-19 2.5.1 SiSU -.BR -Document Manifest @ - - -.BR -.B Dublin Core -(DC) - -.BR -.I DC tags included with this document are provided here. - -.BR -DC Title: -.I SiSU \- Search - -.BR -DC Creator: -.I Ralph Amissah - -.BR -DC Rights: -.I Copyright (C) Ralph Amissah 2007, part of SiSU documentation, License GPL -3 - -.BR -DC Type: -.I information - -.BR -DC Date created: -.I 2002\-08\-28 - -.BR -DC Date issued: -.I 2002\-08\-28 - -.BR -DC Date available: -.I 2002\-08\-28 - -.BR -DC Date modified: -.I 2007\-09\-16 - -.BR -DC Date: -.I 2007\-09\-16 - -.BR -.B Version Information - -.BR -Sourcefile: -.I sisu_postgresql.sst - -.BR -Filetype: -.I SiSU text 0.58 - -.BR -Sourcefile Digest, MD5(sisu_postgresql.sst)= -.I 9010e85001c50e30ba2ab69f9097825a - -.BR -Skin_Digest: MD5(skin_sisu_manual.rb)= -.I 20fc43cf3eb6590bc3399a1aef65c5a9 - -.BR -.B Generated - -.BR -Document (metaverse) last generated: -.I Sat Sep 29 17:05:38 +0100 2007 - -.BR -Generated by: -.I SiSU -.I 0.59.1 -of 2007w39/2 (2007\-09\-25) - -.BR -Ruby version: -.I ruby 1.8.6 (2007\-06\-07 patchlevel 36) \ [i486\-linux] - - -.TP -Other versions of this document: -.TP -manifest: -.TP -html: -.TP -pdf: -.TP -pdf: -.TP -at: -.TP -* Generated by: SiSU 0.59.1 of 2007w39/2 (2007-09-25) -.TP -* Ruby version: ruby 1.8.6 (2007-06-07 patchlevel 36) [i486-linux] -.TP -* Last Generated on: Sat Sep 29 17:05:39 +0100 2007 -.TP -* SiSU http://www.jus.uio.no/sisu +.SH NAME +\fBSiSU\fR \- Structured information, Serialized Units \- a document publishing system, complete dependency package + +.SH DESCRIPTION +\fBSiSU\fR is a lightweight markup based document structuring, publishing and search framework for document collections. +.PP +The sisu_postgresql package enables \fBSiSU\fR to populate a PostgreSQL database. This is done at an object/paragraph level, making granular searches of documents possible. +.PP +This relational database feature of \fBSiSU\fR is not required but provides interesting possibilities, including that of granular searches of documents for matching units of text, primarily paragraphs that can be displayed or identified by object citation number, from which an index of documents matched and each matched paragraph within them can be displayed. + +.SH SEE ALSO +\fIsisu\fR(1), +.br +\fIsisu\fR(8). +.br +\fIsisu_termsheet\fR(1). +.br +\fIsisu_vim\fR(7), +.br +\fIsisu_webrick\fR(1), +.PP +\fIsisu_complete\fR(7), +.br +\fIsisu_pdf\fR(7), +.br +\fIsisu_sqlite\fR(7). + +.SH HOMEPAGE +More information about \fBSiSU\fR can be found at <\fIhttp://www.jus.uio.no/sisu/\fR>. + +.SH AUTHOR +\fBSiSU\fR was written by Ralph Amissah <\fIralph@amissah.com\fR>. diff --git a/debian/manpages/sisu_sqlite.7 b/debian/manpages/sisu_sqlite.7 index 2b738c54..1b1bd546 100644 --- a/debian/manpages/sisu_sqlite.7 +++ b/debian/manpages/sisu_sqlite.7 @@ -1,216 +1,34 @@ -.TH "sisu_sqlite" "1" "2007-09-16" "0.59.1" "SiSU" -.SH NAME -sisu \- package to install what sisu needs to to populate a postgresql database (postgresql dependency component) -.SH SYNOPSIS -sisu \-dv [filename/wildcard ] -.BR -sisu \-dv [instruction] -.SH -SISU \- SEARCH, -RALPH AMISSAH -.BR - -.SH -1. SQLITE -.BR - -.SH -1.1 NAME - -.BR -.B SiSU -\- Structured information, Serialized Units \- a document publishing system. - -.SH -1.2 DESCRIPTION - -.BR -Information related to using sqlite with sisu (and related to the sisu_sqlite -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). - -.SH -1.3 SYNOPSIS - -.BR - sisu \-d \ [instruction] \ [filename/wildcard \ if \ required] - -.BR - sisu \-d \-\-(sqlite|pg) \-\-[instruction] \ [filename/wildcard \ if \ - required] - -.SH -1.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 - -.BR -.B \-d or \-\-sqlite -may be used interchangeably. - -.SH -1.4.1 CREATE AND DESTROY DATABASE - -.TP -.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 -\ creates \ database \ where \ no \ database \ existed \ before \ - -.TP -.B \ sisu \ \-d \ \-\-create -\ creates \ database \ tables \ where \ no \ database \ tables \ existed \ -before \ - -.TP -.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 -\ destroys \ existing \ database \ and \ builds \ a \ new \ empty \ database -\ structure \ - -.SH -1.4.2 IMPORT AND REMOVE DOCUMENTS - -.TP -.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] -updates file contents in database - -.TP -.B \ sisu \ \-d \ \-\-remove \ \-v \ \ [filename/wildcard] -removes specified document from sqlite database. - -.SH -DOCUMENT INFORMATION (METADATA) -.BR - -.SH -METADATA -.BR +.TH SISU_SQLITE 7 2010\-06\-19 2.5.1 SiSU -.BR -Document Manifest @ - - -.BR -.B Dublin Core -(DC) - -.BR -.I DC tags included with this document are provided here. - -.BR -DC Title: -.I SiSU \- Search - -.BR -DC Creator: -.I Ralph Amissah - -.BR -DC Rights: -.I Copyright (C) Ralph Amissah 2007, part of SiSU documentation, License GPL -3 - -.BR -DC Type: -.I information - -.BR -DC Date created: -.I 2002\-08\-28 - -.BR -DC Date issued: -.I 2002\-08\-28 - -.BR -DC Date available: -.I 2002\-08\-28 - -.BR -DC Date modified: -.I 2007\-09\-16 - -.BR -DC Date: -.I 2007\-09\-16 - -.BR -.B Version Information - -.BR -Sourcefile: -.I sisu_sqlite.sst - -.BR -Filetype: -.I SiSU text 0.58 - -.BR -Sourcefile Digest, MD5(sisu_sqlite.sst)= -.I c4717fcab8a43de498d41a916bb99551 - -.BR -Skin_Digest: MD5(skin_sisu_manual.rb)= -.I 20fc43cf3eb6590bc3399a1aef65c5a9 - -.BR -.B Generated - -.BR -Document (metaverse) last generated: -.I Sat Sep 29 17:05:38 +0100 2007 - -.BR -Generated by: -.I SiSU -.I 0.59.1 -of 2007w39/2 (2007\-09\-25) - -.BR -Ruby version: -.I ruby 1.8.6 (2007\-06\-07 patchlevel 36) \ [i486\-linux] - - -.TP -Other versions of this document: -.TP -manifest: -.TP -html: -.TP -pdf: -.TP -pdf: -.TP -at: -.TP -* Generated by: SiSU 0.59.1 of 2007w39/2 (2007-09-25) -.TP -* Ruby version: ruby 1.8.6 (2007-06-07 patchlevel 36) [i486-linux] -.TP -* Last Generated on: Sat Sep 29 17:05:39 +0100 2007 -.TP -* SiSU http://www.jus.uio.no/sisu +.SH NAME +\fBSiSU\fR \- Structured information, Serialized Units \- a document publishing system, complete dependency package + +.SH DESCRIPTION +\fBSiSU\fR is a lightweight markup based document structuring, publishing and search framework for document collections. +.PP +The sisu_sqlite package enables \fBSiSU\fR to populate an SQLite database. This is done at an object/paragraph level, making granular searches of documents possible. +.PP +This relational database feature of \fBSiSU\fR is not required but provides interesting possibilities, including that of granular searches of documents for matching units of text, primarily paragraphs that can be displayed or identified by object citation number, from which an index of documents matched and each matched paragraph within them can be displayed. + +.SH SEE ALSO +\fIsisu\fR(1), +.br +\fIsisu\fR(8). +.br +\fIsisu_termsheet\fR(1). +.br +\fIsisu_vim\fR(7), +.br +\fIsisu_webrick\fR(1), +.PP +\fIsisu_complete\fR(7), +.br +\fIsisu_pdf\fR(7), +.br +\fIsisu_postgresql\fR(7). + +.SH HOMEPAGE +More information about \fBSiSU\fR can be found at <\fIhttp://www.jus.uio.no/sisu/\fR>. + +.SH AUTHOR +\fBSiSU\fR was written by Ralph Amissah <\fIralph@amissah.com\fR>. -- cgit v1.2.3