chiark / gitweb /
hashmap: return more information from resize_buckets()
[elogind.git] / man / sd_journal_stream_fd.xml
index 917ab4fe816bfef96991dd68b45346132036ea2a..c9ce7cdb227e0279f432e94ba850af3a7c139667 100644 (file)
@@ -53,7 +53,7 @@
 
                         <funcprototype>
                                 <funcdef>int <function>sd_journal_stream_fd</function></funcdef>
-                                <paramdef>const char<parameter>identifier</parameter></paramdef>
+                                <paramdef>const char *<parameter>identifier</parameter></paramdef>
                                 <paramdef>int <parameter>priority</parameter></paramdef>
                                 <paramdef>int <parameter>level_prefix</parameter></paramdef>
                         </funcprototype>
                 <para><function>sd_journal_stream_fd()</function> may
                 be used to create a log stream file descriptor. Log
                 messages written to this file descriptor as simple
-                newline separated text strings are written to the
+                newline-separated text strings are written to the
                 journal. This file descriptor can be used internally
-                by applications or be made STDOUT/STDERR of other
-                processes executed.</para>
+                by applications or be made standard output or standard
+                error of other processes executed.</para>
 
                 <para><function>sd_journal_stream_fd()</function>
                 takes a short program identifier string as first
                 <citerefentry><refentrytitle>systemd.journal-fields</refentrytitle><manvolnum>7</manvolnum></citerefentry>
                 for more information). The second argument shall be
                 the default priority level for all messages. The
-                priority level is one of <literal>LOG_EMERG</literal>,
-                <literal>LOG_ALERT</literal>,
-                <literal>LOG_CRIT</literal>,
-                <literal>LOG_ERR</literal>,
-                <literal>LOG_WARNING</literal>,
-                <literal>LOG_NOTICE</literal>,
-                <literal>LOG_INFO</literal>,
-                <literal>LOG_DEBUG</literal>, as defined in
+                priority level is one of <constant>LOG_EMERG</constant>,
+                <constant>LOG_ALERT</constant>,
+                <constant>LOG_CRIT</constant>,
+                <constant>LOG_ERR</constant>,
+                <constant>LOG_WARNING</constant>,
+                <constant>LOG_NOTICE</constant>,
+                <constant>LOG_INFO</constant>,
+                <constant>LOG_DEBUG</constant>, as defined in
                 <filename>syslog.h</filename>, see
-                <citerefentry><refentrytitle>syslog</refentrytitle><manvolnum>3</manvolnum></citerefentry>
+                <citerefentry project='man-pages'><refentrytitle>syslog</refentrytitle><manvolnum>3</manvolnum></citerefentry>
                 for details. The third argument is a boolean: if true
                 kernel-style log priority level prefixes (such as
-                <literal>SD_WARNING</literal>) are interpreted, see
+                <constant>SD_WARNING</constant>) are interpreted, see
                 <citerefentry><refentrytitle>sd-daemon</refentrytitle><manvolnum>3</manvolnum></citerefentry>
                 for more information.</para>
 
                 <para>It is recommended that applications log UTF-8
-                mesages only with this API, but this is not
+                messages only with this API, but this is not
                 enforced.</para>
 
         </refsect1>
                 <title>Notes</title>
 
                 <para>The <function>sd_journal_stream_fd()</function>
-                interface is available as shared library, which can
+                interface is available as shared library, which can
                 be compiled and linked to with the
-                <literal>libsystemd-journal</literal>
-                <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>
 
                 <title>Examples</title>
 
                 <para>Creating a log stream suitable for
-                <citerefentry><refentrytitle>fprintf</refentrytitle><manvolnum>3</manvolnum></citerefentry>:</para>
+                <citerefentry project='man-pages'><refentrytitle>fprintf</refentrytitle><manvolnum>3</manvolnum></citerefentry>:</para>
 
                 <programlisting>#include &lt;syslog.h&gt;
 #include &lt;stdio.h&gt;
@@ -149,6 +148,7 @@ int main(int argc, char *argv[]) {
         fprintf(log, "Hello World!\n");
         fprintf(log, SD_WARNING "This is a warning!\n");
         fclose(log);
+        return 0;
 }</programlisting>
 
         </refsect1>
@@ -161,8 +161,8 @@ int main(int argc, char *argv[]) {
                         <citerefentry><refentrytitle>sd-journal</refentrytitle><manvolnum>3</manvolnum></citerefentry>,
                         <citerefentry><refentrytitle>sd-daemon</refentrytitle><manvolnum>3</manvolnum></citerefentry>,
                         <citerefentry><refentrytitle>sd_journal_print</refentrytitle><manvolnum>3</manvolnum></citerefentry>,
-                        <citerefentry><refentrytitle>syslog</refentrytitle><manvolnum>3</manvolnum></citerefentry>,
-                        <citerefentry><refentrytitle>fprintf</refentrytitle><manvolnum>3</manvolnum></citerefentry>,
+                        <citerefentry project='man-pages'><refentrytitle>syslog</refentrytitle><manvolnum>3</manvolnum></citerefentry>,
+                        <citerefentry project='man-pages'><refentrytitle>fprintf</refentrytitle><manvolnum>3</manvolnum></citerefentry>,
                         <citerefentry><refentrytitle>systemd.journal-fields</refentrytitle><manvolnum>7</manvolnum></citerefentry>
                 </para>
         </refsect1>