man/sd-device.xml

   1 <?xml version='1.0'?>
   2 <!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
   3   "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd">
   4 <!-- SPDX-License-Identifier: LGPL-2.1-or-later -->
   5
   6 <refentry id="sd-device" xmlns:xi="http://www.w3.org/2001/XInclude">
   7
   8   <refentryinfo>
   9     <title>sd-device</title>
  10     <productname>systemd</productname>
  11   </refentryinfo>
  12
  13   <refmeta>
  14     <refentrytitle>sd-device</refentrytitle>
  15     <manvolnum>3</manvolnum>
  16   </refmeta>
  17
  18   <refnamediv>
  19     <refname>sd-device</refname>
  20     <refpurpose>API for enumerating and introspecting local devices</refpurpose>
  21   </refnamediv>
  22
  23   <refsynopsisdiv>
  24     <funcsynopsis>
  25       <funcsynopsisinfo>#include &lt;systemd/sd-device.h&gt;</funcsynopsisinfo>
  26     </funcsynopsis>
  27
  28     <cmdsynopsis>
  29       <command>pkg-config --cflags --libs libsystemd</command>
  30     </cmdsynopsis>
  31
  32   </refsynopsisdiv>
  33
  34   <refsect1>
  35     <title>Description</title>
  36
  37     <para><filename>sd-device.h</filename> is part of
  38     <citerefentry><refentrytitle>libsystemd</refentrytitle><manvolnum>3</manvolnum></citerefentry> and
  39     provides an API to introspect and enumerate devices on the local system. It provides a programmatic
  40     interface to the database of devices and their properties mananaged by
  41     <citerefentry><refentrytitle>systemd-udevd.service</refentrytitle><manvolnum>8</manvolnum></citerefentry>.
  42     This API is a replacement for
  43     <citerefentry><refentrytitle>libudev</refentrytitle><manvolnum>3</manvolnum></citerefentry> and
  44     <filename>libudev.h</filename>.</para>
  45
  46     <para>See
  47     <simplelist>
  48       <member><citerefentry><refentrytitle>sd_device_get_syspath</refentrytitle><manvolnum>3</manvolnum></citerefentry>,</member>
  49       <member><citerefentry><refentrytitle>sd_device_ref</refentrytitle><manvolnum>3</manvolnum></citerefentry></member>
  50     </simplelist>
  51     for more information about the functions available.</para>
  52   </refsect1>
  53
  54   <xi:include href="libsystemd-pkgconfig.xml" />
  55
  56   <refsect1>
  57     <title>See Also</title>
  58     <para><simplelist type="inline">
  59       <member><citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry></member>
  60       <member><citerefentry><refentrytitle>sd-event</refentrytitle><manvolnum>3</manvolnum></citerefentry></member>
  61       <member><citerefentry><refentrytitle>udevadm</refentrytitle><manvolnum>8</manvolnum></citerefentry></member>
  62     </simplelist></para>
  63   </refsect1>
  64
  65 </refentry>