From 06255d6f76f3f630a9634d745a48910b1ea3e4d3 Mon Sep 17 00:00:00 2001 From: David Herrmann Date: Wed, 17 Jun 2015 15:11:11 +0200 Subject: 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). --- man/libudev.xml | 125 ++++++++++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 125 insertions(+) create mode 100644 man/libudev.xml (limited to 'man/libudev.xml') diff --git a/man/libudev.xml b/man/libudev.xml new file mode 100644 index 0000000000..5660b9d990 --- /dev/null +++ b/man/libudev.xml @@ -0,0 +1,125 @@ + + +%entities; +]> + + + + + + + libudev + systemd + + + + Developer + David + Herrmann + dh.herrmann@gmail.com + + + + + + libudev + 3 + + + + libudev + API for enumerating and introspecting local devices + + + + + #include <libudev.h> + + + + pkg-config --cflags --libs libudev + + + + + Description + + libudev.h provides APIs to introspect + and enumerate devices on the local system. + + All functions require a libudev context to operate. This + context can be create via + udev_new3. + It is used to track library state and link objects together. No + global state is used by libudev, everything is always linked to + a udev context. Furthermore, multiple different udev contexts can + be used in parallel by multiple threads. However, a single context + must not be accessed by multiple threads in parallel. The caller + is responsible of providing suitable locking if they intend to use + it from multiple threads. + + To introspect a local device on a system, a udev device + object can be created via + udev_device_new_from_syspath3 + and friends. The device object allows to query current state, + read and write attributes and lookup properties of the device in + question. + + To enumerate local devices on the system, an enumeration + object can be created via + udev_enumerate_new3. + + To monitor the local system for hotplugged or unplugged + devices, a monitor can be created via + udev_monitor_new_from_netlink3. + + Whenever libudev returns a list of objects, the + udev_list_entry3 + API should be used to iterate, access and modify those lists. + + Furthermore, libudev also exports legacy APIs that should + not be used by new software (and as such are not documented as + part of this manual). This includes the hardware-database known + as udev_hwdb (please use the new + sd-hwdb3 + API instead) and the udev_queue object to + query the udev-daemon (which should not be used by new software + at all). + + + + See Also + + udev_new3, + udev_device_new_from_syspath3, + udev_enumerate_new3, + udev_monitor_new_from_netlink3, + udev_list_entry3, + systemd1, + sd-device3, + sd-hwdb3, + pkg-config1 + + + + -- cgit v1.2.3-54-g00ecf