doc/yaz-url-man.xml

   1 <!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook V4.4//EN"
   2  "http://www.oasis-open.org/docbook/xml/4.4/docbookx.dtd"
   3 [
   4      <!ENTITY % local SYSTEM "local.ent">
   5      %local;
   6      <!ENTITY % entities SYSTEM "entities.ent">
   7      %entities;
   8      <!ENTITY % idcommon SYSTEM "common/common.ent">
   9      %idcommon;
  10 ]>
  11 <refentry id="yaz-url">
  12  <refentryinfo>
  13   <productname>YAZ</productname>
  14   <productnumber>&version;</productnumber>
  15   <info><orgname>Index Data</orgname></info>
  16  </refentryinfo>
  17
  18  <refmeta>
  19   <refentrytitle>yaz-url</refentrytitle>
  20   <manvolnum>1</manvolnum>
  21   <refmiscinfo class="manual">Commands</refmiscinfo>
  22  </refmeta>
  23
  24  <refnamediv>
  25   <refname>yaz-url</refname>
  26   <refpurpose>YAZ URL fetch utility</refpurpose>
  27  </refnamediv>
  28
  29  <refsynopsisdiv>
  30   <cmdsynopsis>
  31    <command>yaz-url</command>
  32    <arg>-H <replaceable>name:value</replaceable></arg>
  33    <arg>-m <replaceable>method</replaceable></arg>
  34    <arg>-O <replaceable>fname</replaceable></arg>
  35    <arg>-p <replaceable>fname</replaceable></arg>
  36    <arg>-R <replaceable>num</replaceable></arg>
  37    <arg>-u <replaceable>user/password</replaceable></arg>
  38    <arg>-v</arg>
  39    <arg>-x <replaceable>proxy</replaceable></arg>
  40    <arg rep="repeat">url</arg>
  41   </cmdsynopsis>
  42  </refsynopsisdiv>
  43
  44  <refsect1><title>DESCRIPTION</title>
  45   <para>
  46    <command>yaz-url</command> is utility to get web content. It is very
  47    limited in functionality compared to programs such as curl, wget.
  48   </para>
  49   <para>
  50    The options must be precede the URL given on the command line to take
  51    effect.
  52   </para>
  53   <para>
  54    Fetched HTTP content is written to stdout, unless option -O is given.
  55   </para>
  56  </refsect1>
  57
  58  <refsect1><title>OPTIONS</title>
  59   <variablelist>
  60    <varlistentry>
  61     <term>-H <replaceable>name:value</replaceable></term>
  62     <listitem><para>
  63       Specifies HTTP header content with name and value. This
  64       option can be given multiple times (for different names,
  65       of course).
  66      </para></listitem>
  67    </varlistentry>
  68
  69    <varlistentry>
  70     <term>-m <replaceable>method</replaceable></term>
  71     <listitem><para>
  72       Specifies the HTTP method to be used for the next URL.
  73       Default is method "GET". However, option -p sets it to "POST".
  74      </para></listitem>
  75    </varlistentry>
  76
  77    <varlistentry>
  78     <term>-O <replaceable>fname</replaceable></term>
  79     <listitem><para>
  80       Sets output filename for HTTP content.
  81      </para></listitem>
  82    </varlistentry>
  83
  84    <varlistentry>
  85     <term>-p <replaceable>fname</replaceable></term>
  86     <listitem><para>
  87       Sets a file to be POSTed in the folloing URL.
  88      </para></listitem>
  89    </varlistentry>
  90
  91    <varlistentry>
  92     <term>-R <replaceable>num</replaceable></term>
  93     <listitem><para>
  94       Sets maximum number of HTTP redirects to be followed.
  95       A value of zero disables follow of HTTP redirects.
  96      </para></listitem>
  97    </varlistentry>
  98
  99    <varlistentry>
 100     <term>-u <replaceable>user/password</replaceable></term>
 101     <listitem><para>
 102       Specifies a user and a password to be uesd in HTTP
 103       basic authentication in the following URL fetch. The user
 104       and password must be separated by a slash (this it is not
 105       possible to specify a user with a slash in it).
 106      </para></listitem>
 107    </varlistentry>
 108
 109    <varlistentry>
 110     <term>-v</term>
 111     <listitem><para>
 112       Makes yaz-url dump each HTTP request/response to stdout.
 113      </para></listitem>
 114    </varlistentry>
 115
 116    <varlistentry>
 117     <term>-x <replaceable>proxy</replaceable></term>
 118     <listitem><para>
 119       Specifies a proxy to be used for URL fetch.
 120      </para></listitem>
 121    </varlistentry>
 122
 123   </variablelist>
 124  </refsect1>
 125  <refsect1><title>SEE ALSO</title>
 126   <para>
 127    <citerefentry>
 128     <refentrytitle>yaz</refentrytitle>
 129     <manvolnum>7</manvolnum>
 130    </citerefentry>
 131   </para>
 132  </refsect1>
 133 </refentry>
 134
 135 <!-- Keep this comment at the end of the file
 136 Local variables:
 137 mode: nxml
 138 nxml-child-indent: 1
 139 End:
 140 -->