From e68a2c03c0be4269b842b7d4cee91b0f85a0c97a Mon Sep 17 00:00:00 2001 From: Ralph Amissah Date: Thu, 7 Feb 2013 18:18:57 -0500 Subject: v4: documentation, sisu_manual/sisu_commands, manpage & html --- data/doc/sisu/CHANGELOG_v4 | 4 ++ data/doc/sisu/html/sisu.1.html | 62 +++++++++++++++++----- .../v4/sisu_manual/sisu_commands.sst | 23 ++++++-- man/man1/sisu.1 | 57 +++++++++++++++++--- 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 & redirect).
--keep-processing-files [filename/wildcard/url]
see --maintenance
-
-L
-
prints license information.
-
-M [filename/wildcard/url]
see --maintenance
@@ -429,18 +426,57 @@ Alias --by-* [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
- -
--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
+(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 --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 --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
--po [language_directory/filename language_directory]
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 -- cgit v1.2.3