doc-en/language/context/ftp.xml at master · php/doc-en · GitHub

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
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->

<refentry xml:id="context.ftp" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" annotations="verify_info:false" role="stream_context_option">
 <refnamediv>
  <refname>FTP context options</refname>
  <refpurpose>FTP context option listing</refpurpose>
 </refnamediv>

 <refsect1 role="description">
  &reftitle.description;
  <para>
   Context options for <literal>ftp://</literal> and <literal>ftps://</literal>
   transports.
  </para>
 </refsect1>

 <refsect1 role="options">
  &reftitle.options;
  <para>
   <variablelist>
    <varlistentry xml:id="context.ftp.overwrite">
     <term>
      <parameter>overwrite</parameter>
      <type>bool</type>
     </term>
     <listitem>
      <para>
       Allow overwriting of already existing files on remote server.
       Applies to write mode (uploading) only.
      </para>
      <para>
       Defaults to &false;.
      </para>
     </listitem>
    </varlistentry>
    <varlistentry xml:id="context.ftp.resume-pos">
     <term>
      <parameter>resume_pos</parameter>
      <type>int</type>
     </term>
     <listitem>
      <para>
       File offset at which to begin transfer. Applies to read mode (downloading) only.
      </para>
      <para>
       Defaults to <literal>0</literal> (Beginning of File).
      </para>
     </listitem>
    </varlistentry>
    <varlistentry xml:id="context.ftp.proxy">
     <term>
      <parameter>proxy</parameter>
      <type>string</type>
     </term>
     <listitem>
      <para>
       Proxy FTP request via http proxy server. Applies to file read
       operations only. Ex: <literal>tcp://squid.example.com:8000</literal>.
      </para>
     </listitem>
    </varlistentry>
   </variablelist>
  </para>
 </refsect1>

 <refsect1 role="notes">
  &reftitle.notes;
  <note>
   <title>Underlying socket stream context options</title>
   <simpara>
    Additional context options may be supported by the
    <link linkend="transports.inet">underlying transport</link>.
    For <literal>ftp://</literal> streams, refer to context
    options for the <literal>tcp://</literal> transport.  For
    <literal>ftps://</literal> streams, refer to context options
    for the <literal>ssl://</literal> transport.
   </simpara>
  </note>
 </refsect1>

 <refsect1 role="seealso">
  &reftitle.seealso;
  <para>
   <simplelist>
    <member><xref linkend="wrappers.ftp" /></member>
    <member><xref linkend="context.socket" /></member>
    <member><xref linkend="context.ssl" /></member>
   </simplelist>
  </para>
 </refsect1>

</refentry>

<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
sgml-omittag:t
sgml-shorttag:t
sgml-minimize-attributes:nil
sgml-always-quote-attributes:t
sgml-indent-step:1
sgml-indent-data:t
indent-tabs-mode:nil
sgml-parent-document:nil
sgml-default-dtd-file:"~/.phpdoc/manual.ced"
sgml-exposed-tags:nil
sgml-local-catalogs:nil
sgml-local-ecat-files:nil
End:
vim600: syn=xml fen fdm=syntax fdl=2 si
vim: et tw=78 syn=sgml
vi: ts=1 sw=1
-->