Sync usage with man page.
[netbsd-mini2440.git] / share / examples / refuse / pcifs / pcifs.8
blob0eef95ea65dbcda25e562d559e5a64afb3f9d69f
1 .\" $NetBSD$
2 .\"
3 .\" Copyright © 2007 Alistair Crooks.  All rights reserved.
4 .\"
5 .\" Redistribution and use in source and binary forms, with or without
6 .\" modification, are permitted provided that the following conditions
7 .\" are met:
8 .\" 1. Redistributions of source code must retain the above copyright
9 .\"    notice, this list of conditions and the following disclaimer.
10 .\" 2. Redistributions in binary form must reproduce the above copyright
11 .\"    notice, this list of conditions and the following disclaimer in the
12 .\"    documentation and/or other materials provided with the distribution.
13 .\" 3. The name of the author may not be used to endorse or promote
14 .\"    products derived from this software without specific prior written
15 .\"    permission.
16 .\"
17 .\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS
18 .\" OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
19 .\" WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
20 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY
21 .\" DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
22 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE
23 .\" GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
24 .\" INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
25 .\" WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
26 .\" NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
27 .\" SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
28 .\"
29 .Dd May 16, 2007
30 .Dt PCIFS 8
31 .Os
32 .Sh NAME
33 .Nm pcifs
34 .Nd refuse-based virtual file system to display devices on PCI bus
35 .Sh SYNOPSIS
36 .Nm
37 .Op Fl v
38 .Op Fl b Ar bus
39 .Ar mount_point
40 .Sh DESCRIPTION
41 The
42 .Nm
43 utility can be used to mount a virtual file system which
44 under the
45 mount point, showing the layout
46 of devices on the PCI bus.
47 .Pp
48 The following arguments can be used:
49 .Bl -tag -width Ds
50 .It Fl b Ar bus
51 Use the numeric bus number from the argument for
52 the PCI bus number to list.
53 .It Fl v
54 Produce verbose output
55 .El
56 .Pp
57 The
58 .Nm
59 utility makes use of the
60 .Xr virtdir 3
61 virtual directory routines.
62 .Pp
63 The
64 .Xr refuse 3
65 library is used to provide the file system features.
66 .Pp
67 The mandatory parameter is
68 the local mount
69 point.
70 .Pp
71 The
72 .Xr pcictl 8
73 utility is used to retrieve the information on
74 PCI devices.
75 .Sh SEE ALSO
76 .Xr puffs 3 ,
77 .Xr refuse 3 ,
78 .Xr virtdir 3 ,
79 .Xr pcictl 8
80 .Sh HISTORY
81 The
82 .Nm
83 utility first appeared in
84 .Nx 5.0 .
85 .Sh AUTHORS
86 .An Alistair Crooks Aq agc@NetBSD.org