sisu_webrick(1) manual page

From 50d45c6deb0afd2e4222d2e33a45487a9d1fa676 Mon Sep 17 00:00:00 2001 From: Ralph Amissah Date: Sun, 23 Sep 2007 05:16:21 +0100 Subject: 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 --- data/doc/sisu/html/sisu_webrick.1.html | 204 +++++++++++++++++++++++---------- 1 file changed, 146 insertions(+), 58 deletions(-) (limited to 'data/doc/sisu/html/sisu_webrick.1.html') diff --git a/data/doc/sisu/html/sisu_webrick.1.html b/data/doc/sisu/html/sisu_webrick.1.html index 917c176d..9c6fa2f0 100644 --- a/data/doc/sisu/html/sisu_webrick.1.html +++ b/data/doc/sisu/html/sisu_webrick.1.html @@ -1,69 +1,157 @@ - + -sisu_webrick(1) manual page +"sisu_webrick"("1") manual page Table of Contents

+SISU - SISU_WEBRICK [0.58], RALPH AMISSAH +

SISU WEBRICK +

1. SISU_WEBRICK + +

1.1 NAME +

SiSU - Structured information, Serialized Units - a document -

Name

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

Synopsis

-sisu_webrick [port]

-or

-sisu -W [port] -

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.yaml a sample of which is provided as /etc/sisu/sisurc.yaml -(or in the equivalent directory on your system). -

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 -

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 -

Further Information

publishing system +

1.2 SYNOPSIS +

sisu_webrick [port] +

or +

sisu -W [port] + +

1.3 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). +

1.4 SUMMARY OF MAN PAGE +

sisu_webrick, may be started +on it’s own with the command: sisu_webrick 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 +

1.5 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 +

1.6 FURTHER INFORMATION + +

For more information on SiSU see: <http://www.jus.uio.no/sisu +> +

or man sisu + +

1.7 AUTHOR +

Ralph Amissah <ralph@amissah.com> or <ralph.amissah@gmail.com> +

1.8 + +

Author

-Ralph -Amissah <ralph@amissah.com> or <ralph.amissah@gmail.com> -