From 9b632248e335d60893f4540824036d8e16b7e861 Mon Sep 17 00:00:00 2001 From: Stefan van der Walt Date: Thu, 3 May 2012 14:09:57 -0700 Subject: [PATCH] DOC: Update man page. --- debian/skivi.1 | 57 +++++++++++++++++--------------------------------- 1 file changed, 19 insertions(+), 38 deletions(-) diff --git a/debian/skivi.1 b/debian/skivi.1 index a3103516..802134ef 100644 --- a/debian/skivi.1 +++ b/debian/skivi.1 @@ -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 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\fP and -.\" \fI\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 . -.PP -This manual page was written by Stefan van der Walt , -for the Debian project (and may be used by others). +The scikits-image team: http://skimage.org +