aboutsummaryrefslogtreecommitdiffhomepage
path: root/man/man1/sisu_webrick.1
blob: ecdcb9b4d8847b10d3628bb4feb46f717e521725 (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
.\"  Name: SiSU information Structuring Universe   
.\"  Author: Ralph Amissah
.\"  Description: sisu webrick manpage
.\"  arch-tag: sisu manpage
.\"  License: GPL 2 or later
.\"  Notes: Process this file with
.\"    groff -man -Tascii sisu.1
.\"    nroff -man sisu.1 | most 
.\"  |sisu.1|@|^|<url:sisu.1> 
.TH sisu_webrick 1  "December 17, 2005" "version 0.34" "sisu \-W"
.SH NAME
.B SiSU
\- Structured information, Serialized Units \- a document publishing system
.SH SYNOPSIS
.B sisu_webrick
.I [port]
.PP
or
.PP
.B sisu
.B \-W
.I [port]
.\"%% Description 
.SH DESCRIPTION
.B sisu_webrick
.I is part of SiSU (man sisu)
sisu_webrick starts Ruby\'s Webrick web\-server and points it to the directories to which 
.I SiSU
output is written, providing a list of these directories (assuming 
.I SiSU 
is in use and they exist).
.PP
The default port for sisu_webrick is set to 8081, this may be modified in the yaml file:
.I ~/.sisu/sisurc.yaml
a sample of which is provided as
.I /etc/sisu/sisurc.yaml
(or in the equivalent directory on your system).
.\"%% Summary 
.SH Summary of man page
.PP
sisu_webrick, may be started on it\'s own with the command:
.B sisu_webrick
.I [port]
or using the sisu command with the \-W flag:
.B sisu \-W 
.I [port]
.PP
where no port is given and settings are unchanged the default port is 8081
.\"%% Flags 
.SH DOCUMENT PROCESSING COMMAND FLAGS
.PP
.BI sisu \ \-W \ [port]
starts Ruby Webrick web\-server, serving
.I SiSU
output directories, on the port provided, or if no port is provided and the defaults have not been changed in 
.I ~/.sisu/sisurc.yaml
then on port 8081
.\"%% Further Information
.SH FURTHER INFORMATION
.PP
For more information on 
.I SiSU
see:
.I <http://www.jus.uio.no/sisu>
.PP
or
.I man sisu
.SH AUTHOR
Ralph Amissah
.I <ralph@amissah.com>
or
.I <ralph.amissah@gmail.com>
.SH SEE ALSO
.BR sisu(1),
.BR sisu_vim(7)
.BR sisu(8),