diff options
Diffstat (limited to 'data/doc/sisu/html/sisu_commands.1.html')
-rw-r--r-- | data/doc/sisu/html/sisu_commands.1.html | 554 |
1 files changed, 554 insertions, 0 deletions
diff --git a/data/doc/sisu/html/sisu_commands.1.html b/data/doc/sisu/html/sisu_commands.1.html new file mode 100644 index 00000000..ed2c45e2 --- /dev/null +++ b/data/doc/sisu/html/sisu_commands.1.html @@ -0,0 +1,554 @@ +<!-- manual page source format generated by PolyglotMan v3.2, --> +<!-- available at http://polyglotman.sourceforge.net/ --> + +<html> +<head> +<title>"sisu_commands"("1") manual page</title> +</head> +<body bgcolor='white'> +<a href='#toc'>Table of Contents</a><p> +SISU - COMMANDS [0.58], RALPH AMISSAH +<p> SISU COMMANDS +<p> 1. COMMANDS SUMMARY + +<p> 1.1 SYNOPSIS +<p> <b>SiSU</b> - Structured information, Serialized Units - a document + +<p>publishing system +<p> sisu [ -abcDdFHhIiMmNnopqRrSsTtUuVvwXxYyZz0-9 ] [ filename/ + +<p> sisu [ -Ddcv ] [ instruction ] +<p> sisu [ -CcFLSVvW ] +<p> Note: commands should +be issued from within the directory that contains the marked up files, +cd to markup directory. +<p> 1.2 DESCRIPTION +<p> <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 ( structure +information. For more see: <<a href='http://www.jus.uio.no/sisu'>http://www.jus.uio.no/sisu</a> +> +<p> 1.3 DOCUMENT PROCESSING + +<p>COMMAND FLAGS +<p> +<dl> + +<dt><b> -a [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 [ -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) +<p> </dd> + +<dt><b> -b [filename/wildcard]</b> </dt> +<dd>produces xhtml/XML +output for browser viewing (sax parsing). +<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. +<p> </dd> + +<dt><b> -CC</b> </dt> +<dd> configure/initialise shared output directory files initialize +shared output directory (config files such as css and dtd 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. +such as css and dtd files are updated +<p> </dd> + +<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 ’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). +<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. +<p> </dd> + +<dt><b> -d [--db-[database type (sqlite|pg)]] --[instruction] +</dt> +<dd>[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. +<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) provides some information + +<p>on setting up hyperestraier for sisu +<p> </dd> + +<dt><b> -H [filename/wildcard]</b> </dt> +<dd>produces html +without link suffixes (.html .pdf etc.) ( appropriately configured web server. + [behaviour switched after 0.35 see -h]. +<p> </dd> + +<dt><b> -h [filename/wildcard]</b> </dt> +<dd>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]. +<p> </dd> + +<dt><b> -I [filename/wildcard]</b> +</dt> +<dd>produces texinfo and info file, (view with pinfo). +<p> </dd> + +<dt><b> -L</b> </dt> +<dd> prints license information. + +<p> </dd> + +<dt><b> -M [filename/wildcard/url]</b> </dt> +<dd>maintenance mode files created for processing +preserved and their locations indicated. (also see -V) +<p> </dd> + +<dt><b> -m [filename/wildcard/url]</b> +</dt> +<dd>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 +<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. +<p> </dd> + +<dt><b> -n + [filename/wildcard/url]</b> </dt> +<dd>skip meta-markup (building of -m which is otherwise +assumed by most processing flags. +<p> </dd> + +<dt><b> -o [filename/wildcard/url]</b> </dt> +<dd>output basic +document in opendocument file format (opendocument.odt). +<p> </dd> + +<dt><b> -p [filename/wildcard]</b> +</dt> +<dd>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). +<p> </dd> + +<dt><b> -q [filename/wildcard]</b> +</dt> +<dd>quiet less output to screen. +<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 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 +<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 + +<p>have your +<p> </dd> + +<dt><b> -S</b> </dt> +<dd> produces a sisupod a zipped sisu directory of markup 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). +<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 + +<p> </dd> + +<dt><b> -s [filename/wildcard]</b> </dt> +<dd>copies sisu markup file to output directory. +<p> </dd> + +<dt><b> -t [filename/wildcard + (*.termsheet.rb)]</b> </dt> +<dd>standard form document builder, preprocessing feature +<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, but these + +<p>can be switched to file system paths in sisurc.yml +<p> </dd> + +<dt><b> -u [filename/wildcard]</b> +</dt> +<dd>provides url mapping of output files for the flags requested for processing, + +<p>also see -U +<p> </dd> + +<dt><b> -V</b> </dt> +<dd> on its own, provides <b> SiSU</b> version and environment information + (sisu --help env) +<p> </dd> + +<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> +<dd> on its own, provides <b> SiSU</b> version information +<p> </dd> + +<dt><b> -v [filename/wildcard]</b> +</dt> +<dd>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 +<p> </dd> + +<dt><b> -W</b> </dt> +<dd> starts ruby’s + webrick webserver points at sisu output the default port is set to 8081 + and can be [tip: the so html output should be created using the -h option + rather than -H; also, note -F webrick ]. +<p> </dd> + +<dt><b> -w [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) +<p> </dd> + +<dt><b> -X [filename/wildcard]</b> </dt> +<dd>produces +XML output with deep document structure, in the nature of dom. +<p> </dd> + +<dt><b> -x [filename/wildcard]</b> +</dt> +<dd>produces XML output shallow structure (sax parsing). +<p> </dd> + +<dt><b> -Y [filename/wildcard]</b> +</dt> +<dd>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]) +<p> </dd> + +<dt><b> -y [filename/wildcard]</b> +</dt> +<dd>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. +<p> </dd> + +<dt><b> -Z [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> </dd> + +<dt><b> -z [filename/wildcard]</b> </dt> +<dd>produces php (zend) [this feature is disabled + for the time being] +<p> </dd> +</dl> +2. COMMAND LINE MODIFIERS +<p> +<dl> + +<dt><b> --no-ocn</b> </dt> +<dd> [with -h -H or -p] 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 asterisk or dagger/plus sign +<p> </dd> + +<dt><b> --no-asterisk</b> +</dt> +<dd> strips output text of editor endnotes[^*2] denoted by asterisk sign +<p> </dd> + +<dt><b> --no-dagger</b> +</dt> +<dd> strips output text of editor endnotes[^+1] denoted by dagger/plus sign +<p> +</dd> +</dl> +3. DATABASE COMMANDS +<p> dbi - database interface +<p> -D or --pgsql set for postgresql +-d or --sqlite default set for sqlite -d is modifiable with --db=[database type + (pgsql or sqlite)] +<p> +<dl> + +<dt><b> -Dv --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 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. +<p> </dd> + +<dt><b> -Dv + --import</b> </dt> +<dd> [filename/wildcard] imports data specified to postgresql db (rb.dbi) + [ -dv --import sqlite equivalent] +<p> </dd> + +<dt><b> -Dv --update</b> </dt> +<dd> [filename/wildcard] updates/imports +specified data to postgresql db (rb.dbi) [ -dv --update sqlite equivalent] + +<p> </dd> + +<dt><b> -D --remove</b> </dt> +<dd> [filename/wildcard] removes specified data to postgresql db (rb.dbi) + [ -d --remove sqlite equivalent] +<p> </dd> + +<dt><b> -D --dropall</b> </dt> +<dd> kills data & indexes [ -d --dropall + sqlite equivalent] +<p> The v in e.g. -Dv is for verbose output. +<p> </dd> +</dl> +4. SHORTCUTS, +SHORTHAND FOR MULTIPLE FLAGS +<p> +<dl> + +<dt><b> --update [filename/wildcard]</b> </dt> +<dd>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. +<p> </dd> + +<dt><b> -0 to -5 [filename + or wildcard]</b> </dt> +<dd>Default shorthand mappings (note that the defaults can be +changed/configured in the sisurc.yml file): +<p> </dd> + +<dt><b> -0</b> </dt> +<dd> -mNhwpAobxXyYv [this is the + default action run when no i.e. on ’sisu [filename]’] +<p> </dd> + +<dt><b> -1</b> </dt> +<dd> -mNHwpy give, i.e. on + ’sisu [filename]’] +<p> </dd> + +<dt><b> -2</b> </dt> +<dd> -mNHwpaoy give, i.e. on ’sisu [filename]’] +<p> </dd> + +<dt><b> -3</b> </dt> +<dd> -mNhwpAobxXyY + i.e. on ’sisu [filename]’] +<p> </dd> + +<dt><b> -4</b> </dt> +<dd> -mNhwpAobxXDyY --import ’sisu [filename]’] +<p> </dd> + +<dt><b> -5</b> </dt> +<dd> -mNhwpAobxXDyY + --update ’sisu [filename]’] +<p> add -v for verbose mode and -c for color, e.g. sisu +-2vc [filename or wildcard] +<p> consider -u for appended url info or -v for + +<p>verbose output +<p> </dd> +</dl> +4.0.1 COMMAND LINE WITH FLAGS - BATCH PROCESSING +<p> In the +data directory run sisu -mh filename or wildcard eg. cisg.sst documents. +<p> +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. +<p> DOCUMENT INFORMATION (METADATA) +<p> METADATA +<p> Document Manifest +@ <<a href='http://www.jus.uio.no/sisu/sisu_manual/sisu_commands/sisu_manifest.html'>http://www.jus.uio.no/sisu/sisu_manual/sisu_commands/sisu_manifest.html</a> +> +<p> + <b>Dublin Core</b> (DC) +<p> <i>DC</i> tags included with this document are provided here. + +<p> DC Title: <i>SiSU</i> - Commands [0.58] +<p> DC Creator: <i>Ralph</i> Amissah +<p> DC Rights: +<i>Copyright</i> (C) Ralph Amissah 2007, part of SiSU documentation, License GPL + +<p>3 +<p> DC Type: <i>information</i> +<p> DC Date created: <i>2002-08-28</i> +<p> DC Date issued: + +<p><i>2002-08-28</i> +<p> DC Date available: <i>2002-08-28</i> +<p> DC Date modified: <i>2007-09-16</i> +<p> DC +Date: <i>2007-09-16</i> +<p> <b>Version Information</b> +<p> Sourcefile: <i>sisu_commands.sst</i> +<p> Filetype: + +<p><i>SiSU</i> text 0.58 +<p> Sourcefile Digest, MD5(sisu_commands.sst)= <i>8101d9e72f3de2510ef887202f8db3f9</i> + +<p> 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)= + +<p><i>20fc43cf3eb6590bc3399a1aef65c5a9</i> +<p> <b>Generated</b> +<p> Document (metaverse) last +generated: <i>Sun</i> Sep 23 01:13:58 +0100 2007 +<p> Generated by: <i>SiSU</i> <i>0.58.3</i> of +2007w36/4 (2007-09-06) +<p> Ruby version: <i>ruby</i> 1.8.6 (2007-06-07 patchlevel 36) + [i486-linux] +<p> +<dl> + +<dt><b>*1.</b> </dt> +<dd>square brackets </dd> + +<dt><b>*2.</b> </dt> +<dd>square brackets </dd> + +<dt><b>+1.</b> </dt> +<dd>square brackets +<p> +</dd> + +<dt>Other versions of this document: </dt> +<dd></dd> + +<dt>manifest: <<a href='http://www.jus.uio.no/sisu/sisu_commands/sisu_manifest.html'><a href='http://www.jus.uio.no/sisu/sisu_commands/sisu_manifest.html'>http://www.jus.uio.no/sisu/sisu_commands/sisu_manifest.html</a> +</a> +> +</dt> +<dd></dd> + +<dt>html: <<a href='http://www.jus.uio.no/sisu/sisu_commands/toc.html'><a href='http://www.jus.uio.no/sisu/sisu_commands/toc.html'>http://www.jus.uio.no/sisu/sisu_commands/toc.html</a> +</a> +> </dt> +<dd></dd> + +<dt>pdf: <<a href='http://www.jus.uio.no/sisu/sisu_commands/portrait.pdf'><a href='http://www.jus.uio.no/sisu/sisu_commands/portrait.pdf'>http://www.jus.uio.no/sisu/sisu_commands/portrait.pdf</a> +</a> +> +</dt> +<dd></dd> + +<dt>pdf: <<a href='http://www.jus.uio.no/sisu/sisu_commands/landscape.pdf'><a href='http://www.jus.uio.no/sisu/sisu_commands/landscape.pdf'>http://www.jus.uio.no/sisu/sisu_commands/landscape.pdf</a> +</a> +> </dt> +<dd> </dd> + +<dt>at: <<a href='http://www.jus.uio.no/sisu'><a href='http://www.jus.uio.no/sisu'>http://www.jus.uio.no/sisu</a> +</a> +> +</dt> +<dd></dd> + +<dt>* Generated by: SiSU 0.58.3 of 2007w36/4 (2007-09-06) </dt> +<dd></dd> + +<dt>* Ruby version: ruby +1.8.6 (2007-06-07 patchlevel 36) [i486-linux] </dt> +<dd></dd> + +<dt>* Last Generated on: Sun Sep 23 +01:14:05 +0100 2007 </dt> +<dd></dd> + +<dt>* SiSU <a href='http://www.jus.uio.no/sisu'>http://www.jus.uio.no/sisu</a> + </dt> +<dd></dd> +</dl> +<p> +</body> +</html> |