]> git.ipfire.org Git - thirdparty/systemd.git/blobdiff - man/sd_journal_get_data.xml
systemctl: add support for --wait to is-system-running
[thirdparty/systemd.git] / man / sd_journal_get_data.xml
index b395fe01c92ef0e9836b03b433a242a89319ecc0..464fd16ace16e53a9acd24b3f75719b6f6238f6f 100644 (file)
@@ -1,43 +1,16 @@
 <?xml version='1.0'?> <!--*-nxml-*-->
 <!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN"
-  "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd" [
-<!ENTITY % entities SYSTEM "custom-entities.ent" >
-%entities;
-]>
+  "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd">
 
 <!--
-  This file is part of systemd.
-
-  Copyright 2012 Lennart Poettering
-
-  systemd is free software; you can redistribute it and/or modify it
-  under the terms of the GNU Lesser General Public License as published by
-  the Free Software Foundation; either version 2.1 of the License, or
-  (at your option) any later version.
-
-  systemd is distributed in the hope that it will be useful, but
-  WITHOUT ANY WARRANTY; without even the implied warranty of
-  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
-  Lesser General Public License for more details.
-
-  You should have received a copy of the GNU Lesser General Public License
-  along with systemd; If not, see <http://www.gnu.org/licenses/>.
+  SPDX-License-Identifier: LGPL-2.1+
 -->
 
-<refentry id="sd_journal_get_data">
+<refentry id="sd_journal_get_data" xmlns:xi="http://www.w3.org/2001/XInclude">
 
   <refentryinfo>
     <title>sd_journal_get_data</title>
     <productname>systemd</productname>
-
-    <authorgroup>
-      <author>
-        <contrib>Developer</contrib>
-        <firstname>Lennart</firstname>
-        <surname>Poettering</surname>
-        <email>lennart@poettering.net</email>
-      </author>
-    </authorgroup>
   </refentryinfo>
 
   <refmeta>
     <function>sd_journal_get_data()</function> or
     <function>sd_journal_enumerate_data()</function>, or the read
     pointer is altered. Note that the data returned will be prefixed
-    with the field name and '='. Also note that by default data fields
+    with the field name and '='. Also note that, by default, data fields
     larger than 64K might get truncated to 64K. This threshold may be
     changed and turned off with
     <function>sd_journal_set_data_threshold()</function> (see
     <function>sd_journal_enumerate_unique()</function>. This threshold
     is a hint only: it indicates that the client program is interested
     only in the initial parts of the data fields, up to the threshold
-    in size -- but the library might still return larger data objects.
+    in size  but the library might still return larger data objects.
     That means applications should not rely exclusively on this
     setting to limit the size of the data fields returned, but need to
-    apply a explicit size limit on the returned data as well. This
+    apply an explicit size limit on the returned data as well. This
     threshold defaults to 64K by default. To retrieve the complete
     data fields this threshold should be turned off by setting it to
     0, so that the library always returns the complete data objects.
   <refsect1>
     <title>Notes</title>
 
-    <para>The <function>sd_journal_get_data()</function>,
-    <function>sd_journal_enumerate_data()</function>,
-    <function>sd_journal_restart_data()</function>,
-    <function>sd_journal_set_data_threshold()</function> and
-    <function>sd_journal_get_data_threshold()</function> interfaces
-    are available as a shared library, which can be compiled and
-    linked to with the
-    <constant>libsystemd</constant> <citerefentry project='die-net'><refentrytitle>pkg-config</refentrytitle><manvolnum>1</manvolnum></citerefentry>
-    file.</para>
+    <xi:include href="threads-aware.xml" xpointer="strict"/>
+
+    <xi:include href="libsystemd-pkgconfig.xml" xpointer="pkgconfig-text"/>
   </refsect1>
 
   <refsect1>
     iterate through all fields of the current journal
     entry:</para>
 
-    <programlisting>...
+    <programlisting>
 int print_fields(sd_journal *j) {
   const void *data;
   size_t length;
   SD_JOURNAL_FOREACH_DATA(j, data, length)
     printf("%.*s\n", (int) length, data);
 }
-...</programlisting>
-
+…</programlisting>
   </refsect1>
 
   <refsect1>