xref: /dragonfly/sbin/devattr/devattr.8 (revision ce7a3582)
1.\"
2.\" Copyright (c) 2010 The DragonFly Project.	All rights reserved.
3.\"
4.\" This code is derived from software contributed to The DragonFly Project
5.\" by Nolan Lum <nol888@gmail.com>
6.\"
7.\" Redistribution and use in source and binary forms, with or without
8.\" modification, are permitted provided that the following conditions
9.\" are met:
10.\"
11.\" 1. Redistributions of source code must retain the above copyright
12.\"    notice, this list of conditions and the following disclaimer.
13.\" 2. Redistributions in binary form must reproduce the above copyright
14.\"    notice, this list of conditions and the following disclaimer in
15.\"    the documentation and/or other materials provided with the
16.\"    distribution.
17.\" 3. Neither the name of The DragonFly Project nor the names of its
18.\"    contributors may be used to endorse or promote products derived
19.\"    from this software without specific, prior written permission.
20.\"
21.\" THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
22.\" ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
23.\" LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
24.\" FOR A PARTICULAR PURPOSE ARE DISCLAIMED.	 IN NO EVENT SHALL THE
25.\" COPYRIGHT HOLDERS OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
26.\" INCIDENTAL, SPECIAL, EXEMPLARY OR CONSEQUENTIAL DAMAGES (INCLUDING,
27.\" BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
28.\" LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED
29.\" AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
30.\" OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
31.\" OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
32.\" SUCH DAMAGE.
33.\"
34.Dd December 6, 2010
35.Dt DEVATTR 8
36.Os
37.Sh NAME
38.Nm devattr
39.Nd tool for displaying devices and their associated properties
40.Sh SYNOPSIS
41.Nm
42.Op Fl Ah
43.Op Fl p Ar property
44.Op Fl d Ar device
45.Op Fl m Ar key:value
46.Op Fl r Ar key:value
47.Sh DESCRIPTION
48The
49.Nm
50tool is for displaying a list of devices and some
51associated properties such as their name.
52This tool exposes the same functionality provided by the
53.Xr devattr 3
54library, namely the filtering capabilities offered.
55.Pp
56The options are as follows:
57.Bl -tag -width indent
58.It Fl A
59Excludes aliases from the listing.
60.\"
61.It Fl h
62Displays a help message.
63.\"
64.It Fl p
65Only display the specified
66.Ar property .
67This can be can be specified multiple times and combined
68with all other options.
69.\"
70.It Fl d
71Only display devices with name
72.Ar device .
73When used with
74.Fl p ,
75only the specified properties of
76.Ar device
77are listed.
78Can be specified multiple times.
79Allows wildcards.
80.\"
81.It Fl m
82Only display devices whose property
83.Ar key
84matches with wildcards value
85.Ar value
86unless the key\-value pair starts with ~, in which case
87the match is inverted.
88Stacks with
89.Fl p ,
90.Fl d ,
91.Fl m .
92Can be specified multiple times.
93.\"
94.It Fl r
95Behaves similarly to
96.Fl m ,
97but matches with regex.
98.El
99.Sh EXAMPLES
100List all devices named 'pts/0':
101.Bd -ragged -offset indent
102.Nm Fl d
103pts/0
104.Ed
105.Pp
106List all devices whose major number is 64:
107.Bd -ragged -offset indent
108.Nm Fl m
109major:64
110.Ed
111.Pp
112List all devices whose name is 'pts/0' and major number is not 64:
113.Bd -ragged -offset indent
114.Nm Fl d
115pts/0
116.Fl m
117~major:64
118.Ed
119.Sh SEE ALSO
120.Xr devattr 3 ,
121.Xr udevd 8
122.Sh AUTHORS
123.An Nolan Lum
124