X-Git-Url: http://www.chiark.greenend.org.uk/ucgi/~ianmdlvl/git?p=elogind.git;a=blobdiff_plain;f=man%2Fsystemd-journal-gatewayd.service.xml;h=01b2552015300f8a11e1ba8ad5260ba5426a039e;hp=562d22186b732da3ab4f3d5f0b14f4c730f87cc5;hb=edf2573743b25273bee020230a60f1a054b8ec60;hpb=f274ece0f76b5709408821e317e87aef76123db6

diff --git a/man/systemd-journal-gatewayd.service.xml b/man/systemd-journal-gatewayd.service.xml
index 562d22186..01b255201 100644
--- a/man/systemd-journal-gatewayd.service.xml
+++ b/man/systemd-journal-gatewayd.service.xml
@@ -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>
@@ -52,7 +53,9 @@ along with systemd; If not, see <http://www.gnu.org/licenses/>.
   <refsynopsisdiv>
     <para><filename>systemd-journal-gatewayd.service</filename></para>
     <para><filename>systemd-journal-gatewayd.socket</filename></para>
-    <cmdsynopsis><command>/usr/lib/systemd/systemd-journal-gatewayd</command>
+    <cmdsynopsis>
+      <command>/usr/lib/systemd/systemd-journal-gatewayd</command>
+      <arg choice="opt" rep="repeat">OPTIONS</arg>
     </cmdsynopsis>
   </refsynopsisdiv>
 
@@ -61,7 +64,9 @@ along with systemd; If not, see <http://www.gnu.org/licenses/>.
 
     <para><command>systemd-journal-gatewayd</command> serves journal
     events over the network. Clients must connect using
-    HTTP. The server listens on port 19531 by default.</para>
+    HTTP. The server listens on port 19531 by default.
+    If <option>--cert=</option> is specified, the server expects
+    HTTPS connections.</para>
 
     <para>The program is started by
     <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>
@@ -71,6 +76,35 @@ along with systemd; If not, see <http://www.gnu.org/licenses/>.
     to have it started on boot.</para>
   </refsect1>
 
+  <refsect1>
+    <title>Options</title>
+
+    <para>The following options are understood:</para>
+
+    <variablelist>
+      <varlistentry>
+        <term><option>--cert=</option></term>
+
+        <listitem><para>Specify the path to a file containing a server
+        certificate in PEM format. This option switches
+        <command>systemd-journal-gatewayd</command> into HTTPS mode
+        and must be used together with
+        <option>--key=</option>.</para></listitem>
+      </varlistentry>
+
+      <varlistentry>
+        <term><option>--key=</option></term>
+
+        <listitem><para>Specify the path to a file containing a server
+        key in PEM format corresponding to the certificate specified
+        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>
+
   <refsect1>
     <title>Supported URLs</title>
 
@@ -78,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>
 
@@ -103,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>
@@ -133,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
@@ -149,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
@@ -161,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
@@ -173,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
@@ -191,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
@@ -210,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
@@ -219,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>
@@ -227,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>
@@ -249,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>