From 00f104e60f95521a699becadeac508e20cd0fb07 Mon Sep 17 00:00:00 2001 From: Ralph Amissah Date: Sat, 29 Sep 2007 16:15:42 +0100 Subject: using sisu auto-generated man pages for pdf postgresql and sqlite --- debian/man/man7/sisu_pdf.7 | 248 +++++++++++++++++++++++++++----- debian/man/man7/sisu_postgresql.7 | 294 ++++++++++++++++++++++++++++---------- debian/man/man7/sisu_sqlite.7 | 292 +++++++++++++++++++++++++++---------- 3 files changed, 644 insertions(+), 190 deletions(-) diff --git a/debian/man/man7/sisu_pdf.7 b/debian/man/man7/sisu_pdf.7 index 2836df06..29e36bd0 100644 --- a/debian/man/man7/sisu_pdf.7 +++ b/debian/man/man7/sisu_pdf.7 @@ -1,42 +1,212 @@ -.\" Name: SiSU information Structuring Universe -.\" Author: Ralph Amissah -.\" Description: sisu pdf package manpage -.\" 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_pdf 7 "December 17, 2005" "version 0.34" "sisu \-I" +.TH "sisu_pdf" "1" "2007-09-16" "0.59.1" "SiSU" .SH NAME -.B SiSU -\- Structured information, Serialized Units \- a document publishing system -.PP -Dummy package installs the dependencies required to convert LaTeX output from SiSU to pdf +sisu \- package to install what sisu needs to generate pdf (latex to pdf dependency component) .SH SYNOPSIS -.B sisu -.B \-p -[filename/wildcard] -.\"%% Description -.SH DESCRIPTION -.B sisu_pdf -.I is part of SiSU (man sisu) -sisu_pdf is a dummy package to install dependencies needed for sisu to make rudimentary info files output, documented in man sisu -.\"%% Further Information -.SH FURTHER INFORMATION -.PP -For more information on +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 + +.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(/home/ralph/grotto/theatre/dbld/sisu\-dev/sisu/data/doc/sisu/sisu_markup_samples/sisu_manual/_sisu/skin/doc/skin_sisu_manual.rb)= +.I 20fc43cf3eb6590bc3399a1aef65c5a9 + +.BR +.B Generated + +.BR +Document (metaverse) last generated: +.I Sat Sep 29 16:06:43 +0100 2007 + +.BR +Generated by: .I SiSU -see: -.I -.PP -or -.I man sisu -.SH AUTHOR -Ralph Amissah -.I -or -.I -.SH SEE ALSO -.BR sisu(1), -.BR sisu(8), +.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 +." manpage: http://www.jus.uio.no/sisu/sisu_pdf/sisu_pdf.1 +.TP +at: +.TP +.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 16:06:44 +0100 2007 +.TP +* SiSU http://www.jus.uio.no/sisu diff --git a/debian/man/man7/sisu_postgresql.7 b/debian/man/man7/sisu_postgresql.7 index e8cddf1f..967649a2 100644 --- a/debian/man/man7/sisu_postgresql.7 +++ b/debian/man/man7/sisu_postgresql.7 @@ -1,79 +1,221 @@ -.\" Name: SiSU information Structuring -Universe .\" Author: Ralph Amissah .\" -Description: sisu postgresql package manpage .\" -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_postgresql 7 "September 09, 2006" "version -0.46" "sisu \-I" +.TH "sisu_postgresql" "1" "2007-09-16" "0.59.1" "SiSU" .SH NAME -.B SiSU -\- Structured information, Serialized Units \- a document publishing system, postgresql dependency package -.PP -Dummy package to install the dependencies required by SiSU to populate a postgresql database +sisu \- package to install what sisu needs to to populate a postgresql database (postgresql dependency component) .SH SYNOPSIS -.B sisu -.I \-D [instruction] -.PP -.I \-d \-\-(sqlite|pg) \-\-[instruction] -[filename/wildcard if required] -.PP -.B sisu -.I \-\-pgsql \-\-[instruction] -[filename/wildcard if required] -.PP -.\"%% Description -.SH DESCRIPTION -.B sisu_postgresql -.I is part of SiSU (man sisu) -sisu_postgresql is a dummy dummy package to install dependencies needed for sisu to populate a postgresql database, documented in man sisu -.\"%% Flags Database -.SH databases -.TP -dbi \- database interface -.B \-D -set for -.I postgresql -.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 \-\-pgsql \-\-import \-v -.I [filename/wildcard] -imports data specified to postgresql db (rb.dbi) -.TP -.B \-\-pgsql \-\-update \-v -.I [filename/wildcard] -updates/imports specified data to (postgresql) db (rb.dbi) -.TP -.B \-\-pgsql \-\-remove \-v -.I [filename/wildcard] -removes specified data to (postgresql) db (rb.dbi) -.TP -.B \-\-pgsql \-\-dropall -kills data" and drops (postgresql) db, tables & indexes -.TP -.B \-\-pgsql \-\-recreate -kills data" and drops and rebuilds empty (postgresql) db, tables & indexes -.RE -.\"%% Further Information -.SH FURTHER INFORMATION -.PP -For more information on +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 + +.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(/home/ralph/grotto/theatre/dbld/sisu\-dev/sisu/data/doc/sisu/sisu_markup_samples/sisu_manual/_sisu/skin/doc/skin_sisu_manual.rb)= +.I 20fc43cf3eb6590bc3399a1aef65c5a9 + +.BR +.B Generated + +.BR +Document (metaverse) last generated: +.I Sat Sep 29 16:06:43 +0100 2007 + +.BR +Generated by: .I SiSU -see: -.I -.PP -or -.I man sisu -.SH AUTHOR -Ralph Amissah -.I -or -.I -.SH SEE ALSO -.BR sisu(1), -.BR sisu(8), -.BR sisu_sqlite(7), -.BR sisu_vim(7) +.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 +." manpage: http://www.jus.uio.no/sisu/sisu_postgresql/sisu_postgresql.1 +.TP +at: +.TP +.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 16:06:44 +0100 2007 +.TP +* SiSU http://www.jus.uio.no/sisu diff --git a/debian/man/man7/sisu_sqlite.7 b/debian/man/man7/sisu_sqlite.7 index 8a9c6e3e..43c68657 100644 --- a/debian/man/man7/sisu_sqlite.7 +++ b/debian/man/man7/sisu_sqlite.7 @@ -1,78 +1,220 @@ -.\" Name: SiSU information Structuring Universe -.\" Author: Ralph Amissah -.\" Description: sisu sqlite package manpage -.\" 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_sqlite 7 "September 09, 2006" "version 0.46" "sisu \-I" +.TH "sisu_sqlite" "1" "2007-09-16" "0.59.1" "SiSU" .SH NAME -.B SiSU -\- Structured information, Serialized Units \- a document publishing system, sqlite dependency package -.PP -This is a dummy package to install the dependencies required by SiSU to populate an sqlite database +sisu \- package to install what sisu needs to to populate a postgresql database (postgresql dependency component) .SH SYNOPSIS -.B sisu -.I \-d [instruction] -[filename/wildcard if required] -.PP -.B sisu -.I \-d \-\-(sqlite|pg) \-\-[instruction] -[filename/wildcard if required] -.PP -.\"%% Description -.SH DESCRIPTION -.B sisu_sqlite -.I 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 -.\"%% Flags Database -.SH databases -.TP -dbi \- database interface -.B \-d -set for -.I sqlite -.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 \-\-sqlite \-\-import \-v -.I [filename/wildcard] -imports data specified to (sqlite) db (rb.dbi) -.TP -.B \-\-sqlite \-\-update \-v -.I [filename/wildcard] -updates/imports specified data to (sqlite) db (rb.dbi) -.TP -.B \-\-sqlite \-\-remove \-v -.I [filename/wildcard] -removes specified data to (sqlite) db (rb.dbi) -.TP -.B \-\-sqlite \-\-dropall -kills data" and drops (postgresql) db, tables & indexes -.TP -.B \-\-sqlite \-\-recreate -kills data" and drops and rebuilds empty (postgresql) db, tables & indexes -.RE -.\"%% Further Information -.SH FURTHER INFORMATION -.PP -For more information on +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 + +.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(/home/ralph/grotto/theatre/dbld/sisu\-dev/sisu/data/doc/sisu/sisu_markup_samples/sisu_manual/_sisu/skin/doc/skin_sisu_manual.rb)= +.I 20fc43cf3eb6590bc3399a1aef65c5a9 + +.BR +.B Generated + +.BR +Document (metaverse) last generated: +.I Sat Sep 29 16:06:43 +0100 2007 + +.BR +Generated by: .I SiSU -see: -.I -.PP -or -.I man sisu -.SH AUTHOR -Ralph Amissah -.I -or -.I -.SH SEE ALSO -.BR sisu(1), -.BR sisu(8), -.BR sisu_postgresql(7), -.BR sisu_vim(7) +.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 +." manpage: http://www.jus.uio.no/sisu/sisu_sqlite/sisu_sqlite.1 +.TP +at: +.TP +.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 16:06:44 +0100 2007 +.TP +* SiSU http://www.jus.uio.no/sisu -- cgit v1.2.3