diff options
| author | Ralph Amissah <ralph@amissah.com> | 2011-12-08 21:29:57 -0500 | 
|---|---|---|
| committer | Ralph Amissah <ralph@amissah.com> | 2011-12-08 21:29:57 -0500 | 
| commit | 026075321e776034a1bb5543246d55e5a0f59e83 (patch) | |
| tree | a4650d1d069a04099bc6c94c1bca0b1b74836464 /man/man1 | |
| parent | v3: documentation, add --configure, use ascii chars for dir tree, correct typos (diff) | |
v3: documentation, manpage & html (man2html)sisu_3.1.7
Diffstat (limited to 'man/man1')
| -rw-r--r-- | man/man1/sisu.1 | 112 | 
1 files changed, 101 insertions, 11 deletions
| diff --git a/man/man1/sisu.1 b/man/man1/sisu.1 index 9a3e5535..1d4d280b 100644 --- a/man/man1/sisu.1 +++ b/man/man1/sisu.1 @@ -1,4 +1,4 @@ -.TH "sisu" "1" "2011-10-03" "3.1.0" "SiSU" +.TH "sisu" "1" "2011-12-08" "3.1.7" "SiSU"  .br  .SH NAME  .br @@ -221,13 +221,22 @@ be with colour, if sisurc colour default is set to 'false' or is undefined  screen output will be without colour). Alias \-c  .TP +.B \-\-configure +configure/initialise shared output directory files initialize shared output +directory (config files such as css and dtd files are not updated if they +already exist unless modifier is used). The equivalent of: \-C \-\-init\-site +configure/initialise site, more extensive than \-C on its own, shared output +directory files/force update, existing shared output config files such as css +and dtd files are updated if \-CC is used. + +.TP  .B \-\-concordance [filename/wildcard]  produces concordance (wordmap) a rudimentary index of all the words in a  document. (Concordance files are not generated for documents of over 260,000  words unless this limit is increased in the file sisurc.yml). Alias \-w  .TP -.B \-C [\-\-init\-site] +.B \-C  configure/initialise shared output directory files initialize shared output  directory (config files such as css and dtd files are not updated if they  already exist unless modifier is used). \-C \-\-init\-site configure/initialise @@ -237,12 +246,7 @@ updated if this modifier is used.  .TP  .B \-CC -configure/initialise shared output directory files initialize shared output -directory (config files such as css and dtd files are not updated if they -already exist unless modifier is used). The equivalent of: \-C \-\-init\-site -configure/initialise site, more extensive than \-C on its own, shared output -directory files/force update, existing shared output config files such as css -and dtd files are updated if \-CC is used. +see \-\-configure  .TP  .B \-c [filename/wildcard] @@ -1520,7 +1524,7 @@ An escaped url without decoration  .nf    normal text _http://www.sisudoc.org/ continues -  deb http://www.jus.uio.no/sisu/archive unstable main non\-free +  deb _http://www.jus.uio.no/sisu/archive unstable main non\-free  .fi  .br @@ -1597,6 +1601,14 @@ about SiSU <http://www.sisudoc.org/> [^14] markup    {~^ ruby_logo.png "Ruby" }http://www.ruby\-lang.org/en/  .br  .br +.B markup example: + +.nf +  { tux.png 64x80 }image +  % various url linked images +  {tux.png 64x80 "a better way" }http://www.sisudoc.org/ +  {GnuDebianLinuxRubyBetterWay.png 100x101 "Way Better \- with Gnu/Linux, Debian and Ruby" }http://www.sisudoc.org/ +  {~^ ruby_logo.png "Ruby" }http://www.ruby\-lang.org/en/  .fi  .br @@ -1677,7 +1689,7 @@ information in each column    Very active contributors***     |        0|       31|      190|      692|    1,639|    3,016    No. of English language articles|       25|   16,000|  101,000|  190,000|  320,000|  630,000    No. of articles, all languages  |       25|   19,000|  138,000|  490,000|  862,000|1,600,000 -  \e* Contributed at least ten times; \e** at least 5 times in last month; \e*\e** more than 100 times in last month. +  * Contributed at least ten times; ** at least 5 times in last month; *** more than 100 times in last month.  .fi  .br @@ -2223,7 +2235,7 @@ main term heading from each other by a pipe symbol.  .nf      Paragraph containing main term, second term and sub\-term. -    ={Main term:sub\-term+1|second sub\-term +    ={Main term:sub\-term+1|second sub\-term}      A paragraph that continues discussion of the first sub\-term  .fi @@ -3076,6 +3088,35 @@ Its selection is configured in sisurc.yml  .br  output_dir_structure_by: language +.nf +    |\-\- en +    |\-\- epub +    |\-\- hashes +    |\-\- html +    | |\-\- viral_spiral.david_bollier +    | |\-\- manifest +    | |\-\- qrcode +    | |\-\- odt +    | |\-\- pdf +    | |\-\- sitemaps +    | |\-\- txt +    | |\-\- xhtml +    | `\-\- xml +    |\-\- po4a +    | `\-\- live\-manual +    |     |\-\- po +    |     |\-\- fr +    |     `\-\- pot +    `\-\- _sisu +        |\-\- css +        |\-\- image +        |\-\- image_sys \-> \../../_sisu/image_sys +        `\-\- xml +            |\-\- rnc +            |\-\- rng +            `\-\- xsd +.fi +  .br  #by: language subject_dir/en/manifest/filename.html @@ -3092,6 +3133,34 @@ Its selection is configured in sisurc.yml  .br  output_dir_structure_by: filetype +.nf +    |\-\- epub +    |\-\- hashes +    |\-\- html +    |\-\- viral_spiral.david_bollier +    |\-\- manifest +    |\-\- qrcode +    |\-\- odt +    |\-\- pdf +    |\-\- po4a +    |\-\- live\-manual +    |     |\-\- po +    |     |\-\- fr +    |     `\-\- pot +    |\-\- _sisu +    | |\-\- css +    | |\-\- image +    | |\-\- image_sys \-> \../../_sisu/image_sys +    | `\-\- xml +    |     |\-\- rnc +    |     |\-\- rng +    |     `\-\- xsd +    |\-\- sitemaps +    |\-\- txt +    |\-\- xhtml +    `\-\- xml +.fi +  .br  #by: filetype subject_dir/html/filename/manifest.en.html @@ -3107,6 +3176,27 @@ Its selection is configured in sisurc.yml  .br  output_dir_structure_by: filename +.nf +    |\-\- epub +    |\-\- po4a +    |\-\- live\-manual +    |     |\-\- po +    |     |\-\- fr +    |     `\-\- pot +    |\-\- _sisu +    | |\-\- css +    | |\-\- image +    | |\-\- image_sys \-> \../../_sisu/image_sys +    | `\-\- xml +    |     |\-\- rnc +    |     |\-\- rng +    |     `\-\- xsd +    |\-\- sitemaps +    |\-\- src +    |\-\- pod +    `\-\- viral_spiral.david_bollier +.fi +  .br  #by: filename subject_dir/filename/manifest.en.html | 
