sbin/hammer2/cmd_snapshot.c: Fix error handling
[dragonfly.git] / sbin / devattr / devattr.8
blob778cb1470c433aec75c685076897e477105b86e3
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 September 29, 2016
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 AhM
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
48 The
49 .Nm
50 tool is for displaying a list of devices and some
51 associated properties such as their name.
52 This tool exposes the same functionality provided by the
53 .Xr devattr 3
54 library, namely the filtering capabilities offered.
55 .Pp
56 The options are as follows:
57 .Bl -tag -width indent
58 .It Fl A
59 Excludes aliases from the listing.
60 .\"
61 .It Fl h
62 Displays a help message.
63 .\"
64 .It Fl M
65 Continue monitoring after initial scan.
66 Program continues monitoring for changes and
67 does not exit until killed.
68 .It Fl p
69 Only display the specified
70 .Ar property .
71 This can be can be specified multiple times and combined
72 with all other options.
73 .\"
74 .It Fl d
75 Only display devices with name
76 .Ar device .
77 When used with
78 .Fl p ,
79 only the specified properties of
80 .Ar device
81 are listed.
82 Can be specified multiple times.
83 Allows wildcards.
84 .\"
85 .It Fl m
86 Only display devices whose property
87 .Ar key
88 matches with wildcards value
89 .Ar value
90 unless the key\-value pair starts with ~, in which case
91 the match is inverted.
92 Stacks with
93 .Fl p ,
94 .Fl d ,
95 .Fl m .
96 Can be specified multiple times.
97 .\"
98 .It Fl r
99 Behaves similarly to
100 .Fl m ,
101 but matches with regex.
103 .Sh EXAMPLES
104 List all devices named 'pts/0':
105 .Bd -ragged -offset indent
106 .Nm Fl d
107 pts/0
110 List all devices whose major number is 64:
111 .Bd -ragged -offset indent
112 .Nm Fl m
113 major:64
116 List all devices whose name is 'pts/0' and major number is not 64:
117 .Bd -ragged -offset indent
118 .Nm Fl d
119 pts/0
120 .Fl m
121 ~major:64
123 .Sh SEE ALSO
124 .Xr devattr 3 ,
125 .Xr udevd 8
126 .Sh HISTORY
129 command appeared in
130 .Dx 2.9 .
131 .Sh AUTHORS
132 .An Nolan Lum