diff options
| -rw-r--r-- | data/doc/sisu/CHANGELOG_v5 | 1 | ||||
| -rw-r--r-- | data/doc/sisu/html/sisu.1.html | 235 | ||||
| -rw-r--r-- | data/doc/sisu/markup-samples/sisu_manual/_sisu/rc/sisurc_by_fn.yml | 2 | ||||
| -rw-r--r-- | data/doc/sisu/markup-samples/sisu_manual/_sisu/rc/sisurc_by_ft.yml | 2 | ||||
| -rw-r--r-- | data/doc/sisu/markup-samples/sisu_manual/sisu_commands.sst | 13 | ||||
| -rw-r--r-- | man/man1/sisu.1 | 41 |
6 files changed, 185 insertions, 109 deletions
diff --git a/data/doc/sisu/CHANGELOG_v5 b/data/doc/sisu/CHANGELOG_v5 index f34a4537..9b092a5d 100644 --- a/data/doc/sisu/CHANGELOG_v5 +++ b/data/doc/sisu/CHANGELOG_v5 @@ -45,6 +45,7 @@ http://www.jus.uio.no/sisu/pkg/src/sisu_5.0.8.orig.tar.xz --default-language='en' --default-lang-en if used together with --monolingual and --by-filetype or --by-filename the selected default language document will not have a language code in the output filename + * documentation %% 5.0.7.orig.tar.xz (2013-06-25:25/2) http://sources.sisudoc.org/gitweb/?p=code/sisu.git;a=shortlog;h=refs/tags/sisu_5.0.7 diff --git a/data/doc/sisu/html/sisu.1.html b/data/doc/sisu/html/sisu.1.html index 6f4eb681..65a92c9a 100644 --- a/data/doc/sisu/html/sisu.1.html +++ b/data/doc/sisu/html/sisu.1.html @@ -285,12 +285,14 @@ on to provide seg navigation)); --exc-segsubtoc (exclude sub table of contents, affects html (seg), epub) ; see also --inc-* </dd> <dt><b>-F [--webserv=webrick]</b> </dt> -<dd>see --sample-search-form </dd> +<dd>see --sample-search-form +</dd> <dt><b>-f [optional string part of filename]</b> </dt> <dd>see --find </dd> -<dt><b>--find [optional string part of filename]</b> </dt> +<dt><b>--find [optional string part +of filename]</b> </dt> <dd>without match string, glob all .sst .ssm files in directory (including language subdirectories). With match string, find files that match given string in directory (including language subdirectories). Alias @@ -299,7 +301,8 @@ match given string in directory (including language subdirectories). Alias <dt><b>-G [optional string part of filename]</b> </dt> <dd>see --find </dd> -<dt><b>-g [filename/wildcard]</b> </dt> +<dt><b>-g [filename/wildcard]</b> +</dt> <dd>see --git </dd> <dt><b>--git [filename/wildcard]</b> </dt> @@ -311,7 +314,8 @@ structure in a git repo (experimental and subject to change). Alias -g </dd> <dd>see --find </dd> <dt><b>-h [filename/wildcard]</b> </dt> -<dd>see --html </dd> +<dd>see --html +</dd> <dt><b>--harvest *.ss[tm]</b> </dt> <dd>makes two lists of sisu output based on the sisu markup @@ -347,100 +351,122 @@ and --html </dd> <dd>see --texinfo </dd> <dt><b>-i [filename/wildcard]</b> </dt> -<dd>see --manpage</dd> +<dd>see --manpage +</dd> + +<dt><b>--i18n-*</b> </dt> +<dd>these flags affect output by filetype and filename): --i18n-mono (--monolingual) +output filenames without language code for default language (’en’ or as set); +--i18n-multi (--multilingual) language code provided as part of the output filename, +this is the default. Where output is in one language only the language code +may not be desired. see also --output-by-* </dd> <dt><b>--inc-*</b> </dt> -<dd>include output feature, overrides configuration settings, (usually -the default if none set), has precedence over --exc-* (exclude output feature). -Some detail provided under --exc-*, see --exc-* </dd> +<dd>include output feature, overrides +configuration settings, (usually the default if none set), has precedence +over --exc-* (exclude output feature). Some detail provided under --exc-*, see +--exc-* </dd> <dt><b>-j [filename/wildcard]</b> </dt> -<dd>copies images associated with a file for use by html, xhtml & xml outputs (automatically -invoked by --dump & redirect). </dd> +<dd>copies images associated with a file for use +by html, xhtml & xml outputs (automatically invoked by --dump & redirect). </dd> -<dt><b>-k</b> </dt> +<dt><b>-k</b> +</dt> <dd>see --color-off </dd> <dt><b>--keep-processing-files [filename/wildcard/url]</b> </dt> -<dd>see --maintenance </dd> +<dd>see --maintenance +</dd> <dt><b>-M [filename/wildcard/url]</b> </dt> <dd>see --maintenance </dd> <dt><b>-m [filename/wildcard/url]</b> </dt> -<dd>see --dal (document abstraction level/layer) </dd> +<dd>see +--dal (document abstraction level/layer) </dd> -<dt><b>--machine [filename/wildcard/url]</b> </dt> +<dt><b>--machine [filename/wildcard/url]</b> +</dt> <dd>see --dal (document abstraction level/layer) </dd> -<dt><b>--maintenance [filename/wildcard/url]</b> </dt> +<dt><b>--maintenance [filename/wildcard/url]</b> +</dt> <dd>maintenance mode, interim processing files are preserved and their locations indicated. (also see -V). Aliases -M and --keep-processing-files. </dd> -<dt><b>--manpage [filename/wildcard]</b> </dt> +<dt><b>--manpage [filename/wildcard]</b> +</dt> <dd>produces man page of file, not suitable for all outputs. Alias -i </dd> +<dt><b>--monolingual</b> +</dt> +<dd>see --i18n-* </dd> + +<dt><b>--multilingual</b> </dt> +<dd>see --i18n-* </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. </dd> +<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. </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. </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. </dd> <dt><b>--no-*</b> </dt> <dd>see --exc-* </dd> -<dt><b>-o -[filename/wildcard/url]</b> </dt> +<dt><b>-o [filename/wildcard/url]</b> +</dt> <dd>see --odt </dd> <dt><b>--odf [filename/wildcard/url]</b> </dt> <dd>see --odt </dd> -<dt><b>--odt -[filename/wildcard/url]</b> </dt> -<dd>output basic document in opendocument file format -(opendocument.odt). Alias -o </dd> +<dt><b>--odt [filename/wildcard/url]</b> +</dt> +<dd>output basic document in opendocument file format (opendocument.odt). Alias +-o </dd> <dt><b>--output-by-*</b> </dt> -<dd>select output directory structure from -3 alternatives: --output-by-language, (language directory (based on language -code) with filetype (html, epub, pdf etc.) subdirectories); --output-by-filetype, -(filetype directories with language code as part of filename); --output-by-filename, -(filename directories with language code as part of filename). This is configurable. -Alias --by-* </dd> +<dd>select output directory structure from 3 alternatives: --output-by-language, +(language directory (based on language code) with filetype (html, epub, +pdf etc.) subdirectories); --output-by-filetype, (filetype directories with +language code as part of filename); --output-by-filename, (filename directories +with language code as part of filename). This is configurable. Alias --by-* +</dd> <dt><b>-P [language_directory/filename language_directory]</b> </dt> <dd>see --po4a </dd> -<dt><b>-p -[filename/wildcard]</b> </dt> +<dt><b>-p [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 & 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 +<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 & 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 </dd> @@ -478,7 +504,8 @@ include: --createdb; --create; --dropall; --import [filename]; --update [filenam language_directory]</b> </dt> <dd>see --po4a </dd> -<dt><b>--po4a [language_directory/filename language_directory]</b> </dt> +<dt><b>--po4a [language_directory/filename 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 @@ -495,13 +522,15 @@ directory structure to multilingual. v3, experimental </dd> <dd>generate QR code image of metadata (used in manifest). v3 only. </dd> -<dt><b>--quiet [filename/wildcard]</b> </dt> +<dt><b>--quiet [filename/wildcard]</b> +</dt> <dd>quiet less output to screen. </dd> <dt><b>-R [filename/wildcard]</b> </dt> <dd>see --rsync </dd> -<dt><b>-r [filename/wildcard]</b> </dt> +<dt><b>-r [filename/wildcard]</b> +</dt> <dd>see --scp </dd> <dt><b>--redirect[=directory_path] [filename/wildcard]</b> </dt> @@ -523,7 +552,8 @@ with other flags, it is not). Also see --scp. Alias -R </dd> <dt><b>-S</b> </dt> <dd>see --sisupod </dd> -<dt><b>-S [filename/wildcard]</b> </dt> +<dt><b>-S [filename/wildcard]</b> +</dt> <dd>see --sisupod </dd> <dt><b>-s [filename/wildcard]</b> </dt> @@ -564,10 +594,11 @@ same output directory base path (possible instructions include: --createdb; see database section below. Alias -d </dd> <dt><b>--sisupod</b> </dt> -<dd>produces a sisupod a zipped sisu directory of markup files including sisu -markup source files and the directories local configuration file, images -and skins. Note: this only includes the configuration files or skins contained -in is tested only with zsh). Alias -S </dd> +<dd>produces a sisupod a zipped +sisu directory of markup files including sisu markup source files and the +directories local configuration file, images and skins. Note: this only +includes the configuration files or skins contained in is tested only +with zsh). Alias -S </dd> <dt><b>--sisupod [filename/wildcard]</b> </dt> <dd>produces a zipped file of @@ -589,18 +620,22 @@ the individual files for sending). See the -S option without [filename/wildcard] Alias -S </dd> <dt><b>--source [filename/wildcard]</b> </dt> -<dd>copies sisu markup file to output directory. Alias -s </dd> +<dd>copies sisu markup file to output directory. +Alias -s </dd> <dt><b>-T [filename/wildcard (*.termsheet.rb)]</b> </dt> -<dd>standard form document builder, preprocessing feature </dd> +<dd>standard form document builder, +preprocessing feature </dd> <dt><b>-t [filename/wildcard]</b> </dt> <dd>see --txt </dd> -<dt><b>--texinfo [filename/wildcard]</b> </dt> +<dt><b>--texinfo [filename/wildcard]</b> +</dt> <dd>produces texinfo and info file, (view with pinfo). Alias -I </dd> -<dt><b>--txt [filename/wildcard]</b> </dt> +<dt><b>--txt [filename/wildcard]</b> +</dt> <dd>produces <i>plaintext</i> with Unix linefeeds and without markup, (object numbers are omitted), has footnotes at end of each paragraph that contains them [ -A for equivalent dos (linefeed) output file] [see -e for endnotes]. (Options @@ -612,10 +647,11 @@ paragraph --unix for unix linefeed (default) --msdos for msdos linefeed). Alias <dd>see --urls </dd> <dt><b>-u [filename/wildcard]</b> </dt> -<dd>provides url mapping of output files for the flags -requested for processing, also see -U </dd> +<dd>provides url mapping +of output files for the flags requested for processing, also see -U </dd> -<dt><b>--urls [filename/wildcard]</b> </dt> +<dt><b>--urls +[filename/wildcard]</b> </dt> <dd>prints url output list/map for the available processing flags options and resulting files that could be requested, (can be used to get a list of processing options in relation to a file, together with @@ -625,10 +661,11 @@ is running and provides webrick url mappings where appropriate, but these can be switched to file system paths in sisurc.yml. Alias -U </dd> <dt><b>-V</b> </dt> -<dd>on its own, provides <b>SiSU</b> version -and environment information (sisu --help env) </dd> +<dd>on its own, +provides <b>SiSU</b> version and environment information (sisu --help env) </dd> -<dt><b>-V [filename/wildcard]</b> </dt> +<dt><b>-V [filename/wildcard]</b> +</dt> <dd>even more verbose than the -v flag. </dd> <dt><b>-v</b> </dt> @@ -842,20 +879,21 @@ in the sisu_manual, available at: <p> The manual can be generated from source, found respectively, either within the <b>SiSU</b> tarball or installed locally at: -<p> -<p> /usr/share/doc/sisu/markup-samples/sisu_manual +<p> ./data/doc/sisu/markup-samples/sisu_manual -<p> move to the respective directory and type e.g.: +<p> /usr/share/doc/sisu/markup-samples/sisu_manual +<p> move to the respective +directory and type e.g.: <p> sisu sisu_manual.ssm -<h2><a name='sect14' href='#toc14'>Sisu -Man Pages</a></h2> - -<p> If <b>SiSU</b> is installed on your system usual man commands should -be available, try: -<p> man sisu -<p> Most <b>SiSU</b> man pages are generated directly -from sisu documents that are used to prepare the sisu manual, the sources -files for which are located within the <b>SiSU</b> tarball at: +<h2><a name='sect14' href='#toc14'>Sisu Man Pages</a></h2> + +<p> If <b>SiSU</b> is +installed on your system usual man commands should be available, try: +<p> + man sisu +<p> Most <b>SiSU</b> man pages are generated directly from sisu documents +that are used to prepare the sisu manual, the sources files for which are +located within the <b>SiSU</b> tarball at: <p> ./data/doc/sisu/markup-samples/sisu_manual<br> <p> Once installed, directory equivalent to: @@ -1260,16 +1298,21 @@ first line indented, rest of paragraph no indent <p> in each case level may <p>be 0-9 -<p> <b>live-build</b> A collection of scripts used to build customized Debian<br> - Livesystems.<br> +<p> +<p> <b>live-build</b> A collection of scripts used to build customized<br> + <b>Debian</b> +<p> Livesystems.<br> .I live-build<br> was formerly known as live-helper, and even earlier known as live-package.<br> -<p> <b>live-build</b> -<p> A collection of scripts used to build customized Debian<br> - Livesystems. live-build was formerly known as live-helper, and even earlier<br> - known as live-package.<br> +<p> +<p> <b>live-build</b> +<p> A collection of scripts used to build customized<br> + <b>Debian</b> Livesystems.<br> + <i>live-build</i> was formerly known as live-helper, and even earlier known as +live-package.<br> +<p> <h2><a name='sect29' href='#toc29'>Footnotes / Endnotes</a></h2> <p> Footnotes and endnotes are marked up at the location @@ -2610,8 +2653,7 @@ be created manually and given the same name as working directory, as requested) <dt><b>sisu -D --create</b> </dt> <dd>creates database tables where no database tables existed - -<p>before +before <p> </dd> <dt><b>sisu -D --Dropall</b> </dt> @@ -2715,8 +2757,7 @@ of the same name). <dt><b>sisu -d --recreate</b> </dt> <dd>destroys existing database and builds - -<p>a new empty database structure +a new empty database structure <p> </dd> </dl> diff --git a/data/doc/sisu/markup-samples/sisu_manual/_sisu/rc/sisurc_by_fn.yml b/data/doc/sisu/markup-samples/sisu_manual/_sisu/rc/sisurc_by_fn.yml index 34d4a662..9bcc416e 100644 --- a/data/doc/sisu/markup-samples/sisu_manual/_sisu/rc/sisurc_by_fn.yml +++ b/data/doc/sisu/markup-samples/sisu_manual/_sisu/rc/sisurc_by_fn.yml @@ -96,6 +96,8 @@ db: #% output_dir_structure_by: language (language_and_filetype); filetype; or filename (original v1 & v2) output_dir_structure_by: filename +#% lingual: 'multi' | 'mono' (multi default) +#lingual: multi permission_set: zap: true diff --git a/data/doc/sisu/markup-samples/sisu_manual/_sisu/rc/sisurc_by_ft.yml b/data/doc/sisu/markup-samples/sisu_manual/_sisu/rc/sisurc_by_ft.yml index 57440498..bf34d249 100644 --- a/data/doc/sisu/markup-samples/sisu_manual/_sisu/rc/sisurc_by_ft.yml +++ b/data/doc/sisu/markup-samples/sisu_manual/_sisu/rc/sisurc_by_ft.yml @@ -96,6 +96,8 @@ db: #% output_dir_structure_by: language (language_and_filetype); filetype; or filename (original v1 & v2) output_dir_structure_by: filetype +#% lingual: 'multi' | 'mono' (multi default) +#lingual: multi permission_set: zap: true 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 491c03fd..8e8926ad 100644 --- a/data/doc/sisu/markup-samples/sisu_manual/sisu_commands.sst +++ b/data/doc/sisu/markup-samples/sisu_manual/sisu_commands.sst @@ -156,6 +156,13 @@ see --texinfo !_ -i [filename/wildcard] \\ see --manpage +!_ --i18n-* \\ +these flags affect output by filetype and filename): +--i18n-mono (--monolingual) output filenames without language code for default language ('en' or as set); +--i18n-multi (--multilingual) language code provided as part of the output filename, this is the default. +Where output is in one language only the language code may not be desired. +see also --output-by-* + !_ --inc-* \\ include output feature, overrides configuration settings, (usually the default if none set), has precedence over --exc-* (exclude output feature). Some detail provided under --exc-*, see --exc-* @@ -184,6 +191,12 @@ maintenance mode, interim processing files are preserved and their locations ind !_ --manpage [filename/wildcard] \\ produces man page of file, not suitable for all outputs. Alias -i +!_ --monolingual \\ +see --i18n-* + +!_ --multilingual \\ +see --i18n-* + !_ -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. diff --git a/man/man1/sisu.1 b/man/man1/sisu.1 index 2bafb76b..8292187d 100644 --- a/man/man1/sisu.1 +++ b/man/man1/sisu.1 @@ -1,4 +1,4 @@ -.TH "sisu" "1" "2013-02-22" "4.0.9" "SiSU" +.TH "sisu" "1" "2013-07-25" "4.1.8" "SiSU" .br .SH NAME .br @@ -422,6 +422,13 @@ see --texinfo .B -i [filename/wildcard] see --manpage .TP +.B --i18n-* +these flags affect output by filetype and filename): --i18n-mono +(--monolingual) output filenames without language code for default language +('en' or as set); --i18n-multi (--multilingual) language code provided as part +of the output filename, this is the default. Where output is in one language +only the language code may not be desired. see also --output-by-* (v5) +.TP .B --inc-* include output feature, overrides configuration settings, (usually the default if none set), has precedence over --exc-* (exclude output feature). Some detail @@ -453,6 +460,12 @@ indicated. (also see -V). Aliases -M and --keep-processing-files. .B --manpage [filename/wildcard] produces man page of file, not suitable for all outputs. Alias -i .TP +.B --monolingual +see --i18n-* +.TP +.B --multilingual +see --i18n-* +.TP .B -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 @@ -927,7 +940,7 @@ The most up to date information on sisu should be contained in the sisu_manual, available at: .BR - <http://sisudoc.org/sisu/sisu_manual/> +<http://sisudoc.org/sisu/sisu_manual/> .BR The manual can be generated from source, found respectively, either within the @@ -935,16 +948,16 @@ The manual can be generated from source, found respectively, either within the tarball or installed locally at: .BR - ./data/doc/sisu/markup-samples/sisu_manual +\./data/doc/sisu/markup-samples/sisu_manual .BR - /usr/share/doc/sisu/markup-samples/sisu_manual +/usr/share/doc/sisu/markup-samples/sisu_manual .BR move to the respective directory and type e.g.: .BR - sisu sisu_manual.ssm +sisu sisu_manual.ssm .SH SISU MAN PAGES @@ -954,7 +967,7 @@ If is installed on your system usual man commands should be available, try: .BR - man sisu +man sisu .BR Most @@ -1512,7 +1525,9 @@ in each case level may be 0-9 .BR .B live-build - A collection of scripts used to build customized Debian + A collection of scripts used to build customized +.B Debian + Livesystems. .I live-build was formerly known as live-helper, and even earlier known as live-package. @@ -1520,9 +1535,12 @@ in each case level may be 0-9 .BR .B live-build - A collection of scripts used to build customized Debian - Livesystems. live-build was formerly known as live-helper, and even earlier - known as live-package. + A collection of scripts used to build customized +.B Debian + Livesystems. +.I live-build + was formerly known as live-helper, and even earlier known as live-package. + .SH FOOTNOTES / ENDNOTES .BR @@ -1837,8 +1855,7 @@ information in each column .BR .B markup example: -[^18] - +[^17] .nf !_ Table 3.1: Contributors to Wikipedia, January 2001 - June 2005 |