]> git.ipfire.org Git - thirdparty/systemd.git/blobdiff - man/systemd-journald.service.xml
Merge pull request #30284 from YHNdnzj/fstab-wantedby-defaultdeps
[thirdparty/systemd.git] / man / systemd-journald.service.xml
index 35cfbde86c8b94e728657ad7f8aa3f64c6e5b5cc..48d1afcaf87fd2463e5c1e13ec0866110a2f3afc 100644 (file)
@@ -3,7 +3,8 @@
   "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd">
 <!-- SPDX-License-Identifier: LGPL-2.1-or-later -->
 
-<refentry id="systemd-journald.service">
+<refentry id="systemd-journald.service"
+          xmlns:xi="http://www.w3.org/2001/XInclude">
 
   <refentryinfo>
     <title>systemd-journald.service</title>
   </refnamediv>
 
   <refsynopsisdiv>
-    <para><filename>systemd-journald.service</filename></para>
-    <para><filename>systemd-journald.socket</filename></para>
-    <para><filename>systemd-journald-dev-log.socket</filename></para>
-    <para><filename>systemd-journald-audit.socket</filename></para>
-    <para><filename>systemd-journald@.service</filename></para>
-    <para><filename>systemd-journald@.socket</filename></para>
-    <para><filename>systemd-journald-varlink@.socket</filename></para>
-    <para><filename>/usr/lib/systemd/systemd-journald</filename></para>
+    <para><simplelist>
+      <member><filename>systemd-journald.service</filename></member>
+      <member><filename>systemd-journald.socket</filename></member>
+      <member><filename>systemd-journald-dev-log.socket</filename></member>
+      <member><filename>systemd-journald-audit.socket</filename></member>
+      <member><filename>systemd-journald@.service</filename></member>
+      <member><filename>systemd-journald@.socket</filename></member>
+      <member><filename>systemd-journald-varlink@.socket</filename></member>
+      <member><filename>/usr/lib/systemd/systemd-journald</filename></member>
+    </simplelist></para>
   </refsynopsisdiv>
 
   <refsect1>
       project='man-pages'><refentrytitle>syslog</refentrytitle><manvolnum>3</manvolnum></citerefentry>
       call</para></listitem>
 
-      <listitem><para>Structured system log messages via the native
-      Journal API, see
-      <citerefentry><refentrytitle>sd_journal_print</refentrytitle><manvolnum>3</manvolnum></citerefentry></para></listitem>
+      <listitem><para>Structured system log messages via the native Journal API, see
+      <citerefentry><refentrytitle>sd_journal_print</refentrytitle><manvolnum>3</manvolnum></citerefentry>
+      and <ulink url="https://systemd.io/JOURNAL_NATIVE_PROTOCOL">Native Journal
+      Protocol</ulink></para></listitem>
 
       <listitem><para>Standard output and standard error of service units. For further details see
       below.</para></listitem>
@@ -70,7 +74,7 @@
     </para>
 
     <para>Log data collected by the journal is primarily text-based but can also include binary data where
-    necessary. Individual fields making up a log record stored in the journal may be up to 2^64-1 bytes in size.</para>
+    necessary. Individual fields making up a log record stored in the journal may be up to 2⁶⁴-1 bytes in size.</para>
 
     <para>The journal service stores log data either persistently below <filename>/var/log/journal</filename> or in a
     volatile way below <filename>/run/log/journal/</filename> (in the latter case it is lost at reboot). By default, log
     <citerefentry><refentrytitle>journald.conf</refentrytitle><manvolnum>5</manvolnum></citerefentry> to configure
     where log data is placed, independently of the existence of <filename>/var/log/journal/</filename>.</para>
 
+    <para>Note that journald will initially use volatile storage, until a call to
+    <command>journalctl --flush</command> (or sending <constant>SIGUSR1</constant> to journald) will cause
+    it to switch to persistent logging (under the conditions mentioned above). This is done automatically
+    on boot via <literal>systemd-journal-flush.service</literal>.</para>
+
     <para>On systems where <filename>/var/log/journal/</filename> does not exist yet but where persistent logging is
     desired (and the default <filename>journald.conf</filename> is used), it is sufficient to create the directory, and
     ensure it has the correct access modes and ownership:</para>
@@ -184,7 +193,9 @@ systemd-tmpfiles --create --prefix /var/log/journal</programlisting>
         <command>journalctl --flush</command> command to request flushing of the journal files, and wait for
         the operation to complete. See
         <citerefentry><refentrytitle>journalctl</refentrytitle><manvolnum>1</manvolnum></citerefentry> for
-        details.</para></listitem>
+        details.</para>
+
+        <xi:include href="version-info.xml" xpointer="v186"/></listitem>
       </varlistentry>
 
       <varlistentry>
@@ -192,7 +203,9 @@ systemd-tmpfiles --create --prefix /var/log/journal</programlisting>
 
         <listitem><para>Request immediate rotation of the journal files. Use the <command>journalctl
         --rotate</command> command to request journal file rotation, and wait for the operation to
-        complete.</para></listitem>
+        complete.</para>
+
+        <xi:include href="version-info.xml" xpointer="v186"/></listitem>
       </varlistentry>
 
       <varlistentry>
@@ -200,7 +213,9 @@ systemd-tmpfiles --create --prefix /var/log/journal</programlisting>
 
         <listitem><para>Request that all unwritten log data is written to disk. Use the <command>journalctl
         --sync</command> command to trigger journal synchronization, and wait for the operation to
-        complete.</para></listitem>
+        complete.</para>
+
+        <xi:include href="version-info.xml" xpointer="v228"/></listitem>
       </varlistentry>
     </variablelist>
   </refsect1>
@@ -227,6 +242,8 @@ systemd-tmpfiles --create --prefix /var/log/journal</programlisting>
         <para>See
         <citerefentry><refentrytitle>journald.conf</refentrytitle><manvolnum>5</manvolnum></citerefentry>
         for information about these settings.</para>
+
+        <xi:include href="version-info.xml" xpointer="v186"/>
         </listitem>
 
       </varlistentry>
@@ -275,7 +292,9 @@ systemd-tmpfiles --create --prefix /var/log/journal</programlisting>
 
         <listitem><para>Configure <command>systemd-journald</command> behavior. See
         <citerefentry><refentrytitle>journald.conf</refentrytitle><manvolnum>5</manvolnum></citerefentry>.
-        </para></listitem>
+        </para>
+
+        <xi:include href="version-info.xml" xpointer="v206"/></listitem>
       </varlistentry>
 
       <varlistentry>
@@ -313,7 +332,9 @@ systemd-tmpfiles --create --prefix /var/log/journal</programlisting>
         archived journal files to limit disk use. See <varname>SystemMaxUse=</varname>
         and related settings in
         <citerefentry><refentrytitle>journald.conf</refentrytitle><manvolnum>5</manvolnum></citerefentry>.
-        </para></listitem>
+        </para>
+
+        <xi:include href="version-info.xml" xpointer="v206"/></listitem>
       </varlistentry>
 
       <varlistentry>
@@ -326,7 +347,11 @@ systemd-tmpfiles --create --prefix /var/log/journal</programlisting>
         <listitem><para>Sockets and other file node paths that <command>systemd-journald</command> will
         listen on and are visible in the file system. In addition to these,
         <command>systemd-journald</command> can listen for audit events using <citerefentry
-        project='man-pages'><refentrytitle>netlink</refentrytitle><manvolnum>7</manvolnum></citerefentry>.</para></listitem>
+        project='man-pages'><refentrytitle>netlink</refentrytitle><manvolnum>7</manvolnum></citerefentry>,
+        depending on whether <literal>systemd-journald-audit.socket</literal> is enabled or
+        not.</para>
+
+        <xi:include href="version-info.xml" xpointer="v228"/></listitem>
       </varlistentry>
     </variablelist>