Mercurial > projects > relmon

comparison relmon.1.xml @ 5:86a0c5d11f05 version-1

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
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
comparison
equal deleted inserted replaced
4:f28486666a4f 5:86a0c5d11f05
148 <arg choice="plain"> 148 <arg choice="plain">
149 <replaceable>statefile</replaceable> 149 <replaceable>statefile</replaceable>
150 </arg> 150 </arg>
151 </cmdsynopsis> 151 </cmdsynopsis>
152 <cmdsynopsis> 152 <cmdsynopsis>
153 <command>relmon discover</command>
154 <arg choice="opt">
155 <option>-d</option>
156 </arg>
157 <arg choice="opt">
158 <option>-c</option>
159 <replaceable>max_connections</replaceable>
160 </arg>
161 <arg choice="opt">
162 <option>-C</option>
163 <replaceable>ca_dir</replaceable>
164 </arg>
165 <arg choice="opt">
166 <option>-D</option>
167 <replaceable>delay</replaceable>
168 </arg>
169 <arg choice="opt">
170 <option>-H</option>
171 <replaceable>max_host_connections</replaceable>
172 </arg>
173 <arg choice="opt">
174 <option>-r</option>
175 <replaceable>retries</replaceable>
176 </arg>
177 <arg choice="opt">
178 <option>-t</option>
179 <replaceable>min_time</replaceable>
180 </arg>
181 <arg choice="plain">
182 <replaceable>base_url</replaceable>
183 </arg>
184 <arg choice="opt">
185 <replaceable>pattern</replaceable>
186 </arg>
187 </cmdsynopsis>
188 <cmdsynopsis>
153 <command>relmon help</command> 189 <command>relmon help</command>
154 <arg choice="opt"> 190 <arg choice="opt">
155 <replaceable>subcommand</replaceable> 191 <replaceable>subcommand</replaceable>
156 </arg> 192 </arg>
157 </cmdsynopsis> 193 </cmdsynopsis>
394 </variablelist> 430 </variablelist>
395 </listitem> 431 </listitem>
396 </varlistentry> 432 </varlistentry>
397 <varlistentry> 433 <varlistentry>
398 <term> 434 <term>
435 <command>discover</command>
436 </term>
437 <listitem>
438 <para>The <command>discover</command> subcommand assists with the
439 creation of watchlist entries. The arguments to the
440 <command>discover</command> subcommand correspond to the fields
441 of a watchlist entry without the name field, see
442 <citerefentry><refentrytitle>relmon_format</refentrytitle>
443 <manvolnum>4</manvolnum></citerefentry> for details on the
444 format. Only the <replaceable>base_url</replaceable> is mandatory
445 and <command>relmon</command> will log all matching and
446 non-matching links of each retrieved document or feed so that
447 each step of an update operation for a watchlist entry can be
448 reproduced.</para>
449 <para>The following options are supported:</para>
450 <variablelist>
451 <varlistentry>
452 <term>
453 <option>-d</option>
454 </term>
455 <listitem>
456 <para>Trace and log all transfers and parsing. This option is
457 used for debugging purposes.</para>
458 </listitem>
459 </varlistentry>
460 <varlistentry>
461 <term>
462 <option>-c</option>
463 <replaceable>max_connections</replaceable>
464 </term>
465 <listitem>
466 <para>Limit the number of simultaneous connections to the
467 specified number.</para>
468 </listitem>
469 </varlistentry>
470 <varlistentry>
471 <term>
472 <option>-C</option>
473 <replaceable>ca_dir</replaceable>
474 </term>
475 <listitem>
476 <para>Verify the validity of TLS certificates using the CA
477 certificates in the specified directory.</para>
478 </listitem>
479 </varlistentry>
480 <varlistentry>
481 <term>
482 <option>-D</option>
483 <replaceable>delay</replaceable>
484 </term>
485 <listitem>
486 <para>Wait at least the specified number of seconds before
487 making subsequent connections to the same host.</para>
488 </listitem>
489 </varlistentry>
490 <varlistentry>
491 <term>
492 <option>-H</option>
493 <replaceable>max_host_connections</replaceable>
494 </term>
495 <listitem>
496 <para>Limit the number of simultaneous connections to a single
497 host to the specified number.</para>
498 </listitem>
499 </varlistentry>
500 <varlistentry>
501 <term>
502 <option>-r</option>
503 <replaceable>retries</replaceable>
504 </term>
505 <listitem>
506 <para>Limit the number of retries in case of connection
507 failures.</para>
508 </listitem>
509 </varlistentry>
510 <varlistentry>
511 <term>
512 <option>-t</option>
513 <replaceable>min_time</replaceable>
514 </term>
515 <listitem>
516 <para>Only update version information for projects from the
517 watchlist which have not been updated for the specified
518 number of seconds.</para>
519 </listitem>
520 </varlistentry>
521 </variablelist>
522 </listitem>
523 </varlistentry>
524 <varlistentry>
525 <term>
399 <command>help</command> 526 <command>help</command>
400 </term> 527 </term>
401 <listitem> 528 <listitem>
402 <para>The <command>help</command> subcommand displays usage 529 <para>The <command>help</command> subcommand displays usage
403 information about the specified subcommand or all subcommands and 530 information about the specified subcommand or all subcommands and
406 </varlistentry> 533 </varlistentry>
407 </variablelist> 534 </variablelist>
408 </refsect1> 535 </refsect1>
409 <refsect1> 536 <refsect1>
410 <title>Examples</title> 537 <title>Examples</title>
538 <example>
539 <title>Creating a new watchlist entry</title>
540 <para>The following command displays all links found in the HTML document
541 at <uri>http://example.net/foo/</uri>:</para>
542 <screen>
543 $ relmon discover http://example.net/foo/
544 </screen>
545 <para>The following command tests whether the specified version-matching
546 regular expression matches the distribution file linked from
547 <uri>http://example.net/foo/</uri>:</para>
548 <screen>
549 $ relmon discover http://example.net/foo/ '/foo-([[:digit:].]+)\.tar\.gz'
550 </screen>
551 </example>
411 <example> 552 <example>
412 <title>Updating version information</title> 553 <title>Updating version information</title>
413 <para>The following command retrieves the version information for the 554 <para>The following command retrieves the version information for the
414 entries in the watchlist <filename>foo.watchlist</filename> and stores 555 entries in the watchlist <filename>foo.watchlist</filename> and stores
415 the results in the statefile <filename>foo.json</filename> using using 556 the results in the statefile <filename>foo.json</filename> using using