aboutsummaryrefslogtreecommitdiffhomepage
path: root/data/doc
diff options
context:
space:
mode:
authorRalph Amissah <ralph@amissah.com>2011-04-19 21:28:19 -0400
committerRalph Amissah <ralph@amissah.com>2011-04-19 21:28:19 -0400
commitba819966be60f529a97ed0ccba29f6962f41d078 (patch)
tree76a448b32fd7fcb362d7f8ce5533c0b9f716c225 /data/doc
parentv2 v3: cgi, sample-search-form (diff)
v2 v3: options, -M / --maintenance, new alias --keep-processing-files
* new alias --keep-processing-files (see Bug#622902) * document "--keep-processing-files" alias for "-M" ("--maintenance") * minor rearrangement of regex * (Closes: #622902)
Diffstat (limited to 'data/doc')
-rw-r--r--data/doc/sisu/CHANGELOG_v24
-rw-r--r--data/doc/sisu/CHANGELOG_v38
-rw-r--r--data/doc/sisu/html/sisu.1.html97
-rw-r--r--data/doc/sisu/markup-samples/sisu_manual/sisu_commands.sst5
4 files changed, 63 insertions, 51 deletions
diff --git a/data/doc/sisu/CHANGELOG_v2 b/data/doc/sisu/CHANGELOG_v2
index 2426158a..558ac4e7 100644
--- a/data/doc/sisu/CHANGELOG_v2
+++ b/data/doc/sisu/CHANGELOG_v2
@@ -15,6 +15,10 @@ Reverse Chronological:
%% 2.9.2.orig.tar.gz (2011-04-19:16/2) [see 3.0.7]
http://git.sisudoc.org/?p=code/sisu.git;a=shortlog;h=refs/tags/debian/3.0.7-1
+ * options, maintenance -M (--maintenance, new alias --keep-processing-files)
+ * new alias --keep-processing-files (see Bug#622902)
+ * minor rearrangement of regex
+
* cgi, sample-search-form
* results still not right, (ruby1.9.2 libraries? double check script)
* not yet done variable directory path fixing for result links
diff --git a/data/doc/sisu/CHANGELOG_v3 b/data/doc/sisu/CHANGELOG_v3
index feb9a6cb..45c92859 100644
--- a/data/doc/sisu/CHANGELOG_v3
+++ b/data/doc/sisu/CHANGELOG_v3
@@ -22,6 +22,10 @@ http://www.jus.uio.no/sisu/pkg/src/sisu_3.0.7.orig.tar.gz
* urls, share/reuse code, fix show all urls -U
+ * options, maintenance -M (--maintenance, new alias --keep-processing-files)
+ * new alias --keep-processing-files (see Bug#622902)
+ * minor rearrangement of regex
+
* cgi, sample-search-form
* results still not right, (ruby1.9.2 libraries? double check script)
* not yet done variable directory path fixing for result links
@@ -34,6 +38,10 @@ http://www.jus.uio.no/sisu/pkg/src/sisu_3.0.7.orig.tar.gz
* screen_text_color (ansi colors) touched, consider reviewing later
+ * documentation, sisu-markup-samples, man page, html
+ * document existence of new alias for -M (--maintenance)
+ --keep-maintenance-files (see Bug#622902)
+
%% 3.0.6.orig.tar.gz (2011-03-30:13/3)
http://git.sisudoc.org/?p=code/sisu.git;a=log;h=refs/tags/debian/3.0.6-1
http://www.jus.uio.no/sisu/pkg/src/sisu_3.0.6.orig.tar.gz
diff --git a/data/doc/sisu/html/sisu.1.html b/data/doc/sisu/html/sisu.1.html
index 357adb3b..b982a989 100644
--- a/data/doc/sisu/html/sisu.1.html
+++ b/data/doc/sisu/html/sisu.1.html
@@ -317,99 +317,96 @@ file (scroll.html). Alias -h
<dd>see --manpage
<p> </dd>
+<dt><b>--keep-processing-files [filename/wildcard/url]</b>
+</dt>
+<dd>
+<p>see --maintenance
+<p> </dd>
+
<dt><b>-L</b> </dt>
<dd>prints license information.
-
<p> </dd>
<dt><b>--machine [filename/wildcard/url]</b> </dt>
<dd>see --dal (document abstraction level/layer)
-
<p> </dd>
<dt><b>--maintenance [filename/wildcard/url]</b> </dt>
-<dd>maintenance mode files created for
-processing preserved and their locations indicated. (also see -V). Alias -M
-
+<dd>maintenance mode, interim processing files are preserved and their locations
+indicated. (also see -V). Aliases -M and --keep-processing-files
<p> </dd>
<dt><b>--manpage [filename/wildcard]</b> </dt>
-<dd>produces man page of file, not suitable for
-all outputs. Alias -i
+<dd>produces man page of file, not suitable for all outputs. Alias -i
<p> </dd>
<dt><b>-M [filename/wildcard/url]</b> </dt>
<dd>see --maintenance
<p> </dd>
-<dt><b>-m [filename/wildcard/url]</b>
-</dt>
-<dd>see --dal (document abstraction level/layer)
+<dt><b>-m [filename/wildcard/url]</b> </dt>
+<dd>see --dal (document abstraction
+level/layer)
<p> </dd>
<dt><b>--no-ocn</b> </dt>
-<dd>[with &nbsp;--html &nbsp;--pdf &nbsp;or &nbsp;--epub]
-switches off object citation numbering. Produce output without identifying
-numbers in margins of html or LaTeX/pdf output.
+<dd>[with &nbsp;--html &nbsp;--pdf &nbsp;or &nbsp;--epub] switches off object citation
+numbering. Produce output without identifying numbers in margins of html
+or LaTeX/pdf output.
<p> </dd>
-<dt><b>-N [filename/wildcard/url]</b>
-</dt>
-<dd>document digest or document content certificate ( DCC ) as md5 digest tree
-of the document: the digest for the document, and digests for each object
-contained within the document (together with information on software versions
-that produced it) (digest.txt). -NV for verbose digest output to screen.
+<dt><b>-N [filename/wildcard/url]</b> </dt>
+<dd>document digest or document
+content certificate ( DCC ) as md5 digest tree of the document: the digest
+for the document, and digests for each object contained within the document
+(together with information on software versions that produced it) (digest.txt).
+-NV for verbose digest output to screen.
<p> </dd>
-<dt><b>-n
-[filename/wildcard/url]</b> </dt>
-<dd>skip the creation of intermediate processing files
-(document abstraction) if they already exist, this skips the equivalent
-of -m which is otherwise assumed by most processing flags.
+<dt><b>-n [filename/wildcard/url]</b> </dt>
+<dd>skip the creation of intermediate processing files (document abstraction) if
+they already exist, this skips the equivalent of -m which is otherwise assumed
+by most processing flags.
<p> </dd>
-<dt><b>--odf [filename/wildcard/url]</b>
-</dt>
-<dd>
-<p>see --odt
+<dt><b>--odf [filename/wildcard/url]</b> </dt>
+<dd>see --odt
<p> </dd>
<dt><b>--odt [filename/wildcard/url]</b> </dt>
-<dd>output basic document in opendocument
-file format (opendocument.odt). Alias -o
+<dd>output basic document in opendocument file format (opendocument.odt). Alias
+-o
<p> </dd>
<dt><b>-o [filename/wildcard/url]</b> </dt>
<dd>see --odt
-
<p> </dd>
<dt><b>--pdf [filename/wildcard]</b> </dt>
-<dd>produces LaTeX 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
+<dd>produces
+LaTeX 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
<p> </dd>
-<dt><b>--pg [instruction] [filename]</b> </dt>
-<dd>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
+<dt><b>--pg [instruction]
+[filename]</b> </dt>
+<dd>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
<p> </dd>
-<dt><b>--po [language_directory/filename &nbsp;language_directory]</b>
-</dt>
-<dd>
-<p>see --po4a
+<dt><b>--po [language_directory/filename
+&nbsp;language_directory]</b> </dt>
+<dd>see --po4a
<p> </dd>
-<dt><b>--po4a [language_directory/filename &nbsp;language_directory]</b> </dt>
-<dd>produces
-.pot and po files for the file in the languages specified by the language
-directory. <b>SiSU</b> markup is placed in subdirectories named with the language
-code, e.g. en/ fr/ es/. The sisu config file must set the output directory
-structure to multilingual. v3, experimental
+<dt><b>--po4a [language_directory/filename &nbsp;language_directory]</b>
+</dt>
+<dd>produces .pot and po files for the file in the languages specified by the
+language directory. <b>SiSU</b> markup is placed in subdirectories named with the
+language code, e.g. en/ fr/ es/. The sisu config file must set the output
+directory structure to multilingual. v3, experimental
<p> </dd>
<dt><b>-P [language_directory/filename
diff --git a/data/doc/sisu/markup-samples/sisu_manual/sisu_commands.sst b/data/doc/sisu/markup-samples/sisu_manual/sisu_commands.sst
index eb01a388..4994663c 100644
--- a/data/doc/sisu/markup-samples/sisu_manual/sisu_commands.sst
+++ b/data/doc/sisu/markup-samples/sisu_manual/sisu_commands.sst
@@ -123,6 +123,9 @@ see --texinfo
!_ -i [filename/wildcard] <br>
see --manpage
+!_ --keep-processing-files [filename/wildcard/url] <br>
+see --maintenance
+
!_ -L <br>
prints license information.
@@ -130,7 +133,7 @@ prints license information.
see --dal (document abstraction level/layer)
!_ --maintenance [filename/wildcard/url] <br>
-maintenance mode files created for processing preserved and their locations indicated. (also see -V). Alias -M
+maintenance mode, interim processing files are preserved and their locations indicated. (also see -V). Aliases -M and --keep-processing-files
!_ --manpage [filename/wildcard] <br>
produces man page of file, not suitable for all outputs. Alias -i