diff options
author | Daniel Baumann <daniel@debian.org> | 2010-06-19 16:22:39 +0200 |
---|---|---|
committer | Ralph Amissah <ralph@amissah.com> | 2010-07-02 14:01:26 -0400 |
commit | 0aa81605e6314917562843bf00bc0845b3fc62a3 (patch) | |
tree | a6598addf9ab7902ba3303c0ac898215152a4278 /debian/manpages/sisu_sqlite.7 | |
parent | Adding year in copyright file for setup.rb. (diff) |
Renewing debian specific manpages.
Diffstat (limited to 'debian/manpages/sisu_sqlite.7')
-rw-r--r-- | debian/manpages/sisu_sqlite.7 | 248 |
1 files changed, 33 insertions, 215 deletions
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 @ -<http://sisudoc.org/sisu_manual/sisu_sqlite/sisu_manifest.html> - -.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: <http://www.jus.uio.no/sisu/sisu_sqlite/sisu_manifest.html> -.TP -html: <http://www.jus.uio.no/sisu/sisu_sqlite/toc.html> -.TP -pdf: <http://www.jus.uio.no/sisu/sisu_sqlite/portrait.pdf> -.TP -pdf: <http://www.jus.uio.no/sisu/sisu_sqlite/landscape.pdf> -.TP -at: <http://www.jus.uio.no/sisu> -.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>. |