lsuio.1

.\"                              hey, Emacs:   -*- nroff -*-
.\" lsuio is free software; you can redistribute it and/or modify
.\" it under the terms of the GNU General Public License version 2 as
.\" published by the Free Software Foundation.
.\"
.\" This program is distributed in the hope that it will be useful,
.\" but WITHOUT ANY WARRANTY; without even the implied warranty of
.\" MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
.\" GNU General Public License for more details.
.\"
.\" You should have received a copy of the GNU General Public License
.\" along with this program; see the file COPYING.  If not, write to
.\" the Free Software Foundation, 675 Mass Ave, Cambridge, MA 02139, USA.
.\"
.TH LSUIO 1 "February 22, 2007"
.\" Please update the above date whenever this man page is modified.
.\"
.\" Some roff macros, for reference:
.\" .nh        disable hyphenation
.\" .hy        enable hyphenation
.\" .ad l      left justify
.\" .ad b      justify to both left and right margins (default)
.\" .nf        disable filling
.\" .fi        enable filling
.\" .br        insert line break
.\" .sp <n>    insert n+1 empty lines
.\" for manpage-specific macros, see man(7)
.SH NAME
lsuio \- List UIO devices.
.SH SYNOPSIS
.B lsuio
.RI [ options ]
.SH DESCRIPTION
\fBlsuio\fP lists the Userspace IO devices registered in your system.
.PP
.SH OPTIONS
\fBlsuio\fP accepts the following options:
.TP
.B \-h, \-\-help
Show summary of options.
.TP
.B \-v, \-\-verbose
Extended output, also shows custom attributes registered by each device. To be
more precise, it shows any readable attribute in /sys/class/uio/uioX/device/.
It will neither display nor follow symlinks. Subdirectories are ignored.
.TP
.B \-m, \-\-mmap
Test if device memory can be mapped without problems. This is mainly useful for
UIO device driver authors.
.TP
.B \-u \fInum\fB, \-\-uiodev\fI=num\fP
.RI=num
Show one UIO device only.
.TP
.B \-V, \-\-version
Show version of program.
.SH EXAMPLES
In its simplest form, \fBlsuio\fP can be used without options:
.TP
\fBlsuio\fP
Brief list of UIO devices with their standard attributes.
.TP
\fBlsuio -v -m\fP
Verbose list of UIO devices, mmap() test is performed for each device.
.TP
\fBlsuio -v -u 2\fP
Show information for /dev/uio2 only.
.SH SEE ALSO
Kernel UIO docs: Documentation/DocBook/uio-howto.tmpl
.SH AUTHOR
Hans J. Koch <hjk@linutronix.de>.