2 .\" Copyright (c) 2010 The DragonFly Project. All rights reserved.
4 .\" Redistribution and use in source and binary forms, with or without
5 .\" modification, are permitted provided that the following conditions
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
12 .\" the documentation and/or other materials provided with the
14 .\" 3. Neither the name of The DragonFly Project nor the names of its
15 .\" contributors may be used to endorse or promote products derived
16 .\" from this software without specific, prior written permission.
18 .\" THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
19 .\" ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
20 .\" LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
21 .\" FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
22 .\" COPYRIGHT HOLDERS OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
23 .\" INCIDENTAL, SPECIAL, EXEMPLARY OR CONSEQUENTIAL DAMAGES (INCLUDING,
24 .\" BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
25 .\" LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED
26 .\" AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
27 .\" OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
28 .\" OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
35 .Nm udev_enumerate_new ,
36 .Nm udev_enumerate_ref ,
37 .Nm udev_enumerate_unref ,
38 .Nm udev_enumerate_get_udev ,
39 .Nm udev_enumerate_scan_devices ,
40 .Nm udev_enumerate_get_array ,
41 .Nm udev_enumerate_get_list_entry ,
42 .Nm udev_list_entry_get_next ,
43 .Nm udev_list_entry_foreach ,
44 .Nm udev_list_entry_get_dictionary ,
45 .Nm udev_list_entry_get_device ,
46 .Nm udev_enumerate_add_match_subsystem ,
47 .Nm udev_enumerate_add_nomatch_subsystem ,
48 .Nm udev_enumerate_add_match_expr ,
49 .Nm udev_enumerate_add_match_property ,
50 .Nm udev_enumerate_add_nomatch_expr ,
51 .Nm udev_enumerate_add_nomatch_property ,
52 .Nm udev_enumerate_add_match_regex ,
53 .Nm udev_enumerate_add_nomatch_regex
54 .Nd device listing functions
59 .Ft struct udev_enumerate *
60 .Fn udev_enumerate_new "struct udev *udev_ctx"
61 .Ft struct udev_enumerate *
62 .Fn udev_enumerate_ref "struct udev_enumerate *udev_enum"
64 .Fn udev_enumerate_unref "struct udev_enumerate *udev_enum"
66 .Fn udev_enumerate_get_udev "struct udev_enumerate *udev_enum"
68 .Fn udev_enumerate_scan_devices "struct udev_enumerate *udev_enum"
70 .Fn udev_enumerate_get_array "struct udev_enumerate *udev_enum"
71 .Ft struct udev_list_entry *
72 .Fn udev_enumerate_get_list_entry "struct udev_enumerate *udev_enum"
73 .Ft struct udev_list_entry *
74 .Fn udev_list_entry_get_next "struct udev_list_entry *list_entry"
75 .Fn udev_list_entry_foreach "struct udev_list_entry *list_entry" "struct udev_list_entry *first_entry"
77 .Fn udev_list_entry_get_dictionary "struct udev_list_entry *list_entry"
78 .Ft struct udev_device *
79 .Fn udev_list_entry_get_device "struct udev_list_entry *list_entry"
81 .Fn udev_enumerate_add_match_subsystem "struct udev_enumerate *udev_enum" "const char *subsystem"
83 .Fn udev_enumerate_add_nomatch_subsystem "struct udev_enumerate *udev_enum" "const char *subsystem"
85 .Fn udev_enumerate_add_match_expr "struct udev_enumerate *udev_enum" "const char *key" "char *expr"
87 .Fn udev_enumerate_add_match_property "struct udev_enumerate *udev_enum" "const char *key" "const char *property"
89 .Fn udev_enumerate_add_nomatch_expr "struct udev_enumerate *udev_enum" "const char *key" "char *expr"
91 .Fn udev_enumerate_add_nomatch_property "struct udev_enumerate *udev_enum" "const char *key" "const char *property"
93 .Fn udev_enumerate_add_match_regex "struct udev_enumerate *udev_enum" "const char *key" "char *expr"
95 .Fn udev_enumerate_add_nomatch_regex "struct udev_enumerate *udev_enum" "const char *key" "char *expr"
98 .Fn udev_enumerate_new
99 function creates a new udev_enumerate object in the specified udev context
103 if no such object could be created.
106 .Fn udev_enumerate_ref
108 .Fn udev_enumerate_unref
109 functions increase or decrease the reference count on a
112 When the reference count drops to 0, the object is automatically destroyed.
114 .Fn udev_enumerate_ref
115 function returns the same object that was passed in.
118 .Fn udev_enumerate_get_udev
119 function returns the udev context in which the
124 .Fn udev_enumerate_scan_devices
125 function retrieves the set of devices matching the set of expressions and
126 properties specified with previous calls to
127 .Fn udev_enumerate_add_match_*
129 .Fn udev_enumerate_add_nomatch_* .
130 This function returns -1 in case of failure.
133 .Fn udev_enumerate_get_array
134 function returns the raw
136 array containing the whole set of devices retrieved by
137 .Fn udev_enumerate_scan_devices .
140 .Fn udev_enumerate_get_list_entry
141 function returns the first list entry of the specified
147 .Fn udev_list_entry_get_next
148 returns the next list element after
152 if the current element was the last.
154 .Fn udev_list_entry_foreach
155 is a convenient macro behaving as a for loop that will iterate the whole set
156 starting at the list element specified by
160 to the current element.
163 .Fn udev_list_entry_get_device
166 associated to the current list entry or
168 if no device is associated.
171 .Fn udev_list_entry_get_dictionary
172 function returns the raw
173 .Xr prop_dictionary 3
174 dictionary associated to the list entry or
176 if no dictionary is associated.
179 .Fn udev_enumerate_add_match_subsystem
181 .Fn udev_enumerate_add_nomatch_subsystem
182 functions add a filter to match or not to match, respectively, devices with the
185 These functions return a negative value if an error occurred and 0 if no error
189 .Fn udev_enumerate_add_match_expr ,
190 .Fn udev_enumerate_add_match_property ,
191 .Fn udev_enumerate_add_nomatch_expr
193 .Fn udev_enumerate_add_nomatch_property
194 functions add a filter to match or not to match, respectively, devices with the
201 can contain wildcards.
202 On error, these functions return a negative value and 0 if no error occurred.
205 .Fn udev_enumerate_add_match_regex ,
207 .Fn udev_enumerate_add_nomatch_regex
208 functions add a filter to match or not to match, respectively, devices with the
215 can contain regular expressions according to
217 On error, these functions return a negative value and 0 if no error occurred.