SISU\-CONCORDANCE(1) manual page

From 5e5066823dfd7653372ac67720e6f411cf35ea4f Mon Sep 17 00:00:00 2001 From: Ralph Amissah Date: Mon, 20 Sep 2010 16:20:34 -0400 Subject: html, v2 update (including --long-options) (manpage sync adds files) --- data/doc/sisu/v2/html/sisu-concordance.1.html | 67 ++++ data/doc/sisu/v2/html/sisu-epub.1.html | 10 +- data/doc/sisu/v2/html/sisu-harvest.1.html | 69 ++++ data/doc/sisu/v2/html/sisu-html.1.html | 10 +- data/doc/sisu/v2/html/sisu-odf.1.html | 10 +- data/doc/sisu/v2/html/sisu-pdf.1.html | 12 +- data/doc/sisu/v2/html/sisu-pg.1.html | 8 +- data/doc/sisu/v2/html/sisu-sqlite.1.html | 8 +- data/doc/sisu/v2/html/sisu-txt.1.html | 10 +- data/doc/sisu/v2/html/sisu.1.html | 544 +++++++++++++++++--------- data/doc/sisu/v2/html/sisu_termsheet.1.html | 34 +- data/doc/sisu/v2/html/sisu_webrick.1.html | 49 +-- 12 files changed, 594 insertions(+), 237 deletions(-) create mode 100644 data/doc/sisu/v2/html/sisu-concordance.1.html create mode 100644 data/doc/sisu/v2/html/sisu-harvest.1.html diff --git a/data/doc/sisu/v2/html/sisu-concordance.1.html b/data/doc/sisu/v2/html/sisu-concordance.1.html new file mode 100644 index 00000000..0c1f5622 --- /dev/null +++ b/data/doc/sisu/v2/html/sisu-concordance.1.html @@ -0,0 +1,67 @@ + + + + + +SISU\-CONCORDANCE(1) manual page + + +Table of Contents

+ +

Name

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

system +

Synopsis

+sisu-concordance sisu_document.sst | sisu_document.ssm +

Description

+SiSU +is a lightweight markup based document structuring, publishing and search +framework for document collections.

+The sisu-concordance command is an alias +for sisu --concordance (or sisu -w) which produces an HTML concordance file +(wordlist) of a SiSU markup file. +

Homepage

+More information about SiSU can be found at <http://www.jus.uio.no/sisu/ +>. + +

Author

+SiSU was written by Ralph Amissah <ralph@amissah.com>.

+ +

+Table of Contents

Name
Synopsis
Description
See Also
Homepage
Author

+ + diff --git a/data/doc/sisu/v2/html/sisu-epub.1.html b/data/doc/sisu/v2/html/sisu-epub.1.html index 065aa4cf..f3722477 100644 --- a/data/doc/sisu/v2/html/sisu-epub.1.html +++ b/data/doc/sisu/v2/html/sisu-epub.1.html @@ -22,12 +22,16 @@ is a lightweight markup based document structuring, publishing and search framework for document collections.

The sisu-epub command is an alias for -sisu -e which produces EPUB output of a SiSU markup file. +sisu --epub (or sisu -e) which produces EPUB output of a SiSU markup file. +

Name

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

system +

Synopsis

+sisu-harvest sisu_document.sst | sisu_document.ssm +

Description

+SiSU +is a lightweight markup based document structuring, publishing and search +framework for document collections.

+The sisu-harvest command is an alias +for sisu --harvest 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. +

See +Also

+sisu(1) +,
+sisu-concordance(1) +,
+sisu-epub(1) +,
+sisu-html(1) +,
+sisu-pdf(1) +,
+sisu-odf(1) +,
+sisu-pg(1) +,
+sisu-sqlite(1) +,
+sisu-txt(1) +. +

Homepage

+More information about SiSU can be found at <http://www.jus.uio.no/sisu/ +>. + +

Author

+SiSU was written by Ralph Amissah <ralph@amissah.com>.

+ +

+Table of Contents

Name
Synopsis
Description
See Also
Homepage
Author

+ + diff --git a/data/doc/sisu/v2/html/sisu-html.1.html b/data/doc/sisu/v2/html/sisu-html.1.html index 5d8b2fa0..99fd959f 100644 --- a/data/doc/sisu/v2/html/sisu-html.1.html +++ b/data/doc/sisu/v2/html/sisu-html.1.html @@ -22,14 +22,18 @@ is a lightweight markup based document structuring, publishing and search framework for document collections.

The sisu-html command is an alias for -sisu -h which produces HTML output of a SiSU markup file. +sisu --html (or sisu -h) which produces HTML output of a SiSU markup file. +

See +Also

sisu(1) -, -
+,
+sisu-concordance(1) +,
sisu-epub(1) ,
+sisu-harvest(1) +,
sisu-html(1) ,
sisu-odf(1) diff --git a/data/doc/sisu/v2/html/sisu-pg.1.html b/data/doc/sisu/v2/html/sisu-pg.1.html index 3c94ea10..c87ae7a7 100644 --- a/data/doc/sisu/v2/html/sisu-pg.1.html +++ b/data/doc/sisu/v2/html/sisu-pg.1.html @@ -22,14 +22,18 @@ is a lightweight markup based document structuring, publishing and search framework for document collections.

The sisu-pq command is an alias for sisu --D which populates a PostgreSQL database with SiSU content (for search) -from a SiSU markup file. +--pg (or sisu -D) which populates a PostgreSQL database with SiSU content +(for search) from a SiSU markup file.

sisu(1) -, -
+,
+sisu-concordance(1) +,
sisu-epub(1) ,
+sisu-harvest(1) +,
sisu-html(1) ,
sisu-pdf(1) diff --git a/data/doc/sisu/v2/html/sisu.1.html b/data/doc/sisu/v2/html/sisu.1.html index 91991eea..67867294 100644 --- a/data/doc/sisu/v2/html/sisu.1.html +++ b/data/doc/sisu/v2/html/sisu.1.html @@ -154,18 +154,35 @@ footnotes at end of each paragraph that contains them [ -A for

-b [filename/wildcard]

produces xhtml/XML -output for browser viewing (sax parsing). +

see --xhtml +

+ +

--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 will be with colour, if sisurc colour default +is set to ’false’ or is undefined screen output will be without colour). Alias + +

- +

c +

+ +

--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

-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 update, existing shared -output config files such as css and dtd files are updated if this modifier -is used. +

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 update, existing shared output +config files such as css and dtd files are updated if this modifier is +used.

-CC

@@ -179,163 +196,303 @@ files such as css and dtd files are updated if -CC is used.

-c [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 -will be with colour, if sisurc colour default is set to ’false’ or is undefined -screen output will be without colour). +

see --color-toggle +

+ +

--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 +

+ +

--delete [filename/wildcard] +

see --zap

-D [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. +

see --pg

-d [--db-[database type (sqlite|pg)]] --[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. +

see --sqlite

-e [filename/wildcard]

produces an epub document, [sisu version 2 - only] (filename.epub) +

--epub [filename/wildcard]

produces +an epub document, [sisu version 2 only] (filename.epub). Alias -e +

+ +

-e [filename/wildcard] +

see --epub

-F [--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 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 -

- -

-h [filename/wildcard] +

see --sample-search-form +

+ +

--git [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) +

produces or updates markup source file structure in a git repo (experimental +and subject to change). Alias -g +

+ +

-g [filename/wildcard]

see --git +

+ +

--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. +

+ +

--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, (lang)uage, db, +install, setup, (conf)igure, convert, termsheet, search, sql, features, + +

license +

+ +

--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 +

+ +

-h [filename/wildcard]

see --html

-I [filename/wildcard]

produces texinfo and info file, (view with pinfo). +

see --texinfo

-i [filename/wildcard] -

produces man page of file, not suitable for all outputs. +

-i [filename/wildcard]

see --manpage

-L

prints license -information. +

prints license information. +

-M [filename/wildcard/url]

--machine [filename/wildcard/url]

see --dal (document abstraction level/layer) + +

+ +

--maintenance [filename/wildcard/url]

maintenance mode files created for -processing preserved and their locations indicated. (also see -V) +processing preserved and their locations indicated. (also see -V). Alias -M + +

+ +

--manpage [filename/wildcard]

produces man page of file, not suitable for +all outputs. Alias -i +

+ +

-M [filename/wildcard/url]

see --maintenance

-m [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 +

see --dal (document abstraction level/layer) +

--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.

-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. +

-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.

-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 by most processing -flags. +

-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 by most processing flags.

-o [filename/wildcard/url]

--odf [filename/wildcard/url] +

see --odt +

+ +

--odt [filename/wildcard/url]

output basic document in opendocument -file format (opendocument.odt). +file format (opendocument.odt). Alias -o +

+ +

-o [filename/wildcard/url]

see --odt + +

+ +

--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 +

+ +

--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

-p [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 +

see --pdf

-q [filename/wildcard] +

--quiet [filename/wildcard]

quiet less output to screen.

-q [filename/wildcard]

see --quiet +

+ +

--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 +

-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 +

see --rsync

-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 +

see --scp +

+ +

--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 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 +

+ +

--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 +

+ +

--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 +

+ +

--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 +

+ +

--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 relevant +parts of a sisu document which can then for example be emailed. A sisupod +includes sisu markup source file, (along with associated documents if a +master file, or available in multilingual versions), together with related +images and skin. SiSU 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 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 +

+ +

--source [filename/wildcard]

copies sisu markup +file to output directory. Alias -s

-S

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). -

- -

-S [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 relevant parts -of a sisu document which can then for example be emailed. A sisupod includes -sisu markup source file, (along with associated documents if a master file, -or available in multilingual versions), together with related images and -skin. SiSU 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 -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]. +

see --sisupod +

-S [filename/wildcard] +

see --sisupod

-s [filename/wildcard]

copies sisu markup file to output directory. +

see --source +

+ +

--texinfo [filename/wildcard] +

produces texinfo and info file, (view with pinfo). Alias -I +

+ +

--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 (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

-T [filename/wildcard @@ -345,23 +502,22 @@ the individual files for sending). See the -S option without [filename/wildcard]

-t [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 (Options include: --endnotes for endnotes --footnotes for footnotes at -the end of each paragraph --unix for unix linefeed (default) --msdos for msdos -linefeed) +
see --txt

-
-U [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 requested for processing. The default assumes -sisu_webrick is running and provides webrick url mappings where appropriate, +
--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 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 +

-
but these can be switched to file system paths in sisurc.yml +
-U [filename/wildcard]
+
see --urls

-u [filename/wildcard] @@ -371,6 +527,26 @@ sisu_webrick is running and provides webrick url mappings where appropriate,
also see -U
+
--v1 [filename/wildcard]
+
invokes the sisu v1 document parser/generator. +For use with sisu v1 markup documents. (Markup conversion to v2 involves +the modification of document headers) +

+ +
--v2 [filename/wildcard]
+
invokes the +sisu v2 document parser/generator. This is the default and is normally omitted. + +

+ +
--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 +

+
-V

on its own, provides SiSU version and environment information (sisu --help env) @@ -378,7 +554,7 @@ sisu_webrick is running and provides webrick url mappings where appropriate,
-V [filename/wildcard]

even more verbose than the -v flag. -(also see -M) +

-v
@@ -387,35 +563,55 @@ sisu_webrick is running and provides webrick url mappings where appropriate,
-v [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. See also -V +
+
see --verbose +

+ +
--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 and search +-H ; also, note -F webrick ]. Alias -W

-W
-
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 and search -H ; also, note -F webrick ]. +
see --webrick +

+ +
--wordmap [filename/wildcard] +
+
+
see --concordance +

+ +
-w [filename/wildcard]
+
see --concordance +

+ +
--xhtml [filename/wildcard] +
+
produces xhtml/XML output for browser viewing (sax parsing). Alias -b

-
-w +
--xml-dom [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) +
produces XML output with deep document structure, in +the nature of dom. Alias -X +

+ +
--xml-sax [filename/wildcard]
+
produces XML output +shallow structure (sax parsing). Alias -x

-X [filename/wildcard]
-
produces XML output with deep document -structure, in the nature of dom. +
see --xml-dom +

-x [filename/wildcard]
-
produces XML output -shallow structure (sax parsing). +
see --xml-sax

-Y [filename/wildcard]
@@ -432,42 +628,34 @@ metadata (sisu_manifest.html). This step is assumed for most processing flags.
-
-Z [filename/wildcard]
+
--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

-
-z [filename/wildcard]
-
produces php (zend) [this feature is disabled for - the time being] -

- -
--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. +
-Z [filename/wildcard]
+
see --zap

-3. COMMAND -LINE MODIFIERS +3. COMMAND LINE MODIFIERS

-
--no-ocn
-
[with -h -H or -p] switches off object citation numbering. -Produce output without identifying numbers in margins of html or LaTeX/pdf -output. +
--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. +

--no-annotate
-
strips output text of editor endnotes[^*1] denoted by +
strips output text of editor endnotes[^*1] denoted by asterisk -
asterisk or dagger/plus sign +
or dagger/plus sign

--no-asterisk
@@ -490,7 +678,7 @@ modifiable with --db=[database type (pgsql or sqlite)]

-
-Dv --createall
+
--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 @@ -502,27 +690,27 @@ be SiSU_[present working directory name (without path)]. alphanumerics and underscores.

-
-Dv --import
-
[filename/wildcard] imports data -specified to postgresql db (rb.dbi) [ -dv --import sqlite equivalent] +
--pg -v --import
+
[filename/wildcard] imports +data specified to postgresql db (rb.dbi) [ -dv --import sqlite equivalent] +

-
-Dv --update -
-
[filename/wildcard] updates/imports specified data to postgresql db (rb.dbi) -[ -dv --update sqlite equivalent] +
--pg -v --update
+
[filename/wildcard] updates/imports specified data to postgresql +db (rb.dbi) [ -dv --update sqlite equivalent]

-
-D --remove
-
[filename/wildcard] removes specified -data to postgresql db (rb.dbi) [ -d --remove sqlite equivalent] +
--pg --remove
+
[filename/wildcard] +removes specified data to postgresql db (rb.dbi) [ -d --remove sqlite equivalent] +

-
-D --dropall -
-
kills data" and drops (postgresql or sqlite) db, tables & indexes [ -d --dropall - sqlite equivalent] -
The v in e.g. -Dv is for verbose output. +
--pg --dropall
+
kills data" and drops (postgresql or sqlite) db, tables & indexes +[ -d --dropall sqlite equivalent] +
The -v is for verbose output.

5. SHORTCUTS, @@ -3272,6 +3460,8 @@ are authors’ works that while freely distributable are not freely changeab
sisu-epub(1) ,
+sisu-harvest(1) +,
sisu-html(1) ,
sisu-odf(1) diff --git a/data/doc/sisu/v2/html/sisu_termsheet.1.html b/data/doc/sisu/v2/html/sisu_termsheet.1.html index e2d6416d..061e097d 100644 --- a/data/doc/sisu/v2/html/sisu_termsheet.1.html +++ b/data/doc/sisu/v2/html/sisu_termsheet.1.html @@ -21,40 +21,40 @@ publishing system
Summary of man page

-sisu_termsheet, is started with the command: sisu -t [termsheet-name(s)] - +sisu_termsheet, is started with the command: sisu --termsheet +[termsheet-name(s)]
Document Processing Command Flags

-sisu -t [termsheet-name(s)] (runs sisu_termsheet) -merges the termsheet(s) specified on the commandline with the documents -it is instructed to merge in the termsheet(s), and produces regular SiSU -output documents from the merged results.
-[further documentation on termsheets -required] +sisu -t [termsheet-name(s)] +(runs sisu_termsheet) merges the termsheet(s) specified on the commandline +with the documents it is instructed to merge in the termsheet(s), and produces +regular SiSU output documents from the merged results.
+[further documentation +on termsheets required]
Further Information

-For more information on SiSU see: <http://www.jus.uio.no/sisu -> -
+For more information on SiSU +see: <http://www.jus.uio.no/sisu +>
or man sisu
Author
-Ralph Amissah <ralph@amissah.com> or <ralph.amissah@gmail.com> - +Ralph Amissah <ralph@amissah.com> +or <ralph.amissah@gmail.com>
See Also
sisu(1) , sisu(8) , sisu_webrick(1) , sisu_vim(7) +

Homepage
-More information -about SiSU can be found at <http://www.jus.uio.no/sisu/ +More information about SiSU can be found at <http://www.jus.uio.no/sisu/ >. +

Author
-SiSU was written -by Ralph Amissah <ralph@amissah.com>.
+SiSU was written by Ralph Amissah <ralph@amissah.com>.

Table of Contents
diff --git a/data/doc/sisu/v2/html/sisu_webrick.1.html b/data/doc/sisu/v2/html/sisu_webrick.1.html index 356d2518..ddfb69ba 100644 --- a/data/doc/sisu/v2/html/sisu_webrick.1.html +++ b/data/doc/sisu/v2/html/sisu_webrick.1.html @@ -23,41 +23,44 @@ sisu -W SISU - SISU_WEBRICK, RALPH AMISSAH
1.2 SYNOPSIS
sisu_webrick [port]
or +
sisu --Webrick + [port] +
or
sisu -W [port] -
1.3 DESCRIPTION -
sisu_webrick is part of SiSU (man sisu) sisu_webrick -starts Ruby ’s Webrick web-server and points it to the directories to which -SiSU output is written, providing a list of these directories (assuming -SiSU is in use and they exist). -
The default port for sisu_webrick is set -to 8081, this may be modified in the yaml file: ~/.sisu/sisurc.yml a sample -of which is provided as /etc/sisu/sisurc.yml (or in the equivalent directory -on your system). +
sisu_webrick is part of SiSU +(man sisu) sisu_webrick starts Ruby ’s Webrick web-server and points it to +the directories to which SiSU output is written, providing a list of these +directories (assuming SiSU is in use and they exist). +
The default port +for sisu_webrick is set to 8081, this may be modified in the yaml file: +~/.sisu/sisurc.yml a sample of which is provided as /etc/sisu/sisurc.yml (or +in the equivalent directory on your system).
1.4 SUMMARY OF MAN PAGE -
sisu_webrick, may be started -on it’s own with the command: sisu_webrick or using the sisu command with -the -W flag: sisu -W [port] -
where no port is given and settings are unchanged +
sisu_webrick, +may be started on it’s own with the command: sisu_webrick or using the sisu +command with the -W flag: sisu -W [port] +
where no port is given and settings + +
are unchanged the default port is 8081 +
1.5 DOCUMENT PROCESSING COMMAND -
the default port is 8081 -
1.5 DOCUMENT PROCESSING COMMAND FLAGS -
sisu -W - [port] starts Ruby Webrick web-server, serving SiSU output directories, -on the port provided, or if no port is provided and the defaults have not +
FLAGS +
sisu -W [port] starts Ruby Webrick web-server, serving SiSU output +directories, on the port provided, or if no port is provided and the defaults -
been changed in ~/.sisu/sisurc.yaml then on port 8081 -
1.6 FURTHER INFORMATION +
have not been changed in ~/.sisu/sisurc.yaml then on port 8081 +
1.6 FURTHER +
INFORMATION
For more information on SiSU see: <http://www.jus.uio.no/sisu > -
or man sisu +
or man sisu
1.7 AUTHOR
Ralph Amissah ralph@amissah.com or ralph.amissah@gmail.com -
1.8 -
SEE ALSO +
1.8 SEE ALSO
sisu(1)
-- cgit v1.2.3