diff options
| author | Lennart Poettering <lennart@poettering.net> | 2012-07-31 16:09:01 +0200 |
|---|---|---|
| committer | Lennart Poettering <lennart@poettering.net> | 2012-08-01 19:53:23 +0200 |
| commit | 18c7ed186be28800a2eeb37ad31c9c44480d3d9c (patch) | |
| tree | 71d39423e738bcd866aff16269ea925c3c7eab17 /man/sd_journal_print.xml | |
| parent | 4d9909c93e9c58789c71b34555a1908307c6849e (diff) | |
journal: add sd_journal_perror() to API
Diffstat (limited to 'man/sd_journal_print.xml')
| -rw-r--r-- | man/sd_journal_print.xml | 29 |
1 files changed, 27 insertions, 2 deletions
diff --git a/man/sd_journal_print.xml b/man/sd_journal_print.xml index dfe99192e7..7eac6c8192 100644 --- a/man/sd_journal_print.xml +++ b/man/sd_journal_print.xml @@ -47,6 +47,7 @@ <refname>sd_journal_printv</refname> <refname>sd_journal_send</refname> <refname>sd_journal_sendv</refname> + <refname>sd_journal_perror</refname> <refname>SD_JOURNAL_SUPPRESS_LOCATION</refname> <refpurpose>Submit log entries to the journal</refpurpose> </refnamediv> @@ -81,6 +82,11 @@ <paramdef>int <parameter>n</parameter></paramdef> </funcprototype> + <funcprototype> + <funcdef>int <function>sd_journal_perror</function></funcdef> + <paramdef>const char* <parameter>message</parameter></paramdef> + </funcprototype> + </funcsynopsis> </refsynopsisdiv> @@ -150,6 +156,21 @@ particularly useful to submit binary objects to the journal where that is necessary.</para> + <para><function>sd_journal_perror()</function> is a + similar to + <citerefentry><refentrytitle>perror</refentrytitle><manvolnum>3</manvolnum></citerefentry> + and writes a message to the journal that consists of + the passed string, suffixed with ": " and a human + readable representation of the current error code + stored in + <citerefentry><refentrytitle>errno</refentrytitle><manvolnum>3</manvolnum></citerefentry>. If + the message string is passed as NULL or empty string + only the error string representation will be written, + prefixed with nothing. An additional journal field + ERRNO= is included in the entry containing the numeric + error code formatted as decimal string. The log + priority used is <literal>LOG_ERR</literal> (3).</para> + <para>Note that <function>sd_journal_send()</function> is a wrapper around <function>sd_journal_sendv()</function> to make it @@ -191,8 +212,10 @@ sd_journal_send("MESSAGE=Hello World, this is PID %lu!", (unsigned long) getpid( <refsect1> <title>Return Value</title> - <para>The four calls return 0 on success or a - negative errno-style error code.</para> + <para>The four calls return 0 on success or a negative + errno-style error code. The + <citerefentry><refentrytitle>errno</refentrytitle><manvolnum>3</manvolnum></citerefentry> + variable itself is not altered.</para> </refsect1> <refsect1> @@ -217,6 +240,8 @@ sd_journal_send("MESSAGE=Hello World, this is PID %lu!", (unsigned long) getpid( <citerefentry><refentrytitle>sd-journal</refentrytitle><manvolnum>3</manvolnum></citerefentry>, <citerefentry><refentrytitle>sd_journal_stream_fd</refentrytitle><manvolnum>3</manvolnum></citerefentry>, <citerefentry><refentrytitle>syslog</refentrytitle><manvolnum>3</manvolnum></citerefentry>, + <citerefentry><refentrytitle>perror</refentrytitle><manvolnum>3</manvolnum></citerefentry>, + <citerefentry><refentrytitle>errno</refentrytitle><manvolnum>3</manvolnum></citerefentry>, <citerefentry><refentrytitle>systemd.journal-fields</refentrytitle><manvolnum>7</manvolnum></citerefentry> </para> </refsect1> |