From 9a29fdc4292fc230e6a7831191fab58c881af843 Mon Sep 17 00:00:00 2001 From: Ralph Amissah Date: Sat, 19 Dec 2009 21:35:44 -0500 Subject: documentation, small changes to description of -m & -n processing flags (closing debian bug #555496) --- CHANGELOG | 3 +++ data/doc/sisu/v1/CHANGELOG | 3 +++ data/doc/sisu/v1/html/sisu.1.html | 12 +++++++----- lib/sisu/v1/help.rb | 4 ++-- man/man1/sisu.1 | 12 +++++++----- 5 files changed, 22 insertions(+), 12 deletions(-) diff --git a/CHANGELOG b/CHANGELOG index fb486257..5da70577 100644 --- a/CHANGELOG +++ b/CHANGELOG @@ -30,6 +30,9 @@ http://www.jus.uio.no/sisu/pkg/src/sisu_1.0.0.orig.tar.gz * minor changes inter alia for new directory structure + * documentation, modified description of command flags -m and -n (in line + with communication on Debian bug #555496, closing it) + %% sisu_0.71.4.orig.tar.gz (2009-08-29:34/6) http://www.jus.uio.no/sisu/pkg/src/sisu_0.71.4.orig.tar.gz a9accd67316fcc21fa289dd3923641b182023ee3e038ee7c3324b6e71b129a68 1551081 sisu_0.71.4.orig.tar.gz diff --git a/data/doc/sisu/v1/CHANGELOG b/data/doc/sisu/v1/CHANGELOG index fb486257..5da70577 100644 --- a/data/doc/sisu/v1/CHANGELOG +++ b/data/doc/sisu/v1/CHANGELOG @@ -30,6 +30,9 @@ http://www.jus.uio.no/sisu/pkg/src/sisu_1.0.0.orig.tar.gz * minor changes inter alia for new directory structure + * documentation, modified description of command flags -m and -n (in line + with communication on Debian bug #555496, closing it) + %% sisu_0.71.4.orig.tar.gz (2009-08-29:34/6) http://www.jus.uio.no/sisu/pkg/src/sisu_0.71.4.orig.tar.gz a9accd67316fcc21fa289dd3923641b182023ee3e038ee7c3324b6e71b129a68 1551081 sisu_0.71.4.orig.tar.gz diff --git a/data/doc/sisu/v1/html/sisu.1.html b/data/doc/sisu/v1/html/sisu.1.html index faf8069c..301933b2 100644 --- a/data/doc/sisu/v1/html/sisu.1.html +++ b/data/doc/sisu/v1/html/sisu.1.html @@ -256,9 +256,9 @@ processing preserved and their locations indicated. (also see -V)
-m [filename/wildcard/url]
-
assumed for most other flags, creates new meta-markup file, (the metaverse -) that is used in all subsequent processing of other output. This step is -assumed for most processing flags. To skip it see -n +
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

-N [filename/wildcard/url] @@ -271,8 +271,10 @@ that produced it) (digest.txt). -NV for verbose digest output to screen.
-n [filename/wildcard/url]
-
skip meta-markup (building of -m which is otherwise -assumed by most processing flags. + +
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.

-o [filename/wildcard/url]
diff --git a/lib/sisu/v1/help.rb b/lib/sisu/v1/help.rb index cd5eaf25..101f673b 100644 --- a/lib/sisu/v1/help.rb +++ b/lib/sisu/v1/help.rb @@ -269,11 +269,11 @@ WOK #{@cX.ruby}-M#{@cX.off} #{@cX.green}[filename/wildcard/url]#{@cX.off} maintenance mode, files created for processing are not deleted, and their locations are indicated (also see -V) - #{@cX.ruby}-m#{@cX.off} #{@cX.green}[filename/wildcard/url]#{@cX.off} create (new)metaVerse (used in all subsequent processing). Produce a meta file, the first step in processing, and the file all subsequent processing utilize. (Should usually be run together with other commands to ensure that the lated version of markup source document is used, i.e. add -m flag to other flags required). + #{@cX.ruby}-m#{@cX.off} #{@cX.green}[filename/wildcard/url]#{@cX.off} 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 #{@cX.ruby}-N#{@cX.off} #{@cX.green}[filename/wildcard/url]#{@cX.off} document content certificate as md5 digest tree of document produced (as digest.txt), the digest for the document, and digests for each object contained within the document (together with information on software versions that produced it). Try -mNV for verbose digest output to screen - #{@cX.ruby}-n#{@cX.off} #{@cX.green}[filename/wildcard/url]#{@cX.off} skip meta-markup (building of "metaverse"), this skips the equivalent of -m + #{@cX.ruby}-n#{@cX.off} #{@cX.green}[filename/wildcard/url]#{@cX.off} 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. #{@cX.ruby}-p#{@cX.off} #{@cX.green}[filename/wildcard]#{@cX.off} produces LaTeX pdf (portrait & landscape). 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). diff --git a/man/man1/sisu.1 b/man/man1/sisu.1 index 7cb09654..03d2cad5 100644 --- a/man/man1/sisu.1 +++ b/man/man1/sisu.1 @@ -306,9 +306,10 @@ indicated. (also see \-V) .TP .B \-m [filename/wildcard/url] -assumed for most other flags, creates new meta\-markup file, (the metaverse ) -that is used in all subsequent processing of other output. This step is assumed -for most processing flags. To skip it see \-n + +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 .TP .B \-N [filename/wildcard/url] @@ -319,8 +320,9 @@ that produced it) (digest.txt). \-NV for verbose digest output to screen. .TP .B \-n [filename/wildcard/url] -skip meta\-markup (building of \"metaverse\"), this skips the equivalent of -\-m which is otherwise assumed by most processing flags. +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. .TP .B \-o [filename/wildcard/url] -- cgit v1.2.3