From 3faa85c6816466b6417891315f1402de4a4366fa Mon Sep 17 00:00:00 2001 From: Ralph Amissah Date: Mon, 28 May 2012 04:34:33 -0400 Subject: v3: documentation update, command line control of output dir structure * --output-by-language; --output-by-filetype; --output-by-filename, or --by-language; --by-filetype; --by-filename * sisu_commands.ssi, manpage sisu.1, man2html --- man/man1/sisu.1 | 53 ++++++++++++++++++++++++++++++----------------------- 1 file changed, 30 insertions(+), 23 deletions(-) (limited to 'man/man1/sisu.1') diff --git a/man/man1/sisu.1 b/man/man1/sisu.1 index ceef64ca..35af5f8d 100644 --- a/man/man1/sisu.1 +++ b/man/man1/sisu.1 @@ -1,4 +1,4 @@ -.TH "sisu" "1" "2012-03-19" "3.2.0" "SiSU" +.TH "sisu" "1" "2012-05-25" "3.2.10" "SiSU" .br .SH NAME .br @@ -213,6 +213,10 @@ footnotes at the end of each paragraph \-\-unix for unix linefeed (default) .B \-b [filename/wildcard] see \-\-xhtml +.TP +.B \-\-by\-* +see \-\-output\-by\-* + .TP .B \-C configure/initialise shared output directory files initialize shared output @@ -287,22 +291,22 @@ produces an epub document, [sisu \ version \ >=2 \ ] (filename.epub). Alias \-e .TP .B \-\-exc\-* exclude output feature, overrides configuration settings \-\-exc\-ocn, (exclude -object citation numbering, affects html (seg, scroll), epub, xhtml, xml); -\-\-exc\-toc, (exclude table of contents, affects html (scroll), epub, pdf); -\-\-exc\-links\-to\-manifest, \-\-exc\-manifest\-links, (exclude links to -manifest, affects html (seg, scroll)); \-\-exc\-search\-form, (exclude search -form, affects html (seg, scroll), manifest); \-\-exc\-minitoc, (exclude mini -table of contents, affects html (seg), concordance, manifest); -\-\-exc\-manifest\-minitoc, (exclude mini table of contents, affects manifest); -\-\-exc\-html\-minitoc, (exclude mini table of contents, affects html (seg), -concordance); \-\-exc\-html\-navigation, (exclude navigation, affects html -(seg)); \-\-exc\-html\-navigation\-bar, (exclude navigation bar, affects html -(seg)); \-\-exc\-html\-search\-form, (exclude search form, affects html (seg, -scroll)); \-\-exc\-html\-right\-pane, (exclude right pane/column, affects html -(seg, scroll)); \-\-exc\-html\-top\-band, (exclude top band, affects html (seg, -scroll), concordance (minitoc forced on to provide seg navigation)); -\-\-exc\-segsubtoc (exclude sub table of contents, affects html (seg), epub); -see also \-\-inc\-* +object citation numbering, (switches off object citation numbering), affects +html (seg, scroll), epub, xhtml, xml, pdf); \-\-exc\-toc, (exclude table of +contents, affects html (scroll), epub, pdf); \-\-exc\-links\-to\-manifest, +\-\-exc\-manifest\-links, (exclude links to manifest, affects html (seg, +scroll)); \-\-exc\-search\-form, (exclude search form, affects html (seg, +scroll), manifest); \-\-exc\-minitoc, (exclude mini table of contents, affects +html (seg), concordance, manifest); \-\-exc\-manifest\-minitoc, (exclude mini +table of contents, affects manifest); \-\-exc\-html\-minitoc, (exclude mini +table of contents, affects html (seg), concordance); \-\-exc\-html\-navigation, +(exclude navigation, affects html (seg)); \-\-exc\-html\-navigation\-bar, +(exclude navigation bar, affects html (seg)); \-\-exc\-html\-search\-form, +(exclude search form, affects html (seg, scroll)); \-\-exc\-html\-right\-pane, +(exclude right pane/column, affects html (seg, scroll)); +\-\-exc\-html\-top\-band, (exclude top band, affects html (seg, scroll), +concordance (minitoc forced on to provide seg navigation)); \-\-exc\-segsubtoc +(exclude sub table of contents, affects html (seg), epub); see also \-\-inc\-* .TP .B \-F [\-\-webserv=webrick] @@ -425,12 +429,6 @@ by most processing flags. .B \-\-no\-* see \-\-exc\-* -.TP -.B \-\-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. - .TP .B \-o [filename/wildcard/url] see \-\-odt @@ -443,6 +441,15 @@ see \-\-odt .B \-\-odt [filename/wildcard/url] output basic document in opendocument file format (opendocument.odt). Alias \-o +.TP +.B \-\-output\-by\-* +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\-* + .TP .B \-P [language_directory/filename \ language_directory] see \-\-po4a -- cgit v1.2.3