shaba/systemd
1
0
Fork 0
mirror of https://github.com/systemd/systemd.git synced 2024-11-04 22:21:55 +03:00
Code
86aaccb020
systemd/man/udev_enumerate_add_match_subsystem.xml

153 lines
6.0 KiB
XML
Raw Normal View History

man: add libudev man-pages (skeletons) This adds man-pages for most of the libudev symbols we export. Similar symbols are grouped together in a single man-page, with respective links added. All man-pages contain the full skeleton including NAME, SYNOPSIS, RETURN VALUE and SEE ALSO. However, most of them still lack the DESCRIPTION part. This should be copied from the gtkdoc descriptions in src/libudev/libudev*.[ch]. Any help is welcome! (the whole skeleton is already done, so it's really just about the prose-part of the man-pages to be written). Missing from the man-pages are the following parts: - udev_set_log_fn() - udev_[gs]et_log_priority() - udev_[gs]et_userdata() - udev_list_entry_foreach() - udev_device_get_seqnum() - udev_device_get_usec_since_initialized() - udev_util_encode_string() These are considered legacy, afaik. If not, please feel free to add them now! Furthermore, udev-hwdb and udev-queue are not documented at all (for the same reasons).
2015-06-17 16:11:11 +03:00
<?xml version='1.0'?> <!--*-nxml-*-->
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN"
"http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd" [
<!ENTITY % entities SYSTEM "custom-entities.ent" >
%entities;
]>
<!--
Add SPDX license identifiers to man pages
2017-11-18 19:22:32 +03:00
SPDX-License-Identifier: LGPL-2.1+
man: add libudev man-pages (skeletons) This adds man-pages for most of the libudev symbols we export. Similar symbols are grouped together in a single man-page, with respective links added. All man-pages contain the full skeleton including NAME, SYNOPSIS, RETURN VALUE and SEE ALSO. However, most of them still lack the DESCRIPTION part. This should be copied from the gtkdoc descriptions in src/libudev/libudev*.[ch]. Any help is welcome! (the whole skeleton is already done, so it's really just about the prose-part of the man-pages to be written). Missing from the man-pages are the following parts: - udev_set_log_fn() - udev_[gs]et_log_priority() - udev_[gs]et_userdata() - udev_list_entry_foreach() - udev_device_get_seqnum() - udev_device_get_usec_since_initialized() - udev_util_encode_string() These are considered legacy, afaik. If not, please feel free to add them now! Furthermore, udev-hwdb and udev-queue are not documented at all (for the same reasons).
2015-06-17 16:11:11 +03:00
This file is part of systemd.
Copyright 2015 David Herrmann <dh.herrmann@gmail.com>
-->
<refentry id="udev_enumerate_add_match_subsystem"
xmlns:xi="http://www.w3.org/2001/XInclude">
<refentryinfo>
<title>udev_enumerate_add_match_subsystem</title>
<productname>systemd</productname>
<authorgroup>
<author>
<contrib>Developer</contrib>
<firstname>David</firstname>
<surname>Herrmann</surname>
<email>dh.herrmann@gmail.com</email>
</author>
</authorgroup>
</refentryinfo>
<refmeta>
<refentrytitle>udev_enumerate_add_match_subsystem</refentrytitle>
<manvolnum>3</manvolnum>
</refmeta>
<refnamediv>
<refname>udev_enumerate_add_match_subsystem</refname>
<refname>udev_enumerate_add_nomatch_subsystem</refname>
<refname>udev_enumerate_add_match_sysattr</refname>
<refname>udev_enumerate_add_nomatch_sysattr</refname>
<refname>udev_enumerate_add_match_property</refname>
<refname>udev_enumerate_add_match_sysname</refname>
<refname>udev_enumerate_add_match_tag</refname>
<refname>udev_enumerate_add_match_parent</refname>
<refname>udev_enumerate_add_match_is_initialized</refname>
<refpurpose>Modify filters</refpurpose>
</refnamediv>
<refsynopsisdiv>
<funcsynopsis>
<funcsynopsisinfo>#include &lt;libudev.h&gt;</funcsynopsisinfo>
<funcprototype>
<funcdef>int <function>udev_enumerate_add_match_subsystem</function></funcdef>
<paramdef>struct udev_enumerate *<parameter>udev_enumerate</parameter></paramdef>
<paramdef>const char *<parameter>subsystem</parameter></paramdef>
</funcprototype>
<funcprototype>
<funcdef>int <function>udev_enumerate_add_nomatch_subsystem</function></funcdef>
<paramdef>struct udev_enumerate *<parameter>udev_enumerate</parameter></paramdef>
<paramdef>const char *<parameter>subsystem</parameter></paramdef>
</funcprototype>
<funcprototype>
<funcdef>int <function>udev_enumerate_add_match_sysattr</function></funcdef>
<paramdef>struct udev_enumerate *<parameter>udev_enumerate</parameter></paramdef>
<paramdef>const char *<parameter>sysattr</parameter></paramdef>
<paramdef>const char *<parameter>value</parameter></paramdef>
</funcprototype>
<funcprototype>
<funcdef>int <function>udev_enumerate_add_nomatch_sysattr</function></funcdef>
<paramdef>struct udev_enumerate *<parameter>udev_enumerate</parameter></paramdef>
<paramdef>const char *<parameter>sysattr</parameter></paramdef>
<paramdef>const char *<parameter>value</parameter></paramdef>
</funcprototype>
<funcprototype>
<funcdef>int <function>udev_enumerate_add_match_property</function></funcdef>
<paramdef>struct udev_enumerate *<parameter>udev_enumerate</parameter></paramdef>
<paramdef>const char *<parameter>property</parameter></paramdef>
<paramdef>const char *<parameter>value</parameter></paramdef>
</funcprototype>
<funcprototype>
<funcdef>int <function>udev_enumerate_add_match_sysname</function></funcdef>
<paramdef>struct udev_enumerate *<parameter>udev_enumerate</parameter></paramdef>
<paramdef>const char *<parameter>sysname</parameter></paramdef>
</funcprototype>
<funcprototype>
<funcdef>int <function>udev_enumerate_add_match_tag</function></funcdef>
<paramdef>struct udev_enumerate *<parameter>udev_enumerate</parameter></paramdef>
<paramdef>const char *<parameter>tag</parameter></paramdef>
</funcprototype>
<funcprototype>
<funcdef>int <function>udev_enumerate_add_match_parent</function></funcdef>
<paramdef>struct udev_enumerate *<parameter>udev_enumerate</parameter></paramdef>
<paramdef>struct udev_device *<parameter>parent</parameter></paramdef>
</funcprototype>
<funcprototype>
<funcdef>int <function>udev_enumerate_add_match_is_initialized</function></funcdef>
<paramdef>struct udev_enumerate *<parameter>udev_enumerate</parameter></paramdef>
</funcprototype>
</funcsynopsis>
</refsynopsisdiv>
<!--<refsect1>
<title>Description</title>
<para>XXX: Add short description.</para>
</refsect1>-->
<refsect1>
<title>Return Value</title>
<para>On success,
<function>udev_enumerate_add_match_subsystem</function>,
<function>udev_enumerate_add_nomatch_subsystem</function>,
<function>udev_enumerate_add_match_sysattr</function>,
<function>udev_enumerate_add_nomatch_sysattr</function>,
<function>udev_enumerate_add_match_property</function>,
<function>udev_enumerate_add_match_sysname</function>,
<function>udev_enumerate_add_match_tag</function>,
<function>udev_enumerate_add_match_parent</function> and
<function>udev_enumerate_add_match_is_initialized</function>
return an integer greater than, or equal to,
<constant>0</constant>.</para>
</refsect1>
<refsect1>
<title>See Also</title>
<para>
<citerefentry><refentrytitle>udev_new</refentrytitle><manvolnum>3</manvolnum></citerefentry>,
<citerefentry><refentrytitle>udev_device_new_from_syspath</refentrytitle><manvolnum>3</manvolnum></citerefentry>,
<citerefentry><refentrytitle>udev_enumerate_new</refentrytitle><manvolnum>3</manvolnum></citerefentry>,
<citerefentry><refentrytitle>udev_enumerate_scan_devices</refentrytitle><manvolnum>3</manvolnum></citerefentry>,
<citerefentry><refentrytitle>udev_monitor_new_from_netlink</refentrytitle><manvolnum>3</manvolnum></citerefentry>,
<citerefentry><refentrytitle>udev_list_entry</refentrytitle><manvolnum>3</manvolnum></citerefentry>,
<citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
</para>
</refsect1>
</refentry>
Copy Permalink