Mercurial > projects > relmon
diff relmon.1.xml @ 5:86a0c5d11f05 version-1
Add discover subcommand
The discover subcommand assists with the creation of watchlist entries and
allows to reproduce each step of an update operation for a watchlist entry.
author | Guido Berhoerster <guido+relmon@berhoerster.name> |
---|---|
date | Sun, 26 Oct 2014 21:36:05 +0100 |
parents | f28486666a4f |
children |
line wrap: on
line diff
--- a/relmon.1.xml Fri Oct 24 22:44:39 2014 +0200 +++ b/relmon.1.xml Sun Oct 26 21:36:05 2014 +0100 @@ -150,6 +150,42 @@ </arg> </cmdsynopsis> <cmdsynopsis> + <command>relmon discover</command> + <arg choice="opt"> + <option>-d</option> + </arg> + <arg choice="opt"> + <option>-c</option> + <replaceable>max_connections</replaceable> + </arg> + <arg choice="opt"> + <option>-C</option> + <replaceable>ca_dir</replaceable> + </arg> + <arg choice="opt"> + <option>-D</option> + <replaceable>delay</replaceable> + </arg> + <arg choice="opt"> + <option>-H</option> + <replaceable>max_host_connections</replaceable> + </arg> + <arg choice="opt"> + <option>-r</option> + <replaceable>retries</replaceable> + </arg> + <arg choice="opt"> + <option>-t</option> + <replaceable>min_time</replaceable> + </arg> + <arg choice="plain"> + <replaceable>base_url</replaceable> + </arg> + <arg choice="opt"> + <replaceable>pattern</replaceable> + </arg> + </cmdsynopsis> + <cmdsynopsis> <command>relmon help</command> <arg choice="opt"> <replaceable>subcommand</replaceable> @@ -396,6 +432,97 @@ </varlistentry> <varlistentry> <term> + <command>discover</command> + </term> + <listitem> + <para>The <command>discover</command> subcommand assists with the + creation of watchlist entries. The arguments to the + <command>discover</command> subcommand correspond to the fields + of a watchlist entry without the name field, see + <citerefentry><refentrytitle>relmon_format</refentrytitle> + <manvolnum>4</manvolnum></citerefentry> for details on the + format. Only the <replaceable>base_url</replaceable> is mandatory + and <command>relmon</command> will log all matching and + non-matching links of each retrieved document or feed so that + each step of an update operation for a watchlist entry can be + reproduced.</para> + <para>The following options are supported:</para> + <variablelist> + <varlistentry> + <term> + <option>-d</option> + </term> + <listitem> + <para>Trace and log all transfers and parsing. This option is + used for debugging purposes.</para> + </listitem> + </varlistentry> + <varlistentry> + <term> + <option>-c</option> + <replaceable>max_connections</replaceable> + </term> + <listitem> + <para>Limit the number of simultaneous connections to the + specified number.</para> + </listitem> + </varlistentry> + <varlistentry> + <term> + <option>-C</option> + <replaceable>ca_dir</replaceable> + </term> + <listitem> + <para>Verify the validity of TLS certificates using the CA + certificates in the specified directory.</para> + </listitem> + </varlistentry> + <varlistentry> + <term> + <option>-D</option> + <replaceable>delay</replaceable> + </term> + <listitem> + <para>Wait at least the specified number of seconds before + making subsequent connections to the same host.</para> + </listitem> + </varlistentry> + <varlistentry> + <term> + <option>-H</option> + <replaceable>max_host_connections</replaceable> + </term> + <listitem> + <para>Limit the number of simultaneous connections to a single + host to the specified number.</para> + </listitem> + </varlistentry> + <varlistentry> + <term> + <option>-r</option> + <replaceable>retries</replaceable> + </term> + <listitem> + <para>Limit the number of retries in case of connection + failures.</para> + </listitem> + </varlistentry> + <varlistentry> + <term> + <option>-t</option> + <replaceable>min_time</replaceable> + </term> + <listitem> + <para>Only update version information for projects from the + watchlist which have not been updated for the specified + number of seconds.</para> + </listitem> + </varlistentry> + </variablelist> + </listitem> + </varlistentry> + <varlistentry> + <term> <command>help</command> </term> <listitem> @@ -409,6 +536,20 @@ <refsect1> <title>Examples</title> <example> + <title>Creating a new watchlist entry</title> + <para>The following command displays all links found in the HTML document + at <uri>http://example.net/foo/</uri>:</para> + <screen> +$ relmon discover http://example.net/foo/ + </screen> + <para>The following command tests whether the specified version-matching + regular expression matches the distribution file linked from + <uri>http://example.net/foo/</uri>:</para> + <screen> +$ relmon discover http://example.net/foo/ '/foo-([[:digit:].]+)\.tar\.gz' + </screen> + </example> + <example> <title>Updating version information</title> <para>The following command retrieves the version information for the entries in the watchlist <filename>foo.watchlist</filename> and stores