aboutsummaryrefslogtreecommitdiffhomepage
path: root/data/doc/sisu/v2/html/sisu.1.html
diff options
context:
space:
mode:
Diffstat (limited to 'data/doc/sisu/v2/html/sisu.1.html')
-rw-r--r--data/doc/sisu/v2/html/sisu.1.html544
1 files changed, 367 insertions, 177 deletions
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 &nbsp
<p> </dd>
<dt><b>-b [filename/wildcard]</b> </dt>
-<dd>produces xhtml/XML
-output for browser viewing (sax parsing).
+<dd>see --xhtml
+<p> </dd>
+
+<dt><b>--color-toggle
+[filename/wildcard]</b> </dt>
+<dd>screen toggle ansi screen colour on or off depending
+on default set (unless -c flag is used: if sisurc colour default is set
+to &rsquo;true&rsquo;, output to screen will be with colour, if sisurc colour default
+is set to &rsquo;false&rsquo; or is undefined screen output will be without colour). Alias
+
+<p>-
+<p>c
+<p> </dd>
+
+<dt><b>--concordance [filename/wildcard]</b> </dt>
+<dd>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
<p> </dd>
<dt><b>-C [--init-site]</b> </dt>
-<dd>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.
+<dd>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.
<p> </dd>
<dt><b>-CC</b> </dt>
@@ -179,163 +196,303 @@ files such as css and dtd files are updated if -CC is used.
<dt><b>-c [filename/wildcard]</b>
</dt>
-<dd>screen toggle ansi screen colour on or off depending on default set (unless
--c flag is used: if sisurc colour default is set to &rsquo;true&rsquo;, output to screen
-will be with colour, if sisurc colour default is set to &rsquo;false&rsquo; or is undefined
-screen output will be without colour).
+<dd>
+<p>see --color-toggle
+<p> </dd>
+
+<dt><b>--dal [filename/wildcard/url]</b> </dt>
+<dd>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
+<p> </dd>
+
+<dt><b>--delete [filename/wildcard]</b>
+</dt>
+<dd>
+<p>see --zap
<p> </dd>
<dt><b>-D [instruction] [filename]</b> </dt>
-<dd>database
-postgresql ( --pgsql may be used instead) possible instructions, include:
---createdb; --create; --dropall; --import [filename]; --update [filename]; --remove
-[filename]; see database section below.
+<dd>see --pg
<p> </dd>
<dt><b>-d [--db-[database &nbsp;type &nbsp;(sqlite|pg)]]
--[instruction] [filename]</b> </dt>
-<dd>database type default set to sqlite, (for which
---sqlite may be used instead) or to specify another database --db-[pgsql, &nbsp;sqlite]
-(however see -D) possible instructions include: --createdb; --create; --dropall;
---import [filename]; --update [filename]; --remove [filename]; see database section
-below.
+<dd>see --sqlite
<p> </dd>
-<dt><b>-e [filename/wildcard]</b> </dt>
-<dd>produces an epub document, [sisu &nbsp;version &nbsp;2
-&nbsp;only] (filename.epub)
+<dt><b>--epub [filename/wildcard]</b> </dt>
+<dd>produces
+an epub document, [sisu &nbsp;version &nbsp;2 &nbsp;only] (filename.epub). Alias -e
+<p> </dd>
+
+<dt><b>-e [filename/wildcard]</b>
+</dt>
+<dd>
+<p>see --epub
<p> </dd>
<dt><b>-F [--webserv=webrick]</b> </dt>
-<dd>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)
-
-<p>provides some information on setting up hyperestraier for sisu
-<p> </dd>
-
-<dt><b>-h [filename/wildcard]</b>
+<dd>see --sample-search-form
+<p> </dd>
+
+<dt><b>--git [filename/wildcard]</b>
</dt>
-<dd>produces html output, segmented text with table of contents (toc.html and
-index.html) and the document in a single file (scroll.html)
+<dd>produces or updates markup source file structure in a git repo (experimental
+and subject to change). Alias -g
+<p> </dd>
+
+<dt><b>-g [filename/wildcard]</b> </dt>
+<dd>see --git
+<p> </dd>
+
+<dt><b>--harvest
+*.ss[tm]</b> </dt>
+<dd>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.
+<p> </dd>
+
+<dt><b>--help [topic]</b> </dt>
+<dd>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,
+
+<p>license
+<p> </dd>
+
+<dt><b>--html [filename/wildcard]</b> </dt>
+<dd>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
+<p> </dd>
+
+<dt><b>-h [filename/wildcard]</b> </dt>
+<dd>see --html
<p> </dd>
<dt><b>-I [filename/wildcard]</b>
</dt>
-<dd>produces texinfo and info file, (view with pinfo).
+<dd>
+<p>see --texinfo
<p> </dd>
-<dt><b>-i [filename/wildcard]</b>
-</dt>
-<dd>produces man page of file, not suitable for all outputs.
+<dt><b>-i [filename/wildcard]</b> </dt>
+<dd>see --manpage
<p> </dd>
<dt><b>-L</b> </dt>
-<dd>prints license
-information.
+<dd>prints license information.
+
<p> </dd>
-<dt><b>-M [filename/wildcard/url]</b> </dt>
+<dt><b>--machine [filename/wildcard/url]</b> </dt>
+<dd>see --dal (document abstraction level/layer)
+
+<p> </dd>
+
+<dt><b>--maintenance [filename/wildcard/url]</b> </dt>
<dd>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
+
+<p> </dd>
+
+<dt><b>--manpage [filename/wildcard]</b> </dt>
+<dd>produces man page of file, not suitable for
+all outputs. Alias -i
+<p> </dd>
+
+<dt><b>-M [filename/wildcard/url]</b> </dt>
+<dd>see --maintenance
<p> </dd>
<dt><b>-m [filename/wildcard/url]</b>
</dt>
-<dd>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
+<dd>see --dal (document abstraction level/layer)
+<p> </dd>
+<dt><b>--no-ocn</b> </dt>
+<dd>[with &nbsp;--html &nbsp;--pdf &nbsp;or &nbsp;--epub]
+switches off object citation numbering. Produce output without identifying
+numbers in margins of html or LaTeX/pdf output.
<p> </dd>
-<dt><b>-N [filename/wildcard/url]</b> </dt>
-<dd>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.
+<dt><b>-N [filename/wildcard/url]</b>
+</dt>
+<dd>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.
<p> </dd>
-<dt><b>-n [filename/wildcard/url]</b> </dt>
-<dd>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.
+<dt><b>-n
+[filename/wildcard/url]</b> </dt>
+<dd>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.
<p> </dd>
-<dt><b>-o [filename/wildcard/url]</b> </dt>
+<dt><b>--odf [filename/wildcard/url]</b>
+</dt>
+<dd>
+<p>see --odt
+<p> </dd>
+
+<dt><b>--odt [filename/wildcard/url]</b> </dt>
<dd>output basic document in opendocument
-file format (opendocument.odt).
+file format (opendocument.odt). Alias -o
+<p> </dd>
+
+<dt><b>-o [filename/wildcard/url]</b> </dt>
+<dd>see --odt
+
+<p> </dd>
+
+<dt><b>--pdf [filename/wildcard]</b> </dt>
+<dd>produces LaTeX pdf (portrait.pdf &amp; 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:
+&rsquo;A4&rsquo;, U.S. &rsquo;letter&rsquo; and
+<p> </dd>
+
+<dt><b>--pg [instruction] [filename]</b> </dt>
+<dd>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> </dd>
<dt><b>-p [filename/wildcard]</b> </dt>
-<dd>produces LaTeX pdf
-(portrait.pdf &amp; 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: &rsquo;A4&rsquo;, U.S. &rsquo;letter&rsquo; and
+<dd>see --pdf
<p> </dd>
-<dt><b>-q [filename/wildcard]</b>
+<dt><b>--quiet [filename/wildcard]</b>
</dt>
<dd>quiet less output to screen.
<p> </dd>
+<dt><b>-q [filename/wildcard]</b> </dt>
+<dd>see --quiet
+<p> </dd>
+
+<dt><b>--rsync [filename/wildcard]</b>
+</dt>
+<dd>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
+
+<p>-
+<p>R
+<p> </dd>
+
<dt><b>-R [filename/wildcard]</b> </dt>
-<dd>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
+<dd>see --rsync
<p> </dd>
<dt><b>-r [filename/wildcard]</b> </dt>
-<dd>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
+<dd>see --scp
+<p> </dd>
+
+<dt><b>--sample-search-form
+[--webserv=webrick]</b> </dt>
+<dd>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
+<p> </dd>
+
+<dt><b>--scp [filename/wildcard]</b> </dt>
+<dd>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
+<p> </dd>
+
+<dt><b>--sqlite
+--[instruction] [filename]</b> </dt>
+<dd>database type default set to sqlite, (for which
+--sqlite may be used instead) or to specify another database --db-[pgsql, &nbsp;sqlite]
+(however see -D) possible instructions include: --createdb; --create; --dropall;
+--import [filename]; --update [filename]; --remove [filename]; see database section
+below. Alias -d
+<p> </dd>
+
+<dt><b>--sisupod</b> </dt>
+<dd>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<br>
+ option is tested only with zsh). Alias -S
+<p> </dd>
+
+<dt><b>--sisupod [filename/wildcard]</b> </dt>
+<dd>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. <b>SiSU</b> 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
+<p> </dd>
+
+<dt><b>--source [filename/wildcard]</b> </dt>
+<dd>copies sisu markup
+file to output directory. Alias -s
<p> </dd>
<dt><b>-S</b> </dt>
-<dd>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<br>
- option is tested only with zsh).
-<p> </dd>
-
-<dt><b>-S [filename/wildcard]</b> </dt>
-<dd>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. <b>SiSU</b> 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].
+<dd>see --sisupod
+<p> </dd>
+<dt><b>-S [filename/wildcard]</b>
+</dt>
+<dd>
+<p>see --sisupod
<p> </dd>
<dt><b>-s [filename/wildcard]</b> </dt>
-<dd>copies sisu markup file to output directory.
+<dd>see --source
+<p> </dd>
+
+<dt><b>--texinfo [filename/wildcard]</b>
+</dt>
+<dd>produces texinfo and info file, (view with pinfo). Alias -I
+<p> </dd>
+
+<dt><b>--txt [filename/wildcard]</b>
+</dt>
+<dd>produces plaintext with Unix linefeeds and without markup, (object numbers
+are omitted), has footnotes at end of each paragraph that contains them
+[ &nbsp;-A &nbsp;for &nbsp;equivalent &nbsp;dos &nbsp;(linefeed) &nbsp;output &nbsp;file] [see &nbsp;-e &nbsp;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
<p> </dd>
<dt><b>-T [filename/wildcard
@@ -345,23 +502,22 @@ the individual files for sending). See the -S option without [filename/wildcard]
</dd>
<dt><b>-t [filename/wildcard]</b> </dt>
-<dd>produces plaintext with Unix linefeeds and without
-markup, (object numbers are omitted), has footnotes at end of each paragraph
-that contains them [ &nbsp;-A &nbsp;for &nbsp;equivalent &nbsp;dos &nbsp;(linefeed) &nbsp;output &nbsp;file] [see
-&nbsp;-e &nbsp;for (Options include: --endnotes for endnotes --footnotes for footnotes at
-the end of each paragraph --unix for unix linefeed (default) --msdos for msdos
-linefeed)
+<dd>see --txt
<p> </dd>
-<dt><b>-U [filename/wildcard]</b> </dt>
-<dd>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,
+<dt><b>--urls [filename/wildcard]</b> </dt>
+<dd>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
+<p> </dd>
-<p>but these can be switched to file system paths in sisurc.yml
+<dt><b>-U [filename/wildcard]</b> </dt>
+<dd>see --urls
<p> </dd>
<dt><b>-u [filename/wildcard]</b>
@@ -371,6 +527,26 @@ sisu_webrick is running and provides webrick url mappings where appropriate,
<p>also see -U
<p> </dd>
+<dt><b>--v1 [filename/wildcard]</b> </dt>
+<dd>invokes the sisu v1 document parser/generator.
+For use with sisu v1 markup documents. (Markup conversion to v2 involves
+the modification of document headers)
+<p> </dd>
+
+<dt><b>--v2 [filename/wildcard]</b> </dt>
+<dd>invokes the
+sisu v2 document parser/generator. This is the default and is normally omitted.
+
+<p> </dd>
+
+<dt><b>--verbose [filename/wildcard]</b> </dt>
+<dd>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.
+
+<p>Alias -v
+<p> </dd>
+
<dt><b>-V</b> </dt>
<dd>on its own, provides <b>SiSU</b> version and environment information
(sisu --help env)
@@ -378,7 +554,7 @@ sisu_webrick is running and provides webrick url mappings where appropriate,
<dt><b>-V [filename/wildcard]</b> </dt>
<dd>even more verbose than the -v flag.
-(also see -M)
+
<p> </dd>
<dt><b>-v</b> </dt>
@@ -387,35 +563,55 @@ sisu_webrick is running and provides webrick url mappings where appropriate,
<dt><b>-v [filename/wildcard]</b>
</dt>
-<dd>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
+<dd>
+<p>see --verbose
+<p> </dd>
+
+<dt><b>--webrick</b> </dt>
+<dd>starts ruby&rsquo;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: &nbsp;the &nbsp;webrick &nbsp;server &nbsp;requires &nbsp;link &nbsp;suffixes,
+&nbsp;so &nbsp;html &nbsp;output &nbsp;should &nbsp;be &nbsp;created &nbsp;using &nbsp;the &nbsp;-h &nbsp;option &nbsp;rather &nbsp;than and search
+-H &nbsp;; &nbsp;also, &nbsp;note &nbsp;-F &nbsp;webrick &nbsp;]. Alias -W
<p> </dd>
<dt><b>-W</b> </dt>
-<dd>starts ruby&rsquo;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:
-&nbsp;the &nbsp;webrick &nbsp;server &nbsp;requires &nbsp;link &nbsp;suffixes, &nbsp;so &nbsp;html &nbsp;output &nbsp;should &nbsp;be &nbsp;created
-&nbsp;using &nbsp;the &nbsp;-h &nbsp;option &nbsp;rather &nbsp;than and search -H &nbsp;; &nbsp;also, &nbsp;note &nbsp;-F &nbsp;webrick &nbsp;].
+<dd>see --webrick
+<p> </dd>
+
+<dt><b>--wordmap [filename/wildcard]</b>
+</dt>
+<dd>
+<p>see --concordance
+<p> </dd>
+
+<dt><b>-w [filename/wildcard]</b> </dt>
+<dd>see --concordance
+<p> </dd>
+
+<dt><b>--xhtml [filename/wildcard]</b>
+</dt>
+<dd>produces xhtml/XML output for browser viewing (sax parsing). Alias -b
<p> </dd>
-<dt><b>-w
+<dt><b>--xml-dom
[filename/wildcard]</b> </dt>
-<dd>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)
+<dd>produces XML output with deep document structure, in
+the nature of dom. Alias -X
+<p> </dd>
+
+<dt><b>--xml-sax [filename/wildcard]</b> </dt>
+<dd>produces XML output
+shallow structure (sax parsing). Alias -x
<p> </dd>
<dt><b>-X [filename/wildcard]</b> </dt>
-<dd>produces XML output with deep document
-structure, in the nature of dom.
+<dd>see --xml-dom
+
<p> </dd>
<dt><b>-x [filename/wildcard]</b> </dt>
-<dd>produces XML output
-shallow structure (sax parsing).
+<dd>see --xml-sax
<p> </dd>
<dt><b>-Y [filename/wildcard]</b> </dt>
@@ -432,42 +628,34 @@ metadata (sisu_manifest.html). This step is assumed for most processing flags.
<p> </dd>
-<dt><b>-Z [filename/wildcard]</b> </dt>
+<dt><b>--zap [filename/wildcard]</b> </dt>
<dd>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.
+<p>Alias -Z
<p> </dd>
-<dt><b>-z [filename/wildcard]</b> </dt>
-<dd>produces php (zend) [this &nbsp;feature &nbsp;is &nbsp;disabled &nbsp;for
-&nbsp;the &nbsp;time being]
-<p> </dd>
-
-<dt><b>--harvest *.ss[tm]</b> </dt>
-<dd>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.
+<dt><b>-Z [filename/wildcard]</b> </dt>
+<dd>see --zap
<p> </dd>
</dl>
-3. COMMAND
-LINE MODIFIERS
+3. COMMAND LINE MODIFIERS
<p>
<dl>
-<dt><b>--no-ocn</b> </dt>
-<dd>[with &nbsp;-h &nbsp;-H &nbsp;or &nbsp;-p] switches off object citation numbering.
-Produce output without identifying numbers in margins of html or LaTeX/pdf
-output.
+<dt><b>--no-ocn</b>
+</dt>
+<dd>[with &nbsp;--html &nbsp;--pdf &nbsp;or &nbsp;--epub] switches off object citation numbering. Produce
+output without identifying numbers in margins of html or LaTeX/pdf output.
+
<p> </dd>
<dt><b>--no-annotate</b> </dt>
-<dd>strips output text of editor endnotes[^*1] denoted by
+<dd>strips output text of editor endnotes[^*1] denoted by asterisk
-<p>asterisk or dagger/plus sign
+<p>or dagger/plus sign
<p> </dd>
<dt><b>--no-asterisk</b> </dt>
@@ -490,7 +678,7 @@ modifiable with --db=[database &nbsp;type &nbsp;(pgsql &nbsp;or &nbsp;sqlite)]
<p>
<dl>
-<dt><b>-Dv --createall</b> </dt>
+<dt><b>--pg -v --createall</b> </dt>
<dd>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 &nbsp;working &nbsp;directory &nbsp;name (without &nbsp;path)].
alphanumerics and underscores.
<p> </dd>
-<dt><b>-Dv --import</b> </dt>
-<dd>[filename/wildcard] imports data
-specified to postgresql db (rb.dbi) [ &nbsp;-dv &nbsp;--import &nbsp;sqlite &nbsp;equivalent]
+<dt><b>--pg -v --import</b> </dt>
+<dd>[filename/wildcard] imports
+data specified to postgresql db (rb.dbi) [ &nbsp;-dv &nbsp;--import &nbsp;sqlite &nbsp;equivalent]
+
<p> </dd>
-<dt><b>-Dv --update</b>
-</dt>
-<dd>[filename/wildcard] updates/imports specified data to postgresql db (rb.dbi)
-[ &nbsp;-dv &nbsp;--update &nbsp;sqlite &nbsp;equivalent]
+<dt><b>--pg -v --update</b> </dt>
+<dd>[filename/wildcard] updates/imports specified data to postgresql
+db (rb.dbi) [ &nbsp;-dv &nbsp;--update &nbsp;sqlite &nbsp;equivalent]
<p> </dd>
-<dt><b>-D --remove</b> </dt>
-<dd>[filename/wildcard] removes specified
-data to postgresql db (rb.dbi) [ &nbsp;-d &nbsp;--remove &nbsp;sqlite &nbsp;equivalent]
+<dt><b>--pg --remove</b> </dt>
+<dd>[filename/wildcard]
+removes specified data to postgresql db (rb.dbi) [ &nbsp;-d &nbsp;--remove &nbsp;sqlite &nbsp;equivalent]
+
<p> </dd>
-<dt><b>-D --dropall</b>
-</dt>
-<dd>kills data" and drops (postgresql or sqlite) db, tables &amp; indexes [ &nbsp;-d --dropall
-&nbsp;sqlite &nbsp;equivalent]
-<p> The v in e.g. -Dv is for verbose output.
+<dt><b>--pg --dropall</b> </dt>
+<dd>kills data" and drops (postgresql or sqlite) db, tables &amp; indexes
+[ &nbsp;-d --dropall &nbsp;sqlite &nbsp;equivalent]
+<p> The -v is for verbose output.
<p> </dd>
</dl>
5. SHORTCUTS,
@@ -3272,6 +3460,8 @@ are authors&rsquo; works that while freely distributable are not freely changeab
<br>
<a href='http:~/bin/man2html?sisu-epub:1'><i>sisu-epub</i>(1)</a>
, <br>
+<a href='http:~/bin/man2html?sisu-harvest:1'><i>sisu-harvest</i>(1)</a>
+, <br>
<a href='http:~/bin/man2html?sisu-html:1'><i>sisu-html</i>(1)</a>
, <br>
<a href='http:~/bin/man2html?sisu-odf:1'><i>sisu-odf</i>(1)</a>