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