DOC: Update man page.

This commit is contained in:
Stefan van der Walt
2012-05-03 14:09:57 -07:00
parent 429dedd5c0
commit 9b632248e3
+19 -38
View File
@@ -2,7 +2,8 @@
.\" First parameter, NAME, should be all caps
.\" Second parameter, SECTION, should be 1-8, maybe w/ subsection
.\" other parameters are allowed: see man(7), man(1)
.TH SKIMAGE SECTION "February 3, 2012"
.IX Title "SKIMAGE 1"
.TH SKIMAGE 1
.\" Please adjust this date whenever revising the manpage.
.\"
.\" Some roff macros, for reference:
@@ -16,44 +17,24 @@
.\" .sp <n> insert n+1 empty lines
.\" for manpage-specific macros, see man(7)
.SH NAME
skivi \- image viewer based on scikits-image
skivi \- a scikits-image viewer
.SH SYNOPSIS
.B skivi
.RI [ options ] " file" ...
.br
.B bar
.RI [ options ] " file" ...
.I "filename"
.SH DESCRIPTION
This manual page documents briefly the
.B skimage
and
.B bar
commands.
.PP
.\" TeX users may be more comfortable with the \fB<whatever>\fP and
.\" \fI<whatever>\fP escape sequences to invode bold face and italics,
.\" respectively.
\fBskimage\fP is a program that...
.SH OPTIONS
These programs follow the usual GNU command line syntax, with long
options starting with two dashes (`-').
A summary of options is included below.
For a complete description, see the Info files.
.TP
.B \-h, \-\-help
Show summary of options.
.TP
.B \-v, \-\-version
Show version of program.
.SH SEE ALSO
.BR bar (1),
.BR baz (1).
.br
The programs are documented fully by
.IR "The Rise and Fall of a Fooish Bar" ,
available via the Info system.
An image viewer built on the scikits-image QT display plugin, that allows
adjusting color balance, exposure, etc.
\fBskivi\fP is a convenience wrapper around the following code:
.nf
from skimage import io
import sys
io.use_plugin('qt')
image = io.imread(sys.argv[1])
io.imshow(image, fancy=True)
.fi
.SH AUTHOR
skimage was written by <upstream author>.
.PP
This manual page was written by Stefan van der Walt <stefan@sun.ac.za>,
for the Debian project (and may be used by others).
The scikits-image team: http://skimage.org