summaryrefslogtreecommitdiffstats
path: root/man
diff options
context:
space:
mode:
authorRalph Amissah <ralph@amissah.com>2013-05-29 23:50:40 +0000
committerRalph Amissah <ralph@amissah.com>2013-05-29 23:50:40 +0000
commit4adb525fb4f143781a05c0e62c3798730f9b0713 (patch)
tree0ab8a677b71ce286c8a300d076d5e6185bcc2bc4 /man
parentv4 v5: cgi helper script, sample search form generator, adjust/improve (diff)
downloadsisu-4adb525fb4f143781a05c0e62c3798730f9b0713.zip
sisu-4adb525fb4f143781a05c0e62c3798730f9b0713.tar.xz
v4 v5: help, documentation update, concentrate on man pagessisu_4.1.2
* documentation, manpage update * interactive help, out of date, removed
Diffstat (limited to 'man')
-rw-r--r--man/man1/sisu.1100
1 files changed, 35 insertions, 65 deletions
diff --git a/man/man1/sisu.1 b/man/man1/sisu.1
index 9fcc524..2bafb76 100644
--- a/man/man1/sisu.1
+++ b/man/man1/sisu.1
@@ -601,21 +601,26 @@ see --sisupod
.B -s [filename/wildcard]
see --source
.TP
-.B --sample-search-form [--webserv=webrick]
+.B --sample-search-form [--db=(pgsql|sqlite)] [--webserv=webrick]
generate examples of (naive) cgi search form for
.I SQLite
-and PgSQL depends on your already having used sisu to populate an
+or PgSQL depends on your already having used sisu to populate an
.I SQLite
-and/or PgSQL database, (the
+or PgSQL database, (the
.I 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). Alias -F
+is first necessary to create them, before generating the search form) see
+--sqlite & --pg and the database section below. Optional additional parameters
+include: url location of webserver search form and db:
+--webserv-search='[url]'; location of webserver output:
+--webserv-output='[url]'; cgi search form link name:
+--cgi-search-form-name='[name.cgi]'; for pgsql, database user:
+--db-user='[username]'. 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). Alias -F
.TP
.B --scp [filename/wildcard]
copies sisu output files to remote host using scp. This requires that
@@ -986,45 +991,10 @@ An online version of the sisu man page is available here:
.BR
* sisu.1 <http://www.jus.uio.no/sisu/man/sisu.1.html> [^10]
-.SH SISU BUILT\-IN INTERACTIVE HELP
+.SH SISU BUILT-IN INTERACTIVE HELP, [DISCONTINUED]
.BR
-This is particularly useful for getting the current sisu setup/environment
-information:
-
-.BR
- sisu --help
-
-.BR
- sisu --help [subject]
-
-.BR
-sisu --help commands
-
-.BR
-sisu --help markup
-
-.BR
-sisu --help env [for feedback on the way your system is setup with regard
- to sisu ]
-
-.BR
- sisu -V [environment information, same as above command]
-
-.BR
- sisu (on its own provides version and some help information)
-
-.BR
-Apart from real-time information on your current configuration the
-.B SiSU
-manual and man pages are likely to contain more up-to-date information than the
-sisu interactive help (for example on commands and markup).
-
-.BR
-NOTE: Running the command 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.
-
+This fell out of date and has been discontinued.
.SH INTRODUCTION TO SISU MARKUP[^11]
.SH SUMMARY
@@ -1067,10 +1037,10 @@ primary outline of the document structure. Markup of substantive text includes:
* footnotes/endnotes
.BR
- * linked text and images
+* linked text and images
.BR
- * paragraph actions, such as indent, bulleted, numbered-lists, etc.
+* paragraph actions, such as indent, bulleted, numbered-lists, etc.
.BR
Some interactive help on markup is available, by typing sisu and selecting
@@ -1080,19 +1050,19 @@ markup or sisu --help markup
To check the markup in a file:
.BR
- sisu --identify [filename].sst
+sisu --identify [filename].sst
.BR
For brief descriptive summary of markup history
.BR
- sisu --query-history
+sisu --query-history
.BR
or if for a particular version:
.BR
- sisu --query-0.38
+sisu --query-0.38
.SH MARKUP EXAMPLES
.SH ONLINE
@@ -2431,7 +2401,7 @@ locally or on a remote server for which a url is provided.
source markup can be shared with the command:
.BR
- sisu -s [filename]
+sisu -s [filename]
.SH SISU TEXT - REGULAR FILES (.SST)
@@ -2511,13 +2481,13 @@ documents.
The command to create a sisupod is:
.BR
- sisu -S [filename]
+sisu -S [filename]
.BR
Alternatively, make a pod of the contents of a whole directory:
.BR
- sisu -S
+sisu -S
.BR
.B SiSU
@@ -2959,7 +2929,7 @@ for the configuration directory, namely ./_sisu ; ~/_sisu ; /etc/sisu From
there they are copied to the root of the output directory with the command:
.BR
- sisu -CC
+sisu -CC
.SH MARKUP AND OUTPUT EXAMPLES
.SH MARKUP EXAMPLES
@@ -3143,25 +3113,25 @@ should they so choose). All site texts/documents are (currently) streamed to
four tables:
.BR
- * one containing semantic (and other) headers, including, title, author,
+* one containing semantic (and other) headers, including, title, author,
subject, (the
.I Dublin Core.
..);
.BR
- * another the substantive texts by individual "paragraph" (or object) - along
+* another the substantive texts by individual "paragraph" (or object) - along
with structural information, each paragraph being identifiable by its
paragraph number (if it has one which almost all of them do), and the
substantive text of each paragraph quite naturally being searchable (both in
formatted and clean text versions for searching); and
.BR
- * a third containing endnotes cross-referenced back to the paragraph from
+* a third containing endnotes cross-referenced back to the paragraph from
which they are referenced (both in formatted and clean text versions for
searching).
.BR
- * a fourth table with a one to one relation with the headers table contains
+* a fourth table with a one to one relation with the headers table contains
full text versions of output, eg. pdf, html, xml, and
.I ascii.
@@ -3217,10 +3187,10 @@ to populate a postgresql database, this being part of
.SH SYNOPSIS
.BR
- sisu -D [instruction] [filename/wildcard if required]
+sisu -D [instruction] [filename/wildcard if required]
.BR
- sisu -D --pg --[instruction] [filename/wildcard if required]
+sisu -D --pg --[instruction] [filename/wildcard if required]
.SH COMMANDS
.BR
@@ -3295,10 +3265,10 @@ to populate an sqlite database, this being part of
.SH SYNOPSIS
.BR
- sisu -d [instruction] [filename/wildcard if required]
+sisu -d [instruction] [filename/wildcard if required]
.BR
- sisu -d --(sqlite|pg) --[instruction] [filename/wildcard if required]
+sisu -d --(sqlite|pg) --[instruction] [filename/wildcard if required]
.SH COMMANDS
@@ -3397,7 +3367,7 @@ The following is feedback on the setup on a machine provided by the help
command:
.BR
- sisu --help sql
+sisu --help sql
.nf
Postgresql
user: ralph