summaryrefslogtreecommitdiffstats
path: root/man
diff options
context:
space:
mode:
authorRalph Amissah <ralph@amissah.com>2014-02-14 05:26:53 +0000
committerRalph Amissah <ralph@amissah.com>2014-02-14 05:26:55 +0000
commit06145fcda953ce6ea963b63a91e4ac8103c9cc58 (patch)
treee29a1853cdaa1f9ffca13e71cb96183c5b6b8a5b /man
parentv5 v6: version & changelog (& rakefile) (diff)
downloadsisu-06145fcda953ce6ea963b63a91e4ac8103c9cc58.zip
sisu-06145fcda953ce6ea963b63a91e4ac8103c9cc58.tar.xz
v5 v6: ocn, object citation numbering, --no-numbering option & default tuningsisu_5.3.4
* add less cryptic --numbering --no-numbering command-line options (to --no-ocn) * plaintext & odt switch default to ocn==true for consistency with other output * [decide how fine-grained ocn/numbering switches could be: could be per output type by command-line instruction (see txt & odt); currently set per sisu instruction for all outputs]
Diffstat (limited to 'man')
-rw-r--r--man/man1/sisu.161
1 files changed, 30 insertions, 31 deletions
diff --git a/man/man1/sisu.1 b/man/man1/sisu.1
index 478f1f6..c3229e0 100644
--- a/man/man1/sisu.1
+++ b/man/man1/sisu.1
@@ -1,4 +1,4 @@
-.TH "sisu" "1" "2014-02-05" "6.0.3" "SiSU"
+.TH "sisu" "1" "2014-02-14" "6.0.4" "SiSU"
.br
.SH NAME
.br
@@ -141,7 +141,7 @@ linefeed (default) --msdos for msdos linefeed)
assumed for most other flags, creates new intermediate files for processing
(abstract objects, document abstraction) that is used in all subsequent
processing of other output. This step is assumed for most processing flags. To
-skip it see -n. Alias -m. (sisu v5)
+skip it see -n. Alias -m.
.TP
.B -b [filename/wildcard]
see --xhtml
@@ -198,16 +198,14 @@ see --pg
see --sqlite
.TP
.B --dal [filename/wildcard/url]
-assumed for most other flags, creates new intermediate files for processing
-(abstract objects, document abstraction) that is used in all subsequent
-processing of other output. This step is assumed for most processing flags. To
-skip it see -n. Renamed --ao (abstract objects) in sisu v5. Alias -m
+(abstract objects, document abstraction renamed abstract objects in sisu5) see
+--ao
.TP
.B --delete [filename/wildcard]
see --zap
.TP
.B --docbook [filename/wildcard/url]
-docbook smart text (sisu v5)
+docbook smart text (not available)
.TP
.B --dump[=directory_path] [filename/wildcard]
places output in directory specified, if none is specified in the current
@@ -222,25 +220,23 @@ see --epub
produces an epub document, [sisu version >=2 ] (filename.epub). Alias -e
.TP
.B --exc-*
-exclude output feature, overrides configuration settings --exc-ocn, (exclude
-.I object citation numbering,
-(switches off
-.I object citation numbering
-) , affects html (seg, scroll), epub, xhtml, xml, pdf) ; --exc-toc, (exclude
-table of contents, affects html (scroll), epub, pdf) ; --exc-links-to-manifest,
---exc-manifest-links, (exclude links to manifest, affects html (seg, scroll));
---exc-search-form, (exclude search form, affects html (seg, scroll), manifest);
---exc-minitoc, (exclude mini table of contents, affects html (seg),
-concordance, manifest); --exc-manifest-minitoc, (exclude mini table of
-contents, affects manifest); --exc-html-minitoc, (exclude mini table of
-contents, affects html (seg), concordance); --exc-html-navigation, (exclude
-navigation, affects html (seg)); --exc-html-navigation-bar, (exclude navigation
-bar, affects html (seg)); --exc-html-search-form, (exclude search form, affects
-html (seg, scroll)); --exc-html-right-pane, (exclude right pane/column, affects
-html (seg, scroll)); --exc-html-top-band, (exclude top band, affects html (seg,
-scroll), concordance (minitoc forced on to provide seg navigation));
---exc-segsubtoc (exclude sub table of contents, affects html (seg), epub) ; see
-also --inc-*
+exclude output feature, overrides configuration settings --exc-numbering, see
+--exc-ocn; --exc-ocn, (exclude "object citation numbering", (switches off
+object citation numbers), affects html (seg, scroll), epub, xhtml, xml, pdf) ;
+--exc-toc, (exclude table of contents, affects html (scroll), epub, pdf) ;
+--exc-links-to-manifest, --exc-manifest-links, (exclude links to manifest,
+affects html (seg, scroll)); --exc-search-form, (exclude search form, affects
+html (seg, scroll), manifest); --exc-minitoc, (exclude mini table of contents,
+affects html (seg), concordance, manifest); --exc-manifest-minitoc, (exclude
+mini table of contents, affects manifest); --exc-html-minitoc, (exclude mini
+table of contents, affects html (seg), concordance); --exc-html-navigation,
+(exclude navigation, affects html (seg)); --exc-html-navigation-bar, (exclude
+navigation bar, affects html (seg)); --exc-html-search-form, (exclude search
+form, affects html (seg, scroll)); --exc-html-right-pane, (exclude right
+pane/column, affects html (seg, scroll)); --exc-html-top-band, (exclude top
+band, affects html (seg, scroll), concordance (minitoc forced on to provide seg
+navigation)); --exc-segsubtoc (exclude sub table of contents, affects html
+(seg), epub) ; see also --inc-*
.TP
.B -F [--webserv=webrick]
see --sample-search-form
@@ -249,7 +245,7 @@ see --sample-search-form
see --find
.TP
.B --fictionbook [filename/wildcard/url]
-fictionbook smart text (sisu v5)
+fictionbook smart text (not available)
.TP
.B --find [optional string part of filename]
without match string, glob all .sst .ssm files in directory (including language
@@ -344,7 +340,7 @@ maintenance mode, interim processing files are preserved and their locations
indicated. (also see -V). Aliases -M and --keep-processing-files.
.TP
.B --markdown [filename/wildcard/url]
-markdown smart text (sisu v5)
+markdown smart text (not available)
.TP
.B --manpage [filename/wildcard]
produces man page of file, not suitable for all outputs. Alias -i
@@ -369,11 +365,14 @@ by most processing flags.
.B --no-*
see --exc-*
.TP
+.B --numbering
+turn on "object citation numbers". See --inc-ocn and --exc-ocn
+.TP
.B -o [filename/wildcard/url]
see --odt
.TP
.B --ocn
-see --inc-ocn and --exc-ocn
+"object citation numbers". See --inc-ocn and --exc-ocn
.TP
.B --odf [filename/wildcard/url]
see --odt
@@ -490,7 +489,7 @@ subdirectory under the current directory (pwd). Unlike using default settings
files have embedded css. Compare --dump
.TP
.B --rst [filename/wildcard/url]
-ReST (rST restructured text) smart text (sisu v5)
+ReST (rST restructured text) smart text (not available)
.TP
.B --rsync [filename/wildcard]
copies sisu output files to remote host using rsync. This requires that
@@ -593,7 +592,7 @@ see --txt
produces texinfo and info file, (view with pinfo). Alias -I
.TP
.B --textile [filename/wildcard/url]
-textile smart text (sisu v5)
+textile smart text (not available)
.TP
.B --txt [filename/wildcard]
produces