aboutsummaryrefslogtreecommitdiffhomepage
path: root/data/doc/sisu/markup-samples
diff options
context:
space:
mode:
authorRalph Amissah <ralph@amissah.com>2013-02-03 23:24:37 -0500
committerRalph Amissah <ralph@amissah.com>2013-02-04 00:09:44 -0500
commit0506d0a1261305a0a631b00d0b401edc2bf790ae (patch)
tree3b4fa8d37a0f1fac8b04049fe5001325003c788b /data/doc/sisu/markup-samples
parentv4: html (urls), scroll & seg optionally discrete, individually callable (diff)
v4: documentation, include --html-scroll and --html-seg optionssisu_4.0.5
* sisu_manual/sisu_commands * manpage & html
Diffstat (limited to 'data/doc/sisu/markup-samples')
-rw-r--r--data/doc/sisu/markup-samples/v4/sisu_manual/sisu_commands.sst12
1 files changed, 9 insertions, 3 deletions
diff --git a/data/doc/sisu/markup-samples/v4/sisu_manual/sisu_commands.sst b/data/doc/sisu/markup-samples/v4/sisu_manual/sisu_commands.sst
index 2811e961..86f818f6 100644
--- a/data/doc/sisu/markup-samples/v4/sisu_manual/sisu_commands.sst
+++ b/data/doc/sisu/markup-samples/v4/sisu_manual/sisu_commands.sst
@@ -86,7 +86,7 @@ assumed for most other flags, creates new intermediate files for processing (doc
see --zap
!_ --dump[=directory_path] [filename/wildcard] \\
-places output in directory specified, if none is specified in the current directory (pwd). Compare --redirect
+places output in directory specified, if none is specified in the current directory (pwd). Unlike using default settings HTML files have embedded css. Compare --redirect
!_ -e [filename/wildcard] \\
see --epub
@@ -142,7 +142,13 @@ makes two lists of sisu output based on the sisu markup documents in a directory
provides help on the selected topic, where topics (keywords) include: list, (com)mands, short(cuts), (mod)ifiers, (env)ironment, markup, syntax, headers, headings, endnotes, tables, example, customise, skin, (dir)ectories, path, (lang)uage, db, install, setup, (conf)igure, convert, termsheet, search, sql, features, license.
!_ --html [filename/wildcard] \\
-produces html output, segmented text with table of contents (toc.html and index.html) and the document in a single file (scroll.html). Alias -h
+produces html output, in two forms (i) segmented text with table of contents (toc.html and index.html) and (ii) the document in a single file (scroll.html). Alias -h
+
+!_ --html-scroll [filename/wildcard] \\
+produces html output, the document in a single file (scroll.html) only. Compare --html-seg and --html
+
+!_ --html-seg [filename/wildcard] \\
+produces html output, segmented text with table of contents (toc.html and index.html). Compare --html-scroll and --html
!_ -I [filename/wildcard] \\
see --texinfo
@@ -243,7 +249,7 @@ see --rsync
see --scp
!_ --redirect[=directory_path] [filename/wildcard] \\
-places output in subdirectory under specified directory, subdirectory uses the filename (without the suffix). If no output directory is specified places the subdirectory under the current directory (pwd). Compare --dump
+places output in subdirectory under specified directory, subdirectory uses the filename (without the suffix). If no output directory is specified places the subdirectory under the current directory (pwd). Unlike using default settings HTML files have embedded css. Compare --dump
!_ --rsync [filename/wildcard] \\
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