sisu_sqlite(7) manual page

From 50d45c6deb0afd2e4222d2e33a45487a9d1fa676 Mon Sep 17 00:00:00 2001 From: Ralph Amissah Date: Sun, 23 Sep 2007 05:16:21 +0100 Subject: primarily todo with sisu documentation, changelog reproduced below: * start documenting sisu using sisu * sisu markup source files in data/doc/sisu/sisu_markup_samples/sisu_manual/ /usr/share/doc/sisu/sisu_markup_samples/sisu_manual/ * default output [sisu -3] in data/doc/manuals_generated/sisu_manual/ /usr/share/doc/manuals_generated/sisu_manual/ (adds substantially to the size of sisu package!) * help related edits * manpage, work on ability to generate manpages, improved * param, exclude footnote mark count when occurs within code block * plaintext changes made * shared_txt, line wrap visited * file:// link option introduced (in addition to existing https?:// and ftp://) a bit arbitrarily, diff here, [double check changes in sysenv and hub] * minor adjustments * html url match refinement * css added tiny_center * plaintext * endnotes fix * footnote adjustment to make more easily distinguishable from substantive text * flag -a only [flags -A -e -E dropped] controlled by modifiers --unix/msdos --footnote/endnote * defaults, homepage * renamed homepage (instead of index) implications for modifying skins, which need likewise to have any homepage entry renamed * added link to sisu_manual in homepage * css the css for the default homepage is renamed homepage.css (instead of index.css) [consider removing this and relying on html.css] * ruby version < ruby1.9 * place stop on installation and working with for now [ruby String.strip broken in ruby 1.9.0 (2007-09-10 patchlevel 0) [i486-linux], 2007-09-18:38/2] * debian/control restrict use to ruby > 1.8.4 and ruby < 1.9 * debian * debian/control restrict use to ruby > 1.8.4 and ruby < 1.9 * sisu-doc new sub-package for sisu documentation debian/control and sisu-doc.install --- data/doc/sisu/html/sisu_sqlite.7.html | 228 ++++++++++++++++++++++++---------- 1 file changed, 161 insertions(+), 67 deletions(-) (limited to 'data/doc/sisu/html/sisu_sqlite.7.html') diff --git a/data/doc/sisu/html/sisu_sqlite.7.html b/data/doc/sisu/html/sisu_sqlite.7.html index 4d85c37b..139501b2 100644 --- a/data/doc/sisu/html/sisu_sqlite.7.html +++ b/data/doc/sisu/html/sisu_sqlite.7.html @@ -1,91 +1,185 @@ - + -sisu_sqlite(7) manual page +"sisu_sqlite"("1") manual page Table of Contents

+SISU - SISU INFORMATION STRUCTURING UNIVERSE - SEARCH [0.58], RALPH AMISSAH + +

SISU SEARCH +

SISU SQLITE +

1. SQLITE +

1.1 NAME +

SiSU - Structured information, +Serialized Units - a document publishing system. +

1.2 DESCRIPTION +

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 SiSU +to populate an sqlite database, this being part of SiSU - man sisu). +

1.3 -

Name

-SiSU - Structured information, Serialized Units - a document -publishing system, sqlite dependency package

-This is a dummy package to -install the dependencies required by SiSU to populate an sqlite database - -

Synopsis

-sisu -d [instruction] [filename/wildcard if required]

-sisu -d --(sqlite|pg) ---[instruction] [filename/wildcard if required]

SYNOPSIS +

sisu -d [instruction] [filename/wildcard if required]
-

Description

-sisu_sqlite is -part of SiSU (man sisu) sisu_sqlite is a dummy package to install dependencies -needed for sisu to populate an sqlite database, documented in man sisu +

sisu -d --(sqlite|pg) --[instruction] [filename/wildcard if
+ required]
-

databases

- +

1.4 COMMANDS +

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 or --sqlite may +be used interchangeably. +

1.4.1 CREATE AND DESTROY DATABASE +

dbi - database interface: -d set for sqlite
--sqlite --createall +: initial step, creates required relations (tables, indexes) in existing + (sqlite) database (a database should be created as requested) (rb.dbi) the + same name as working directory, as +
sisu -d --createdb: creates database where + no database existed before as +
--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)
sisu -d --create: creates database tables where + no database tables existed before database tables where no database tables + existed +
--sqlite --import -v: [filename/wildcard] -imports data specified to (sqlite) db (rb.dbi)
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). a +
--sqlite --update -v: [filename/wildcard] -updates/imports specified data to (sqlite) db (rb.dbi)
sisu -d --recreate: destroys -
--sqlite --remove -v -: [filename/wildcard] removes specified data to (sqlite) db (rb.dbi)

+1.4.2 IMPORT + +

AND REMOVE DOCUMENTS +

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). +
--sqlite ---dropall: kills data" and drops (postgresql) db, tables & indexes
sisu -d --update -v [filename/wildcard]: updates -
--sqlite ---recreate: kills data" and drops and rebuilds empty (postgresql) db, tables -&
sisu -d --remove -v [filename/wildcard]: removes +specified document from sqlite database. +

-indexes +DOCUMENT INFORMATION (METADATA) -

Further Information

METADATA +

Document Manifest @ <http://www.jus.uio.no/sisu/sisu_manual/sisu_sqlite/sisu_manifest.html +> + +

Dublin Core (DC) +

DC tags included with this document are provided here. + +

DC Title: SiSU - SiSU information Structuring Universe - Search [0.58]

-For more information on SiSU see: <http://www.jus.uio.no/sisu -> + DC Creator: Ralph Amissah +

DC Rights: Copyright (C) Ralph Amissah 2007, +part of SiSU documentation, License GPL 3 +

DC Type: information +

DC Date +created: 2002-08-28 +

DC Date issued: 2002-08-28 +

DC Date available: 2002-08-28 + +

DC Date modified: 2007-09-16 +

DC Date: 2007-09-16 +

Version Information + +

Sourcefile: sisu_sqlite.sst +

Filetype: SiSU text 0.58 +

Sourcefile Digest, +MD5(sisu_sqlite.sst)= 61ba58f6a2f5cc9651b985a8eabb96e9 +

Skin_Digest: MD5(/home/ralph/grotto/theatre/dbld/sisu-dev/sisu/data/doc/sisu/sisu_markup_samples/sisu_manual/_sisu/skin/doc/skin_sisu_manual.rb)= + +

20fc43cf3eb6590bc3399a1aef65c5a9 +

Generated +

Document (metaverse) last +generated: Sun Sep 23 01:14:03 +0100 2007 +

Generated by: SiSU 0.58.3 of +2007w36/4 (2007-09-06) +

Ruby version: ruby 1.8.6 (2007-06-07 patchlevel 36) + [i486-linux] +

Other versions of this document:
manifest: <http://www.jus.uio.no/sisu/sisu_sqlite/sisu_manifest.html + +> +
html: <http://www.jus.uio.no/sisu/sisu_sqlite/toc.html + +>
pdf: <http://www.jus.uio.no/sisu/sisu_sqlite/portrait.pdf + +> +
pdf: <http://www.jus.uio.no/sisu/sisu_sqlite/landscape.pdf + +>
at: <http://www.jus.uio.no/sisu + +> +
* Generated by: SiSU 0.58.3 of 2007w36/4 (2007-09-06)
* Ruby version: ruby +1.8.6 (2007-06-07 patchlevel 36) [i486-linux]
* Last Generated on: Sun Sep 23 +01:14:07 +0100 2007
* SiSU http://www.jus.uio.no/sisu +

-or man sisu -

Author

-Ralph Amissah <ralph@amissah.com> or <ralph.amissah@gmail.com> - -