diff options
Diffstat (limited to 'man')
| -rw-r--r-- | man/man1/sisu.1 | 54 |
1 files changed, 24 insertions, 30 deletions
diff --git a/man/man1/sisu.1 b/man/man1/sisu.1 index 3e85a9db..f6f4a943 100644 --- a/man/man1/sisu.1 +++ b/man/man1/sisu.1 @@ -1,4 +1,4 @@ -.TH "sisu" "1" "2014-05-12" "6.0.5" "SiSU" +.TH "sisu" "1" "2014-05-18" "6.0.6" "SiSU" .br .SH NAME .br @@ -470,7 +470,7 @@ see --qrcode see --quiet .TP .B --qrcode [filename/wildcard] -generate QR code image of metadata (used in manifest). v3 only. +generate QR code image of metadata (used in manifest). .TP .B --quiet [filename/wildcard] quiet less output to screen. @@ -508,7 +508,7 @@ see --sisupod .B -s [filename/wildcard] see --source .TP -.B --sample-search-form [--db=(pgsql|sqlite)] [--webserv=webrick] +.B --sample-search-form [--db-(pg|sqlite)] generate examples of (naive) cgi search form for .I SQLite or PgSQL depends on your already having used sisu to populate an @@ -517,17 +517,10 @@ 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 ---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 +--sqlite & --pg and the database section below. Optional additional parameters: +--db-user='www-data'. 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 @@ -813,8 +806,8 @@ 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 .B -0 to -5 [filename or wildcard] -Default shorthand mappings (for v3, note that the defaults can be -changed/configured in the sisurc.yml file): +Default shorthand mappings (note that the defaults can be changed/configured in +the sisurc.yml file): .TP .B -0 -NQhewpotbxXyYv [this is the default action run when no options are give, i.e. @@ -1163,8 +1156,8 @@ to this one: synopsis=sisu [-abcDdeFhIiMmNnopqRrSsTtUuVvwXxYyZz0-9] [filename/wildcard ] . sisu [-Ddcv] [instruction] . sisu [-CcFLSVvW] - . sisu --v4 [operations] - . sisu --v3 [operations] + . sisu --v5 [operations] + . sisu --v6 [operations] @links: { SiSU Homepage }http://www.sisudoc.org/ @@ -2196,6 +2189,7 @@ group{ to death."' + .SH CODE @@ -2548,7 +2542,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) @@ -2629,13 +2623,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 @@ -2675,19 +2669,19 @@ resource configuration is determined by looking at the following files if they exist: .BR - ./_sisu/v4/sisurc.yml + ./_sisu/v5/sisurc.yml .BR ./_sisu/sisurc.yml .BR - ~/.sisu/v4/sisurc.yml + ~/.sisu/v5/sisurc.yml .BR ~/.sisu/sisurc.yml .BR - /etc/sisu/v4/sisurc.yml + /etc/sisu/v5/sisurc.yml .BR /etc/sisu/sisurc.yml @@ -2719,19 +2713,19 @@ the @make header may be set by placing them in a file sisu_document_make. The search order is as for resource configuration: .BR - ./_sisu/v4/sisu_document_make + ./_sisu/v5/sisu_document_make .BR ./_sisu/sisu_document_make .BR - ~/.sisu/v4/sisu_document_make + ~/.sisu/v5/sisu_document_make .BR ~/.sisu/sisu_document_make .BR - /etc/sisu/v4/sisu_document_make + /etc/sisu/v5/sisu_document_make .BR /etc/sisu/sisu_document_make @@ -3443,10 +3437,10 @@ to populate an sqlite database, this being part of .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 @@ -3587,7 +3581,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 |