man: add sd_event_add_signal(3)

[elogind.git] / man / sd_event_add_time.xml

diff --git a/man/sd_event_add_time.xml b/man/sd_event_add_time.xml
index 9af8bb9c45503bd449b7297a92d64923e565b4bb..d3775e5d5f795ead67f11cedcc81310593b033f7 100644 (file)
--- a/man/sd_event_add_time.xml
+++ b/man/sd_event_add_time.xml
@@ -65,13 +65,20 @@ along with systemd; If not, see <http://www.gnu.org/licenses/>.
         <paramdef>uint64_t <parameter>usec</parameter></paramdef>
         <paramdef>uint64_t <parameter>accuracy</parameter></paramdef>
         <paramdef>sd_event_time_handler_t <parameter>handler</parameter></paramdef>
-        <paramdef>void* <parameter>userdata</parameter></paramdef>
+        <paramdef>void *<parameter>userdata</parameter></paramdef>
+      </funcprototype>
+
+      <funcprototype>
+        <funcdef>typedef int (*<function>sd_event_time_handler_t</function>)</funcdef>
+        <paramdef>sd_event_source *<parameter>s</parameter></paramdef>
+        <paramdef>uint64_t <parameter>usec</parameter></paramdef>
+        <paramdef>void *<parameter>userdata</parameter></paramdef>
       </funcprototype>
 
       <funcprototype>
         <funcdef>int <function>sd_event_source_get_time</function></funcdef>
         <paramdef>sd_event_source *<parameter>source</parameter></paramdef>
-        <paramdef>usec_t* <parameter>usec</parameter></paramdef>
+        <paramdef>usec_t *<parameter>usec</parameter></paramdef>
       </funcprototype>
 
       <funcprototype>
@@ -121,7 +128,7 @@ along with systemd; If not, see <http://www.gnu.org/licenses/>.
     accuracy value in microseconds specifying a time the timer event
     may be delayed. Specify 0 for selecting the default accuracy
     (250ms). Specify 1 for most accurate timers. Consider specifying
-    60000000 or larger (1h) for long running events that may be
+    60000000 or larger (1h) for long-running events that may be
     delayed substantially. Picking higher accuracy values allows the
     system to coalesce timer events more aggressively, thus improving
     power efficiency. The <parameter>handler</parameter> shall
@@ -132,11 +139,15 @@ along with systemd; If not, see <http://www.gnu.org/licenses/>.
     actually have been called at a slightly later time, subject to the
     specified accuracy value, the kernel timer slack (see
     <citerefentry><refentrytitle>prctl</refentrytitle><manvolnum>2</manvolnum></citerefentry>)
-    and additional scheduling latencies. By default the timer will
-    elapse once (SD_EVENT_ONESHOT), but this may be changed with
-    <citerefentry><refentrytitle>sd_event_source_set_enabled</refentrytitle><manvolnum>3</manvolnum></citerefentry>. If
-    the handler function returns a negative error code it will be
-    disabled after the invocation, even if SD_EVENT_ON mode is set.
+    and additional scheduling latencies.</para>
+
+    <para>By default, the timer will elapse once
+    (<constant>SD_EVENT_ONESHOT</constant>), but this may be changed
+    with
+    <citerefentry><refentrytitle>sd_event_source_set_enabled</refentrytitle><manvolnum>3</manvolnum></citerefentry>.
+    If the handler function returns a negative error code, it will be
+    disabled after the invocation, even if
+    <constant>SD_EVENT_ON</constant> mode is set.
     </para>
 
     <para><function>sd_event_source_get_time()</function> retrieves
@@ -187,7 +198,7 @@ along with systemd; If not, see <http://www.gnu.org/licenses/>.
       <varlistentry>
         <term><varname>-ENOMEM</varname></term>
 
-        <listitem><para>Not enough memory to allocate object.</para></listitem>
+        <listitem><para>Not enough memory to allocate an object.</para></listitem>
       </varlistentry>
 
       <varlistentry>
@@ -226,7 +237,7 @@ along with systemd; If not, see <http://www.gnu.org/licenses/>.
     <para><function>sd_event_add_time()</function> and the other functions
     described here are available as a shared library, which can be
     compiled and linked to with the
-    <constant>libsystemd</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>
 
@@ -237,6 +248,7 @@ along with systemd; If not, see <http://www.gnu.org/licenses/>.
       <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
       <citerefentry><refentrytitle>sd-event</refentrytitle><manvolnum>3</manvolnum></citerefentry>,
       <citerefentry><refentrytitle>sd_event_new</refentrytitle><manvolnum>3</manvolnum></citerefentry>,
+      <citerefentry><refentrytitle>sd_event_add_signal</refentrytitle><manvolnum>3</manvolnum></citerefentry>,
       <citerefentry><refentrytitle>clock_gettime</refentrytitle><manvolnum>2</manvolnum></citerefentry>,
       <citerefentry><refentrytitle>sd_event_source_set_enabled</refentrytitle><manvolnum>3</manvolnum></citerefentry>
     </para>