aboutsummaryrefslogtreecommitdiffhomepage
path: root/data/doc/sisu/markup-samples/sisu_manual/sisu_webrick.sst
diff options
context:
space:
mode:
Diffstat (limited to 'data/doc/sisu/markup-samples/sisu_manual/sisu_webrick.sst')
-rw-r--r--data/doc/sisu/markup-samples/sisu_manual/sisu_webrick.sst59
1 files changed, 59 insertions, 0 deletions
diff --git a/data/doc/sisu/markup-samples/sisu_manual/sisu_webrick.sst b/data/doc/sisu/markup-samples/sisu_manual/sisu_webrick.sst
new file mode 100644
index 00000000..6e56e53a
--- /dev/null
+++ b/data/doc/sisu/markup-samples/sisu_manual/sisu_webrick.sst
@@ -0,0 +1,59 @@
+% SiSU 4.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: 2012-10-03
+
+@rights:
+ :copyright: Copyright (C) Ralph Amissah 2007
+ :license: GPL 3 (part of SiSU documentation)
+
+@classify:
+ :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
+
+@make:
+ :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