Browse files

Start building up Hem website and add some more meat to the hem(1) ma…

…npage.
  • Loading branch information...
1 parent c2d81e2 commit e8faf57fed7b840ce501e2b52662525343b62e35 @rtomayko committed Mar 6, 2008
Showing with 182 additions and 26 deletions.
  1. +5 −5 README
  2. +23 −13 doc/Makefile
  3. +2 −2 doc/asciidoc.conf
  4. +29 −6 doc/hem.1.txt
  5. +58 −0 doc/index.txt
  6. +34 −0 doc/stylesheets/bare.css
  7. +31 −0 doc/xhtml11-article.conf
View
10 README
@@ -1,18 +1,18 @@
Hem - persistent ssh connection and tunnel manager
-Hem manages multiple background SSH connections using an `ifconfig` /
-`rc` style interface. It is most often used to setup persistent /
+Hem manages multiple background SSH connections using an ifconfig /
+rc style interface. It is most often used to setup persistent /
long-running port tunnels and control master connections. Hem monitors
connection upedness and can automatically bounce downed connection.
Hem is Free Software covered by the "New and Simplified BSD License". It
-was originally written by Ryan Tomayko <rtomayko@gmail.com>.
+was originally written by Ryan Tomayko <r@tomayko.com>.
Please read the file INSTALL for installation and hacking instructions. Hem
should run on most flavors of Unix/Gnu that include a posix compatible sh
-interpreter. Hem currently requires OpenSSH's ssh(1) as well as Carson Harding's
-autossh(1).
+interpreter. Hem currently requires fairly recent version of OpenSSH's ssh(1) as
+well as Carson Harding's autossh(1) (included with distribution).
More information on Hem is accessible from http://tomayko.com/src/hem/
including full documentation, examples, and distributables. There is
View
36 doc/Makefile
@@ -3,22 +3,27 @@ all::
# Read version in from VERSION file.
HEM_VERSION := $(shell cat ../VERSION)
-DOCFILES = hem.1.txt
-XMLFILES = hem.1.xml
-MANFILES = hem.1
-HTMLFILES = hem.1.html
+DOCFILES = hem.1.txt index.txt
+MANFILES = hem.1
+MANXMLFILES = hem.1.xml
+MANHTMLFILES = hem.1.html
+SITEHTMLFILES = index.html
-SRCS = $(DOCFILES)
-TARGETS = $(MANFILES) $(HTMLFILES)
-INTERS = $(XMLFILES)
+HTMLFILES = $(MANHTMLFILES) $(SITEHTMLFILES)
+
+SRCS = $(DOCFILES)
+TARGETS = $(MANFILES) $(HTMLFILES)
+AUX = $(XMLFILES)
ASCIIDOC = asciidoc --unsafe \
- -a stylesdir=$(shell pwd)/stylesheets \
- -a theme=bare \
- -a hem_version=$(HEM_VERSION)
+ -a stylesdir=./stylesheets \
+ -a linkcss= \
+ -a theme=bare \
+ -a hem_version=$(HEM_VERSION)
A2X = a2x --xsltproc-opts='--catalogs --nonet --novalid'
+
man: $(MANFILES)
html: $(HTMLFILES)
@@ -30,13 +35,18 @@ all:: doc
$(MANFILES): %.1: %.1.txt
$(A2X) -d manpage -f manpage -D . $<
-$(HTMLFILES): %.1.html: %.1.txt
- $(ASCIIDOC) -d manpage -f manpage.conf $<
+$(MANHTMLFILES): %.1.html: %.1.txt
+ $(ASCIIDOC) -d manpage $<
+
+$(SITEHTMLFILES): %.html: %.txt
+ $(ASCIIDOC) -o $@ $<
$(MANFILES) $(HTMLFILES): asciidoc.conf
+$(SITEHTMLFILES): xhtml11-article.conf
+
clean:
- rm -rf $(MANFILES) $(HTMLFILES) $(XMLFILES)
+ rm -rf $(HTMLFILES) $(XMLFILES) $(MANFILES)
FORCE:
View
4 doc/asciidoc.conf
@@ -3,10 +3,10 @@ newline=\n
ifdef::backend-xhtml11[]
[man-inlinemacro]
-<a href="http://unixhelp.ed.ac.uk/CGI/man-cgi?{target}{0?+{0}}">{target}{0?({0})}</a>
+<tt><a class='manpage' href="http://unixhelp.ed.ac.uk/CGI/man-cgi?{target}{0?+{0}}">{target}{0?({0})}</a></tt>
[manlocal-inlinemacro]
-<a href="{target}.{0?{0}}.html">{target}{0?({0})}</a>
+<tt><a class='manpage' href="{target}.{0?{0}}.html">{target}{0?({0})}</a></tt>
endif::backend-xhtml11[]
View
35 doc/hem.1.txt
@@ -158,13 +158,36 @@ ENVIRONMENT VARIABLES
---------------------
`HEM_CONFIG`::
- If `HEM_CONFIG` is set, `hem` uses it as the location of the
- global configuration file. It overrides the default configuration
- file location (*~/.hem/config*), but is overridden by the `-c`
- invocation option.
+ If `HEM_CONFIG` is set, `hem` uses it as the location of the
+ global configuration file. It overrides the default configuration
+ file location (*~/.hem/config*), but is overridden by the `-c`
+ invocation option.
`HEM_EXEC`::
- The path to hem executables.
+ The path to hem executables.
+
+FILES
+-----
+
+*~/.hem/config*::
+ This is the default per user configuration file. The settings in
+ this file provide defaults for all connection profiles. Available
+ configuration variables are described in the manlocal:hem_config[5]
+ manual page.
+
+*~/.hem/profile*::
+ The default hem connection profile directory. Each file contains
+ configuration for an individual remote SSH connection. Available
+ configuration variables are described in the manlocal:hem_profile[5]
+ manual page.
+
+*~/.hem/run*::
+ Hem stores *.pid* files for running connections in this directory by
+ default. The location of this directory can be configured by setting
+ the `run_dir` option. See manlocal:hem_config[5] for more information.
+
+*~/.hem/log*::
+ Hem logs messages here if no `log_to` option has been specified.
SEE ALSO
--------
@@ -188,4 +211,4 @@ COPYING
Copyright \(C) 2008, Ryan Tomayko. Free use of this software is
granted under the terms of the New and Simplified BSD License.
-// vim: tw=78 ts=4 sts=0 noexpandtab
+// vim: tw=78 ts=8 sts=0 noexpandtab
View
58 doc/index.txt
@@ -0,0 +1,58 @@
+Hem
+===
+Ryan Tomayko <r@tomayko.com>
+v{hem_version}, March 2008
+
+*Hem* manages multiple background SSH connections. It is most often used to setup
+reliable, long-running port forwards, control masters, or VPN tunnels. *Hem*
+monitors SSH connection upedness and automatically bounces downed connections
+(repeatedly, if necessary).
+
+*Hem* is *Free Software* covered by the
+http://opensource.org/licenses/bsd-license.php[New and Simplified BSD License].
+It was originally written, and is still maintained, by
+http://tomayko.com[Ryan Tomayko].
+
+Documentation
+-------------
+A comprehensive set of manual pages are installed with Hem and available
+here for ease of viewing:
+
+* The manlocal:hem[1] manpage is a good starting point.
+
+* Each of *Hem*'s sub-commands have manual pages of there own: manlocal:hem-init[1],
+ manlocal:hem-manage[1], manlocal:hem-status[1], manlocal:hem-info[1],
+ manlocal:hem-up[1], manlocal:hem-down[1], and manlocal:hem-bounce[1].
+
+* Finally, *Hem*'s global and connection profile configuration files are
+ documented in manlocal:hem_config[5] and manlocal:hem_profile[5],
+ respectively.
+
+Installation
+------------
+Hem should run on most flavors of Unix/GNU that include a
+http://www.opengroup.org/onlinepubs/009695399/utilities/sh.html[POSIX compatible `sh(1)`].
+In order to be useful, *Hem* requires a fairly recent version of
+http://www.openssh.com/[OpenSSH] as well as
+http://www.harding.motd.ca/autossh/[Carson Harding's `autossh`]
+(included with distribution).
+
+*Current Release / Source Distribution*::
+ http://tomayko.com/dist/hem/hem-{hem_version}.tar.gz[hem-{hem_version}.tar.gz]
+ (http://tomayko.com/dist/hem/hem-{hem_version}.cksums[MD5/SHA1/SHA256])
+
+*Previous Releases*::
+ http://tomayko.com/dist/hem/[]
+
+Please read the link:install.html[INSTALL] file included with the distribution for
+installation and hacking instructions.
+
+See Also
+--------
+
+* http://github.com/rtomayko/hem/[The Hem Project Page] on GitHub
+* http://www.openssh.com/[OpenSSH]
+* http://www.harding.motd.ca/autossh/[autossh] - Carson Harding's SSH connection monitor.
+* http://sourceforge.net/projects/rstunnel/[RSTunnel] - Reliable SSH Tunnel.
+* http://www.linux.com/feature/54498?theme=print[Accelerating OpenSSH connections with ControlMaster]
+
View
34 doc/stylesheets/bare.css
@@ -177,4 +177,38 @@ pre {
text-transform:uppercase
}
+/* Hem customizations */
+
+body {
+ color:#445;
+}
+
+strong {
+ font-weight:normal;
+ color:#000
+}
+
+a, a:link, a:visited {
+ color:#225;
+}
+
+a:hover {
+ color:#000;
+ background:#ddf;
+}
+
+a.manpage, a.manpage:link, a.manpage:visited {
+ text-decoration:none;
+ font-weight:bold;
+ color:#272;
+}
+
+a.manpage:hover {
+ background:#dfd;
+}
+
+pre tt {
+ font-weight:normal;
+}
+
/* vim: set ft=css ts=4 sw=4 noexpandtab: */
View
31 doc/xhtml11-article.conf
@@ -0,0 +1,31 @@
+[header]
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN" "http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
+<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="{lang=en}">
+<head>
+<title>{doctitle=}</title>
+<meta http-equiv="Content-Type" content="{quirks=application/xhtml+xml}{quirks?text/html}; charset={encoding}" />
+<meta name="generator" content="AsciiDoc {asciidoc-version}" />
+ifdef::linkcss[]
+<link rel="stylesheet" href="{stylesdir=.}/{theme={backend}}.css" type="text/css" />
+endif::linkcss[]
+ifndef::linkcss[]
+<style type="text/css">
+include1::{stylesdir=./stylesheets}/{theme={backend}}.css[]
+</style>
+endif::linkcss[]
+</head>
+<body>
+<div id="header">
+<h1>{doctitle}</h1>
+<span id="revision">v{revision}</span>
+</div>
+
+[footer]
+<div id="footer">
+<div id="footer-text">
+<strong>Hem</strong> is copyright &#169; 2008,
+<a class='author' href='http://tomayko.com'>Ryan Tomayko</a>
+</div>
+</div>
+</body>
+</html>

0 comments on commit e8faf57

Please sign in to comment.