aboutsummaryrefslogtreecommitdiffhomepage
path: root/man/man1/sisu_webrick.1
diff options
context:
space:
mode:
authorRalph Amissah <ralph@amissah.com>2007-09-23 05:16:21 +0100
committerRalph Amissah <ralph@amissah.com>2007-09-23 05:16:21 +0100
commit50d45c6deb0afd2e4222d2e33a45487a9d1fa676 (patch)
tree100c62d678f009139999bf77c26c81653a721eeb /man/man1/sisu_webrick.1
parentsisu-0.58.3 + md5s (diff)
primarily todo with sisu documentation, changelog reproduced below:
* start documenting sisu using sisu * sisu markup source files in data/doc/sisu/sisu_markup_samples/sisu_manual/ /usr/share/doc/sisu/sisu_markup_samples/sisu_manual/ * default output [sisu -3] in data/doc/manuals_generated/sisu_manual/ /usr/share/doc/manuals_generated/sisu_manual/ (adds substantially to the size of sisu package!) * help related edits * manpage, work on ability to generate manpages, improved * param, exclude footnote mark count when occurs within code block * plaintext changes made * shared_txt, line wrap visited * file:// link option introduced (in addition to existing https?:// and ftp://) a bit arbitrarily, diff here, [double check changes in sysenv and hub] * minor adjustments * html url match refinement * css added tiny_center * plaintext * endnotes fix * footnote adjustment to make more easily distinguishable from substantive text * flag -a only [flags -A -e -E dropped] controlled by modifiers --unix/msdos --footnote/endnote * defaults, homepage * renamed homepage (instead of index) implications for modifying skins, which need likewise to have any homepage entry renamed * added link to sisu_manual in homepage * css the css for the default homepage is renamed homepage.css (instead of index.css) [consider removing this and relying on html.css] * ruby version < ruby1.9 * place stop on installation and working with for now [ruby String.strip broken in ruby 1.9.0 (2007-09-10 patchlevel 0) [i486-linux], 2007-09-18:38/2] * debian/control restrict use to ruby > 1.8.4 and ruby < 1.9 * debian * debian/control restrict use to ruby > 1.8.4 and ruby < 1.9 * sisu-doc new sub-package for sisu documentation debian/control and sisu-doc.install
Diffstat (limited to 'man/man1/sisu_webrick.1')
-rw-r--r--man/man1/sisu_webrick.1278
1 files changed, 210 insertions, 68 deletions
diff --git a/man/man1/sisu_webrick.1 b/man/man1/sisu_webrick.1
index 40d96473..337aa335 100644
--- a/man/man1/sisu_webrick.1
+++ b/man/man1/sisu_webrick.1
@@ -1,76 +1,218 @@
-.\" Name: SiSU information Structuring Universe
-.\" Author: Ralph Amissah
-.\" Description: sisu webrick manpage
-.\" arch-tag: sisu manpage
-.\" License: GPL 3 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
+.TH "sisu_webrick" "1" "2007-09-16" "0.58.3" "SiSU"
+.SH
+SISU \- SISU_WEBRICK \ [0.58],
+RALPH AMISSAH
+.BR
+
+.SH
+SISU WEBRICK
+.BR
+
+.SH
+1. SISU_WEBRICK
+.BR
+
+.SH
+1.1 NAME
+
+.BR
.B SiSU
\- Structured information, Serialized Units \- a document publishing system
-.SH SYNOPSIS
-.B sisu_webrick
-.I [port]
-.PP
+
+.SH
+1.2 SYNOPSIS
+
+.BR
+sisu_webrick \ [port]
+
+.BR
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
+
+.BR
+sisu \-W \ [port]
+
+.SH
+1.3 DESCRIPTION
+
+.BR
+sisu_webrick is part of
+.B SiSU
+(man sisu) sisu_webrick starts
+.B Ruby
+\'s Webrick web\-server and points it to the directories to which
+.B SiSU
output is written, providing a list of these directories (assuming
-.I SiSU
+.B 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
+
+.BR
+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).
+
+.SH
+1.4 SUMMARY OF MAN PAGE
+
+.BR
+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]
+
+.BR
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
+
+.SH
+1.5 DOCUMENT PROCESSING COMMAND FLAGS
+
+.BR
+sisu \-W \ [port] starts
+.B Ruby
+Webrick web\-server, serving
+.B 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
+
+.SH
+1.6 FURTHER INFORMATION
+
+.BR
For more information on
+.B SiSU
+see: <http://www.jus.uio.no/sisu>
+
+.BR
+or man sisu
+
+.SH
+1.7 AUTHOR
+
+.BR
+Ralph Amissah <ralph@amissah.com> or <ralph.amissah@gmail.com>
+
+.SH
+1.8 SEE ALSO
+
+.BR
+ sisu(1)
+
+.BR
+ sisu_vim(7)
+
+.BR
+ sisu(8)
+
+.SH
+DOCUMENT INFORMATION (METADATA)
+.BR
+
+.SH
+METADATA
+.BR
+
+.BR
+Document Manifest @
+<http://www.jus.uio.no/sisu/sisu_manual/sisu_webrick/sisu_manifest.html>
+
+.BR
+.B Dublin Core
+(DC)
+
+.BR
+.I DC tags included with this document are provided here.
+
+.BR
+DC Title:
+.I SiSU \- sisu_webrick \ [0.58]
+
+.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 2007\-08\-28
+
+.BR
+DC Date modified:
+.I 2007\-09\-16
+
+.BR
+DC Date:
+.I 2007\-09\-16
+
+.BR
+.B Version Information
+
+.BR
+Sourcefile:
+.I sisu_webrick.sst
+
+.BR
+Filetype:
+.I SiSU text 0.58
+
+.BR
+Sourcefile Digest, MD5(sisu_webrick.sst)=
+.I d288c50a18a6d7464fdb3413479b8b98
+
+.BR
+Skin_Digest: MD5(/etc/sisu/skin/doc/skin_sisu.rb)=
+.I c4b3c21ba1ed0d491bfe14cd0fcd075e
+
+.BR
+.B Generated
+
+.BR
+Document (metaverse) last generated:
+.I Sun Sep 23 01:14:00 +0100 2007
+
+.BR
+Generated by:
.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),
+.I 0.58.3
+of 2007w36/4 (2007\-09\-06)
+
+.BR
+Ruby version:
+.I ruby 1.8.6 (2007\-06\-07 patchlevel 36) \ [i486\-linux]
+
+
+.TP
+Other versions of this document:
+.TP
+manifest: <http://www.jus.uio.no/sisu/sisu_webrick/sisu_manifest.html>
+.TP
+html: <http://www.jus.uio.no/sisu/sisu_webrick/toc.html>
+.TP
+pdf: <http://www.jus.uio.no/sisu/sisu_webrick/portrait.pdf>
+.TP
+pdf: <http://www.jus.uio.no/sisu/sisu_webrick/landscape.pdf>
+." .TP
+." manpage: http://www.jus.uio.no/sisu/sisu_webrick/sisu_webrick.1
+.TP
+at: <http://www.jus.uio.no/sisu>
+.TP
+.TP
+* Generated by: SiSU 0.58.3 of 2007w36/4 (2007-09-06)
+.TP
+* Ruby version: ruby 1.8.6 (2007-06-07 patchlevel 36) [i486-linux]
+.TP
+* Last Generated on: Sun Sep 23 01:14:06 +0100 2007
+.TP
+* SiSU http://www.jus.uio.no/sisu