From: Yu Watanabe <watanabe.yu+github@gmail.com>
Date: Sun, 27 Aug 2017 07:20:12 +0000 (+0900)
Subject: man: journal-remote: active mode without --url option requires output filename
X-Git-Tag: v235~219^2~1
X-Git-Url: http://git.ipfire.org/gitweb.cgi?a=commitdiff_plain;h=c298b083c652f84a08f67d314ffff8ac92f6188c;p=thirdparty%2Fsystemd.git

man: journal-remote: active mode without --url option requires output filename

Closes #6675.
---

diff --git a/man/systemd-journal-remote.xml b/man/systemd-journal-remote.xml
index d7750e416eb..d37b9b20210 100644
--- a/man/systemd-journal-remote.xml
+++ b/man/systemd-journal-remote.xml
@@ -106,6 +106,8 @@
 
     <variablelist>
       <varlistentry>
+        <term><arg choice="opt" rep="repeat">SOURCES</arg></term>
+
         <listitem><para>When <option>-</option> is given as a
         positional argument, events will be read from standard input.
         Other positional arguments will be treated as filenames
@@ -124,6 +126,20 @@
         instance, e.g. http://some.host:19531/ or
         https://some.host:19531/.</para></listitem>
       </varlistentry>
+
+      <varlistentry>
+        <term><option>--getter='<replaceable>PROG</replaceable> <arg choice="opt" rep="repeat">OPTIONS</arg>'</option></term>
+
+        <listitem><para>Program to invoke to retrieve data. The journal
+        event stream must be generated on standard output.</para>
+
+        <para>Examples:</para>
+
+        <programlisting>--getter='curl "-HAccept: application/vnd.fdo.journal" https://some.host:19531/'</programlisting>
+
+        <programlisting>--getter='wget --header="Accept: application/vnd.fdo.journal" -O- https://some.host:19531/'</programlisting>
+        </listitem>
+      </varlistentry>
     </variablelist>
 
     <para>Passive sources can be specified in the following
@@ -225,8 +241,9 @@
     escaped hostname of the source endpoint of the connection, or the
     numerical address if the hostname cannot be determined.</para>
 
-    <para>In case of "active" sources, the output file name must
-    always be given explicitly.</para>
+    <para>In the case that "active" sources are given by the positional
+    arguments or <option>--getter=</option> option, the output file name
+    must always be given explicitly.</para>
   </refsect1>
 
   <refsect1>
@@ -265,20 +282,6 @@
         The default is <literal>no</literal>.</para></listitem>
       </varlistentry>
 
-      <varlistentry>
-        <term><option>--getter=<replaceable>PROG --option1 --option2</replaceable></option></term>
-
-        <listitem><para>Program to invoke to retrieve data. The journal
-        event stream must be generated on standard output.</para>
-
-        <para>Examples:</para>
-
-        <programlisting>--getter='curl "-HAccept: application/vnd.fdo.journal" https://some.host:19531/'</programlisting>
-
-        <programlisting>--getter='wget --header="Accept: application/vnd.fdo.journal" -O- https://some.host:19531/'</programlisting>
-        </listitem>
-      </varlistentry>
-
       <xi:include href="standard-options.xml" xpointer="help" />
       <xi:include href="standard-options.xml" xpointer="version" />
     </variablelist>
@@ -288,7 +291,7 @@
     <title>Examples</title>
     <para>Copy local journal events to a different journal directory:
     <programlisting>
-journalctl -o export | systemd-journal-remote -o /tmp/dir -
+journalctl -o export | systemd-journal-remote -o /tmp/dir/foo.journal -
     </programlisting>
     </para>