From 74849f94f8ddd536ea2d2c1618d129b2dc33efc1 Mon Sep 17 00:00:00 2001 From: Ralph Amissah Date: Wed, 7 Jul 2010 10:54:27 -0400 Subject: documentation, minor updates --- man/man1/sisu.1 | 48 ++++++++++++++++++++++++++++++++---------------- 1 file changed, 32 insertions(+), 16 deletions(-) (limited to 'man/man1') diff --git a/man/man1/sisu.1 b/man/man1/sisu.1 index ef5edb98..79d1f4ef 100644 --- a/man/man1/sisu.1 +++ b/man/man1/sisu.1 @@ -1,4 +1,4 @@ -.TH "sisu" "1" "2010-03-03" "2.0.0" "SiSU" +.TH "sisu" "1" "2010-07-07" "2.6.0" "SiSU" .SH NAME sisu \- documents: markup, structuring, publishing in multiple standard formats, and search .SH SYNOPSIS @@ -370,9 +370,18 @@ individual files for sending). See the \-S option without [filename/wildcard]. copies sisu markup file to output directory. .TP -.B \-t [filename/wildcard \ (*.termsheet.rb)] +.B \-T [filename/wildcard \ (*.termsheet.rb)] standard form document builder, preprocessing feature +.TP +.B \-t [filename/wildcard] +produces plaintext 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 include: \-\-endnotes for endnotes \-\-footnotes for +footnotes at the end of each paragraph \-\-unix for unix linefeed (default) +\-\-msdos for msdos linefeed) + .TP .B \-U [filename/wildcard] prints url output list/map for the available processing flags options and @@ -1074,7 +1083,8 @@ normally be marked 1.1.1 or 1.1.2 or 1.2.1 or 2.1.1 etc. in a document .nf - normal text !{emphasis}! *{bold text}* _{underscore}_ /{italics}/ \"{citation}\" ^{superscript}^ ,{subscript}, +{inserted text}+ + normal text, *{emphasis}*, !{bold text}!, /{italics}/, _{underscore}_, "{citation}", + ^{superscript}^, ,{subscript},, +{inserted text}+, \-{strikethrough}\- #{monospace}# .BR normal text .BR @@ -1095,6 +1105,8 @@ normally be marked 1.1.1 or 1.1.2 or 1.2.1 or 2.1.1 etc. in a document +{inserted text}+ .BR \-{strikethrough}\- +.BR + #{monospace}# .fi .BR @@ -1106,22 +1118,24 @@ normal text .B bold text .I underscore .I italics -"citation" ^superscript^ [subscript] ++inserted text++ \-\-strikethrough\-\- +"citation" ^superscript^ [subscript] ++inserted text++ \-\-strikethrough\-\- monospace .BR normal text .BR .B emphasis +[note: \ can \ be \ configured \ to \ be \ represented \ by \ bold, \ italics +\ or \ underscore] .BR .B bold text .BR -.I underscore +.I italics .BR -.I italics +.I underscore .BR "citation" @@ -1138,6 +1152,9 @@ normal text .BR \-\-strikethrough\-\- +.BR +monospace + .SH 9.3 INDENTATION AND BULLETS @@ -1281,7 +1298,6 @@ normal text [^*3] continues .BR normal text [^+2] continues - .BR .B Alternative endnote pair notation for footnotes/endnotes: @@ -1304,7 +1320,7 @@ the standard and pair notation cannot be mixed in the same document 9.5.1 NAKED URLS WITHIN TEXT, DEALING WITH URLS .BR -urls are found within text and marked up automatically. A url within text is +urls found within text are marked up automatically. A url within text is automatically hyperlinked to itself and by default decorated with angled braces, unless they are contained within a code block (in which case they are passed as normal text), or escaped by a preceding underscore (in which case the @@ -1395,7 +1411,7 @@ automatically as a footnote .B resulting output: .BR -aboutSiSU [^14] markup +abou tSiSU [^14] markup .SH 9.5.3 LINKING IMAGES @@ -4630,19 +4646,19 @@ Filetype: .TP Source digest: -.I MD5(sisu.ssm.sst)= fd741a3ccf160aa55b942d76bd4e3f2a +.I SHA256(sisu.ssm.sst)= a704e4b934fba753bf594990673cdd43a974d405702b78a12788ba80b5021850 .TP Generated by: -.I Generated by: SiSU 2.0.0 of 2010w09/6 (2010-03-06) +.I Generated by: SiSU 2.6.0 of 2010w27/3 (2010-07-07) .TP Ruby version: -.I ruby 1.8.7 (2010-01-10 patchlevel 249) [i486-linux] +.I ruby 1.8.7 (2010-06-23 patchlevel 299) [i486-linux] .TP Document (dal) last generated: -.I Wed Mar 17 13:34:15 -0400 2010 +.I Wed Jul 07 09:33:25 -0400 2010 .TP Other versions of this document: @@ -4662,10 +4678,10 @@ pdf: at: .TP .TP -* Generated by: SiSU 2.0.0 of 2010w09/6 (2010-03-06) +* Generated by: SiSU 2.6.0 of 2010w27/3 (2010-07-07) .TP -* Ruby version: ruby 1.8.7 (2010-01-10 patchlevel 249) [i486-linux] +* Ruby version: ruby 1.8.7 (2010-06-23 patchlevel 299) [i486-linux] .TP -* Last Generated on: Wed Mar 17 13:34:17 -0400 2010 +* Last Generated on: Wed Jul 07 09:33:28 -0400 2010 .TP * SiSU http://www.jus.uio.no/sisu -- cgit v1.2.3