summaryrefslogtreecommitdiffstats
path: root/man
diff options
context:
space:
mode:
authorRalph Amissah <ralph@amissah.com>2013-12-03 05:34:46 +0000
committerRalph Amissah <ralph@amissah.com>2013-12-03 05:34:46 +0000
commit88b3272a0f19387b3c5551c8e04b99e3535dd3a1 (patch)
treefb73b323e9d02f4f3c7c47e8e4a7563a58f7c403 /man
parentv5: xml, fictionbook (diff)
downloadsisu-88b3272a0f19387b3c5551c8e04b99e3535dd3a1.zip
sisu-88b3272a0f19387b3c5551c8e04b99e3535dd3a1.tar.xz
v5: documentation related to commands for new outputs in developmentsisu_4.2.13
Diffstat (limited to 'man')
-rw-r--r--man/man1/sisu.187
1 files changed, 76 insertions, 11 deletions
diff --git a/man/man1/sisu.1 b/man/man1/sisu.1
index 7125122..a692a9f 100644
--- a/man/man1/sisu.1
+++ b/man/man1/sisu.1
@@ -1,4 +1,4 @@
-.TH "sisu" "1" "2013-07-25" "4.1.8" "SiSU"
+.TH "sisu" "1" "2013-11-27" "5.1.0" "SiSU"
.br
.SH NAME
.br
@@ -266,6 +266,12 @@ footnotes at end of each paragraph that contains them [ -A for equivalent dos
endnotes --footnotes for footnotes at the end of each paragraph --unix for unix
linefeed (default) --msdos for msdos linefeed)
.TP
+.B --ao [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. Alias -m. (sisu v5)
+.TP
.B -b [filename/wildcard]
see --xhtml
.TP
@@ -322,13 +328,16 @@ see --sqlite
.TP
.B --dal [filename/wildcard/url]
assumed for most other flags, creates new intermediate files for processing
-(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
+(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
.TP
.B --delete [filename/wildcard]
see --zap
.TP
+.B --docbook [filename/wildcard/url]
+docbook smart text (sisu v5)
+.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
@@ -368,6 +377,9 @@ see --sample-search-form
.B -f [optional string part of filename]
see --find
.TP
+.B --fictionbook [filename/wildcard/url]
+fictionbook smart text (sisu v5)
+.TP
.B --find [optional string part of filename]
without match string, glob all .sst .ssm files in directory (including language
subdirectories). With match string, find files that match given string in
@@ -457,6 +469,9 @@ see --dal (document abstraction level/layer)
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)
+.TP
.B --manpage [filename/wildcard]
produces man page of file, not suitable for all outputs. Alias -i
.TP
@@ -597,6 +612,9 @@ subdirectory under the current directory (pwd). Unlike using default settings
.I HTML
files have embedded css. Compare --dump
.TP
+.B --rst [filename/wildcard/url]
+ReST (rST restructured text) smart text (sisu v5)
+.TP
.B --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
@@ -693,6 +711,9 @@ see --txt
.B --texinfo [filename/wildcard]
produces texinfo and info file, (view with pinfo). Alias -I
.TP
+.B --textile [filename/wildcard/url]
+textile smart text (sisu v5)
+.TP
.B --txt [filename/wildcard]
produces
.I plaintext
@@ -702,6 +723,18 @@ footnotes at end of each paragraph that contains them [ -A for equivalent dos
endnotes --footnotes for footnotes at the end of each paragraph --unix for unix
linefeed (default) --msdos for msdos linefeed). Alias -t
.TP
+.B --txt-asciitext [filename/wildcard]
+see --asciitext
+.TP
+.B --txt-markdown [filename/wildcard]
+see --markdown
+.TP
+.B --txt-rst [filename/wildcard]
+see --rst
+.TP
+.B --txt-textile [filename/wildcard]
+see --textile
+.TP
.B -U [filename/wildcard]
see --urls
.TP
@@ -1596,7 +1629,7 @@ normal text [^**] continues
.nf
normal text ~[* editors notes, numbered asterisk footnote/endnote series ]~ continues
-normal text ~[+ editors notes, numbered asterisk footnote/endnote series ]~ continues
+normal text ~[+ editors notes, numbered plus symbol footnote/endnote series ]~ continues
.fi
.BR
@@ -1855,7 +1888,7 @@ information in each column
.BR
.B markup example:
-[^17]
+[^18]
.nf
!_ Table 3.1: Contributors to Wikipedia, January 2001 - June 2005
@@ -2257,7 +2290,7 @@ its own:
page new =\e= or breaks the page, starts a new page.
.BR
-page break -\\- or breaks a column, starts a new column, if using columns,
+page break -\e- or breaks a column, starts a new column, if using columns,
else breaks the page, starts a new page.
.BR
@@ -2335,7 +2368,10 @@ If multiple sub-terms appear under one paragraph, they are separated under the
main term heading from each other by a pipe symbol.
.nf
Paragraph containing main term, second term and sub-term.
- ={Main term:sub-term+1|second sub-term}
+ ={Main term:
+ sub-term+2|second sub-term;
+ Another term
+ }
A paragraph that continues discussion of the first sub-term
.fi
@@ -2347,6 +2383,7 @@ additional paragraph. The logical structure of the resulting index would be:
Main term, 1,
sub-term, 1-3,
second sub-term, 1,
+ Another term, 1
.fi
.SH COMPOSITE DOCUMENTS MARKUP
@@ -2384,7 +2421,36 @@ The form described above should be relied on. Within the
.I Vim
editor it results in the text thus linked becoming hyperlinked to the document
it is calling in which is convenient for editing.
+.SH SUBSTITUTIONS
+
+
+.BR
+
+.B markup example:
+.nf
+The current Debian is ${debian_stable} the next debian will be ${debian_testing}
+Configure substitution in _sisu/sisu_document_make
+
+@make:
+:substitute: /${debian_stable}/,'*{Wheezy}*' /${debian_testing}/,'*{Jessie}*'
+.fi
+
+
+.BR
+
+.B resulting output:
+
+.BR
+The current
+.B Debian
+is
+.B Wheezy
+the next debian will be
+.B Jessie
+
+.BR
+Configure substitution in _sisu/sisu_document_make
.SH SISU FILETYPES
.BR
@@ -2668,8 +2734,7 @@ supported by XeTeX polyglosia.
.SH GENERAL DIRECTORIES
.nf
- ./subject_name/
-
+\./subject_name/
% files stored at this level e.g. sisu_manual.sst or
% for sisu v3 may be under language sub-directories
% e.g.
@@ -3788,7 +3853,7 @@ editors notes, numbered asterisk footnote/endnote series
.BR
.TP
.BI +2.
-editors notes, numbered asterisk footnote/endnote series
+editors notes, numbered plus symbol footnote/endnote series
.BR
.TP