summaryrefslogtreecommitdiffstats
path: root/README
diff options
context:
space:
mode:
authorRalph Amissah <ralph@amissah.com>2007-07-07 08:21:47 +0000
committerRalph Amissah <ralph@amissah.com>2007-07-07 08:21:47 +0000
commit52f8b9c0b1e1606a4260ef2e0df4d525497691b1 (patch)
treecfb189e2c1dce1af31fc4eb9c414b3bbc6128202 /README
parent0.55.1 sync (diff)
downloadsisu-52f8b9c0b1e1606a4260ef2e0df4d525497691b1.zip
sisu-52f8b9c0b1e1606a4260ef2e0df4d525497691b1.tar.xz
cgi-sample search form; texinfo fix; xml scaffold; help, man pages etc. visited; screen output, color set to true; docbook entries removed
* cgi generated sample search form * order results on files of the same title, in multiple files (with different filenames) * postgresql, character case sensitivity, control, on/off * tail decoration, gplv3 & sisu info * texinfo/info (pinfo) module starts to do something vaguely useful again [not a much used module, testing required] * print XML rendition of document structure to screen -T * sisurc.yml default, color set to true [apologies if this causes anyone any inconvenience, it is configurable in sisurc.yml] * help, man pages, README (man(8) related and env, 'sisu -V') * docbook entries removed for the present time * sisu-install (install ruby rant script renamed) and permissions set to executable
Diffstat (limited to 'README')
-rw-r--r--README59
1 files changed, 32 insertions, 27 deletions
diff --git a/README b/README
index b2f8a69..789f95e 100644
--- a/README
+++ b/README
@@ -1,5 +1,5 @@
-SiSU 0.49 2007w08/5 20070223
-homepage: http://www.jus.uio.no/sisu
+SiSU 0.55 2007w27/6 2007-07-07
+homepage: <http://www.jus.uio.no/sisu>
%% Description
---------------
@@ -42,7 +42,7 @@ homepage: http://www.jus.uio.no/sisu
the substantive content of the marked up documents provided is that provided
by the author or original publisher.
- Homepage: http://www.jus.uio.no/sisu
+ Homepage: <http://www.jus.uio.no/sisu>
-----
@@ -87,14 +87,11 @@ Once set up it is simple to use.
%% Online Information, places to look
---------------
-http://www.jus.uio.no/sisu
+<http://www.jus.uio.no/sisu>
Download Sources:
- http://www.jus.uio.no/sisu/SiSU/download.html#current
- http://www.jus.uio.no/sisu/SiSU/download.html#debian
-or the same:
- http://www.jus.uio.no/sisu/sisu_download/download.html#current
- http://www.jus.uio.no/sisu/sisu_download/download.html#debian
+ <http://www.jus.uio.no/sisu/SiSU/download.html#current>
+ <http://www.jus.uio.no/sisu/SiSU/download.html#debian>
%% Installation
---------------
@@ -104,8 +101,7 @@ NB. Platform is Unix / Linux.
---------------
If you use Debian use the Debian packages,
check the information at:
- http://www.jus.uio.no/sisu/SiSU/download.html#debian
- http://www.jus.uio.no/sisu/sisu_download/download.html#debian
+ <http://www.jus.uio.no/sisu/SiSU/download.html#debian>
(A) SiSU is available directly off the Debian archives for Sid and testing. It
should necessary only to run as root:
@@ -135,13 +131,12 @@ RPMs are provided though untested, they are prepared by running alien against th
source package, and against the debs.
They may be downloaded from:
- http://www.jus.uio.no/sisu/SiSU/download.html#rpm
+ <http://www.jus.uio.no/sisu/SiSU/download.html#rpm>
%% Source package .tgz
---------------
Otherwise to install SiSU from source, check information at:
- http://www.jus.uio.no/sisu/SiSU/download.html#current
- http://www.jus.uio.no/sisu/sisu_download/download.html#current
+ <http://www.jus.uio.no/sisu/SiSU/download.html#current>
two alternative modes of installation from source are provided,
setup.rb (by Minero Aoki) and a rant(by Stefan Lang) built install file,
@@ -149,7 +144,7 @@ in either case: the first steps are the same, download and unpack the
source file:
1. Download the latest source (information available) from:
- http://www.jus.uio.no/sisu/SiSU/download.html#current
+ <http://www.jus.uio.no/sisu/SiSU/download.html#current>
2. Unpack the source
@@ -164,16 +159,16 @@ in the root directory of the unpacked SiSU as root type:
ruby setup.rb install
further information:
- http://i.loveruby.net/en/projects/setup/
- http://i.loveruby.net/en/projects/setup/doc/usage.html
+ <http://i.loveruby.net/en/projects/setup/>
+ <http://i.loveruby.net/en/projects/setup/doc/usage.html>
%% to use install (prapared with "Rant")
---------------
in the root directory of the unpacked SiSU as root type:
- ruby install
+ ruby ./sisu-install
or
- ruby install base
+ ruby ./sisu-install base
This makes use of Rant (by Stefan Lang) and the provided Rantfile. It has been
configured to do post installation setup setup configuration and generation of
@@ -181,12 +176,12 @@ first test file. Note however, that additional external package dependencies,
such as tetex-extra are not taken care of for you.
further information:
- http://make.rubyforge.org/
- http://rubyforge.org/frs/?group_id=615
+ <http://make.rubyforge.org/>
+ <http://rubyforge.org/frs/?group_id=615>
For a list of alternative actions you may type:
- ruby install help
- ruby install -T
+ ruby ./sisu-install help
+ ruby ./sisu-install -T
Dependencies
--------------
@@ -262,7 +257,7 @@ examine source document, vim has syntax support
gvim free_as_in_freedom.rms_and_free_software.sam_williams.sst
additional markup samples in
-http://www.jus.uio.no/sisu/SiSU/2.html
+<http://www.jus.uio.no/sisu/SiSU/2.html>
For help
man sisu
@@ -353,12 +348,15 @@ for questions about mappings, output paths etc.
---------------
Once installed, type:
sisu --help env
+or
+ sisu -V
%% Configuration File
---------------
The defaults can be changed via SiSU's configure file sisurc.yml which the
-program expects to find in ./_sisu ~/.sisu or /etc/sisu
+program expects to find in ./_sisu ~/.sisu or /etc/sisu (searched in that
+order, stopping on the first one found)
%% Markup
---------------
@@ -366,6 +364,8 @@ program expects to find in ./_sisu ~/.sisu or /etc/sisu
See man pages.
man sisu
+ man 8 sisu
+
Once installed there is some information on SiSU Markup in its help:
sisu --help markup
and
@@ -379,9 +379,10 @@ These are installed on the system usually at:
/usr/share/doc/sisu/sisu_markup_samples/dfsg
More markup samples are available in the package sisu-markup-samples
+ <http://www.jus.uio.no/sisu/SiSU/download.html#sisu-markup-samples>
Many more are available online off:
- http://www.jus.uio.no/sisu/SiSU/2.html
+ <http://www.jus.uio.no/sisu/SiSU/2.html>
%% Additional Things
---------------
@@ -419,4 +420,8 @@ All Rights Reserved.
* however note the License section
-
+CHANGELOG
+ ./CHANGELOG
+and see
+ <http://www.jus.uio.no/sisu/SiSU/changelog.html>
+ <http://www.jus.uio.no/sisu/SiSU/changelog_markup_samples.html>