Merge commit 'c5bab7026b8e0ac44b25ee08507ea360f177d844' into merges
[unleashed.git] / share / man / man8 / getdev.8
blobbbcefee4f0207040326d043a764514cea20f0440
1 '\" te
2 .\"  Copyright 1989 AT&T  Copyright (c) 1997 Sun Microsystems, Inc.  All Rights Reserved.
3 .\" The contents of this file are subject to the terms of the Common Development and Distribution License (the "License").  You may not use this file except in compliance with the License.
4 .\" You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing.  See the License for the specific language governing permissions and limitations under the License.
5 .\" When distributing Covered Code, include this CDDL HEADER in each file and include the License file at usr/src/OPENSOLARIS.LICENSE.  If applicable, add the following below this CDDL HEADER, with the fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner]
6 .TH GETDEV 8 "Jul 5, 1990"
7 .SH NAME
8 getdev \- lists devices based on criteria
9 .SH SYNOPSIS
10 .LP
11 .nf
12 \fBgetdev\fR [\fB-ae\fR] [\fIcriteria\fR]... [\fIdevice\fR]...
13 .fi
15 .SH DESCRIPTION
16 .sp
17 .LP
18 \fBgetdev\fR generates a list of devices that match certain criteria. The
19 criteria includes a list of attributes (given in expressions) and a list of
20 devices. If no  criteria are given, all devices are included in the list.
21 .sp
22 .LP
23 Devices must satisfy at least one of the criteria in the list unless the
24 \fB-a\fR option is used. Then, only those devices which match all of the
25 criteria in a list will be included.
26 .sp
27 .LP
28 Devices which are defined on the command line and which match the criteria are
29 included in the generated list. However, if the \fB-e\fR option is used, the
30 list becomes a set of devices to be \fIexcluded\fR from the list. See
31 \fBOPTIONS\fR and  \fBOPERANDS\fR.
32 .SH OPTIONS
33 .sp
34 .LP
35 The following options are supported:
36 .sp
37 .ne 2
38 .na
39 \fB\fB-a\fR\fR
40 .ad
41 .RS 6n
42 Specifies that a device must match all criteria to be included in the list
43 generated by this command. The option has no effect if no criteria are defined.
44 .RE
46 .sp
47 .ne 2
48 .na
49 \fB\fB-e\fR\fR
50 .ad
51 .RS 6n
52 Specifies that the list of devices which follows on the command line should be
53 \fIexcluded\fR from the list generated by this command. Without the \fB-e\fR
54 the named devices are \fIincluded\fR in the generated list. The flag has no
55 effect if no devices are defined.
56 .RE
58 .SH OPERANDS
59 .sp
60 .LP
61 The following operands are supported:
62 .sp
63 .ne 2
64 .na
65 \fB\fIcriteria\fR\fR
66 .ad
67 .RS 12n
68 Defines the criteria that a device must match to be included in the generated
69 list. \fIcriteria\fR is specified by expressions.
70 .sp
71 There are four possible expression types which the criteria specified in the
72 \fIcriteria\fR argument may follow:
73 .sp
74 .ne 2
75 .na
76 \fB\fIattribute\fR\fB=\fR\fIvalue\fR\fR
77 .ad
78 .RS 20n
79 Selects all devices whose attribute \fIattribute\fR is defined and is equal to
80 \fIvalue\fR.
81 .RE
83 .sp
84 .ne 2
85 .na
86 \fB\fIattribute\fR\fB!=\fR\fIvalue\fR\fR
87 .ad
88 .RS 20n
89 Selects all devices whose attribute \fIattribute\fR is defined and does not
90 equal \fIvalue\fR.
91 .RE
93 .sp
94 .ne 2
95 .na
96 \fB\fIattribute\fR\fB:*\fR\fR
97 .ad
98 .RS 20n
99 Selects all devices which have the attribute \fIattribute\fR defined.
103 .ne 2
105 \fB\fIattribute\fR\fB!:*\fR\fR
107 .RS 20n
108 Selects all devices which do not have the attribute \fIattribute\fR defined.
111 See the \fBputdev\fR(8) manual page for a complete listing and description of
112 available attributes.
116 .ne 2
118 \fB\fIdevice\fR\fR
120 .RS 12n
121 Defines the devices which should be included in the generated list. This can be
122 the pathname of the device or the device alias.
125 .SH EXIT STATUS
128 The  following  exit values are returned:
130 .ne 2
132 \fB\fB0\fR\fR
134 .RS 5n
135 Successful completion.
139 .ne 2
141 \fB\fB1\fR\fR
143 .RS 5n
144 Command syntax was incorrect, invalid option was used, or an internal error
145 occurred.
149 .ne 2
151 \fB\fB2\fR\fR
153 .RS 5n
154 Device table could not be opened for reading.
157 .SH FILES
159 .ne 2
161 \fB\fB/etc/device.tab\fR\fR
163 .RS 19n
167 .SH SEE ALSO
170 \fBdevattr\fR(8), \fBgetdgrp\fR(8), \fBputdev\fR(8), \fBputdgrp\fR(8),
171 \fBattributes\fR(5)