aboutsummaryrefslogtreecommitdiffhomepage
path: root/data/doc/sisu/markup-samples
diff options
context:
space:
mode:
authorRalph Amissah <ralph@amissah.com>2013-05-29 19:50:40 -0400
committerRalph Amissah <ralph@amissah.com>2013-05-29 19:50:40 -0400
commit4adb525fb4f143781a05c0e62c3798730f9b0713 (patch)
tree0ab8a677b71ce286c8a300d076d5e6185bcc2bc4 /data/doc/sisu/markup-samples
parentv4 v5: cgi helper script, sample search form generator, adjust/improve (diff)
v4 v5: help, documentation update, concentrate on man pagessisu_4.1.2
* documentation, manpage update * interactive help, out of date, removed
Diffstat (limited to 'data/doc/sisu/markup-samples')
-rw-r--r--data/doc/sisu/markup-samples/sisu_manual/sisu_commands.sst4
-rw-r--r--data/doc/sisu/markup-samples/sisu_manual/sisu_help.sst22
2 files changed, 4 insertions, 22 deletions
diff --git a/data/doc/sisu/markup-samples/sisu_manual/sisu_commands.sst b/data/doc/sisu/markup-samples/sisu_manual/sisu_commands.sst
index 1c5c1cec..491c03fd 100644
--- a/data/doc/sisu/markup-samples/sisu_manual/sisu_commands.sst
+++ b/data/doc/sisu/markup-samples/sisu_manual/sisu_commands.sst
@@ -278,8 +278,8 @@ see --sisupod
!_ -s [filename/wildcard] \\
see --source
-!_ --sample-search-form [--webserv=webrick] \\
-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). Alias -F
+!_ --sample-search-form [--db=(pgsql|sqlite)] [--webserv=webrick] \\
+generate examples of (naive) cgi search form for SQLite or PgSQL depends on your already having used sisu to populate an SQLite 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 --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
!_ --scp [filename/wildcard] \\
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
diff --git a/data/doc/sisu/markup-samples/sisu_manual/sisu_help.sst b/data/doc/sisu/markup-samples/sisu_manual/sisu_help.sst
index ce6627b7..69535085 100644
--- a/data/doc/sisu/markup-samples/sisu_manual/sisu_help.sst
+++ b/data/doc/sisu/markup-samples/sisu_manual/sisu_help.sst
@@ -72,24 +72,6 @@ _* {~^ various sisu man pages }http://www.jus.uio.no/sisu/man/
_* {~^ sisu.1 }http://www.jus.uio.no/sisu/man/sisu.1.html
-2~ SiSU built-in interactive help
+2~ SiSU built-in interactive help, [discontinued]
-This is particularly useful for getting the current sisu setup/environment information:
-
-_1 sisu --help
-
-_1 sisu --help [subject]
-
-_2 sisu --help commands
-
-_2 sisu --help markup
-
-_2 sisu --help env [for feedback on the way your system is setup with regard to sisu]
-
-_1 sisu -V [environment information, same as above command]
-
-_1 sisu (on its own provides version and some help information)
-
-Apart from real-time information on your current configuration the 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).
-
-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.