File: yaz-url-man.xml

package info (click to toggle)
yaz 5.27.1-2
  • links: PTS, VCS
  • area: main
  • in suites: buster
  • size: 16,184 kB
  • sloc: xml: 123,414; ansic: 72,530; sh: 5,007; tcl: 2,169; makefile: 1,321; yacc: 382
file content (140 lines) | stat: -rw-r--r-- 3,922 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook V4.4//EN"
 "http://www.oasis-open.org/docbook/xml/4.4/docbookx.dtd"
[
     <!ENTITY % local SYSTEM "local.ent">
     %local;
     <!ENTITY % entities SYSTEM "entities.ent">
     %entities;
     <!ENTITY % idcommon SYSTEM "common/common.ent">
     %idcommon;
]>
<refentry id="yaz-url">
 <refentryinfo>
  <productname>YAZ</productname>
  <productnumber>&version;</productnumber>
  <orgname>Index Data</orgname>
 </refentryinfo>

 <refmeta>
  <refentrytitle>yaz-url</refentrytitle>
  <manvolnum>1</manvolnum>
  <refmiscinfo class="manual">Commands</refmiscinfo>
 </refmeta>

 <refnamediv>
  <refname>yaz-url</refname>
  <refpurpose>YAZ URL fetch utility</refpurpose>
 </refnamediv>

 <refsynopsisdiv>
  <cmdsynopsis>
   <command>yaz-url</command>
   <arg>-H <replaceable>name:value</replaceable></arg>
   <arg>-m <replaceable>method</replaceable></arg>
   <arg>-O <replaceable>fname</replaceable></arg>
   <arg>-p <replaceable>fname</replaceable></arg>
   <arg>-R <replaceable>num</replaceable></arg>
   <arg>-u <replaceable>user/password</replaceable></arg>
   <arg>-v</arg>
   <arg>-x <replaceable>proxy</replaceable></arg>
   <arg rep="repeat">url</arg>
  </cmdsynopsis>
 </refsynopsisdiv>

 <refsect1><title>DESCRIPTION</title>
  <para>
   <command>yaz-url</command> is utility to get web content. It is very
   limited in functionality compared to programs such as curl, wget.
  </para>
  <para>
   The options must precede the URL given on the command line, to take
   effect.
  </para>
  <para>
   Fetched HTTP content is written to stdout, unless option -O is given.
  </para>
 </refsect1>

 <refsect1><title>OPTIONS</title>
  <variablelist>
   <varlistentry>
    <term>-H <replaceable>name:value</replaceable></term>
    <listitem><para>
      Specifies HTTP header content with name and value. This
      option can be given multiple times (for different names,
      of course).
     </para></listitem>
   </varlistentry>

   <varlistentry>
    <term>-m <replaceable>method</replaceable></term>
    <listitem><para>
      Specifies the HTTP method to be used for the next URL.
      Default is method "GET". However, option -p sets it to "POST".
     </para></listitem>
   </varlistentry>

   <varlistentry>
    <term>-O <replaceable>fname</replaceable></term>
    <listitem><para>
      Sets output filename for HTTP content.
     </para></listitem>
   </varlistentry>

   <varlistentry>
    <term>-p <replaceable>fname</replaceable></term>
    <listitem><para>
      Sets a file to be POSTed in the folloing URL.
     </para></listitem>
   </varlistentry>

   <varlistentry>
    <term>-R <replaceable>num</replaceable></term>
    <listitem><para>
      Sets maximum number of HTTP redirects to be followed.
      A value of zero disables follow of HTTP redirects.
     </para></listitem>
   </varlistentry>

   <varlistentry>
    <term>-u <replaceable>user/password</replaceable></term>
    <listitem><para>
      Specifies a user and a password to be uesd in HTTP
      basic authentication in the following URL fetch. The user
      and password must be separated by a slash (thus it is not
      possible to specify a user with a slash in it).
     </para></listitem>
   </varlistentry>

   <varlistentry>
    <term>-v</term>
    <listitem><para>
      Makes yaz-url dump each HTTP request/response to stdout.
     </para></listitem>
   </varlistentry>

   <varlistentry>
    <term>-x <replaceable>proxy</replaceable></term>
    <listitem><para>
      Specifies a proxy to be used for URL fetch.
     </para></listitem>
   </varlistentry>

  </variablelist>
 </refsect1>
 <refsect1><title>SEE ALSO</title>
  <para>
   <citerefentry>
    <refentrytitle>yaz</refentrytitle>
    <manvolnum>7</manvolnum>
   </citerefentry>
  </para>
 </refsect1>
</refentry>

<!-- Keep this comment at the end of the file
Local variables:
mode: nxml
nxml-child-indent: 1
End:
-->