diff options
Diffstat (limited to 'data/doc/sisu/markup-samples/sisu_manual/sisu_commands.sst')
| -rw-r--r-- | data/doc/sisu/markup-samples/sisu_manual/sisu_commands.sst | 13 |
1 files changed, 11 insertions, 2 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 201b927e..253553a0 100644 --- a/data/doc/sisu/markup-samples/sisu_manual/sisu_commands.sst +++ b/data/doc/sisu/markup-samples/sisu_manual/sisu_commands.sst @@ -87,6 +87,9 @@ assumed for most other flags, creates new intermediate files for processing (doc !_ --delete [filename/wildcard] \\ see --zap +!_ --dump[=directory_path] [filename/wildcard] \\ +places output in directory specified, if none is specified in the current directory (pwd). Compare --redirect + !_ -D [instruction] [filename] \\ see --pg @@ -124,7 +127,7 @@ see --git makes two lists of sisu output based on the sisu markup documents in a directory: list of author and authors works (year and titles), and; list by topic with titles and author. Makes use of header metadata fields (author, title, date, topic_register). Can be used with maintenance (-M) and remote placement (-R) flags. !_ --help [topic] \\ -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 +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 @@ -138,6 +141,9 @@ see --texinfo !_ -i [filename/wildcard] \\ see --manpage +!_ -j [filename/wildcard] \\ +copies images associated with a file for use by html, xhtml & xml outputs (automatically invoked by --dump & redirect). + !_ --keep-processing-files [filename/wildcard/url] \\ see --maintenance @@ -148,7 +154,7 @@ prints license information. see --dal (document abstraction level/layer) !_ --maintenance [filename/wildcard/url] \\ -maintenance mode, interim processing files are preserved and their locations indicated. (also see -V). Aliases -M and --keep-processing-files +maintenance mode, interim processing files are preserved and their locations indicated. (also see -V). Aliases -M and --keep-processing-files. !_ --manpage [filename/wildcard] \\ produces man page of file, not suitable for all outputs. Alias -i @@ -207,6 +213,9 @@ see --qrcode !_ -q [filename/wildcard] \\ see --quiet +!_ --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 + !_ --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 |