X-Git-Url: http://www.chiark.greenend.org.uk/ucgi/~ianmdlvl/git?p=elogind.git;a=blobdiff_plain;f=man%2Fsd_login_monitor_new.xml;h=ba6623826fd114235e2283fa6759d66be398475d;hp=26af0ea247f3eb358ba7bde6d93152572756165c;hb=308d72dc1e2106f94ae637e2ea510e8d466d2af1;hpb=e10375f2c0f5dd0dc8508f3ca165eb8aa63c64fb diff --git a/man/sd_login_monitor_new.xml b/man/sd_login_monitor_new.xml index 26af0ea24..ba6623826 100644 --- a/man/sd_login_monitor_new.xml +++ b/man/sd_login_monitor_new.xml @@ -59,34 +59,34 @@ int sd_login_monitor_new - const char* category - sd_login_monitor** ret + const char *category + sd_login_monitor **ret - sd_login_monitor* sd_login_monitor_unref - sd_login_monitor* m + sd_login_monitor *sd_login_monitor_unref + sd_login_monitor *m int sd_login_monitor_flush - sd_login_monitor* m + sd_login_monitor *m int sd_login_monitor_get_fd - sd_login_monitor* m + sd_login_monitor *m int sd_login_monitor_get_events - sd_login_monitor* m + sd_login_monitor *m int sd_login_monitor_get_timeout - sd_login_monitor* m - uint64_t* timeout_usec + sd_login_monitor *m + uint64_t *timeout_usec @@ -96,7 +96,7 @@ Description sd_login_monitor_new() may - be used to monitor login sessions, users, seats and + be used to monitor login sessions, users, seats, and virtual machines/containers. Via a monitor object a file descriptor can be integrated into an application defined event loop which is woken up each time a user @@ -112,7 +112,7 @@ logins) or machine (to get only notifications when a virtual machine or container is started or stopped). If notifications shall be - generated in all these conditions, NULL may be + generated in all these conditions, NULL may be passed. Note that in the future additional categories may be defined. The second parameter returns a monitor object and needs to be freed with the @@ -129,7 +129,7 @@ object. Whenever an event causes the monitor to wake up the event loop via the file descriptor this function needs to be called to reset the wake-up - state. If this call is not invoked the file descriptor + state. If this call is not invoked, the file descriptor will immediately wake up the event loop again. sd_login_monitor_get_fd() @@ -154,22 +154,22 @@ sd_login_monitor_get_events() will return the poll() mask to wait for. This function will return a combination of - POLLIN, POLLOUT + POLLIN, POLLOUT and similar to fill into the - .events field of struct - pollfd. + .events field of struct + pollfd. sd_login_monitor_get_timeout() will return a timeout value for usage in poll(). This returns a value in - microseconds since the epoch of CLOCK_MONOTONIC for - timing out poll() in - timeout_usec. See + microseconds since the epoch of CLOCK_MONOTONIC + for timing out poll() in + timeout_usec. See clock_gettime2 for details about - CLOCK_MONOTONIC. If there's no + CLOCK_MONOTONIC. If there is no timeout to wait for this will fill in - (uint64_t) -1 instead. Note that + (uint64_t) -1 instead. Note that poll() takes a relative timeout in milliseconds rather than an absolute timeout in microseconds. To convert the absolute 'us' timeout into @@ -189,7 +189,7 @@ else { } The code above does not do any error checking - for brevity's sake. The calculated msec + for brevity's sake. The calculated msec integer can be passed directly as poll()'s timeout parameter. @@ -198,21 +198,21 @@ else { Return Value - On success + On success, sd_login_monitor_new(), sd_login_monitor_flush() and sd_login_monitor_get_timeout() - return 0 or a positive integer. On success + return 0 or a positive integer. On success, sd_login_monitor_get_fd() returns - a Unix file descriptor. On success + a Unix file descriptor. On success, sd_login_monitor_get_events() - returns a combination of POLLIN, - POLLOUT and suchlike. On failure, + returns a combination of POLLIN, + POLLOUT and suchlike. On failure, these calls return a negative errno-style error code. sd_login_monitor_unref() - always returns NULL. + always returns NULL. @@ -224,10 +224,9 @@ else { sd_login_monitor_get_fd(), sd_login_monitor_get_events() and sd_login_monitor_get_timeout() - interfaces are available as shared library, which can + interfaces are available as a shared library, which can be compiled and linked to with the - libsystemd-login - pkg-config1 + libsystemd pkg-config1 file.