summaryrefslogtreecommitdiffstats
path: root/man
diff options
context:
space:
mode:
authorRalph Amissah <ralph@amissah.com>2011-05-30 00:33:38 +0000
committerRalph Amissah <ralph@amissah.com>2011-05-30 00:33:38 +0000
commit0e921adab8fbbd638f001a2876bccfb6820499a5 (patch)
treeaa4268dc5668e87def5c46b64fa0ac19cd228c18 /man
parentv3: options --find & --glob (-f -G) added, parses language sub-dirs (diff)
downloadsisu-0e921adab8fbbd638f001a2876bccfb6820499a5.zip
sisu-0e921adab8fbbd638f001a2876bccfb6820499a5.tar.xz
v3: documentation, minor update, includes --find / --globsisu_3.0.11
Diffstat (limited to 'man')
-rw-r--r--man/man1/sisu.1128
1 files changed, 74 insertions, 54 deletions
diff --git a/man/man1/sisu.1 b/man/man1/sisu.1
index 9f77082..c152d5e 100644
--- a/man/man1/sisu.1
+++ b/man/man1/sisu.1
@@ -82,13 +82,14 @@ markup applied to a document,
custom builds (to take advantage of the strengths of different ways of
representing documents) various standard open output formats including plain
text, HTML, XHTML, XML, EPUB, OpenDocument, LaTeX or PDF files, and populate an
-SQL database with objects[^1] (equating generally to paragraph\-sized chunks) so
-searches may be performed and matches returned with that degree of granularity
-( e.g. your search criteria is met by these documents and at these locations
-within each document). Document output formats share a common object numbering
-system for locating content. This is particularly suitable for "published"
-works (finalized texts as opposed to works that are frequently changed or
-updated) for which it provides a fixed means of reference of content.
+SQL database with objects[^1] (equating generally to paragraph\-sized chunks)
+so searches may be performed and matches returned with that degree of
+granularity ( e.g. your search criteria is met by these documents and at these
+locations within each document). Document output formats share a common object
+numbering system for locating content. This is particularly suitable for
+"published" works (finalized texts as opposed to works that are frequently
+changed or updated) for which it provides a fixed means of reference of
+content.
.br
In preparing a
@@ -189,13 +190,11 @@ content prepared in
.br
.B SiSU
-.B SiSU
is a document publishing system, that from a simple single marked\-up
-document, produces multiple of output formats including: plaintext, html,
-xhtml, XML, epub, odt (odf text), LaTeX, pdf, info, and SQL (PostgreSQL and
-SQLite), which share numbered text objects ("object citation numbering") and
-the same document structure information. For more see:
-<http://www.jus.uio.no/sisu>
+document, produces multiple output formats including: plaintext, html, xhtml,
+XML, epub, odt (odf text), LaTeX, pdf, info, and SQL (PostgreSQL and SQLite),
+which share text object numbers ("object citation numbering") and the same
+document structure information. For more see: <http://www.jus.uio.no/sisu>
.SH 2.2 DOCUMENT PROCESSING COMMAND FLAGS
@@ -204,9 +203,9 @@ the same document structure information. For more see:
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)
+endnotes]. (Options include: \-\-endnotes for endnotes \-\-footnotes for
+footnotes at the end of each paragraph \-\-unix for unix linefeed (default)
+\-\-msdos for msdos linefeed)
.TP
.B \-b [filename/wildcard]
@@ -268,7 +267,7 @@ see \-\-sqlite
.TP
.B \-\-epub [filename/wildcard]
-produces an epub document, [sisu \ version \ 2 \ only] (filename.epub). Alias
+produces an epub document, [sisu \ version \ >=2 \ ] (filename.epub). Alias
\-e
.TP
@@ -276,15 +275,33 @@ produces an epub document, [sisu \ version \ 2 \ only] (filename.epub). Alias
see \-\-epub
.TP
+.B \-\-find [optional \ string \ part \ of \ filename]
+without match string, glob all \.sst \.ssm files in directory (including
+language subdirectories). With match string, find files that match given string
+in directory (including language subdirectories). Alias \-f, \-\-glob, \-G
+
+.TP
.B \-F [\-\-webserv=webrick]
see \-\-sample\-search\-form
.TP
+.B \-f [optional \ string \ part \ of \ filename]
+see \-\-find
+
+.TP
.B \-\-git [filename/wildcard]
produces or updates markup source file structure in a git repo (experimental
and subject to change). Alias \-g
.TP
+.B \-\-glob [optional \ string \ part \ of \ filename]
+see \-\-find
+
+.TP
+.B \-G [optional \ string \ part \ of \ filename]
+see \-\-find
+
+.TP
.B \-g [filename/wildcard]
see \-\-git
@@ -352,9 +369,9 @@ see \-\-dal (document abstraction level/layer)
.TP
.B \-\-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.
+[with \ \-\-html \ \-\-pdf \ or \ \-\-epub] switches off object citation
+numbering. Produce output without identifying numbers in margins of html or
+LaTeX/pdf output.
.TP
.B \-N [filename/wildcard/url]
@@ -392,8 +409,9 @@ parameter, e.g. \-\-papersize\-a4 preset sizes include: 'A4', U.S. 'letter' and
.TP
.B \-\-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
+include: \-\-createdb; \-\-create; \-\-dropall; \-\-import [filename];
+\-\-update [filename]; \-\-remove [filename]; see database section below. Alias
+\-D
.TP
.B \-\-po [language_directory/filename \ language_directory]
@@ -430,8 +448,8 @@ 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
+\-\-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
.TP
.B \-R [filename/wildcard]
@@ -448,8 +466,8 @@ 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
+\-\-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)
@@ -463,18 +481,19 @@ that you have your "keys" and ssh agent in place. Also see \-\-rsync. Alias \-r
.TP
.B \-\-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
+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
.TP
.B \-\-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
+ \./_sisu not those in ~/.sisu \-S [filename/wildcard] option. Note: (this
+option is tested only with zsh). Alias \-S
.TP
.B \-\-sisupod [filename/wildcard]
@@ -522,9 +541,9 @@ produces texinfo and info file, (view with pinfo). Alias \-I
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). Alias \-t
+endnotes]. (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
.TP
.B \-T [filename/wildcard \ (*.termsheet.rb)]
@@ -658,9 +677,9 @@ see \-\-zap
.TP
.B \-\-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.
+[with \ \-\-html \ \-\-pdf \ or \ \-\-epub] switches off object citation
+numbering. Produce output without identifying numbers in margins of html or
+LaTeX/pdf output.
.TP
.B \-\-no\-annotate
@@ -682,19 +701,19 @@ strips output text of editor endnotes[^+1] denoted by dagger/plus sign
dbi \- database interface
.br
-\-D or \-\-pgsql set for postgresql \-d or \-\-sqlite default set for sqlite \-d is
-modifiable with \-\-db=[database \ type \ (pgsql \ or \ sqlite)]
+\-D or \-\-pgsql set for postgresql \-d or \-\-sqlite default set for sqlite
+\-d is modifiable with \-\-db=[database \ type \ (pgsql \ or \ sqlite)]
.TP
.B \-\-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 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.
+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.
.TP
.B \-\-pg \-v \-\-import
@@ -708,8 +727,8 @@ Please use only alphanumerics and underscores.
.TP
.B \-\-pg \-\-remove
-[filename/wildcard] removes specified data to postgresql db (rb.dbi) [ \ \-d \
-\-\-remove \ sqlite \ equivalent]
+[filename/wildcard] removes specified data to postgresql db (rb.dbi) [ \ \-d
+\ \-\-remove \ sqlite \ equivalent]
.TP
.B \-\-pg \-\-dropall
@@ -726,8 +745,8 @@ The \-v is for verbose output.
.B \-\-update [filename/wildcard]
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
+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.
.TP
@@ -770,8 +789,8 @@ consider \-u for appended url info or \-v for verbose output
.SH 5.1 COMMAND LINE WITH FLAGS \- BATCH PROCESSING
.br
-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.
+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.
.br
Running sisu (alone without any flags, filenames or wildcards) brings up the
@@ -1166,9 +1185,10 @@ This is a sample header
.br
Heading levels are :A~ ,:B~ ,:C~ ,1~ ,2~ ,3~ \... :A \- :C being part / section
-headings, followed by other heading levels, and 1 \-6 being headings followed by
-substantive text or sub\-headings. :A~ usually the title :A~? conditional level
-1 heading (used where a stand\-alone document may be imported into another)
+headings, followed by other heading levels, and 1 \-6 being headings followed
+by substantive text or sub\-headings. :A~ usually the title :A~? conditional
+level 1 heading (used where a stand\-alone document may be imported into
+another)
.br
.B :A~ [heading \ text]