summaryrefslogtreecommitdiffstats
path: root/data/doc/sisu/markup-samples/sisu_manual/sisu_installation.ssi
blob: f908bb6e017add104842fd68381d21559adea1f5 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
% SiSU insert 2.0

@title: SiSU
 :subtitle: Installation

@creator:
 :author: Amissah, Ralph

@date:
 :published: 2007-09-16
 :created: 2002-11-12
 :issued: 2002-11-12
 :available: 2002-11-12
 :modified: 2011-02-07

@rights:
 :copyright: Copyright (C) Ralph Amissah 2007
 :license: GPL 3 (part of SiSU documentation)

:A~? SiSU Installation notes

:C~ Installation

1~installation Installation

See the {~^ download pages }http://www.jus.uio.no/sisu/SiSU/download.html for information related to installation.

2~ Debian

SiSU is developed on Debian, and packages are available for Debian that take care of the dependencies encountered on installation.

The package is divided into the following components:

_1 *sisu*, the base code, (the main package on which the others depend), without any dependencies other than ruby (and for convenience the ruby webrick web server), this generates a number of types of output on its own, other packages provide additional functionality, and have their dependencies

_1 *sisu-complete*, a dummy package that installs the whole of greater sisu as described below, apart from sisu-examples

_1 *sisu-pdf*, dependencies used by sisu to produce pdf from LaTeX generated

_1 *sisu-postgresql*, dependencies used by sisu to populate postgresql database (further configuration is necessary)

_1 *sisu-remote*, dependencies used to place sisu output on a remote server (further configuration is necessary)

_1 *sisu-sqlite*, dependencies used by sisu to populate sqlite database

_1 *sisu-markup-samples*, sisu markup samples and other miscellany (under Debian Free Software Guidelines non-free)

SiSU is available off { Debian Unstable and Testing }http://packages.debian.org/cgi-bin/search_packages.pl?searchon=names&subword=1&version=all&release=all&keywords=sisu&sourceid=mozilla-search ~{ http://packages.qa.debian.org/s/sisu.html }~ install it using apt-get, aptitude or alternative Debian install tools. SiSU is currently comprised of eight packages. *~apt-get

Initial packaging is done here and to get the latest version of SiSU available you may add the following line(s) to your sources list: *~sources.list

code{

#/etc/apt/sources.list

deb http://www.jus.uio.no/sisu/archive unstable main non-free
deb-src http://www.jus.uio.no/sisu/archive unstable main non-free

}code

The non-free section is for sisu markup samples provided, which contain authored works the substantive text of which cannot be changed, and which as a result do not meet the debian free software guidelines.

On Debian there is little more to know beyond how to install software on Debian using apt, aptitude or synaptic.

code{

#Using aptitude:

  aptitude update

  aptitude install sisu-complete sisu-markup-samples

}code

code{

Using apt-get

  apt-get update

  apt get install sisu-complete sisu-examples

}code

2~ Other Unix / Linux

A source tarball or an rpms built using alien are available, (however dependencies have not been tested). SiSU is first packaged and tested with dependency handling for Debian.~{ Notes on dependencies are provided in the section that follows }~ Information on dependencies configured for Debian is provided as this may be of assistance.

3~ source tarball

!_ installation with provided install script

To install SiSU, in the root directory of the unpacked SiSU _{as root type}_:~{ This makes use of rant and the provided Rantfile. Note however, that additional external package dependencies, such as tetex-extra are not taken care of for you. }~

_1 ruby install

Once installed see man 8 sisu for information on additional programs that sisu makes use of.

Further notes on install script.

The install script is prepared using Rant, and a Rantfile *~rant is provided,~{ a Rantfile has been configured to do post installation setup }~ with more comprehensive install options, and post install and setup configuration and generation of first test file, if you have installed Stefan Lang's {~^ Rant }http://make.rubyforge.org/ ~{ http://make.rubyforge.org/ <br> http://rubyforge.org/frs/?group_id=615 }~ installed. While in the package directory, type: rant help, or rant -T, or to install SiSU _{as root}_, type:

*install* is an install script prepared using Stefan Lang's {~^ Rant }http://make.rubyforge.org/ ~{ http://make.rubyforge.org/ <br> http://rubyforge.org/frs/?group_id=615 }~ It should work whether you have previously installed Rant or not. It has fairly comprehensive install options, and can do some post install and setup configuration and generation of first test file. For options type:

_1 ruby install -T

To install as root type:

_1 ruby install

For a minimal install type:

_1 ruby install base

!_ installation with setup.rb

{~^ setup.rb }http://i.loveruby.net/en/projects/setup/ is provided the package and will install SiSU~{ Minero Aoki<br> http://i.loveruby.net/en/projects/setup/doc/ }~ installation is a 3 step process~{ Installation instructions<br> http://i.loveruby.net/en/projects/setup/doc/usage.html }~ the following string assumes you are in the package directory and that you have root as sudo:

_1 ruby setup.rb config && ruby setup.rb setup && sudo ruby setup.rb install

!_ installation of rpm

The RPM is generated from the source file using Alien.~{ http://www.kitenet.net/programs/alien/ }~ Dependencies are not handled, not even that of the essential Ruby.

1~install_dependencies_and_notes SiSU Components, Dependencies and Notes

The dependency lists are from the Debian control file for SiSU version 0.36, and may assist in building SiSU on other distributions.

2~ sisu

_* the base code, (the main package on which the others depend), without any dependencies other than ruby (and for convenience the ruby webrick web server), this generates a number of types of output on its own, other packages provide additional functionality, and have their dependencies

*Depends:* on ruby (>=1.8.2), libwebrick-ruby

*Recommends:* sisu-pdf, sisu-sqlite, sisu-postgresql, sisu-examples, librmagick-ruby, trang, tidy, libtidy, librexml-ruby, zip, unzip, openssl

initialise directory

_1 sisu -CC

html

_1 sisu -hv [filename/wildcard]

_1 sisu -Hv [filename/wildcard]

LaTeX (but sisu-pdf dependencies required to convert that to pdf)

_1 sisu -pv [filename/wildcard]

plain text Unix with footnotes

_1 sisu -av [filename/wildcard]

plain text Dos with footnotes

_1 sisu -Av [filename/wildcard]

plain text Unix with endnotes

_1 sisu -ev [filename/wildcard]

plain text Dos with endnotes

_1 sisu -Ev [filename/wildcard]

openoffice odt

_1 sisu -ov [filename/wildcard]

xhtml

_1 sisu -bv [filename/wildcard]

XML SAX

_1 sisu -xv [filename/wildcard]

XML DOM

_1 sisu -Xv [filename/wildcard]

wordmap (a rudimentary index of content)

_1 sisu -wv [filename/wildcard]

document content certificate

_1 sisu -Nv [filename/wildcard]

placement of sourcefile in output directory

_1 sisu -sv [filename/wildcard]

creation of source tarball with images, and placement of source tarball in ouput directory

_1 sisu -Sv [filename/wildcard]

manifest of output produced (polls output directory and provides links to existing output)

_1 sisu -yv [filename/wildcard]

url for output files -u -U

_1 sisu -uv[and other flags] [filename/wildcard]

_1 sisu -Uv [filename/wildcard]

toggle screen colour

_1 sisu -cv[and processing flags] [filename/wildcard]

verbose mode

_1 sisu -v[and processing flags] [filename/wildcard]

_1 sisu -V[and processing flags] [filename/wildcard]

quiet mode

_1 sisu -q[and processing flags] [filename/wildcard]

maintenance mode, intermediate files kept -M

_1 sisu -Mv[and other flags] [filename/wildcard]

[the -v is for verbose]

start the webrick server

_1 sisu -W

2~ sisu-complete

_* a dummy package that installs the whole SiSU, apart from sisu-examples

*Depends:* ruby (>=1.8.2), sisu, sisu-pdf, sisu-postgresql, sisu-remote, sisu-sqlite

*Recommends:* sisu-examples

2~ sisu-examples

_* installs sisu markup samples and other miscelleny

*Depends:* sisu

2~ sisu-pdf

_* dependencies used by sisu to produce pdf from LaTeX generated

*Depends:* sisu, tetex-bin, tetex-extra, latex-ucs

*Suggests:* evince, xpdf

converts sisu LaTeX produced to pdf

_1 sisu -pv [filename/wildcard]

[the -v is for verbose]

2~ sisu-postgresql

_* dependencies used by sisu to populate postgresql database (further configuration is necessary)

*Depends:* sisu, postgresql-8.1, libdbi-ruby, libdbm-ruby, libdbd-pg-ruby

*Suggests:* pgaccess, libdbd-pgsql, postgresql-contrib-8.1

installs dependencies for sisu to work with and populate postgresql database

create database

_1 sisu -Dv createall

drop database

_1 sisu -Dv dropall

import content

_1 sisu -Div [filename/wildcard]

_1 sisu -Dv import [filename/wildcard]

update content

_1 sisu -Duv [filename/wildcard]

_1 sisu -Dv update [filename/wildcard]

[the -v is for verbose]

The following are available without installation of the sisu-postgresql component, but are of interest in this context

generate a sample database query form for use with webserver on port 80

_1 sisu -F

or for use with webrick server

_1 sisu -F webrick

to start webrick server

_1 sisu -W

2~ sisu-remote

_* dependencies used to place sisu output on a remote server (further configuration is necessary)

scp

_1 sisu -vr[and processing flags] [filename/wildcard]

rsync

_1 sisu -vR[and processing flags] [filename/wildcard]

[the -v is for verbose]

*Depends:* sisu, rsync, openssh-client|lsh-client, keychain

2~ sisu-sqlite

_* dependencies used by sisu to populate sqlite database

*Depends:* sisu, sqlite, libdbi-ruby, libdbm-ruby, libdbd-sqlite-ruby

*Suggests:* libdbd-sqlite

installs dependencies for sisu to work with and populate sqlite database

create database

_1 sisu -dv createall

drop database

_1 sisu -dv dropall

update content

_1 sisu -div [filename/wildcard]

_1 sisu -dv import [filename/wildcard]

update content

_1 sisu -duv [filename/wildcard]

_1 sisu -dv update [filename/wildcard]

[the -v is for verbose]

The following are available without installation of the sisu-sqlite component, but are of interest in this context

generate a sample database query form for use with webserver on port 80

_1 sisu -F

or for use with webrick server

_1 sisu -F webrick

to start webrick server

_1 sisu -W