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>-u <replaceable>user/password</replaceable></arg>
  37    <arg>-x <replaceable>proxy</replaceable></arg>
  38    <arg rep="repeat">url</arg>
  39   </cmdsynopsis>
  40  </refsynopsisdiv>
  41
  42  <refsect1><title>DESCRIPTION</title>
  43   <para>
  44    <command>yaz-url</command> is utility to get web content. It is very
  45    limited in functionality compared to programs such as curl, wget.
  46   </para>
  47   <para>
  48    The options must be precede the URL given on the command line to take
  49    effect.
  50   </para>
  51   <para>
  52    Fetched HTTP content is written to stdout, unless option -O is given.
  53   </para>
  54  </refsect1>
  55
  56  <refsect1><title>OPTIONS</title>
  57   <variablelist>
  58    <varlistentry>
  59     <term>-H <replaceable>name:value</replaceable></term>
  60     <listitem><para>
  61       Specifies HTTP header content with name and value. This
  62       option can be given multiple times (for different names,
  63       of course).
  64      </para></listitem>
  65    </varlistentry>
  66
  67    <varlistentry>
  68     <term>-m <replaceable>method</replaceable></term>
  69     <listitem><para>
  70       Specifies the HTTP method to be used for the next URL.
  71       Default is method "GET". However, option -p sets it to "POST".
  72      </para></listitem>
  73    </varlistentry>
  74
  75    <varlistentry>
  76     <term>-O <replaceable>fname</replaceable></term>
  77     <listitem><para>
  78       Sets output filename for HTTP content.
  79      </para></listitem>
  80    </varlistentry>
  81
  82    <varlistentry>
  83     <term>-p <replaceable>fname</replaceable></term>
  84     <listitem><para>
  85       Sets a file to be POSTed in the folloing URL.
  86      </para></listitem>
  87    </varlistentry>
  88
  89    <varlistentry>
  90     <term>-u <replaceable>user/password</replaceable></term>
  91     <listitem><para>
  92       Specifies a user and a password to be uesd in HTTP
  93       basic authentication in the following URL fetch. The user
  94       and password must be separated by a slash (this it is not
  95       possible to specify a user with a slash in it).
  96      </para></listitem>
  97    </varlistentry>
  98
  99    <varlistentry>
 100     <term>-x <replaceable>proxy</replaceable></term>
 101     <listitem><para>
 102       Specifies a proxy to be used for URL fetch.
 103      </para></listitem>
 104    </varlistentry>
 105
 106   </variablelist>
 107  </refsect1>
 108  <refsect1><title>SEE ALSO</title>
 109   <para>
 110    <citerefentry>
 111     <refentrytitle>yaz</refentrytitle>
 112     <manvolnum>7</manvolnum>
 113    </citerefentry>
 114   </para>
 115  </refsect1>
 116 </refentry>
 117
 118 <!-- Keep this comment at the end of the file
 119 Local variables:
 120 mode: sgml
 121 sgml-omittag:t
 122 sgml-shorttag:t
 123 sgml-minimize-attributes:nil
 124 sgml-always-quote-attributes:t
 125 sgml-indent-step:1
 126 sgml-indent-data:t
 127 sgml-parent-document:nil
 128 sgml-local-catalogs: nil
 129 sgml-namecase-general:t
 130 End:
 131 -->