<?xml version="1.0" encoding="UTF-8" standalone="no"?>
<?xml-stylesheet type="text/css" href="../_sisu/css/xhtml.css"?>
<!-- Document processing information:
* Generated by: SiSU 0.59.0 of 2007w38/0 (2007-09-23)
* Ruby version: ruby 1.8.6 (2007-06-07 patchlevel 36) [i486-linux]
*
* Last Generated on: Mon Sep 24 15:31:59 +0100 2007
* SiSU http://www.jus.uio.no/sisu
-->
<document>
<head>
<meta http-equiv="Content-Type" content="text/html;charset=utf-8" />
<meta>Title:</meta>
<title class="dc">
SiSU - Commands
</title>
<br />
<meta>Creator:</meta>
<creator class="dc">
Ralph Amissah
</creator>
<br />
<meta>Rights:</meta>
<rights class="dc">
Copyright (C) Ralph Amissah 2007, part of SiSU documentation, License GPL 3
</rights>
<br />
<meta>Type:</meta>
<type class="dc">
information
</type>
<br />
<meta>Subject:</meta>
<subject class="dc">
ebook, epublishing, electronic book, electronic publishing, electronic document, electronic citation, data structure, citation systems, search
</subject>
<br />
<meta>Date created:</meta>
<date_created class="extra">
2002-08-28
</date_created>
<br />
<meta>Date issued:</meta>
<date_issued class="extra">
2002-08-28
</date_issued>
<br />
<meta>Date available:</meta>
<date_available class="extra">
2002-08-28
</date_available>
<br />
<meta>Date modified:</meta>
<date_modified class="extra">
2007-09-16
</date_modified>
<br />
<meta>Date:</meta>
<date class="dc">
2007-09-16
</date>
<br />
</head>
<body>
<object id="1">
<text class="h1">
SiSU - Commands,<br /> Ralph Amissah
</text>
<ocn>1</ocn>
</object>
<object id="2">
<text class="h2">
SiSU Commands
</text>
<ocn>2</ocn>
</object>
<object id="3">
<text class="h4">
1. Commands Summary
</text>
<ocn>3</ocn>
</object>
<object id="4">
<text class="h5">
1.1 Synopsis
</text>
<ocn>4</ocn>
</object>
<object id="5">
<text class="norm">
<b>SiSU</b> - Structured information, Serialized Units - a document
publishing system
</text>
<ocn>5</ocn>
</object>
<object id="6">
<text class="norm">
sisu [ -abcDdFHhIiMmNnopqRrSsTtUuVvwXxYyZz0-9 ] [ filename/ wildcard ]
</text>
<ocn>6</ocn>
</object>
<object id="7">
<text class="norm">
sisu [ -Ddcv ] [ instruction ]
</text>
<ocn>7</ocn>
</object>
<object id="8">
<text class="norm">
sisu [ -CcFLSVvW ]
</text>
<ocn>8</ocn>
</object>
<object id="9">
<text class="norm">
Note: commands should be issued from within the directory that contains
the marked up files, cd to markup directory.
</text>
<ocn>9</ocn>
</object>
<object id="10">
<text class="h5">
1.2 Description
</text>
<ocn>10</ocn>
</object>
<object id="11">
<text class="norm">
<b>SiSU</b> <b>SiSU</b> is a document publishing system, that from a
simple single marked-up document, produces multiple of output formats
including: plaintext, html, LaTeX, pdf, xhtml, XML, info, and SQL
(PostgreSQL and SQLite), which share numbered text objects ("object
citation numbering") and the same document structure information. For
more see: <<link xmlns:xlink="http://www.w3.org/1999/xlink"
xlink:type="simple"
xlink:href="http://www.jus.uio.no/sisu">http://www.jus.uio.no/sisu</link>>
</text>
<ocn>11</ocn>
</object>
<object id="12">
<text class="h5">
1.3 Document Processing Command Flags
</text>
<ocn>12</ocn>
</object>
<object id="13">
<text class="norm">
<b>-a [filename/wildcard] </b><br /> 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 endnotes]. (Options
include: --endnotes for endnotes --footnotes for footnotes at the end
of each paragraph --unix for unix linefeed (default) --msdos for msdos
linefeed)
</text>
<ocn>13</ocn>
</object>
<object id="14">
<text class="norm">
<b>-b [filename/wildcard] </b><br /> produces xhtml/XML output for
browser viewing (sax parsing).
</text>
<ocn>14</ocn>
</object>
<object id="15">
<text class="norm">
<b>-C [--init-site] </b><br /> 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.
</text>
<ocn>15</ocn>
</object>
<object id="16">
<text class="norm">
<b>-CC </b><br /> 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).
The equivalent of: -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 -CC is used.
</text>
<ocn>16</ocn>
</object>
<object id="17">
<text class="norm">
<b>-c [filename/wildcard] </b><br /> 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).
</text>
<ocn>17</ocn>
</object>
<object id="18">
<text class="norm">
<b>-D [instruction] [filename] </b><br /> database postgresql ( --pgsql
may be used instead) possible instructions, include: --createdb;
--create; --dropall; --import [filename]; --update [filename]; --remove
[filename]; see database section below.
</text>
<ocn>18</ocn>
</object>
<object id="19">
<text class="norm">
<b>-d [--db-[database type (sqlite|pg)]] --[instruction] [filename]
</b><br /> 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.
</text>
<ocn>19</ocn>
</object>
<object id="20">
<text class="norm">
<b>-F [--webserv=webrick] </b><br /> 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
</text>
<ocn>20</ocn>
</object>
<object id="21">
<text class="norm">
<b>-H [filename/wildcard] </b><br /> produces html without link
suffixes (.html .pdf etc.) ("Hide"). Requires an appropriately
configured web server. [behaviour switched after 0.35 see -h].
</text>
<ocn>21</ocn>
</object>
<object id="22">
<text class="norm">
<b>-h [filename/wildcard] </b><br /> produces html (with hardlinks i.e.
with name suffixes in links/local urls). html, with internal document
links that include the document suffix, i.e. whether it is .html or
.pdf (required for browsing directly off a file system, and works with
most web servers). [behaviour switched after 0.35 see -H].
</text>
<ocn>22</ocn>
</object>
<object id="23">
<text class="norm">
<b>-I [filename/wildcard] </b><br /> produces texinfo and info file,
(view with pinfo).
</text>
<ocn>23</ocn>
</object>
<object id="24">
<text class="norm">
<b>-L </b><br /> prints license information.
</text>
<ocn>24</ocn>
</object>
<object id="25">
<text class="norm">
<b>-M [filename/wildcard/url] </b><br /> maintenance mode files created
for processing preserved and their locations indicated. (also see -V)
</text>
<ocn>25</ocn>
</object>
<object id="26">
<text class="norm">
<b>-m [filename/wildcard/url] </b><br /> assumed for most other flags,
creates new meta-markup file, (the metaverse ) that is used in all
subsequent processing of other output. This step is assumed for most
processing flags. To skip it see -n
</text>
<ocn>26</ocn>
</object>
<object id="27">
<text class="norm">
<b>-N [filename/wildcard/url] </b><br /> 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.
</text>
<ocn>27</ocn>
</object>
<object id="28">
<text class="norm">
<b>-n [filename/wildcard/url] </b><br /> skip meta-markup (building of
"metaverse"), this skips the equivalent of -m which is otherwise
assumed by most processing flags.
</text>
<ocn>28</ocn>
</object>
<object id="29">
<text class="norm">
<b>-o [filename/wildcard/url] </b><br /> output basic document in
opendocument file format (opendocument.odt).
</text>
<ocn>29</ocn>
</object>
<object id="30">
<text class="norm">
<b>-p [filename/wildcard] </b><br /> 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
'legal' and book sizes 'A5' and 'B5' (system defaults to A4).
</text>
<ocn>30</ocn>
</object>
<object id="31">
<text class="norm">
<b>-q [filename/wildcard] </b><br /> quiet less output to screen.
</text>
<ocn>31</ocn>
</object>
<object id="32">
<text class="norm">
<b>-R [filename/wildcard] </b><br /> 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
</text>
<ocn>32</ocn>
</object>
<object id="33">
<text class="norm">
<b>-r [filename/wildcard] </b><br /> 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
</text>
<ocn>33</ocn>
</object>
<object id="34">
<text class="norm">
<b>-S </b><br /> 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).
</text>
<ocn>34</ocn>
</object>
<object id="35">
<text class="norm">
<b>-S [filename/wildcard] </b><br /> 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].
</text>
<ocn>35</ocn>
</object>
<object id="36">
<text class="norm">
<b>-s [filename/wildcard] </b><br /> copies sisu markup file to output
directory.
</text>
<ocn>36</ocn>
</object>
<object id="37">
<text class="norm">
<b>-t [filename/wildcard (*.termsheet.rb)] </b><br /> standard form
document builder, preprocessing feature
</text>
<ocn>37</ocn>
</object>
<object id="38">
<text class="norm">
<b>-U [filename/wildcard] </b><br /> 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
</text>
<ocn>38</ocn>
</object>
<object id="39">
<text class="norm">
<b>-u [filename/wildcard] </b><br /> provides url mapping of output
files for the flags requested for processing, also see -U
</text>
<ocn>39</ocn>
</object>
<object id="40">
<text class="norm">
<b>-V </b><br /> on its own, provides <b>SiSU</b> version and
environment information (sisu --help env)
</text>
<ocn>40</ocn>
</object>
<object id="41">
<text class="norm">
<b>-V [filename/wildcard] </b><br /> even more verbose than the -v
flag. (also see -M)
</text>
<ocn>41</ocn>
</object>
<object id="42">
<text class="norm">
<b>-v </b><br /> on its own, provides <b>SiSU</b> version information
</text>
<ocn>42</ocn>
</object>
<object id="43">
<text class="norm">
<b>-v [filename/wildcard] </b><br /> provides verbose output of what is
being built, where it is being built (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
</text>
<ocn>43</ocn>
</object>
<object id="44">
<text class="norm">
<b>-W </b><br /> 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 -H; also, note -F webrick ].
</text>
<ocn>44</ocn>
</object>
<object id="45">
<text class="norm">
<b>-w [filename/wildcard] </b><br /> 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)
</text>
<ocn>45</ocn>
</object>
<object id="46">
<text class="norm">
<b>-X [filename/wildcard] </b><br /> produces XML output with deep
document structure, in the nature of dom.
</text>
<ocn>46</ocn>
</object>
<object id="47">
<text class="norm">
<b>-x [filename/wildcard] </b><br /> produces XML output shallow
structure (sax parsing).
</text>
<ocn>47</ocn>
</object>
<object id="48">
<text class="norm">
<b>-Y [filename/wildcard] </b><br /> produces a short sitemap entry for
the document, based on html output and the sisu_manifest. --sitemaps
generates/updates the sitemap index of existing sitemaps.
(Experimental, [g,y,m announcement this week])
</text>
<ocn>48</ocn>
</object>
<object id="49">
<text class="norm">
<b>-y [filename/wildcard] </b><br /> produces an html summary of output
generated (hyperlinked to content) and document specific metadata
(sisu_manifest.html). This step is assumed for most processing flags.
</text>
<ocn>49</ocn>
</object>
<object id="50">
<text class="norm">
<b>-Z [filename/wildcard] </b><br /> 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.
</text>
<ocn>50</ocn>
</object>
<object id="51">
<text class="norm">
<b>-z [filename/wildcard] </b><br /> produces php (zend) [this feature
is disabled for the time being]
</text>
<ocn>51</ocn>
</object>
<object id="52">
<text class="h4">
2. command line modifiers
</text>
<ocn>52</ocn>
</object>
<object id="53">
<text class="norm">
<b>--no-ocn </b><br /> [with -h -H or -p] switches off object citation
numbering. Produce output without identifying numbers in margins of
html or LaTeX/pdf output.
</text>
<ocn>53</ocn>
</object>
<object id="54">
<text class="norm">
<b>--no-annotate </b><br /> strips output text of editor
endnotes<en>*1</en> denoted by asterisk or dagger/plus sign
</text>
<endnote symbol="*1">
*1 square brackets
</endnote>
<ocn>54</ocn>
</object>
<object id="55">
<text class="norm">
<b>--no-asterisk </b><br /> strips output text of editor
endnotes<en>*2</en> denoted by asterisk sign
</text>
<endnote symbol="*2">
*2 square brackets
</endnote>
<ocn>55</ocn>
</object>
<object id="56">
<text class="norm">
<b>--no-dagger </b><br /> strips output text of editor
endnotes<en>+1</en> denoted by dagger/plus sign
</text>
<endnote symbol="+1">
+1 square brackets
</endnote>
<ocn>56</ocn>
</object>
<object id="57">
<text class="h4">
3. database commands
</text>
<ocn>57</ocn>
</object>
<object id="58">
<text class="norm">
dbi - database interface
</text>
<ocn>58</ocn>
</object>
<object id="59">
<text class="norm">
-D or --pgsql set for postgresql -d or --sqlite default set for sqlite
-d is modifiable with --db=[database type (pgsql or sqlite)]
</text>
<ocn>59</ocn>
</object>
<object id="60">
<text class="norm">
<b>-Dv --createall </b><br /> 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) [ -dv --createall sqlite equivalent] it may be
necessary to run sisu -Dv --createdb initially NOTE: at the present
time for postgresql it may be necessary to manually create the
database. The command would be 'createdb [database name]' where
database name would be SiSU_[present working directory name (without
path)]. Please use only alphanumerics and underscores.
</text>
<ocn>60</ocn>
</object>
<object id="61">
<text class="norm">
<b>-Dv --import </b><br /> [filename/wildcard] imports data specified
to postgresql db (rb.dbi) [ -dv --import sqlite equivalent]
</text>
<ocn>61</ocn>
</object>
<object id="62">
<text class="norm">
<b>-Dv --update </b><br /> [filename/wildcard] updates/imports
specified data to postgresql db (rb.dbi) [ -dv --update sqlite
equivalent]
</text>
<ocn>62</ocn>
</object>
<object id="63">
<text class="norm">
<b>-D --remove </b><br /> [filename/wildcard] removes specified data to
postgresql db (rb.dbi) [ -d --remove sqlite equivalent]
</text>
<ocn>63</ocn>
</object>
<object id="64">
<text class="norm">
<b>-D --dropall </b><br /> kills data" and drops (postgresql or sqlite)
db, tables & indexes [ -d --dropall sqlite equivalent]
</text>
<ocn>64</ocn>
</object>
<object id="65">
<text class="norm">
The v in e.g. -Dv is for verbose output.
</text>
<ocn>65</ocn>
</object>
<object id="66">
<text class="h4">
4. Shortcuts, Shorthand for multiple flags
</text>
<ocn>66</ocn>
</object>
<object id="67">
<text class="norm">
<b>--update [filename/wildcard] </b><br /> Checks existing file output
and runs the flags required to update this output. This means that if
only html and pdf output was requested on previous runs, only the -hp
files will be applied, and only these will be generated this time,
together with the summary. This can be very convenient, if you offer
different outputs of different files, and just want to do the same
again.
</text>
<ocn>67</ocn>
</object>
<object id="68">
<text class="norm">
<b>-0 to -5 [filename or wildcard] </b><br /> Default shorthand
mappings (note that the defaults can be changed/configured in the
sisurc.yml file):
</text>
<ocn>68</ocn>
</object>
<object id="69">
<text class="norm">
<b>-0 </b><br /> -mNhwpAobxXyYv [this is the default action run when no
options are give, i.e. on 'sisu [filename]']
</text>
<ocn>69</ocn>
</object>
<object id="70">
<text class="norm">
<b>-1 </b><br /> -mNHwpy
</text>
<ocn>70</ocn>
</object>
<object id="71">
<text class="norm">
<b>-2 </b><br /> -mNHwpaoy
</text>
<ocn>71</ocn>
</object>
<object id="72">
<text class="norm">
<b>-3 </b><br /> -mNhwpAobxXyY
</text>
<ocn>72</ocn>
</object>
<object id="73">
<text class="norm">
<b>-4 </b><br /> -mNhwpAobxXDyY --import
</text>
<ocn>73</ocn>
</object>
<object id="74">
<text class="norm">
<b>-5 </b><br /> -mNhwpAobxXDyY --update
</text>
<ocn>74</ocn>
</object>
<object id="75">
<text class="norm">
add -v for verbose mode and -c for color, e.g. sisu -2vc [filename or
wildcard]
</text>
<ocn>75</ocn>
</object>
<object id="76">
<text class="norm">
consider -u for appended url info or -v for verbose output
</text>
<ocn>76</ocn>
</object>
<object id="77">
<text class="h6">
4.0.1 Command Line with Flags - Batch Processing
</text>
<ocn>77</ocn>
</object>
<object id="78">
<text class="norm">
In the data directory run sisu -mh filename or wildcard eg. "sisu -h
cisg.sst" or "sisu -h *.{sst,ssm}" to produce html version of all
documents.
</text>
<ocn>78</ocn>
</object>
<object id="79">
<text class="norm">
Running sisu (alone without any flags, filenames or wildcards) brings
up the interactive help, as does any sisu command that is not
recognised. Enter to escape.
</text>
<ocn>79</ocn>
</object>
</body>
</document>