.\" Copyright (c) 2006 Soeren Straarup
.\" All rights reserved.
.\"
.\" Redistribution and use in source and binary forms, with or without
.\" modification, are permitted provided that the following conditions
.\" are met:
.\" 1. Redistributions of source code must retain the above copyright
.\"    notice, this list of conditions and the following disclaimer.
.\" 2. Redistributions in binary form must reproduce the above copyright
.\"    notice, this list of conditions and the following disclaimer in the
.\"    documentation and/or other materials provided with the distribution.
.\"
.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
.\" SUCH DAMAGE.
.\"
.\" $FreeBSD: src/share/examples/mdoc/example.1,v 1.23 2005/01/16 22:22:28 ru Exp $
.\"
.Dd September 22, 2006
.Dt GEOMGUI 1
.Os
.Sh NAME
.Nm geomgui
.Nd "Viewer for the FreeBSD GEOM layer"
.Sh SYNOPSIS
.Nm
.Op Fl r Ar user@host
.Sh DESCRIPTION
The
.Nm
program is a viewer for the GEOM layer of the
.Fx
kernel.
.Sh OPTIONS
.Bl -tag -width ".Fl r Ar user@host"
.It Fl r Ar user@host
Can be used to fetch kernel info from a remote server via
.Xr ssh 1 .
The password will be prompted for on the console.
.El
.Pp
The keys are as follows:
.Bl -tag -width ".Cm z "
.It Cm z
Zoom out.
.It Cm Z
Zoom in.
.It Cm h
Move the view port to the left.
.It Cm l
Move the view port to the right.
.It Cm k
Move the view port up.
.It Cm j
Move the view port down.
.It Cm u
Update/re-read the data.
.It Cm q
Quit
.Nm .
.El
.Sh FILES
.Bl -tag -width ".Pa /tmp/geomgui.svg-XXX" -compact
.It Pa /tmp/geomgui.xml-XXX
Kernel output
.It Pa /tmp/geomgui.dot-XXX
Intermediate files
.It Pa /tmp/geomgui.svg-XXX
.Nm
output
.El
.Sh EXAMPLES
The following is an example of a typical usage
of the
.Nm
command:
.Pp
.Dl "geomgui -r user@host"
.Sh HISTORY
The
.Nm
project was started in 2006.
.Sh AUTHORS
.An Soeren Straarup Aq xride@x12.dk
.Sh BUGS
There are no known bugs.
Should you encounter one, please report it to the author.