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
|
.TH "sisu_help" "1" "2007-08-30" "0.59.1" "SiSU"
.SH
SISU \- HELP,
RALPH AMISSAH
.BR
.SH
SISU HELP
.BR
.SH
1. HELP
.BR
.SH
1.1 SISU MANUAL
.BR
The most up to date information on sisu should be contained in the sisu_manual,
available at:
.BR
<http://www.jus.uio.no/sisu/sisu_manual/>
.BR
and (from
.B SiSU
0.59 onwards) installed locally at:
.BR
/usr/share/doc/sisu/sisu_manual/
.BR
or equivalent directory
.BR
Within the
.B SiSU
tarball at:
.BR
\./data/doc/sisu/sisu_manual/
.SH
1.2 SISU MAN PAGES
.BR
If
.B SiSU
is installed on your system usual man commands should be available, try:
.BR
man sisu
.BR
man sisu_markup
.BR
man sisu_commands
.BR
Most
.B SiSU
man pages are generated directly from sisu documents that are used to prepare
the sisu manual, the sources files for which are located within the
.B SiSU
tarball at:
.BR
\./data/doc/sisu/sisu_manual/
.BR
Once installed, directory equivalent to:
.BR
/usr/share/doc/sisu/sisu_manual/
.BR
Available man pages are converted back to html using man2html:
.BR
/usr/share/doc/sisu/html/
.BR
\./data/doc/sisu/html/
.BR
The
.B SiSU
man pages can be viewed online at:[^1]
.BR
An online version of the sisu man page is available here:
.BR
* various sisu man pages <http://www.jus.uio.no/sisu/man/> \ [^2]
.BR
* sisu.1 <http://www.jus.uio.no/sisu/man/sisu.1.html> \ [^3]
.BR
* sisu.8 <http://www.jus.uio.no/sisu/man/sisu.8.html> \ [^4]
.BR
* sisu_examples.1 <http://www.jus.uio.no/sisu/man/sisu_examples.1.html> \ [^5]
.BR
* sisu_webrick.1 <http://www.jus.uio.no/sisu/man/sisu_webrick.1.html> \ [^6]
.SH
1.3 SISU BUILT\-IN INTERACTIVE HELP
.BR
This is particularly useful when current installation information is obtained
as the interactive help is able to provide information on your sisu
configuration and setup.
.BR
sisu \-\-help
.BR
sisu \-\-help \ [subject]
.BR
sisu \-\-help env \ [for \ feedback \ on \ the \ way \ your \ system \ is \
setup \ with \ regard \ to \ sisu]
.BR
sisu \-V \ [same \ as \ above \ command]
.BR
sisu \-\-help commands
.BR
sisu \-\-help markup
.BR
Apart from real\-time information on your current configuration the
.B SiSU
manual and man pages are likely to contain more up\-to\-date information than
the sisu interactive help (for example on commands and markup).
.BR
NOTE: Running the command sisu (alone without any flags, filenames or
wildcards) brings up the interactive help, as does any sisu command that is not
recognised. Enter to escape.
.SH
1.4 HELP SOURCES
.BR
For lists of alternative help sources, see:
.BR
.B man page
.BR
man sisu_help_sources
.BR
.B man2html
.BR
/usr/share/doc/sisu/sisu_manual/sisu_help_sources/index.html
.BR
.B sisu generated html
.BR
/usr/share/doc/sisu/html/sisu_help_sources/index.html
.BR
<http://sisudoc.org/sisu_manual/sisu_help_sources/index.html>
.BR
<http://www.jus.uio.no/sisu/sisu_manual/sisu_help_sources/index.html>
.SH
DOCUMENT INFORMATION (METADATA)
.BR
.SH
METADATA
.BR
.BR
Document Manifest @
<http://www.jus.uio.no/sisu/sisu_manual/sisu_help/sisu_manifest.html>
.BR
.B Dublin Core
(DC)
.BR
.I DC tags included with this document are provided here.
.BR
DC Title:
.I SiSU \- Help
.BR
DC Creator:
.I Ralph Amissah
.BR
DC Rights:
.I Copyright (C) Ralph Amissah 2007, part of SiSU documentation, License GPL
3
.BR
DC Type:
.I information
.BR
DC Date created:
.I 2002\-08\-28
.BR
DC Date issued:
.I 2002\-08\-28
.BR
DC Date available:
.I 2002\-08\-28
.BR
DC Date modified:
.I 2007\-08\-30
.BR
DC Date:
.I 2007\-08\-30
.BR
.B Version Information
.BR
Sourcefile:
.I sisu_help.sst
.BR
Filetype:
.I SiSU text 0.58
.BR
Sourcefile Digest, MD5(sisu_help.sst)=
.I 66d04ba5f3dd4ede774ffa5549b3faba
.BR
Skin_Digest:
MD5(/home/ralph/grotto/theatre/dbld/builds/sisu/sisu/data/doc/sisu/sisu_markup_samples/sisu_manual/_sisu/skin/doc/skin_sisu_manual.rb)=
.I 20fc43cf3eb6590bc3399a1aef65c5a9
.BR
.B Generated
.BR
Document (metaverse) last generated:
.I Tue Sep 25 02:54:42 +0100 2007
.BR
Generated by:
.I SiSU
.I 0.59.1
of 2007w39/2 (2007\-09\-25)
.BR
Ruby version:
.I ruby 1.8.6 (2007\-06\-07 patchlevel 36) \ [i486\-linux]
.TP
.BI 1.
generated from source using rman
<http://polyglotman.sourceforge.net/rman.html>
With regard to
.B SiSU
man pages the formatting generated for markup syntax is not quite right, for
that you might prefer the links under:
<http://www.jus.uio.no/sample>
.TP
.BI 2.
<http://www.jus.uio.no/sisu/man/>
.TP
.BI 3.
<http://www.jus.uio.no/sisu/man/sisu.1.html>
.TP
.BI 4.
<http://www.jus.uio.no/sisu/man/sisu.8.html>
.TP
.BI 5.
<http://www.jus.uio.no/sisu/man/sisu_examples.1.html>
.TP
.BI 6.
<http://www.jus.uio.no/sisu/man/sisu_webrick.1.html>
.TP
Other versions of this document:
.TP
manifest: <http://www.jus.uio.no/sisu/sisu_help/sisu_manifest.html>
.TP
html: <http://www.jus.uio.no/sisu/sisu_help/toc.html>
.TP
pdf: <http://www.jus.uio.no/sisu/sisu_help/portrait.pdf>
.TP
pdf: <http://www.jus.uio.no/sisu/sisu_help/landscape.pdf>
." .TP
." manpage: http://www.jus.uio.no/sisu/sisu_help/sisu_help.1
.TP
at: <http://www.jus.uio.no/sisu>
.TP
.TP
* Generated by: SiSU 0.59.1 of 2007w39/2 (2007-09-25)
.TP
* Ruby version: ruby 1.8.6 (2007-06-07 patchlevel 36) [i486-linux]
.TP
* Last Generated on: Tue Sep 25 02:54:50 +0100 2007
.TP
* SiSU http://www.jus.uio.no/sisu
|
