aboutsummaryrefslogtreecommitdiffhomepage
diff options
context:
space:
mode:
authorRalph Amissah <ralph@amissah.com>2013-02-07 18:18:57 -0500
committerRalph Amissah <ralph@amissah.com>2013-02-07 18:18:57 -0500
commite68a2c03c0be4269b842b7d4cee91b0f85a0c97a (patch)
treecfba4b717952e88afef5ce284781da0bcc3f8382
parentv4: options, for pdf, concentrate & simplify matching of orientation & papersize (diff)
v4: documentation, sisu_manual/sisu_commands, manpage & html
-rw-r--r--data/doc/sisu/CHANGELOG_v44
-rw-r--r--data/doc/sisu/html/sisu.1.html62
-rw-r--r--data/doc/sisu/markup-samples/v4/sisu_manual/sisu_commands.sst23
-rw-r--r--man/man1/sisu.157
4 files changed, 121 insertions, 25 deletions
diff --git a/data/doc/sisu/CHANGELOG_v4 b/data/doc/sisu/CHANGELOG_v4
index 715341a5..36275e85 100644
--- a/data/doc/sisu/CHANGELOG_v4
+++ b/data/doc/sisu/CHANGELOG_v4
@@ -53,6 +53,10 @@ http://www.jus.uio.no/sisu/pkg/src/sisu_4.0.6.orig.tar.xz
dir where relative path provided (remove possibility of it being done from a
language sub-directory), fix
+* v4: documentation
+ * sisu_manual/sisu_commands
+ * manpage & html
+
%% 4.0.5.orig.tar.xz (2013-02-03:04/7)
http://sources.sisudoc.org/gitweb/?p=code/sisu.git;a=shortlog;h=refs/tags/sisu_4.0.5
http://sources.sisudoc.org/gitweb/?p=code/sisu.git;a=shortlog;h=refs/tags/debian/sisu_4.0.5-1
diff --git a/data/doc/sisu/html/sisu.1.html b/data/doc/sisu/html/sisu.1.html
index 2063c021..3d852a3e 100644
--- a/data/doc/sisu/html/sisu.1.html
+++ b/data/doc/sisu/html/sisu.1.html
@@ -365,9 +365,6 @@ invoked by --dump &amp; redirect). </dd>
<dt><b>--keep-processing-files [filename/wildcard/url]</b> </dt>
<dd>see --maintenance </dd>
-<dt><b>-L</b> </dt>
-<dd>prints license information. </dd>
-
<dt><b>-M [filename/wildcard/url]</b> </dt>
<dd>see --maintenance </dd>
@@ -429,18 +426,57 @@ Alias --by-* </dd>
[filename/wildcard]</b> </dt>
<dd>see --pdf </dd>
+<dt><b>--papersize-(a4|a5|b5|letter|legal)</b> </dt>
+<dd>in conjunction
+with --pdf set pdf papersize, overriding any configuration settings, to set
+more than one papersize repeat the option --pdf --papersize-a4 --papersize-letter.
+See also --papersize=*
+<p>
+<p> <b>--papersize=a4,a5,b5,letter,legal</b> in conjunction
+with --pdf set pdf papersize, overriding any configuration settings, to set
+more than one papersize list after the equal sign with a comma separator
+--papersize=a4,letter. See also --papersize-* </dd>
+
<dt><b>--pdf [filename/wildcard]</b> </dt>
<dd>produces <i>LaTeX</i> pdf
-(portrait.pdf &amp; landscape.pdf). Default paper size is set in config file, or
-document header, or provided with additional command line parameter, e.g.
---papersize-a4 preset sizes include: &rsquo;A4&rsquo;, U.S. &rsquo;letter&rsquo; and &rsquo;legal&rsquo; and book sizes
-&rsquo;A5&rsquo; and &rsquo;B5&rsquo; (system defaults to A4). Alias -p </dd>
-
-<dt><b>--pg [instruction] [filename]</b> </dt>
-<dd>database
-<i>PostgreSQL</i> ( --pgsql may be used instead) possible instructions, include:
---createdb; --create; --dropall; --import [filename]; --update [filename]; --remove
-[filename]; see database section below. Alias -D </dd>
+(portrait.pdf &amp; landscape.pdf). Orientation and papersize may be
+set on the command-line. Default paper size is set in config file, or document
+header, or provided with additional command line parameter, e.g. --papersize-a4
+preset sizes include: &rsquo;A4&rsquo;, U.S. &rsquo;letter&rsquo; and &rsquo;legal&rsquo; and book sizes &rsquo;A5&rsquo; and &rsquo;B5&rsquo;
+(system defaults to A4), and; --landscape or --portrait, so: e.g. "sisu --pdf-a4
+--pdf-letter --landscape --verbose [filename/wildcard]" or "sisu --pdf --landscape
+--a4 --letter --verbose [filename/wildcard]". --pdf defaults to both landscape &amp;
+portrait output, and a4 if no other papersizes are configured. Related options
+--pdf-landscape --pdf-portrait --pdf-papersize-* --pdf-papersize=[list]. Alias -p </dd>
+
+<dt><b>--pdf-l
+[filename/wildcard]</b> </dt>
+<dd>See --pdf-landscape </dd>
+
+<dt><b>--pdf-landscape [filename/wildcard]</b> </dt>
+<dd>sets
+orientation, produces <i>LaTeX</i> pdf landscape.pdf. Default paper size is set
+in config file, or document header, or provided with additional command
+line parameter, e.g. --papersize-a4 preset sizes include: &rsquo;A4&rsquo;, U.S. &rsquo;letter&rsquo; and
+&rsquo;legal&rsquo; and book sizes &rsquo;A5&rsquo; and --papersize-* or --papersize=[list]. Alias --pdf-l
+or in conjunction with --pdf --landscape </dd>
+
+<dt><b>--pdf-p [filename/wildcard]</b> </dt>
+<dd>See --pdf-portrait
+</dd>
+
+<dt><b>--pdf-portrait [filename/wildcard]</b> </dt>
+<dd>sets orientation, produces <i>LaTeX</i> pdf portrait.pdf.pdf.
+Default paper size is set in config file, or document header, or provided
+with additional command line parameter, e.g. --papersize-a4 preset sizes include:
+&rsquo;A4&rsquo;, U.S. &rsquo;letter&rsquo; and &rsquo;legal&rsquo; and book sizes &rsquo;A5&rsquo; and --papersize-* or --papersize=[list].
+Alias --pdf-p or in conjunction with --pdf --portrait </dd>
+
+<dt><b>--pg [instruction] [filename]</b>
+</dt>
+<dd>database <i>PostgreSQL</i> ( --pgsql may be used instead) possible instructions,
+include: --createdb; --create; --dropall; --import [filename]; --update [filename];
+--remove [filename]; see database section below. Alias -D </dd>
<dt><b>--po [language_directory/filename
language_directory]</b> </dt>
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 86f818f6..1c5c1cec 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
@@ -169,9 +169,6 @@ see --color-off
!_ --keep-processing-files [filename/wildcard/url] \\
see --maintenance
-!_ -L \\
-prints license information.
-
!_ -M [filename/wildcard/url] \\
see --maintenance
@@ -218,8 +215,26 @@ see --po4a
!_ -p [filename/wildcard] \\
see --pdf
+!_ --papersize-(a4|a5|b5|letter|legal) \\
+in conjunction with --pdf set pdf papersize, overriding any configuration settings, to set more than one papersize repeat the option --pdf --papersize-a4 --papersize-letter. See also --papersize=*
+
+!_ --papersize=a4,a5,b5,letter,legal
+in conjunction with --pdf set pdf papersize, overriding any configuration settings, to set more than one papersize list after the equal sign with a comma separator --papersize=a4,letter. See also --papersize-*
+
!_ --pdf [filename/wildcard] \\
-produces LaTeX pdf (portrait.pdf & landscape.pdf). Default paper size is set in config file, or document header, or provided with additional command line parameter, e.g. --papersize-a4 preset sizes include: 'A4', U.S. 'letter' and 'legal' and book sizes 'A5' and 'B5' (system defaults to A4). Alias -p
+produces LaTeX pdf (portrait.pdf & landscape.pdf). Orientation and papersize may be set on the command-line. Default paper size is set in config file, or document header, or provided with additional command line parameter, e.g. --papersize-a4 preset sizes include: 'A4', U.S. 'letter' and 'legal' and book sizes 'A5' and 'B5' (system defaults to A4), and; --landscape or --portrait, so: e.g. "sisu --pdf-a4 --pdf-letter --landscape --verbose [filename/wildcard]" or "sisu --pdf --landscape --a4 --letter --verbose [filename/wildcard]". --pdf defaults to both landscape & portrait output, and a4 if no other papersizes are configured. Related options --pdf-landscape --pdf-portrait --pdf-papersize-* --pdf-papersize=[list]. Alias -p
+
+!_ --pdf-l [filename/wildcard] \\
+See --pdf-landscape
+
+!_ --pdf-landscape [filename/wildcard] \\
+sets orientation, produces LaTeX pdf landscape.pdf. Default paper size is set in config file, or document header, or provided with additional command line parameter, e.g. --papersize-a4 preset sizes include: 'A4', U.S. 'letter' and 'legal' and book sizes 'A5' and 'B5' (system defaults to A4). Related options --pdf --pdf-portrait. See also --papersize-* or --papersize=[list]. Alias --pdf-l or in conjunction with --pdf --landscape
+
+!_ --pdf-p [filename/wildcard] \\
+See --pdf-portrait
+
+!_ --pdf-portrait [filename/wildcard] \\
+sets orientation, produces LaTeX pdf portrait.pdf.pdf. Default paper size is set in config file, or document header, or provided with additional command line parameter, e.g. --papersize-a4 preset sizes include: 'A4', U.S. 'letter' and 'legal' and book sizes 'A5' and 'B5' (system defaults to A4). Related options --pdf --pdf-landscape. See also --papersize-* or --papersize=[list]. Alias --pdf-p or in conjunction with --pdf --portrait
!_ --pg [instruction] [filename] \\
database PostgreSQL ( --pgsql may be used instead) possible instructions, include: --createdb; --create; --dropall; --import [filename]; --update [filename]; --remove [filename]; see database section below. Alias -D
diff --git a/man/man1/sisu.1 b/man/man1/sisu.1
index 11c88a3d..f21808b1 100644
--- a/man/man1/sisu.1
+++ b/man/man1/sisu.1
@@ -1,4 +1,4 @@
-.TH "sisu" "1" "2013-02-03" "4.0.5" "SiSU"
+.TH "sisu" "1" "2013-02-07" "4.0.6" "SiSU"
.br
.SH NAME
.br
@@ -437,9 +437,6 @@ see --color-off
.B --keep-processing-files [filename/wildcard/url]
see --maintenance
.TP
-.B -L
-prints license information.
-.TP
.B -M [filename/wildcard/url]
see --maintenance
.TP
@@ -492,13 +489,57 @@ see --po4a
.B -p [filename/wildcard]
see --pdf
.TP
+.B --papersize-(a4|a5|b5|letter|legal)
+in conjunction with --pdf set pdf papersize, overriding any configuration
+settings, to set more than one papersize repeat the option --pdf --papersize-a4
+--papersize-letter. See also --papersize=*
+
+.BR
+
+.B --papersize=a4,a5,b5,letter,legal
+in conjunction with --pdf set pdf papersize, overriding any configuration
+settings, to set more than one papersize list after the equal sign with a comma
+separator --papersize=a4,letter. See also --papersize-*
+.TP
.B --pdf [filename/wildcard]
produces
.I LaTeX
-pdf (portrait.pdf & landscape.pdf). Default paper size is set in config file,
-or document header, or provided with additional command line parameter, e.g.
---papersize-a4 preset sizes include: 'A4', U.S. 'letter' and 'legal' and book
-sizes 'A5' and 'B5' (system defaults to A4). Alias -p
+pdf (portrait.pdf & landscape.pdf). Orientation and papersize may be set on the
+command-line. Default paper size is set in config file, or document header, or
+provided with additional command line parameter, e.g. --papersize-a4 preset
+sizes include: 'A4', U.S. 'letter' and 'legal' and book sizes 'A5' and 'B5'
+(system defaults to A4), and; --landscape or --portrait, so: e.g. "sisu
+--pdf-a4 --pdf-letter --landscape --verbose [filename/wildcard]" or "sisu --pdf
+--landscape --a4 --letter --verbose [filename/wildcard]". --pdf defaults to
+both landscape & portrait output, and a4 if no other papersizes are configured.
+Related options --pdf-landscape --pdf-portrait --pdf-papersize-*
+--pdf-papersize=[list]. Alias -p
+.TP
+.B --pdf-l [filename/wildcard]
+See --pdf-landscape
+.TP
+.B --pdf-landscape [filename/wildcard]
+sets orientation, produces
+.I LaTeX
+pdf landscape.pdf. Default paper size is set in config file, or document
+header, or provided with additional command line parameter, e.g. --papersize-a4
+preset sizes include: 'A4', U.S. 'letter' and 'legal' and book sizes 'A5' and
+'B5' (system defaults to A4). Related options --pdf --pdf-portrait. See also
+--papersize-* or --papersize=[list]. Alias --pdf-l or in conjunction with --pdf
+--landscape
+.TP
+.B --pdf-p [filename/wildcard]
+See --pdf-portrait
+.TP
+.B --pdf-portrait [filename/wildcard]
+sets orientation, produces
+.I LaTeX
+pdf portrait.pdf.pdf. Default paper size is set in config file, or document
+header, or provided with additional command line parameter, e.g. --papersize-a4
+preset sizes include: 'A4', U.S. 'letter' and 'legal' and book sizes 'A5' and
+'B5' (system defaults to A4). Related options --pdf --pdf-landscape. See also
+--papersize-* or --papersize=[list]. Alias --pdf-p or in conjunction with --pdf
+--portrait
.TP
.B --pg [instruction] [filename]
database