]> git.ipfire.org Git - thirdparty/systemd.git/commitdiff
man: add description of org.freedesktop.LogControl1
authorZbigniew Jędrzejewski-Szmek <zbyszek@in.waw.pl>
Fri, 24 Apr 2020 19:04:43 +0000 (21:04 +0200)
committerZbigniew Jędrzejewski-Szmek <zbyszek@in.waw.pl>
Tue, 5 May 2020 20:41:23 +0000 (22:41 +0200)
I'm not sure if the LogTarget property is sufficiently general to be made into
a property that can be generally implemented. It is very closely tied to the internal
systemd logic. The other two seem fine thoough.

man/org.freedesktop.LogControl1.xml [new file with mode: 0644]
man/rules/meson.build
man/systemd-hostnamed.service.xml
man/systemd-importd.service.xml
man/systemd-localed.service.xml
man/systemd-logind.service.xml
man/systemd-machined.service.xml
man/systemd-resolved.service.xml
man/systemd-timedated.service.xml
man/systemd.xml

diff --git a/man/org.freedesktop.LogControl1.xml b/man/org.freedesktop.LogControl1.xml
new file mode 100644 (file)
index 0000000..125a008
--- /dev/null
@@ -0,0 +1,106 @@
+<?xml version='1.0'?>
+<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
+  "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd" >
+<!-- SPDX-License-Identifier: LGPL-2.1+ -->
+
+<refentry id="org.freedesktop.LogControl1"
+    xmlns:xi="http://www.w3.org/2001/XInclude">
+  <refentryinfo>
+    <title>org.freedesktop.LogControl1</title>
+    <productname>systemd</productname>
+  </refentryinfo>
+
+  <refmeta>
+    <refentrytitle>org.freedesktop.LogControl1</refentrytitle>
+    <manvolnum>5</manvolnum>
+  </refmeta>
+
+  <refnamediv>
+    <refname>org.freedesktop.LogControl1</refname>
+    <refpurpose>D-Bus interface to query and set logging configuration</refpurpose>
+  </refnamediv>
+
+  <refsect1>
+    <title>Introduction</title>
+
+    <para><interfacename>org.freedesktop.LogControl1</interfacename> is a generic interface that is intended
+    to be used by any daemon which should allow setting the log level and target over D-Bus. It is implemented
+    by various daemons that are part of the
+    <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry> suite.</para>
+
+    <para>It is assumed that those settings are global for the whole program, so a fixed object path is
+    used. The interface should always be available under the path
+    <filename>/org/freedesktop/LogControl1</filename>.</para>
+  </refsect1>
+
+  <refsect1>
+    <title>Description</title>
+
+    <para>The following interface is exposed:</para>
+
+    <programlisting executable="systemd" node="/org/freedesktop/LogControl1" interface="org.freedesktop.LogControl1">
+node /org/freedesktop/LogControl1 {
+  interface org.freedesktop.LogControl1 {
+    properties:
+      @org.freedesktop.DBus.Property.EmitsChangedSignal("false")
+      @org.freedesktop.systemd1.Privileged("true")
+      readwrite s LogLevel = '...';
+      @org.freedesktop.DBus.Property.EmitsChangedSignal("false")
+      @org.freedesktop.systemd1.Privileged("true")
+      readwrite s LogTarget = '...';
+      @org.freedesktop.DBus.Property.EmitsChangedSignal("false")
+      readonly s SyslogIdentifier = '...';
+  };
+  interface org.freedesktop.DBus.Peer { ... };
+  interface org.freedesktop.DBus.Introspectable { ... };
+  interface org.freedesktop.DBus.Properties { ... };
+};
+    </programlisting>
+
+    <!--Autogenerated cross-references for systemd.directives, do not edit-->
+
+    <variablelist class="dbus-interface" generated="True" extra-ref="org.freedesktop.LogControl1"/>
+
+    <variablelist class="dbus-interface" generated="True" extra-ref="org.freedesktop.LogControl1"/>
+
+    <variablelist class="dbus-property" generated="True" extra-ref="LogLevel"/>
+
+    <variablelist class="dbus-property" generated="True" extra-ref="LogTarget"/>
+
+    <variablelist class="dbus-property" generated="True" extra-ref="SyslogIdentifier"/>
+
+    <!--End of Autogenerated section-->
+
+    <refsect2>
+      <title>Properties</title>
+
+      <para><varname>LogLevel</varname> describes the
+      <citerefentry><refentrytitle>syslog</refentrytitle><manvolnum>3</manvolnum></citerefentry>-style
+      log-level, and should be one of <literal>emerg</literal>, <literal>alert</literal>,
+      <literal>crit</literal>, <literal>err</literal>, <literal>warning</literal>, <literal>notice</literal>,
+      <literal>info</literal>, <literal>debug</literal>, in order of increasing verbosity.</para>
+
+      <para><varname>LogTarget</varname> describes the log target (mechanism). It should be one of
+      <literal>console</literal> (log to the console or standard output),
+      <literal>kmsg</literal> (log to the kernel ring buffer),
+      <literal>journal</literal> (log the the journal natively, see
+      <citerefentry><refentrytitle>systemd-journald.service</refentrytitle><manvolnum>8</manvolnum></citerefentry>),
+      <literal>syslog</literal> (log using the
+      <citerefentry><refentrytitle>syslog</refentrytitle><manvolnum>3</manvolnum></citerefentry> call).
+      </para>
+
+      <para>Those two properties are writable, so they may be set by sufficiently privileged users.</para>
+
+      <para><varname>SyslogIdentifier</varname> is a read-only property that shows the "syslog identifier".
+      It is a short string that identifies the program that is the source of log messages that is passed to
+      the <citerefentry><refentrytitle>syslog</refentrytitle><manvolnum>3</manvolnum></citerefentry> call.
+      </para>
+
+      <para>Note: <command>journalctl</command> option <option>-p</option>/<option>--priority=</option> may
+      be used to filter log messages by log level, option <option>-t</option>/<option>--identifier=</option>
+      may be used to by the syslog identifier, and filters like <literal>_TRANSPORT=syslog</literal>,
+      <literal>_TRANSPORT=journal</literal>, and <literal>_TRANSPORT=kernel</literal> may be used to filter
+      messages by the mechanism through which they reached <command>systemd-journald</command>.</para>
+    </refsect2>
+  </refsect1>
+</refentry>
index 2096222c50da375f1f3733d68cfef657896a1420..cda68ef99b71dd147c203d44ea49bb4dc84bc186 100644 (file)
@@ -44,6 +44,7 @@ manpages = [
  ['nss-mymachines', '8', ['libnss_mymachines.so.2'], 'ENABLE_NSS_MYMACHINES'],
  ['nss-resolve', '8', ['libnss_resolve.so.2'], 'ENABLE_NSS_RESOLVE'],
  ['nss-systemd', '8', ['libnss_systemd.so.2'], 'ENABLE_NSS_SYSTEMD'],
+ ['org.freedesktop.LogControl1', '5', [], ''],
  ['org.freedesktop.hostname1', '5', [], 'ENABLE_HOSTNAMED'],
  ['org.freedesktop.import1', '5', [], 'ENABLE_IMPORTD'],
  ['org.freedesktop.locale1', '5', [], 'ENABLE_LOCALED'],
index 699316a09a2eadf447043be5b0e9174a86a66b1d..1aa32a61cedc3b9a0291d2349e482fed407d1b3f 100644 (file)
@@ -56,7 +56,9 @@
     is a command line client to this service.</para>
 
     <para>See
-    <citerefentry><refentrytitle>org.freedesktop.hostname1</refentrytitle><manvolnum>1</manvolnum></citerefentry>
+    <citerefentry><refentrytitle>org.freedesktop.hostname1</refentrytitle><manvolnum>5</manvolnum></citerefentry>
+    and
+    <citerefentry><refentrytitle>org.freedesktop.LogControl1</refentrytitle><manvolnum>5</manvolnum></citerefentry>
     for a description of the D-Bus API.</para>
   </refsect1>
 
index 355e5b0b98190a2a0fb53380a84b4e32b38d25cd..fa3c3a812f05e035fad9c5c80d1d67194c8b249d 100644 (file)
     <command>pull-raw</command>, <command>pull-tar</command>, <command>import-raw</command>,
     <command>import-tar</command>, <command>export-raw</command>, and <command>export-tar</command> commands.</para>
 
-    <para>See the
-    <ulink url="https://www.freedesktop.org/wiki/Software/systemd/importd">
-    importd D-Bus API Documentation</ulink> for information about the
-    APIs <filename>systemd-importd</filename> provides.</para>
+    <para>See
+    <citerefentry><refentrytitle>org.freedesktop.import1</refentrytitle><manvolnum>5</manvolnum></citerefentry>
+    and
+    <citerefentry><refentrytitle>org.freedesktop.LogControl1</refentrytitle><manvolnum>5</manvolnum></citerefentry>
+    for a description of the D-Bus API.</para>
   </refsect1>
 
   <refsect1>
index e5f6b78d218acd10b98a1b22b10973e2a226afb8..49eeeffee6e368e55c977d2dfc07eb06f50ef418 100644 (file)
@@ -41,7 +41,9 @@
     is a command line client to this service.</para>
 
     <para>See
-    <citerefentry><refentrytitle>org.freedesktop.locale1</refentrytitle><manvolnum>1</manvolnum></citerefentry>
+    <citerefentry><refentrytitle>org.freedesktop.locale1</refentrytitle><manvolnum>5</manvolnum></citerefentry>
+    and
+    <citerefentry><refentrytitle>org.freedesktop.LogControl1</refentrytitle><manvolnum>5</manvolnum></citerefentry>
     for a description of the D-Bus API.</para>
   </refsect1>
 
index 12f9f7a0f683af827c21d47c44392f6ee0c570e3..c602b2e42fe800fcac5a0dd420a01180d3e2f36b 100644 (file)
@@ -79,7 +79,9 @@
     such as users, sessions and seats.</para>
 
     <para>See
-    <citerefentry><refentrytitle>org.freedesktop.login1</refentrytitle><manvolnum>3</manvolnum></citerefentry>
+    <citerefentry><refentrytitle>org.freedesktop.login1</refentrytitle><manvolnum>5</manvolnum></citerefentry>
+    and
+    <citerefentry><refentrytitle>org.freedesktop.LogControl1</refentrytitle><manvolnum>5</manvolnum></citerefentry>
     for information about the D-Bus APIs <filename>systemd-logind</filename> provides.</para>
 
     <para>For more information on the inhibition logic see the <ulink
index e15cc963b407c565e8c0131407061cf764ef2ae4..ab58d8fd3f76fd35f141c234a801f829ad050489 100644 (file)
     For more information please consult
     <citerefentry><refentrytitle>sd-login</refentrytitle><manvolnum>3</manvolnum></citerefentry>
     and
-    <citerefentry><refentrytitle>org.freedesktop.machine1</refentrytitle><manvolnum>3</manvolnum></citerefentry>.
+    <citerefentry><refentrytitle>org.freedesktop.machine1</refentrytitle><manvolnum>5</manvolnum></citerefentry>.
+    and
+    <citerefentry><refentrytitle>org.freedesktop.LogControl1</refentrytitle><manvolnum>5</manvolnum></citerefentry>
     </para>
 
     <para>A small companion daemon
index 2f4efab1ff87e05359582e9a5e4457a43a09941e..6e1ee9f4a5158229561b579277944d10ce90d49a 100644 (file)
@@ -38,6 +38,8 @@
       <listitem><para>The native, fully-featured API <command>systemd-resolved</command> exposes on the bus,
       see
       <citerefentry><refentrytitle>org.freedesktop.resolve1</refentrytitle><manvolnum>5</manvolnum></citerefentry>
+      and
+      <citerefentry><refentrytitle>org.freedesktop.LogControl1</refentrytitle><manvolnum>5</manvolnum></citerefentry>
       for details. Usage of this API is generally recommended to clients as it is asynchronous and fully
       featured (for example, properly returns DNSSEC validation status and interface scope for addresses as
       necessary for supporting link-local networking).</para></listitem>
index b722b33115ff78ef54c4570d61e410990eebefc3..93cfdf511803a06c109101e6450aa8b0905f1fc3 100644 (file)
@@ -55,6 +55,8 @@
 
     <para>See
     <citerefentry><refentrytitle>org.freedesktop.timedate1</refentrytitle><manvolnum>5</manvolnum></citerefentry>
+    and
+    <citerefentry><refentrytitle>org.freedesktop.LogControl1</refentrytitle><manvolnum>5</manvolnum></citerefentry>
     for information about the D-Bus API.</para>
   </refsect1>
 
index 4e08ff6254466ce538c13c427819616b383e3652..11954a78da8ed2ef14686298245dd50ee78b0ad0 100644 (file)
     <citerefentry><refentrytitle>systemd.generator</refentrytitle><manvolnum>7</manvolnum></citerefentry>.</para>
 
     <para>The D-Bus API of <command>systemd</command> is described in
-    <citerefentry><refentrytitle>org.freedesktop.systemd1</refentrytitle><manvolnum>5</manvolnum></citerefentry>.</para>
+    <citerefentry><refentrytitle>org.freedesktop.systemd1</refentrytitle><manvolnum>5</manvolnum></citerefentry>
+    and
+    <citerefentry><refentrytitle>org.freedesktop.LogControl1</refentrytitle><manvolnum>5</manvolnum></citerefentry>.
+    </para>
 
     <para>Systems which invoke systemd in a container or initrd environment should implement the <ulink
     url="https://systemd.io/CONTAINER_INTERFACE">Container Interface</ulink> or <ulink