From 23b07d95a58713eca27df7e6013be890892faf0c Mon Sep 17 00:00:00 2001 From: Ralph Amissah <ralph@amissah.com> Date: Fri, 8 Aug 2014 00:37:20 -0400 Subject: documentation related --- man/man1/sisu.1 | 69 ++++++++++++++------------------------------------------- 1 file changed, 17 insertions(+), 52 deletions(-) (limited to 'man/man1') diff --git a/man/man1/sisu.1 b/man/man1/sisu.1 index 5cc2c7d9..608f69a2 100644 --- a/man/man1/sisu.1 +++ b/man/man1/sisu.1 @@ -1,4 +1,4 @@ -.TH "sisu" "1" "2014-07-22" "5.5.2" "SiSU" +.TH "sisu" "1" "2014-02-05" "6.2.1" "SiSU" .br .SH NAME .br @@ -128,14 +128,8 @@ document structure information. For more see: <http://sisudoc.org> or .SH DOCUMENT PROCESSING COMMAND FLAGS .TP -.B -a [filename/wildcard] -produces -.I plaintext -with Unix linefeeds and without markup, (object numbers are omitted), has -footnotes at end of each paragraph that contains them [ -A for equivalent dos -(linefeed) output file] [see -e for endnotes]. (Options include: --endnotes for -endnotes --footnotes for footnotes at the end of each paragraph --unix for unix -linefeed (default) --msdos for msdos linefeed) +.B -[0-9] [filename/wildcard] +see --act .TP .B --ao [filename/wildcard/url] assumed for most other flags, creates new intermediate files for processing @@ -143,6 +137,13 @@ assumed for most other flags, creates new intermediate files for processing processing of other output. This step is assumed for most processing flags. To skip it see -n. Alias -m. .TP +.B --act[0-9] [filename/wildcard] +--act0 to --act9 configurable shortcuts for multiple flags, -0 to -9 synonyms, +configure in sisurc.yml, sisu default action on a specified file where no flag +is provided is --act0, current default setting for --act0 is --digest --qrcode +--text --html --epub --concordance --pdf --odf --docbook --xhtml --xml-sax +--xml-dom --sqlite --manifest --verbose +.TP .B --asciitext [filename/wildcard] asciitext, smart text (not available) .TP @@ -160,9 +161,6 @@ site more extensive than -C on its own, shared output directory files/force update, existing shared output config files such as css and dtd files are updated if this modifier is used. .TP -.B -CC -see --configure -.TP .B -c [filename/wildcard] see --color-toggle .TP @@ -214,6 +212,9 @@ screen. .B --docbook [filename/wildcard/url] docbook xml .TP +.B --dom [filename/wildcard/url] +see --xml-dom +.TP .B --dump[=directory_path] [filename/wildcard] places output in directory specified, if none is specified in the current directory (pwd). Unlike using default settings @@ -531,6 +532,9 @@ is first necessary to create them, before generating the search form) see which must be writable, (with screen instructions given that they be copied to the cgi-bin directory). Alias -F .TP +.B --sax [filename/wildcard/url] +see --xml-sax +.TP .B --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 @@ -802,45 +806,6 @@ equivalent] .BR The -v is for verbose output. -.SH SHORTCUTS, SHORTHAND FOR MULTIPLE FLAGS - -.TP -.B --update [filename/wildcard] -Checks existing file output and runs the flags required to update this output. -This means that if only html and pdf output was requested on previous runs, -only the -hp files will be applied, and only these will be generated this time, -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 (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. -on 'sisu [filename]'] -.TP -.B -1 --Qhewpoty -.TP -.B -2 --NQhewpotbxXy -.TP -.B -3 --NQhewpotbxXyY -.TP -.B -4 --NQhewpotbxXDyY --update -.TP -.B -5 --NQhewpotbxXDyYv --update - -.BR -add -v for verbose mode and -c to toggle color state, e.g. sisu -2vc [filename -or wildcard] - -.BR -consider -u for appended url info or -v for verbose output .SH COMMAND LINE WITH FLAGS - BATCH PROCESSING @@ -1926,7 +1891,7 @@ information in each column .BR .B markup example: -[^10] +[^9] .nf !_ Table 3.1: Contributors to Wikipedia, January 2001 - June 2005 -- cgit v1.2.3