From ba819966be60f529a97ed0ccba29f6962f41d078 Mon Sep 17 00:00:00 2001 From: Ralph Amissah Date: Tue, 19 Apr 2011 21:28:19 -0400 Subject: 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) --- data/doc/sisu/CHANGELOG_v2 | 4 + data/doc/sisu/CHANGELOG_v3 | 8 ++ data/doc/sisu/html/sisu.1.html | 97 +++++++++++----------- .../markup-samples/sisu_manual/sisu_commands.sst | 5 +- lib/sisu/v2/options.rb | 66 +++++++-------- lib/sisu/v3/options.rb | 70 ++++++++-------- man/man1/sisu.1 | 10 ++- 7 files changed, 138 insertions(+), 122 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
see --manpage

+
--keep-processing-files [filename/wildcard/url] +
+
+

see --maintenance +

+
-L
prints license information. -

--machine [filename/wildcard/url]
see --dal (document abstraction level/layer) -

--maintenance [filename/wildcard/url]
-
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]
-
produces man page of file, not suitable for -all outputs. Alias -i +
produces man page of file, not suitable for all outputs. Alias -i

-M [filename/wildcard/url]
see --maintenance

-
-m [filename/wildcard/url] -
-
see --dal (document abstraction level/layer) +
-m [filename/wildcard/url]
+
see --dal (document abstraction +level/layer)

--no-ocn
-
[with  --html  --pdf  or  --epub] -switches off object citation numbering. Produce output without identifying -numbers in margins of html or LaTeX/pdf output. +
[with  --html  --pdf  or  --epub] switches off object citation +numbering. Produce output without identifying numbers in margins of html +or LaTeX/pdf output.

-
-N [filename/wildcard/url] -
-
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. +
-N [filename/wildcard/url]
+
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.

-
-n -[filename/wildcard/url]
-
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. +
-n [filename/wildcard/url]
+
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.

-
--odf [filename/wildcard/url] -
-
-

see --odt +

--odf [filename/wildcard/url]
+
see --odt

--odt [filename/wildcard/url]
-
output basic document in opendocument -file format (opendocument.odt). Alias -o +
output basic document in opendocument file format (opendocument.odt). Alias +-o

-o [filename/wildcard/url]
see --odt -

--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 +
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

-
--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 +
--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] -
-
-

see --po4a +

--po [language_directory/filename + language_directory]
+
see --po4a

-
--po4a [language_directory/filename  language_directory]
-
produces -.pot and po files for the file in the languages specified by the language -directory. SiSU 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 +
--po4a [language_directory/filename  language_directory] +
+
produces .pot and po files for the file in the languages specified by the +language directory. SiSU 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 [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]
see --manpage +!_ --keep-processing-files [filename/wildcard/url]
+see --maintenance + !_ -L
prints license information. @@ -130,7 +133,7 @@ prints license information. see --dal (document abstraction level/layer) !_ --maintenance [filename/wildcard/url]
-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]
produces man page of file, not suitable for all outputs. Alias -i diff --git a/lib/sisu/v2/options.rb b/lib/sisu/v2/options.rb index 72db8207..4997e35d 100644 --- a/lib/sisu/v2/options.rb +++ b/lib/sisu/v2/options.rb @@ -125,39 +125,39 @@ module SiSU_commandline unless m.empty? m.each do |m| case m - when /^(?:--color-toggle)$/; c=c+'c' - when /^(?:--configure)$/; c=c+'CC' - when /^(?:--dal?|--machine|--abstraction|--abs)$/; c=c+'m' - when /^(?:--txt|--text|--plaintext)$/; c=c+'t' - when /^(?:--html)$/; c=c+'h' - when /^(?:--epub)$/; c=c+'e' - when /^(?:--od[ft])$/; c=c+'o' - when /^(?:--pdf)$/; c=c+'p' - when /^(?:--concordance|--wordmap)$/; c=c+'w' - when /^(?:--manpage)$/; c=c+'i' - when /^(?:--texinfo)$/; c=c+'I' - when /^(?:--xhtml)$/; c=c+'b' - when /^(?:--xml-sax)$/; c=c+'x' - when /^(?:--xml-dom)$/; c=c+'X' - when /^(?:--digest)$/; c=c+'N' - when /^(?:--termsheet)$/; c=c+'T' - when /^(?:--manifest)$/; c=c+'y' - when /^(?:--sqlite)$/; c=c+'d' - when /^(?:--pg|--pg?sql|--postgresql)$/; c=c+'D' - when /^(?:--remote|--rsync)$/; c=c+'R' - when /^(?:--scp)$/; c=c+'r' - when /^(?:--source)$/; c=c+'s' - when /^(?:--sisupod|--pod)$/; c=c+'S' - when /^(?:--git)$/; c=c+'g' - when /^(?:--urls)$/; c=c+'U' - when /^(?:--zap|--delete)$/; c=c+'Z' - when /^(?:--sample-search-form)$/; c=c+'F' - when /^(?:--webserv|--webrick)$/; c=c+'W' - when /^(?:--maintenance)$/; c=c+'M' - when /^(?:--verbose[=-]3)$/; c=c+'VM' - when /^(?:--verbose[=-]2|--Verbose|--VERBOSE)$/; c=c+'V' - when /^(?:--verbose(?:[=-]1)?)$/; c=c+'v' - when /^(?:--verbose[=-]0|--quiet|--silent)$/; c=c+'q' + when /^--(?:color-toggle)$/; c=c+'c' + when /^--(?:configure)$/; c=c+'CC' + when /^--(?:dal?|machine|abstraction|abs)$/; c=c+'m' + when /^--(?:txt|text|plaintext)$/; c=c+'t' + when /^--(?:html)$/; c=c+'h' + when /^--(?:epub)$/; c=c+'e' + when /^--(?:od[ft])$/; c=c+'o' + when /^--(?:pdf)$/; c=c+'p' + when /^--(?:concordance|wordmap)$/; c=c+'w' + when /^--(?:manpage)$/; c=c+'i' + when /^--(?:texinfo)$/; c=c+'I' + when /^--(?:xhtml)$/; c=c+'b' + when /^--(?:xml-sax)$/; c=c+'x' + when /^--(?:xml-dom)$/; c=c+'X' + when /^--(?:digest)$/; c=c+'N' + when /^--(?:termsheet)$/; c=c+'T' + when /^--(?:manifest)$/; c=c+'y' + when /^--(?:sqlite)$/; c=c+'d' + when /^--(?:pg|pg?sql|postgresql)$/; c=c+'D' + when /^--(?:remote|rsync)$/; c=c+'R' + when /^--(?:scp)$/; c=c+'r' + when /^--(?:source)$/; c=c+'s' + when /^--(?:sisupod|pod)$/; c=c+'S' + when /^--(?:git)$/; c=c+'g' + when /^--(?:urls)$/; c=c+'U' + when /^--(?:zap|delete)$/; c=c+'Z' + when /^--(?:sample-search-form)$/; c=c+'F' + when /^--(?:webserv|webrick)$/; c=c+'W' + when /^--(?:maintenance|keep-processing-files)$/; c=c+'M' + when /^--(?:verbose[=-]3)$/; c=c+'VM' + when /^--(?:verbose[=-]2|Verbose|VERBOSE)$/; c=c+'V' + when /^--(?:verbose(?:[=-]1)?)$/; c=c+'v' + when /^--(?:verbose[=-]0|quiet|silent)$/; c=c+'q' else @mod << m end end diff --git a/lib/sisu/v3/options.rb b/lib/sisu/v3/options.rb index a79b08f3..89efb0a6 100644 --- a/lib/sisu/v3/options.rb +++ b/lib/sisu/v3/options.rb @@ -179,41 +179,41 @@ module SiSU_commandline unless m.empty? m.each do |m| case m - when /^(?:--color-toggle)$/; c=c+'c' - when /^(?:--configure)$/; c=c+'CC' - when /^(?:--dal?|--machine|--abstraction|--abs)$/; c=c+'m' - when /^(?:--txt|--text|--plaintext)$/; c=c+'t' - when /^(?:--html)$/; c=c+'h' - when /^(?:--epub)$/; c=c+'e' - when /^(?:--od[ft])$/; c=c+'o' - when /^(?:--pdf)$/; c=c+'p' - when /^(?:--concordance|--wordmap)$/; c=c+'w' - when /^(?:--manpage)$/; c=c+'i' - when /^(?:--texinfo)$/; c=c+'I' - when /^(?:--xhtml)$/; c=c+'b' - when /^(?:--xml-sax)$/; c=c+'x' - when /^(?:--xml-dom)$/; c=c+'X' - when /^(?:--digest)$/; c=c+'N' - when /^(?:--po4a|--pot?)$/; c=c+'P' - when /^(?:--termsheet)$/; c=c+'T' - when /^(?:--manifest)$/; c=c+'y' - when /^(?:--sqlite)$/; c=c+'d' - when /^(?:--pg|--pg?sql|--postgresql)$/; c=c+'D' - when /^(?:--remote|--rsync)$/; c=c+'R' - when /^(?:--scp)$/; c=c+'r' - when /^(?:--source)$/; c=c+'s' - when /^(?:--sisupod|--pod)$/; c=c+'S' - when /^(?:--git)$/; c=c+'g' - when /^(?:--urls)$/; c=c+'U' - when /^(?:--zap|--delete)$/; c=c+'Z' - when /^(?:--sample-search-form)$/; c=c+'F' - when /^(?:--webserv|--webrick)$/; c=c+'W' - when /^(?:--maintenance)$/; c=c+'M' - when /^(?:--verbose[=-]3)$/; c=c+'VM' - when /^(?:--verbose[=-]2|--Verbose|--VERBOSE)$/; c=c+'V' - when /^(?:--verbose(?:[=-]1)?)$/; c=c+'v' - when /^(?:--verbose[=-]0|--quiet|--silent)$/; c=c+'q' - else @mod << m + when /^--(?:color-toggle)$/; c=c+'c' + when /^--(?:configure)$/; c=c+'CC' + when /^--(?:dal?|machine|abstraction|abs)$/; c=c+'m' + when /^--(?:txt|text|plaintext)$/; c=c+'t' + when /^--(?:html)$/; c=c+'h' + when /^--(?:epub)$/; c=c+'e' + when /^--(?:od[ft])$/; c=c+'o' + when /^--(?:pdf)$/; c=c+'p' + when /^--(?:concordance|wordmap)$/; c=c+'w' + when /^--(?:manpage)$/; c=c+'i' + when /^--(?:texinfo)$/; c=c+'I' + when /^--(?:xhtml)$/; c=c+'b' + when /^--(?:xml-sax)$/; c=c+'x' + when /^--(?:xml-dom)$/; c=c+'X' + when /^--(?:hash-digests)$/; c=c+'N' + when /^--(?:po4a|pot?)$/; c=c+'P' + when /^--(?:termsheet)$/; c=c+'T' + when /^--(?:manifest)$/; c=c+'y' + when /^--(?:sqlite)$/; c=c+'d' + when /^--(?:pg|pg?sql|postgresql)$/; c=c+'D' + when /^--(?:remote|rsync)$/; c=c+'R' + when /^--(?:scp)$/; c=c+'r' + when /^--(?:source)$/; c=c+'s' + when /^--(?:sisupod|pod)$/; c=c+'S' + when /^--(?:git)$/; c=c+'g' + when /^--(?:urls)$/; c=c+'U' + when /^--(?:zap|delete)$/; c=c+'Z' + when /^--(?:sample-search-form)$/; c=c+'F' + when /^--(?:webserv|webrick)$/; c=c+'W' + when /^--(?:maintenance|keep-processing-files)$/; c=c+'M' + when /^--(?:verbose[=-]3)$/; c=c+'VM' + when /^--(?:verbose[=-]2|Verbose|VERBOSE)$/; c=c+'V' + when /^--(?:verbose(?:[=-]1)?)$/; c=c+'v' + when /^--(?:verbose[=-]0|quiet|silent)$/; c=c+'q' + else mod << m #mod only contains command modifiers; commands converted to character end end end diff --git a/man/man1/sisu.1 b/man/man1/sisu.1 index c0676d20..255b21a1 100644 --- a/man/man1/sisu.1 +++ b/man/man1/sisu.1 @@ -1,4 +1,4 @@ -.TH "sisu" "1" "2011-03-09" "3.0.3-beta-rb1.9.2p180" "SiSU" +.TH "sisu" "1" "2011-04-17" "3.0.7-beta-rb1.9.2p180" "SiSU" .br .SH NAME .br @@ -321,6 +321,10 @@ see --texinfo .B -i [filename/wildcard] see --manpage +.TP +.B --keep-processing-files [filename/wildcard/url] +see --maintenance + .TP .B -L prints license information. @@ -331,8 +335,8 @@ see --dal (document abstraction level/layer) .TP .B --maintenance [filename/wildcard/url] -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 .TP .B --manpage [filename/wildcard] -- cgit v1.2.3