aboutsummaryrefslogtreecommitdiffhomepage
path: root/data/doc/sisu/markup-samples/v3/sisu_manual/sisu_webrick.sst
blob: 8140118918269959cf2e65fc557fa343a635b418 (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
% SiSU 2.0

@title: SiSU
 :subtitle: sisu_webrick

@creator:
 :author: Amissah, Ralph

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

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

@classify:
 :type: information
 :topic_register: electronic documents:SiSU:document:webrick;SiSU:manual:webrick;electronic documents:SiSU:manual:webrick;SiSU:document:webrick;SiSU:document:webrick
 :subject: ebook, epublishing, electronic book, electronic publishing, electronic document, electronic citation, data structure, citation systems, search

@links:
 { SiSU Homepage }http://www.sisudoc.org/
 { SiSU Manual }http://www.sisudoc.org/sisu/sisu_manual/
 { Book Samples & Markup Examples }http://www.jus.uio.no/sisu/SiSU/examples.html
 { SiSU Download }http://www.jus.uio.no/sisu/SiSU/download.html
 { SiSU Changelog }http://www.jus.uio.no/sisu/SiSU/changelog.html
 { SiSU Git repo }http://git.sisudoc.org/?p=code/sisu.git;a=summary
 { SiSU List Archives }http://lists.sisudoc.org/pipermail/sisu/
 { SiSU @ Debian }http://packages.qa.debian.org/s/sisu.html
 { SiSU Project @ Debian }http://qa.debian.org/developer.php?login=sisu@lists.sisudoc.org
 { SiSU @ Wikipedia }http://en.wikipedia.org/wiki/SiSU

@make:
 :num_top: 1
 :breaks: new=C; break=1
 :skin: skin_sisu
 :bold: /Gnu|Debian|Ruby|SiSU/
 :manpage: section=7; name=sisu - documents: structuring, publishing in multiple formats, and search; synopsis=sisu -W

:A~? @title @creator

:B~? SiSU Webrick

1~webrick sisu_webrick

2~ Name

SiSU - Structured information, Serialized Units - a document publishing system

2~ Synopsis

sisu_webrick [port]

or

sisu -W [port]

2~ Description

sisu_webrick is part of SiSU (man sisu) sisu_webrick starts Ruby's Webrick web-server and points it to the directories to which SiSU output is written, providing a list of these directories (assuming SiSU is in use and they exist).

The default port for sisu_webrick is set to 8081, this may be modified in the yaml file: ~/.sisu/sisurc.yml a sample of which is provided as /etc/sisu/sisurc.yml (or in the equivalent directory on your system).

2~ Summary of man page

sisu_webrick, may be started on it's own with the command: sisu_webrick [port] or using the sisu command with the -W flag: sisu -W [port]

where no port is given and settings are unchanged the default port is 8081

2~ Document processing command flags

sisu -W [port] starts Ruby Webrick web-server, serving SiSU output directories, on the port provided, or if no port is provided and the defaults have not been changed in ~/.sisu/sisurc.yaml then on port 8081

2~ Further information

For more information on SiSU see: http://www.sisudoc.org/ or http://www.jus.uio.no/sisu

or man sisu

2~ Author

Ralph Amissah ralph@amissah.com or ralph.amissah@gmail.com

2~ SEE ALSO

_1 sisu(1)

_1 sisu_vim(7)