chiark / gitweb /
~ianmdlvl / elogind.git / blobdiff
? search:
summary | shortlog | log | commit | commitdiff | tree
raw | inline | side by side
networkd: support vxlan parameters
[elogind.git] / man / systemd-journal-gatewayd.service.xml
diff --git a/man/systemd-journal-gatewayd.service.xml b/man/systemd-journal-gatewayd.service.xml
index 37b39c2d3ef0341362b221a7aa4feccf5671f174..7420b59c955e4630a13fd5c10eb1a33f42b6e893 100644 (file)
--- a/man/systemd-journal-gatewayd.service.xml
+++ b/man/systemd-journal-gatewayd.service.xml
@@ -1,4 +1,4 @@
-<?xml version='1.0'?> <!--*-nxml-*-->
+<?xml version='1.0'?> <!--*- Mode: nxml; nxml-child-indent: 2; indent-tabs-mode: nil -*-->
 <!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN"
 "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd">
 
@@ -21,7 +21,8 @@ You should have received a copy of the GNU Lesser General Public License
 along with systemd; If not, see <http://www.gnu.org/licenses/>.
 -->
 
-<refentry id="systemd-journal-gatewayd.service">
+<refentry id="systemd-journal-gatewayd.service" conditional='HAVE_MICROHTTPD'
+          xmlns:xi="http://www.w3.org/2001/XInclude">
 
   <refentryinfo>
     <title>systemd-journal-gatewayd.service</title>
@@ -81,21 +82,6 @@ along with systemd; If not, see <http://www.gnu.org/licenses/>.
     <para>The following options are understood:</para>
 
     <variablelist>
-      <varlistentry>
-        <term><option>--help</option></term>
-        <term><option>-h</option></term>
-
-        <listitem><para>Prints a short help
-        text and exits.</para></listitem>
-      </varlistentry>
-
-      <varlistentry>
-        <term><option>--version</option></term>
-
-        <listitem><para>Prints a short version
-        string and exits.</para></listitem>
-      </varlistentry>
-
       <varlistentry>
         <term><option>--cert=</option></term>
 
@@ -114,6 +100,8 @@ along with systemd; If not, see <http://www.gnu.org/licenses/>.
         with <option>--cert=</option>.</para></listitem>
       </varlistentry>
 
+      <xi:include href="standard-options.xml" xpointer="help" />
+      <xi:include href="standard-options.xml" xpointer="version" />
     </variablelist>
   </refsect1>
 
@@ -124,13 +112,13 @@ along with systemd; If not, see <http://www.gnu.org/licenses/>.
 
     <variablelist>
       <varlistentry>
-        <term><option>/browse</option></term>
+        <term><uri>/browse</uri></term>
 
         <listitem><para>Interactive browsing.</para></listitem>
       </varlistentry>
 
       <varlistentry>
-        <term><option>/entries[?option1&amp;option2=value...]</option></term>
+        <term><uri>/entries[?option1&amp;option2=value...]</uri></term>
 
         <listitem><para>Retrieval of events in various formats.</para>
 
@@ -149,25 +137,23 @@ along with systemd; If not, see <http://www.gnu.org/licenses/>.
       </varlistentry>
 
       <varlistentry>
-        <term><option>/machine</option></term>
+        <term><uri>/machine</uri></term>
 
         <listitem><para>Return a JSON structure describing the machine.</para>
 
         <para>Example:
-        <programlisting>
-{ "machine_id" : "8cf7ed9d451ea194b77a9f118f3dc446",
+        <programlisting>{ "machine_id" : "8cf7ed9d451ea194b77a9f118f3dc446",
   "boot_id" : "3d3c9efaf556496a9b04259ee35df7f7",
   "hostname" : "fedora",
   "os_pretty_name" : "Fedora 19 (Rawhide)",
   "virtualization" : "kvm",
-  ...}
-        </programlisting>
+  ...}</programlisting>
         </para>
         </listitem>
       </varlistentry>
 
       <varlistentry>
-        <term><option>/fields/</option><replaceable>FIELD_NAME</replaceable></term>
+        <term><uri>/fields/<replaceable>FIELD_NAME</replaceable></uri></term>
 
         <listitem><para>Return a list of values of this field present in the logs.</para>
         </listitem>
@@ -179,14 +165,14 @@ along with systemd; If not, see <http://www.gnu.org/licenses/>.
     <title>Accept header</title>
 
     <para>
-      <option>Accept: </option><replaceable>format</replaceable>
+      <option>Accept: <replaceable>format</replaceable></option>
     </para>
 
     <para>Recognized formats:</para>
 
     <variablelist>
       <varlistentry>
-        <term><option>text/plain</option></term>
+        <term><constant>text/plain</constant></term>
 
         <listitem><para>The default. Plaintext syslog-like output,
         one line per journal entry
@@ -195,7 +181,7 @@ along with systemd; If not, see <http://www.gnu.org/licenses/>.
       </varlistentry>
 
       <varlistentry>
-        <term><option>application/json</option></term>
+        <term><constant>application/json</constant></term>
 
         <listitem><para>Entries are formatted as JSON data structures,
         one per line
@@ -207,7 +193,7 @@ along with systemd; If not, see <http://www.gnu.org/licenses/>.
       </varlistentry>
 
       <varlistentry>
-        <term><option>application/event-stream</option></term>
+        <term><constant>application/event-stream</constant></term>
 
         <listitem><para>Entries are formatted as JSON data structures,
         wrapped in a format suitable for <ulink
@@ -219,7 +205,7 @@ along with systemd; If not, see <http://www.gnu.org/licenses/>.
       </varlistentry>
 
       <varlistentry>
-        <term><option>application/vnd.fdo.journal</option></term>
+        <term><constant>application/vnd.fdo.journal</constant></term>
 
         <listitem><para>Entries are serialized into a binary (but
         mostly text-based) stream suitable for backups and network
@@ -237,7 +223,7 @@ along with systemd; If not, see <http://www.gnu.org/licenses/>.
     <title>Range header</title>
 
     <para>
-      <option>Range: entries=&lt;cursor&gt;[[:&lt;num_skip&gt;]:&lt;num_entries&gt;]</option>
+      <option>Range: entries=<replaceable>cursor</replaceable>[[:<replaceable>num_skip</replaceable>]:<replaceable>num_entries</replaceable>]</option>
     </para>
 
     <para>where
@@ -256,7 +242,7 @@ along with systemd; If not, see <http://www.gnu.org/licenses/>.
 
     <variablelist>
       <varlistentry>
-        <term><option>follow</option></term>
+        <term><uri>follow</uri></term>
 
         <listitem><para>wait for new events
         (like <command>journalctl --follow</command>, except that
@@ -265,7 +251,7 @@ along with systemd; If not, see <http://www.gnu.org/licenses/>.
       </varlistentry>
 
       <varlistentry>
-        <term><option>discrete</option></term>
+        <term><uri>discrete</uri></term>
 
         <listitem><para>Test that the specified cursor refers to an
         entry in the journal. Returns just this entry.</para>
@@ -273,14 +259,14 @@ along with systemd; If not, see <http://www.gnu.org/licenses/>.
       </varlistentry>
 
       <varlistentry>
-        <term><option>boot</option></term>
+        <term><uri>boot</uri></term>
 
         <listitem><para>Limit events to the current boot of the system
         (like <command>journalctl --this--boot</command>).</para></listitem>
       </varlistentry>
 
       <varlistentry>
-        <term><option>&lt;KEY&gt;=&lt;match&gt;</option></term>
+        <term><uri><replaceable>KEY</replaceable>=<replaceable>match</replaceable></uri></term>
 
         <listitem><para>Match journal fields. See
         <citerefentry><refentrytitle>systemd.journal-fields</refentrytitle><manvolnum>7</manvolnum></citerefentry>.</para>
@@ -295,16 +281,12 @@ along with systemd; If not, see <http://www.gnu.org/licenses/>.
     in <ulink
     url="http://www.freedesktop.org/wiki/Software/systemd/export">Journal
     Export Format</ulink>:
-    <programlisting>
-curl --silent -H'Accept: application/vnd.fdo.journal' \
-       'http://localhost:19531/entries?boot'
-    </programlisting>
+    <programlisting>curl --silent -H'Accept: application/vnd.fdo.journal' \
+       'http://localhost:19531/entries?boot'</programlisting>
     </para>
 
     <para>Listen for core dumps:
-    <programlisting>
-curl 'http://localhost:19531/entries?follow&amp;MESSAGE_ID=fc2e22bc6ee647b6b90729ab34a250b1'
-    </programlisting></para>
+    <programlisting>curl 'http://localhost:19531/entries?follow&amp;MESSAGE_ID=fc2e22bc6ee647b6b90729ab34a250b1'</programlisting></para>
   </refsect1>
 
   <refsect1>
Unnamed repository; edit this file 'description' to name the repository.