chiark / gitweb /
core: allow informing systemd about service status changes with RELOADING=1 and STOPP...
[elogind.git] / man / sd_login_monitor_new.xml
index c7650e6ba3a838af6a082c277934dd1baf0b683e..ba6623826fd114235e2283fa6759d66be398475d 100644 (file)
 
                         <funcprototype>
                                 <funcdef>int <function>sd_login_monitor_new</function></funcdef>
-                                <paramdef>const char<parameter>category</parameter></paramdef>
-                                <paramdef>sd_login_monitor** <parameter>ret</parameter></paramdef>
+                                <paramdef>const char *<parameter>category</parameter></paramdef>
+                                <paramdef>sd_login_monitor **<parameter>ret</parameter></paramdef>
                         </funcprototype>
 
                         <funcprototype>
-                                <funcdef>sd_login_monitor<function>sd_login_monitor_unref</function></funcdef>
-                                <paramdef>sd_login_monitor<parameter>m</parameter></paramdef>
+                                <funcdef>sd_login_monitor *<function>sd_login_monitor_unref</function></funcdef>
+                                <paramdef>sd_login_monitor *<parameter>m</parameter></paramdef>
                         </funcprototype>
 
                         <funcprototype>
                                 <funcdef>int <function>sd_login_monitor_flush</function></funcdef>
-                                <paramdef>sd_login_monitor<parameter>m</parameter></paramdef>
+                                <paramdef>sd_login_monitor *<parameter>m</parameter></paramdef>
                         </funcprototype>
 
                         <funcprototype>
                                 <funcdef>int <function>sd_login_monitor_get_fd</function></funcdef>
-                                <paramdef>sd_login_monitor<parameter>m</parameter></paramdef>
+                                <paramdef>sd_login_monitor *<parameter>m</parameter></paramdef>
                         </funcprototype>
 
                         <funcprototype>
                                 <funcdef>int <function>sd_login_monitor_get_events</function></funcdef>
-                                <paramdef>sd_login_monitor<parameter>m</parameter></paramdef>
+                                <paramdef>sd_login_monitor *<parameter>m</parameter></paramdef>
                         </funcprototype>
 
                         <funcprototype>
                                 <funcdef>int <function>sd_login_monitor_get_timeout</function></funcdef>
-                                <paramdef>sd_login_monitor<parameter>m</parameter></paramdef>
-                                <paramdef>uint64_t<parameter>timeout_usec</parameter></paramdef>
+                                <paramdef>sd_login_monitor *<parameter>m</parameter></paramdef>
+                                <paramdef>uint64_t *<parameter>timeout_usec</parameter></paramdef>
                         </funcprototype>
 
                 </funcsynopsis>
                 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.</para>
 
                 <para><function>sd_login_monitor_get_fd()</function>
                 <varname>timeout_usec</varname>. See
                 <citerefentry><refentrytitle>clock_gettime</refentrytitle><manvolnum>2</manvolnum></citerefentry>
                 for details about
-                <constant>CLOCK_MONOTONIC</constant>. If there's no
+                <constant>CLOCK_MONOTONIC</constant>. If there is no
                 timeout to wait for this will fill in
                 <constant>(uint64_t) -1</constant> instead. Note that
                 <function>poll()</function> takes a relative timeout
@@ -198,13 +198,13 @@ else {
         <refsect1>
                 <title>Return Value</title>
 
-                <para>On success
+                <para>On success,
                 <function>sd_login_monitor_new()</function>,
                 <function>sd_login_monitor_flush()</function> and
                 <function>sd_login_monitor_get_timeout()</function>
-                return 0 or a positive integer. On success
+                return 0 or a positive integer. On success,
                 <function>sd_login_monitor_get_fd()</function> returns
-                a Unix file descriptor. On success
+                a Unix file descriptor. On success,
                 <function>sd_login_monitor_get_events()</function>
                 returns a combination of <constant>POLLIN</constant>,
                 <constant>POLLOUT</constant> and suchlike. On failure,
@@ -224,10 +224,9 @@ else {
                 <function>sd_login_monitor_get_fd()</function>,
                 <function>sd_login_monitor_get_events()</function> and
                 <function>sd_login_monitor_get_timeout()</function>
-                interfaces are available as shared library, which can
+                interfaces are available as shared library, which can
                 be compiled and linked to with the
-                <constant>libsystemd-login</constant>
-                <citerefentry><refentrytitle>pkg-config</refentrytitle><manvolnum>1</manvolnum></citerefentry>
+                <constant>libsystemd</constant> <citerefentry project='die-net'><refentrytitle>pkg-config</refentrytitle><manvolnum>1</manvolnum></citerefentry>
                 file.</para>
         </refsect1>