ruby-web 1.1.1

Sign up to get free protection for your applications and to get access to all the features.
Files changed (190) hide show
  1. data/ChangeLog +474 -0
  2. data/INSTALL.txt +9 -0
  3. data/InstalledFiles +180 -0
  4. data/LICENSE.txt +74 -0
  5. data/Rakefile +529 -0
  6. data/TODO +65 -0
  7. data/doc/additional.xml +149 -0
  8. data/doc/core.xml +652 -0
  9. data/doc/credits/index.xml +52 -0
  10. data/doc/credits/php.contributors.xml +118 -0
  11. data/doc/credits/php.language-snippets.ent +622 -0
  12. data/doc/install/index.xml +136 -0
  13. data/doc/install/mac/index.xml +21 -0
  14. data/doc/install/ruby-web.install.rb.instructions.xml +7 -0
  15. data/doc/install/unix/index.xml +46 -0
  16. data/doc/install/win/apache1.xml +166 -0
  17. data/doc/install/win/apache2.xml +141 -0
  18. data/doc/install/win/iis.xml +162 -0
  19. data/doc/install/win/index.xml +24 -0
  20. data/doc/install/win/installer.xml +31 -0
  21. data/doc/install/win/manual.xml +43 -0
  22. data/doc/manual.xml +69 -0
  23. data/doc/old/apache_cgi.txt +23 -0
  24. data/doc/old/fastcgi.txt +23 -0
  25. data/doc/old/mod_ruby.txt +21 -0
  26. data/doc/old/snippets.rdoc +183 -0
  27. data/doc/old/webrick.txt +23 -0
  28. data/doc/old/windows_cgi.txt +9 -0
  29. data/doc/tutorial.xml +14 -0
  30. data/doc/xsl/manual-multi.xsl +10 -0
  31. data/doc/xsl/manual-pdf.xsl +6 -0
  32. data/doc/xsl/manual-single.xsl +6 -0
  33. data/doc/xsl/manual.css +22 -0
  34. data/install.rb +1022 -0
  35. data/lib/formatter.rb +314 -0
  36. data/lib/html-parser.rb +429 -0
  37. data/lib/htmlrepair.rb +113 -0
  38. data/lib/htmlsplit.rb +842 -0
  39. data/lib/sgml-parser.rb +332 -0
  40. data/lib/web.rb +68 -0
  41. data/lib/web/assertinclude.rb +129 -0
  42. data/lib/web/config.rb +50 -0
  43. data/lib/web/connection.rb +1070 -0
  44. data/lib/web/convenience.rb +154 -0
  45. data/lib/web/formreader.rb +318 -0
  46. data/lib/web/htmlparser/html-parser.rb +429 -0
  47. data/lib/web/htmlparser/sgml-parser.rb +332 -0
  48. data/lib/web/htmltools/element.rb +296 -0
  49. data/lib/web/htmltools/stparser.rb +276 -0
  50. data/lib/web/htmltools/tags.rb +286 -0
  51. data/lib/web/htmltools/tree.rb +139 -0
  52. data/lib/web/htmltools/xmltree.rb +160 -0
  53. data/lib/web/htmltools/xpath.rb +71 -0
  54. data/lib/web/info.rb +63 -0
  55. data/lib/web/load.rb +210 -0
  56. data/lib/web/mime.rb +87 -0
  57. data/lib/web/phprb.rb +340 -0
  58. data/lib/web/resources/test/cookie.rb +33 -0
  59. data/lib/web/resources/test/counter.rb +20 -0
  60. data/lib/web/resources/test/multipart.rb +14 -0
  61. data/lib/web/resources/test/redirect.rb +8 -0
  62. data/lib/web/resources/test/stock.rb +33 -0
  63. data/lib/web/sapi/apache.rb +129 -0
  64. data/lib/web/sapi/fastcgi.rb +22 -0
  65. data/lib/web/sapi/install/apache.rb +180 -0
  66. data/lib/web/sapi/install/iis.rb +93 -0
  67. data/lib/web/sapi/install/macosx.rb +90 -0
  68. data/lib/web/sapi/webrick.rb +86 -0
  69. data/lib/web/session.rb +83 -0
  70. data/lib/web/shim/cgi.rb +129 -0
  71. data/lib/web/shim/rails.rb +175 -0
  72. data/lib/web/stringio.rb +78 -0
  73. data/lib/web/strscanparser.rb +24 -0
  74. data/lib/web/tagparser.rb +96 -0
  75. data/lib/web/testing.rb +666 -0
  76. data/lib/web/traceoutput.rb +75 -0
  77. data/lib/web/unit.rb +56 -0
  78. data/lib/web/upload.rb +59 -0
  79. data/lib/web/validate.rb +52 -0
  80. data/lib/web/wiki.rb +557 -0
  81. data/lib/web/wiki/linker.rb +72 -0
  82. data/lib/web/wiki/page.rb +201 -0
  83. data/lib/webunit.rb +27 -0
  84. data/lib/webunit/assert.rb +152 -0
  85. data/lib/webunit/converter.rb +154 -0
  86. data/lib/webunit/cookie.rb +118 -0
  87. data/lib/webunit/domwalker.rb +185 -0
  88. data/lib/webunit/exception.rb +14 -0
  89. data/lib/webunit/form.rb +116 -0
  90. data/lib/webunit/frame.rb +37 -0
  91. data/lib/webunit/htmlelem.rb +122 -0
  92. data/lib/webunit/image.rb +26 -0
  93. data/lib/webunit/jscript.rb +31 -0
  94. data/lib/webunit/link.rb +33 -0
  95. data/lib/webunit/params.rb +321 -0
  96. data/lib/webunit/parser.rb +229 -0
  97. data/lib/webunit/response.rb +464 -0
  98. data/lib/webunit/runtest.rb +41 -0
  99. data/lib/webunit/table.rb +148 -0
  100. data/lib/webunit/testcase.rb +45 -0
  101. data/lib/webunit/ui/cui/testrunner.rb +50 -0
  102. data/lib/webunit/utils.rb +68 -0
  103. data/lib/webunit/webunit.rb +28 -0
  104. data/test/dev/action.rb +83 -0
  105. data/test/dev/forms.rb +104 -0
  106. data/test/dev/forms2.rb +104 -0
  107. data/test/dev/parser.rb +17 -0
  108. data/test/dev/scripts/dump.rb +24 -0
  109. data/test/dev/scripts/makedist.rb +62 -0
  110. data/test/dev/scripts/uri.rb +41 -0
  111. data/test/dev/scripts/uri/common.rb +432 -0
  112. data/test/dev/scripts/uri/ftp.rb +149 -0
  113. data/test/dev/scripts/uri/generic.rb +1106 -0
  114. data/test/dev/scripts/uri/http.rb +76 -0
  115. data/test/dev/scripts/uri/https.rb +26 -0
  116. data/test/dev/scripts/uri/ldap.rb +238 -0
  117. data/test/dev/scripts/uri/mailto.rb +260 -0
  118. data/test/dev/scripts/urireg.rb +174 -0
  119. data/test/dev/simpledispatcher.rb +156 -0
  120. data/test/dev/test.action.rb +146 -0
  121. data/test/dev/test.formreader.rb +463 -0
  122. data/test/dev/test.simpledispatcher.rb +186 -0
  123. data/test/dev/webunit/conv/digit-0.rb +21 -0
  124. data/test/dev/webunit/conv/digit-1.rb +17 -0
  125. data/test/dev/webunit/conv/digit.rb +23 -0
  126. data/test/dev/webunit/conv/test_digit-0.rb +16 -0
  127. data/test/dev/webunit/conv/test_digit-1.rb +19 -0
  128. data/test/dev/webunit/conv/test_digit.rb +26 -0
  129. data/test/dev/webunit/conv/test_digit_view-0.rb +76 -0
  130. data/test/dev/webunit/conv/test_digit_view-1.rb +102 -0
  131. data/test/dev/webunit/conv/test_digit_view.rb +134 -0
  132. data/test/installation/htdocs/cgi_test.rb +296 -0
  133. data/test/installation/htdocs/test_install.rb +4 -0
  134. data/test/installation/runwebtest.rb +5 -0
  135. data/test/installation/test_cookie.rb +128 -0
  136. data/test/installation/test_form.rb +47 -0
  137. data/test/installation/test_multipart.rb +51 -0
  138. data/test/installation/test_request.rb +24 -0
  139. data/test/installation/test_response.rb +35 -0
  140. data/test/unit/htdocs/cookie.rb +32 -0
  141. data/test/unit/htdocs/multipart.rb +28 -0
  142. data/test/unit/htdocs/redirect.rb +12 -0
  143. data/test/unit/htdocs/simple.rb +13 -0
  144. data/test/unit/htdocs/stock.rb +33 -0
  145. data/test/unit/test_assert.rb +162 -0
  146. data/test/unit/test_cookie.rb +114 -0
  147. data/test/unit/test_domwalker.rb +77 -0
  148. data/test/unit/test_form.rb +42 -0
  149. data/test/unit/test_frame.rb +40 -0
  150. data/test/unit/test_htmlelem.rb +74 -0
  151. data/test/unit/test_image.rb +45 -0
  152. data/test/unit/test_jscript.rb +57 -0
  153. data/test/unit/test_link.rb +85 -0
  154. data/test/unit/test_multipart.rb +51 -0
  155. data/test/unit/test_params.rb +210 -0
  156. data/test/unit/test_parser.rb +53 -0
  157. data/test/unit/test_response.rb +150 -0
  158. data/test/unit/test_table.rb +70 -0
  159. data/test/unit/test_utils.rb +106 -0
  160. data/test/unit/test_webunit.rb +28 -0
  161. data/test/web/mod_ruby_stub.rb +39 -0
  162. data/test/web/test.assertinclude.rb +109 -0
  163. data/test/web/test.buffer.rb +182 -0
  164. data/test/web/test.code.loader.rb +78 -0
  165. data/test/web/test.config.rb +31 -0
  166. data/test/web/test.error.handling.rb +91 -0
  167. data/test/web/test.formreader-2.0.rb +352 -0
  168. data/test/web/test.load.rb +125 -0
  169. data/test/web/test.mime-type.rb +23 -0
  170. data/test/web/test.narf.cgi.rb +106 -0
  171. data/test/web/test.phprb.rb +239 -0
  172. data/test/web/test.request.rb +368 -0
  173. data/test/web/test.response.rb +637 -0
  174. data/test/web/test.ruby-web.rb +10 -0
  175. data/test/web/test.session.rb +50 -0
  176. data/test/web/test.shim.cgi.rb +96 -0
  177. data/test/web/test.tagparser.rb +65 -0
  178. data/test/web/test.template2.rb +297 -0
  179. data/test/web/test.testing2.rb +318 -0
  180. data/test/web/test.upload.rb +45 -0
  181. data/test/web/test.validate.rb +46 -0
  182. data/test/web/test.web.test.rb +495 -0
  183. data/test/wiki/test.history.rb +297 -0
  184. data/test/wiki/test.illustration_page.rb +287 -0
  185. data/test/wiki/test.linker.rb +197 -0
  186. data/test/wiki/test.tarpit.rb +56 -0
  187. data/test/wiki/test.wiki.rb +300 -0
  188. data/test/wikitestroot/admin.rb +7 -0
  189. data/test/wikitestroot/wiki.rb +6 -0
  190. metadata +234 -0
@@ -0,0 +1,52 @@
1
+ <chapter>
2
+ <title>Source Code Credits</title>
3
+ <para>
4
+ ruby-web is written by Patrick May and Tom Clarke, partly based on cgi.rb
5
+ written by Wakou Aoyama. It makes significant use of ruby-htmltools,
6
+ written by Ned Konz. Also, Keunwoo Lee patched Request.read_multipart
7
+ to be cleaner.
8
+ </para>
9
+
10
+ <para>
11
+ <emphasis>ruby-web</emphasis> contains code from the following projects, and we are in their debt:
12
+ </para>
13
+
14
+ <variablelist>
15
+ <varlistentry>
16
+ <term>ruby-htmltools</term>
17
+ <listitem>
18
+ This is a Ruby library for building trees representing HTML structure.
19
+ <ulink url="http://bike-nomad.com/ruby">http://bike-nomad.com/ruby</ulink>
20
+ </listitem>
21
+ </varlistentry>
22
+
23
+ <varlistentry>
24
+ <term>sgml-parser</term>
25
+ <listitem>
26
+ The html-parser package is a variant language implementation of the
27
+ Python's SGML parser (sgmllib.py), HTML parser (htmllib.py) and
28
+ Formatter (formatter.py).
29
+ <ulink url="http://www.jin.gr.jp/%7Enahi/Ruby/html-parser/README.html">http://www.jin.gr.jp/%7Enahi/Ruby/html-parser/README.html</ulink>
30
+ </listitem>
31
+ </varlistentry>
32
+
33
+ <varlistentry>
34
+ <term>webunit</term>
35
+ <listitem>
36
+ WebUnit is Ruby API for testing html/cgi without browser, and is
37
+ idealy suited for automated unit testing of web sites when combined
38
+ with a Ruby unit test framework such as RubyUnit. It was designed
39
+ and implemented by Masaki Suketa.
40
+ <ulink url="http://www.xpenguin.biz/download/webunit/index-en.html">http://www.xpenguin.biz/download/webunit/index-en.html</ulink>
41
+ </listitem>
42
+ </varlistentry>
43
+ </variablelist>
44
+ </chapter>
45
+
46
+ <chapter>
47
+ <title>Manual Credits</title>
48
+ <para>Much of the installation portion of the manual has been derived from the PHP manual. Below are the many contributers to this great resource.</para>
49
+
50
+ &php.credits;
51
+
52
+ </chapter>
@@ -0,0 +1,118 @@
1
+ <?xml version="1.0" encoding="iso-8859-1"?>
2
+ <!-- $Revision: 1.12 $ -->
3
+
4
+ <!--
5
+ This file shold only be present in the English doc tree. If you
6
+ copy it over to your translation tree you will be hunted down
7
+ relentlessly! You have been warned! :)
8
+ -->
9
+ <bridgehead renderas="sect1">&Credit.Authors.and.Contributors;</bridgehead>
10
+
11
+ &Credit.Introduction;
12
+
13
+ <bridgehead renderas="sect2" role="NotInTOC">&Credit.Authors.and.Editors;</bridgehead>
14
+
15
+ <para>
16
+ &Credit.Past.Authors.Text;
17
+ Jouni Ahto, <!-- jah -->
18
+ Alexander Aulbach, <!-- ssilk [at] ssilk.de [no cvs user] -->
19
+ Daniel Beckham, <!-- danbeck -->
20
+ Stig Bakken, <!-- ssb -->
21
+ Jesus M. Castagnetto, <!-- jmcastagnetto -->
22
+ Ron Chmara, <!-- ronabop -->
23
+ Sean Coates, <!-- sean -->
24
+ John Coggeshall, <!-- john -->
25
+ Simone Cortesi, <!-- cortesi -->
26
+ Markus Fischer, <!-- mfischer -->
27
+ Wez Furlong, <!-- wez -->
28
+ Sara Golemon, <!-- pollita -->
29
+ Rui Hirokawa, <!-- hirokawa -->
30
+ Brad House, <!-- bradmssw -->
31
+ Moriyoshi Koizumi, <!-- moriyoshi -->
32
+ Rasmus Lerdorf, <!-- rasmus -->
33
+ Andrew Lindeman, <!-- alindeman -->
34
+ Stanislav Malyshev, <!-- stas -->
35
+ Rafael Martinez, <!-- rafael -->
36
+ Yasuo Ohgaki, <!-- yohgaki -->
37
+ Derick Rethans, <!-- derick -->
38
+ Sander Roobol, <!-- sander -->
39
+ Egon Schmid, <!-- eschmid -->
40
+ Thomas Schoefbeck, <!-- tom -->
41
+ Sascha Schumann, <!-- sas -->
42
+ Dan Scott, <!-- dbs -->
43
+ Lars Torben Wilson, <!-- torben and also cslawi -->
44
+ Jim Winstead, <!-- jimw and also jim(?) -->
45
+ Jeroen van Wolffelaar&listendand; <!-- jeroen -->
46
+ Andrei Zmievski. <!-- andrei -->
47
+ </para>
48
+
49
+ <para>
50
+ &Credit.Past.Editors.Text;
51
+ Stig Bakken, <!-- ssb -->
52
+ Hartmut Holzgraefe&listendand; <!-- hholzgra -->
53
+ Egon Schmid. <!-- eschmid -->
54
+ </para>
55
+
56
+ <bridgehead renderas="sect2">&Credit.Note.Editors.Title;</bridgehead>
57
+
58
+ <para>
59
+ &Credit.Note.Editors.Active;
60
+ Mehdi Achour, <!-- didou -->
61
+ Friedhelm Betz, <!-- betz -->
62
+ Vincent Gevers, <!-- vincent -->
63
+ Aidan Lister, <!-- aidan -->
64
+ Nuno Lopes&listendand; <!-- nlopess -->
65
+ Tom Sommer. <!-- tomsommer -->
66
+ </para>
67
+
68
+ <para>
69
+ &Credit.Note.Editors.Inactive;
70
+ Daniel Beckham, <!-- danbeck -->
71
+ Victor Boivie, <!-- victor -->
72
+ Jesus M. Castagnetto, <!-- jmcastagnetto -->
73
+ Nicolas Chaillan, <!-- nicos -->
74
+ Ron Chmara, <!-- ronabop -->
75
+ James Cox, <!-- imajes -->
76
+ Sara Golemon, <!-- pollita -->
77
+ Zak Greant, <!-- zak -->
78
+ Szabolcs Heilig, <!-- cece -->
79
+ Oliver Hinckel, <!-- tix -->
80
+ Hartmut Holzgraefe, <!-- hholzgra -->
81
+ Rasmus Lerdorf, <!-- rasmus -->
82
+ Andrew Lindeman, <!-- alindeman -->
83
+ Maxim Maletsky, <!-- maxim -->
84
+ James Moore, <!-- jmoore -->
85
+ Sebastian Picklum, <!-- spic and also sp -->
86
+ Derick Rethans, <!-- derick -->
87
+ Sander Roobol, <!-- sander -->
88
+ Damien Seguy, <!-- dams -->
89
+ Jason Sheets, <!-- jsheets -->
90
+ Jani Taskinen, <!-- sniper -->
91
+ Yasuo Ohgaki, <!-- yohgaki -->
92
+ Philip Olson, <!-- philip -->
93
+ Lars Torben Wilson, <!-- torben -->
94
+ Jim Winstead, <!-- jimw -->
95
+ Jared Wyles&listendand; <!-- rioter -->
96
+ Jeroen van Wolffelaar. <!-- jeroen -->
97
+ </para>
98
+
99
+ <!-- Keep this comment at the end of the file
100
+ Local variables:
101
+ mode: sgml
102
+ sgml-omittag:t
103
+ sgml-shorttag:t
104
+ sgml-minimize-attributes:nil
105
+ sgml-always-quote-attributes:t
106
+ sgml-indent-step:1
107
+ sgml-indent-data:t
108
+ indent-tabs-mode:nil
109
+ sgml-parent-document:nil
110
+ sgml-default-dtd-file:"../manual.ced"
111
+ sgml-exposed-tags:nil
112
+ sgml-local-catalogs:nil
113
+ sgml-local-ecat-files:nil
114
+ End:
115
+ vim600: syn=xml fen fdm=syntax fdl=2 si
116
+ vim: et tw=78 syn=sgml
117
+ vi: ts=1 sw=1
118
+ -->
@@ -0,0 +1,622 @@
1
+ <!-- $Revision: 1.158 $ -->
2
+ <!-- Keep 'em sorted -->
3
+
4
+ <!-- Snippets and titles for the contributors section -->
5
+ <!ENTITY Credit.Authors.and.Contributors 'Authors and Contributors'>
6
+
7
+ <!ENTITY Credit.Introduction '<para> We highlight the currently most active
8
+ people on the manual frontpage, but there are many more contributors who
9
+ currently help in our work or provided a great amount of help to the project
10
+ in the past. There are a lot of unnamed people who help out with their user
11
+ notes on manual pages, which continually get included in the references, the
12
+ work of whom we are also very thankful for. All the lists provided below are in
13
+ alphabetical order.
14
+ </para>'>
15
+
16
+ <!ENTITY Credit.Authors.and.Editors 'Authors and Editors'>
17
+
18
+ <!ENTITY Credit.Past.Authors.Text 'The following contributors should be
19
+ recognized for the impact they have made and/or continue to make by adding
20
+ content to the manual:'>
21
+
22
+ <!ENTITY Credit.Past.Editors.Text 'The following contributors have done
23
+ significant work editing the manual:'>
24
+
25
+ <!ENTITY Credit.Note.Editors.Title 'User Note Maintainers'>
26
+
27
+ <!ENTITY Credit.Note.Editors.Active 'The currently most active maintainers are:'>
28
+
29
+ <!ENTITY Credit.Note.Editors.Inactive 'These people have also put a lot of effort
30
+ into managing user notes:'>
31
+
32
+ <!ENTITY listendand ' and'>
33
+
34
+
35
+
36
+ <!-- Notes -->
37
+
38
+ <!ENTITY note.bin-safe '<note><simpara>This function is
39
+ binary-safe.</simpara></note>'>
40
+
41
+ <!ENTITY note.clearstatcache '<note><simpara>The results of this
42
+ function are cached. See <function>clearstatcache</function> for
43
+ more details.</simpara></note>'>
44
+
45
+ <!ENTITY note.context-support '<note><simpara>Context support was added
46
+ with PHP 5.0.0. For a description of <literal>contexts</literal>, refer to
47
+ <xref linkend="ref.stream"/>.</simpara></note>'>
48
+
49
+ <!ENTITY note.exec-bg '<note><para>If you start a program using this function
50
+ and want to leave it running in the background, you have to make sure that the
51
+ output of that program is redirected to a file or some other output stream or
52
+ else PHP will hang until the execution of the program ends.</para></note>'>
53
+
54
+ <!ENTITY note.func-callback '<note><simpara>Instead of a function name, an
55
+ array containing an object reference and a method name can also be
56
+ supplied.</simpara></note>'>
57
+
58
+ <!ENTITY note.line-endings '<note><simpara>If you are having problems
59
+ with PHP not recognizing the line endings when reading files either on or
60
+ created by a Macintosh computer, you might want to enable the
61
+ <link linkend="ini.auto-detect-line-endings">auto_detect_line_endings</link>
62
+ run-time configuration option.</simpara></note>'>
63
+
64
+ <!ENTITY note.no-remote '<note><simpara>This function will not work on
65
+ <link linkend="features.remote-files">remote files</link> as the file to
66
+ be examined must be accessible via the servers filesystem.</simpara></note>'>
67
+
68
+ <!ENTITY note.not-bin-safe '<warning><simpara>This function
69
+ is not (yet) binary safe!</simpara></warning>'>
70
+
71
+ <!ENTITY note.no-key-association '<note><simpara>This function
72
+ assigns new keys for the elements in <parameter>array</parameter>.
73
+ It will remove any existing keys you may have assigned, rather
74
+ than just reordering the keys.</simpara></note>'>
75
+
76
+ <!ENTITY note.no-windows '<note><simpara>This function is not
77
+ implemented on Windows platforms.</simpara></note>'>
78
+
79
+ <!ENTITY note.no-windows.extension '<note><simpara>This extension is not
80
+ available on Windows platforms.</simpara></note>'>
81
+
82
+ <!ENTITY note.randomseed '<note><simpara>As of PHP 4.2.0, there is no need
83
+ to seed the random number generator with <function>srand</function> or
84
+ <function>mt_srand</function> as this is now done automatically.
85
+ </simpara></note>'>
86
+
87
+ <!ENTITY note.registerglobals '<note><title>register_globals: important
88
+ note</title><para>Since PHP 4.2.0, the default value for the PHP directive
89
+ <link linkend="ini.register-globals">register_globals</link> is <emphasis>
90
+ off</emphasis>. The PHP community encourages all to not rely on this
91
+ directive but instead use other means, such as the &link.superglobals;.
92
+ </para></note>'>
93
+
94
+ <!ENTITY note.superglobals '<note><title>Superglobals: availability note
95
+ </title><para>Since PHP 4.1.0, superglobal arrays such as <varname>$_GET
96
+ </varname>, <varname>$_POST</varname>, and <varname>$_SERVER</varname>,
97
+ etc. have been available. For more information, read the manual section
98
+ on &link.superglobals;</para></note>'>
99
+
100
+ <!ENTITY note.funcnoparam '<note><para>Because this function depends on the
101
+ current scope to determine parameter details, it cannot be used as a
102
+ function parameter. If you must pass this value, assign the results to a
103
+ variable, and pass the variable.</para></note>'>
104
+
105
+ <!-- Tips -->
106
+
107
+ <!ENTITY tip.fopen-wrapper '<tip><simpara>You can use a URL as a
108
+ filename with this function if the <link linkend="ini.allow-url-fopen"
109
+ >fopen wrappers</link> have been enabled.
110
+ See <function>fopen</function> for more details on how to specify
111
+ the filename and <xref linkend="wrappers"/> for a list of supported
112
+ URL protocols.</simpara></tip>'>
113
+
114
+ <!ENTITY tip.fopen-wrapper.stat '<tip><simpara>As of PHP 5.0.0 this function
115
+ can also be used with <emphasis>some</emphasis> URL wrappers. Refer to
116
+ <xref linkend="wrappers"/> for a listing of which wrappers support
117
+ <function>stat</function> family of functionality.</simpara></tip>'>
118
+
119
+ <!ENTITY tip.ob-capture '<tip><simpara>As with anything that outputs
120
+ its result directly to the browser, you can use the <link
121
+ linkend="ref.outcontrol">output-control functions</link> to capture
122
+ the output of this function, and save it in a
123
+ <type>string</type> (for example).</simpara></tip>'>
124
+
125
+
126
+ <!-- Warnings -->
127
+
128
+ <!ENTITY warn.escapeshell '<warning><para>If you are going to allow data coming
129
+ from user input to be passed to this function, then you should be using
130
+ <function>escapeshellarg</function> or <function>escapeshellcmd</function>
131
+ to make sure that users cannot trick the system into executing arbitrary
132
+ commands.</para></warning>'>
133
+
134
+ <!ENTITY warn.experimental '<warning><simpara>This extension is
135
+ <emphasis>EXPERIMENTAL</emphasis>. The behaviour of this extension --
136
+ including the names of its functions and anything else documented
137
+ about this extension -- may change without notice in a future release of PHP.
138
+ Use this extension at your own risk.</simpara></warning>'>
139
+
140
+ <!ENTITY warn.experimental.func '<warning><simpara>This function is
141
+ <emphasis>EXPERIMENTAL</emphasis>. The behaviour of this function, the
142
+ name of this function, and anything else documented about this
143
+ function may change without notice in a future release of PHP.
144
+ Use this function at your own risk.</simpara></warning>'>
145
+
146
+ <!ENTITY warn.imaprecodeyaz '<warning><simpara>The <link
147
+ linkend="ref.imap">IMAP</link> extension cannot be used in conjuction with
148
+ the <link linkend="ref.recode">recode</link>, <link
149
+ linkend="ref.yaz">YAZ</link> or <link
150
+ linkend="ref.cyrus">Cyrus</link> extensions. This is due to the fact that they
151
+ both share the same internal symbol.</simpara></warning>'>
152
+
153
+ <!ENTITY warn.install.cgi '<warning><para>By using the CGI setup, your server
154
+ is open to several possible attacks. Please read our
155
+ <link linkend="security.cgi-bin">CGI security section</link> to learn how to
156
+ defend yourself from those attacks.</para></warning>'>
157
+
158
+ <!ENTITY note.magicquotes.gpc '<note><title>directive note: magic_quotes_gpc
159
+ </title><para>The PHP directive <link linkend="ini.magic-quotes-gpc">
160
+ magic_quotes_gpc</link> defaults to <literal>on</literal>. It essentially
161
+ runs <function>addslashes</function> on all your GET, POST, and COOKIE data.
162
+ You may use <function>stripslashes</function> to strip them.</para></note>'>
163
+
164
+ <!ENTITY warn.no-win32-fopen-wrapper '<warning><para>Windows versions of PHP
165
+ prior to PHP 4.3.0 do not support accessing remote files via this function, even if
166
+ <link linkend="ini.allow-url-fopen">allow_url_fopen</link> is enabled.
167
+ </para></warning>'>
168
+
169
+ <!ENTITY warn.ssl-non-standard '<warning><para>When using SSL, Microsoft IIS
170
+ will violate the protocol by closing the connection without sending a
171
+ close_notify indicator. PHP will report this as "SSL: Fatal Protocol Error"
172
+ when you reach the end of the data. To workaround this, you should lower your
173
+ <link linkend="ini.error-reporting">error_reporting</link> level not to include warnings.
174
+ PHP 4.3.7 and higher can detect buggy IIS server software when you open
175
+ the stream using the https:// wrapper and will suppress the warning for you.
176
+ If you are using <function>fsockopen</function> to create an ssl:// socket,
177
+ you are responsible for detecting and suppressing the warning yourself.
178
+ </para></warning>'>
179
+
180
+ <!ENTITY warn.undocumented.func '<warning><simpara>This function is
181
+ currently not documented; only the argument list is
182
+ available.</simpara></warning>'>
183
+
184
+
185
+ <!-- Misc -->
186
+
187
+ <!ENTITY example.outputs '<para>The above example will output:</para>'>
188
+
189
+ <!ENTITY example.outputs.similar '<para>The above example will output
190
+ something similar to:</para>'>
191
+
192
+ <!ENTITY array.resetspointer '<note><simpara>This function will
193
+ <function>reset</function> the <type>array</type> pointer after
194
+ use.</simpara></note>'>
195
+
196
+ <!ENTITY seealso.callback 'information about the <link linkend="language.types.callback">callback</link> type'>
197
+
198
+ <!ENTITY avail.register-long-arrays 'As of PHP 5.0.0, the long PHP
199
+ <link linkend="language.variables.predefined">predefined variable</link>
200
+ arrays may be disabled with the
201
+ <link linkend="ini.register-long-arrays">register_long_arrays</link>
202
+ directive.'>
203
+
204
+ <!ENTITY ini.shorthandbytes '<simpara>When an <type>integer</type> is used, the
205
+ value is measured in bytes. You may also use shorthand notation as described
206
+ in <link linkend="faq.using.shorthandbytes">this FAQ</link>.</simpara>'>
207
+
208
+ <!ENTITY info.deprecated.alias 'For downward compatibility, the following
209
+ deprecated alias may be used: '>
210
+
211
+ <!ENTITY info.function.alias 'This function is an alias of: '>
212
+
213
+ <!ENTITY info.function.alias.deprecated '<simpara>This function alias is
214
+ deprecated and only exists for backwards compatibility reasons. It is
215
+ recommended to not use this function as one day it may be removed from
216
+ PHP.</simpara>'>
217
+
218
+ <!-- Returns -->
219
+
220
+ <!ENTITY return.success 'Returns &true; on success or &false; on failure.'>
221
+
222
+ <!ENTITY return.void 'No value is returned.'>
223
+
224
+ <!ENTITY return.falseproblem '<warning><simpara>This function may
225
+ return Boolean &false;, but may also return a non-Boolean value which
226
+ evaluates to &false;, such as <literal>0</literal> or
227
+ &quot;&quot;. Please read the section on <link
228
+ linkend="language.types.boolean">Booleans</link> for more
229
+ information. Use <link linkend="language.operators.comparison">the ===
230
+ operator</link> for testing the return value of this
231
+ function.</simpara></warning>'>
232
+
233
+
234
+
235
+
236
+ <!-- Image (GD) Notes -->
237
+ <!ENTITY note.config.t1lib '<note><simpara>This function is only available
238
+ if PHP is compiled using <option role="configure">--with-t1lib[=DIR]</option>.
239
+ </simpara></note>'>
240
+
241
+ <!ENTITY note.config.jpeg '<note><simpara>JPEG support is only available if
242
+ PHP was compiled against GD-1.8 or later.</simpara></note>'>
243
+
244
+ <!ENTITY note.config.wbmp '<note><simpara>WBMP support is only available if
245
+ PHP was compiled against GD-1.8 or later.</simpara></note>'>
246
+
247
+ <!ENTITY note.bundled.gd '<note><simpara>This function is only available if
248
+ PHP is compiled with the bundled version of the GD library.</simpara></note>'>
249
+
250
+ <!ENTITY note.gd.2 '<note><simpara>This function requires GD 2.0.1 or later.</simpara></note>'>
251
+
252
+ <!-- DomXml Notes -->
253
+ <!ENTITY node.inserted 'This node will not show up in the document unless it
254
+ is inserted with e.g. <function>domnode_append_child</function>.'>
255
+
256
+
257
+ <!-- Dom Notes -->
258
+ <!ENTITY dom.node.inserted 'This node will not show up in the document unless
259
+ it is inserted with e.g. <link
260
+ linkend="function.dom-domnode-appendchild">DOMNode->appendChild()</link>.'>
261
+
262
+
263
+ <!-- FileSystem entities -->
264
+ <!ENTITY fs.validfp.all '<para>The file pointer must be valid, and must point to
265
+ a file successfully opened by <function>fopen</function> or
266
+ <function>fsockopen</function> (and not yet closed by
267
+ <function>fclose</function>).</para>'>
268
+
269
+ <!-- Oracle -->
270
+ <!ENTITY oci.charset "<para>Using Oracle server version 9.2 and greater, you can
271
+ indicate <parameter>charset</parameter> parameter, which will be used in the new
272
+ connection. If you're using Oracle server &lt; 9.2, this parameter will be ignored
273
+ and NLS_LANG environment variable will be used instead.</para>">
274
+
275
+ <!ENTITY oci.datatypes '<para>For details on the data type mapping performed by
276
+ the oci8 driver, see the <link linkend="oci8.datatypes">datatypes
277
+ supported by the driver</link></para>'>
278
+
279
+ <!-- PCNTL Notes -->
280
+ <!ENTITY pcntl.parameter.status '<para>The parameter
281
+ <parameter>status</parameter> is the status parameter supplied to a successfull
282
+ call to <function>pcntl_waitpid</function>.</para>'>
283
+
284
+
285
+ <!-- XSLT Notes -->
286
+ <!ENTITY note.xslt.windows '<note><para>Please note that <emphasis>file://</emphasis>
287
+ is needed in front of path if you use Windows.</para></note>'>
288
+
289
+
290
+ <!-- Notes for safe-mode limited functions: -->
291
+ <!ENTITY note.sm.disabled '<note><simpara>&sm.disabled;</simpara></note>'>
292
+
293
+ <!ENTITY note.sm.uidcheck '<note><simpara>When <link
294
+ linkend="features.safe-mode">safe mode</link> is enabled, PHP checks whether
295
+ the files or directories you are about to operate on have the same UID (owner) as the
296
+ script that is being executed.</simpara></note>'>
297
+
298
+ <!ENTITY note.sm.uidcheck.dir '<note><simpara>When <link
299
+ linkend="features.safe-mode">safe mode</link> is enabled, PHP checks whether
300
+ the directory in which you are about to operate has the same UID (owner) as the
301
+ script that is being executed.</simpara></note>'>
302
+
303
+ <!ENTITY note.open-basedir.func '<note><para>This function is affected by <link
304
+ linkend="ini.open-basedir">open_basedir</link>.</para></note>'>
305
+
306
+
307
+ <!ENTITY note.language-construct '<note><simpara>Because this is a
308
+ language construct and not a function, it cannot be called using
309
+ <link linkend="functions.variable-functions">variable functions</link></simpara>
310
+ </note>'>
311
+
312
+ <!-- Common pieces in features/safe-mode.xml
313
+ Jade doesn't allow in-line entities, so I put them here... Though they
314
+ should have been inline in safe-mode.xml -->
315
+ <!ENTITY sm.uidcheck 'Checks whether the files or directories you are
316
+ about to operate on have the same UID (owner) as the script that is being
317
+ executed.'>
318
+
319
+ <!ENTITY warn.sm.exec '<warning><simpara>With <link linkend="features.safe-mode">safe mode</link> enabled,
320
+ all words following the initial command string are treated as a single argument. Thus,
321
+ <literal>echo y | echo x</literal> becomes <literal>echo "y | echo x"</literal>.</simpara></warning>'>
322
+
323
+ <!ENTITY note.exec-path '<note><simpara>When
324
+ <link linkend="features.safe-mode">safe mode</link> is enabled, you can only
325
+ execute executables within the <link linkend="ini.safe-mode-exec-dir">safe_mode_exec_dir</link>.
326
+ For practical reasons it is currently not allowed to have <literal>..</literal>
327
+ components in the path to the executable. </simpara></note>'>
328
+
329
+ <!ENTITY sm.uidcheck.dir 'Checks whether the directory in which
330
+ you are about to operate has the same UID (owner) as the script that is being
331
+ executed.'>
332
+
333
+ <!ENTITY sm.disabled 'This function is disabled in <link
334
+ linkend="features.safe-mode">safe mode</link>.'>
335
+
336
+ <!-- Common pieces in partintro-sections -->
337
+ <!ENTITY no.config '<para>This extension has no configuration directives defined in &php.ini;.</para>'>
338
+ <!ENTITY no.resource '<para>This extension has no resource types defined.</para>'>
339
+ <!ENTITY no.constants '<para>This extension has no constants defined.</para>'>
340
+ <!ENTITY no.requirement '<para>No external libraries are needed to build this extension.</para>'>
341
+ <!ENTITY no.install '<para>There is no installation needed to use these
342
+ functions; they are part of the PHP core.</para>'>
343
+
344
+ <!-- Used in every chapter that has directive descriptions -->
345
+ <!ENTITY ini.descriptions.title '<para>Here&apos;s a short explanation of
346
+ the configuration directives.</para>'>
347
+
348
+ <!-- Common pieces for reference part BEGIN-->
349
+
350
+ <!-- Used in reference/$extname/ini.xml -->
351
+ <!ENTITY extension.runtime '<simpara>
352
+ The behaviour of these functions is affected by settings in &php.ini;.
353
+ </simpara>'>
354
+
355
+ <!ENTITY ini.php.constants 'For further details and definitions of the
356
+ PHP_INI_* constants, see the <xref linkend="ini"/>.'>
357
+
358
+ <!-- Used in reference/$extname/constants.xml -->
359
+ <!ENTITY extension.constants '<simpara>
360
+ The constants below are defined by this extension, and
361
+ will only be available when the extension has either
362
+ been compiled into PHP or dynamically loaded at runtime.
363
+ </simpara>'>
364
+
365
+ <!-- For STANDARD Constants used in reference/$extname/constants.xml -->
366
+ <!ENTITY extension.constants.core '<simpara>
367
+ The constants below are always available as part of the PHP core.
368
+ </simpara>'>
369
+
370
+ <!-- Used in reference/$extname/classes.xml -->
371
+ <!ENTITY extension.classes '<simpara>
372
+ The classes below are defined by this extension, and
373
+ will only be available when the extension has either
374
+ been compiled into PHP or dynamically loaded at runtime.
375
+ </simpara>'>
376
+
377
+ <!ENTITY note.extension.php5 '<note><simpara>
378
+ This extension requires PHP 5.</simpara></note>'>
379
+
380
+ <!-- PDO entities -->
381
+ <!ENTITY pdo.driver-constants '<simpara>The constants below are defined by
382
+ this driver, and will only be available when the extension has been either
383
+ compiled into PHP or dynamically loaded at runtime. In addition, these
384
+ driver-specific constants should only be used if you are using this driver.
385
+ Using mysql-specific attributes with the postgres driver may result in
386
+ unexpected behaviour. <function>PDO::getAttribute</function> may be used to
387
+ obtain the <constant>PDO_ATTR_DRIVER_NAME</constant> attribute to check the
388
+ driver, if your code can run against multiple drivers.</simpara>'>
389
+
390
+ <!-- PECL entities -->
391
+ <!ENTITY pecl.moved 'This <ulink url="&url.pecl;">PECL</ulink> extension
392
+ is not bundled with PHP.'>
393
+
394
+ <!ENTITY pecl.bundled 'This <ulink url="&url.pecl;">PECL</ulink> extension
395
+ is bundled with PHP.'>
396
+
397
+ <!ENTITY pecl.info 'Additional information such as new releases,
398
+ downloads, source files, maintainer information, and a CHANGELOG, can be
399
+ located here: '>
400
+
401
+ <!ENTITY pecl.source.4 'In PHP 4 this <acronym>PECL</acronym> extensions
402
+ source can be found in the <filename>ext/</filename> directory within the
403
+ PHP source or at the <acronym>PECL</acronym> link above.'>
404
+
405
+ <!ENTITY pecl.windows.4 'In PHP 4 this <acronym>DLL</acronym> resides in
406
+ the <filename>extensions/</filename> directory within the PHP Windows
407
+ binaries download.'>
408
+
409
+ <!ENTITY pecl.windows.download 'You may download this <acronym>PECL</acronym>
410
+ extension <acronym>DLL</acronym> from the <ulink url="&url.php.downloads;">
411
+ PHP Downloads</ulink> page or at <ulink url="&url.php.snapshots;">
412
+ &url.php.snapshots;</ulink>.'>
413
+
414
+ <!ENTITY pecl.windows.download.unbundled 'You may obtain this
415
+ unbundled <acronym>PECL</acronym> extension from the various
416
+ <acronym>PECL</acronym> snaps pages (select the appropriate repository for
417
+ your version of PHP): <ulink url="&url.pecl.get.win.php4.3;">PECL for PHP
418
+ 4.3.x</ulink>, <ulink url="&url.pecl.get.win.php5.0;">PECL for PHP 5.0.x
419
+ </ulink> or <ulink url="&url.pecl.get.win.unstable;">PECL Unstable</ulink>.'>
420
+
421
+ <!ENTITY pecl.moved-ver 'This extension has been moved to the <ulink
422
+ url="&url.pecl;">PECL</ulink> repository and is no longer bundled with
423
+ PHP as of PHP '>
424
+
425
+ <!-- kept for BC -->
426
+ <!ENTITY note.pecl-php5 '<note><simpara>
427
+ This extension has been removed as of PHP 5 and moved to the
428
+ <ulink url="&url.pecl;">PECL</ulink> repository.
429
+ </simpara></note>'>
430
+
431
+ <!-- Common pieces for reference part END -->
432
+
433
+
434
+ <!ENTITY windows.builtin '<simpara> The windows version of PHP has built in
435
+ support for this extension. You do not need to load any additional
436
+ extension in order to use these functions.</simpara>'>
437
+
438
+ <!-- These are here as helpers for manual consistency and brievety-->
439
+ <!ENTITY safemode '<link linkend="ini.safe-mode">safe mode</link>'>
440
+
441
+ <!ENTITY sqlsafemode '<link linkend="ini.sql.safe-mode">SQL safe mode</link>'>
442
+
443
+ <!-- Notes for SAPI/Apache -->
444
+ <!ENTITY note.apache.nsapi-module '<note><para>As of PHP 4.3.3 you can use this function with the
445
+ <link linkend="ref.nsapi">NSAPI server module</link> in Netscape/iPlanet/SunONE
446
+ webservers, too.</para></note>'>
447
+
448
+ <!ENTITY apache.req.module '<simpara>This function is only supported when PHP
449
+ is installed as an Apache module.</simpara>'>
450
+
451
+ <!-- SimpleXML Notes -->
452
+ <!ENTITY simplexml.iteration '<note><simpara>SimpleXML has made a rule of adding
453
+ iterative properties to most methods. They cannot be viewed using <function>var_dump</function>
454
+ or anything else which can examine objects.</simpara></note>'>
455
+
456
+ <!-- SQLite Notes -->
457
+ <!ENTITY sqlite.case-fold '<para>The column names returned by
458
+ <constant>SQLITE_ASSOC</constant> and <constant>SQLITE_BOTH</constant> will be
459
+ case-folded according to the value of the
460
+ <link linkend="ini.sqlite.assoc-case">sqlite.assoc_case</link> configuration
461
+ option.</para>'>
462
+
463
+ <!ENTITY sqlite.decode-bin '<para>When the <parameter>decode_binary</parameter>
464
+ parameter is set to &true; (the default), PHP will decode the binary encoding
465
+ it applied to the data if it was encoded using the
466
+ <function>sqlite_escape_string</function>. You should normally leave this
467
+ value at its default, unless you are interoperating with databases created by
468
+ other sqlite capable applications.</para>'>
469
+
470
+ <!ENTITY sqlite.no-unbuffered '<note><para>This function cannot be used with
471
+ unbuffered result handles.</para></note>'>
472
+
473
+ <!ENTITY sqlite.param-compat '<note><simpara>Two alternative syntaxes are
474
+ supported for compatibility with other database extensions (such as MySQL).
475
+ The preferred form is the first, where the <parameter>dbhandle</parameter>
476
+ parameter is the first parameter to the function.</simpara></note>'>
477
+
478
+ <!ENTITY sqlite.result-type '<para>The optional <parameter>result_type</parameter>
479
+ parameter accepts a constant and determines how the returned array will be
480
+ indexed. Using <constant>SQLITE_ASSOC</constant> will return only associative
481
+ indices (named fields) while <constant>SQLITE_NUM</constant> will return
482
+ only numerical indices (ordinal field numbers). <constant>SQLITE_BOTH</constant>
483
+ will return both associative and numerical indices.
484
+ <constant>SQLITE_BOTH</constant> is the default for this function.</para>'>
485
+
486
+ <!-- Database Notes -->
487
+ <!ENTITY database.field-case '<note><simpara>Field names returned by this function
488
+ are <emphasis>case-sensitive</emphasis>.</simpara></note>'>
489
+
490
+ <!ENTITY database.fetch-null '<note><simpara>This function sets NULL fields to
491
+ PHP &null; value.</simpara></note>'>
492
+
493
+ <!-- MSQL Notes -->
494
+ <!-- The msql.*.description entities are used in the parameters refsect1 -->
495
+ <!ENTITY msql.linkid.description '<varlistentry><term><parameter>
496
+ link_identifier</parameter></term><listitem><para>The mSQL connection.
497
+ If not specified, the last link opened by <function>msql_connect</function>
498
+ is assumed. If no such link is found, the function will try to establish a
499
+ link as if <function>msql_connect</function> was called, and use it.
500
+ </para></listitem></varlistentry>'>
501
+
502
+ <!ENTITY msql.result.description '<varlistentry><term><parameter>
503
+ result</parameter></term><listitem><para>The result <type>resource</type> that
504
+ is being evaluated. This result comes from a call to
505
+ <function>msql_query</function>.</para></listitem></varlistentry>'>
506
+
507
+ <!ENTITY msql.field-offset.req.description '<varlistentry><term><parameter>
508
+ field_offset</parameter></term><listitem><para>The numerical field offset. The
509
+ <parameter>field_offset</parameter> starts at <literal>1</literal>.</para></listitem></varlistentry>'>
510
+
511
+
512
+ <!-- MySQL Notes -->
513
+ <!-- The mysql.*.description entities are used in the parameters refsect1 -->
514
+ <!ENTITY mysql.linkid.description '<varlistentry><term><parameter>
515
+ link_identifier</parameter></term><listitem><para>The MySQL connection. If the
516
+ link identifier is not specified, the last link opened by
517
+ <function>mysql_connect</function> is assumed. If no such link is found, it
518
+ will try to create one as if <function>mysql_connect</function> was called
519
+ with no arguments. If by chance no connection is found or established, an
520
+ <constant>E_WARNING</constant> level warning is generated.</para></listitem>
521
+ </varlistentry>'>
522
+
523
+ <!ENTITY mysql.result.description '<varlistentry><term><parameter>
524
+ result</parameter></term><listitem><para>The result <type>resource</type> that
525
+ is being evaluated. This result comes from a call to
526
+ <function>mysql_query</function>.</para></listitem></varlistentry>'>
527
+
528
+ <!ENTITY mysql.field-offset.req.description '<varlistentry><term><parameter>
529
+ field_offset</parameter></term><listitem><para>The numerical field offset. The
530
+ <parameter>field_offset</parameter> starts at <literal>0</literal>. If
531
+ <parameter>field_offset</parameter> does not exist, an error of level
532
+ <constant>E_WARNING</constant> is also issued.</para></listitem></varlistentry>'>
533
+
534
+ <!-- Sybase Notes -->
535
+ <!ENTITY sybase.ct.only '<note><simpara>This function is only available using
536
+ the CT library interface to Sybase, and not the DB library.</simpara></note>'>
537
+
538
+ <!ENTITY sybase.db.only '<note><simpara>This function is only available using
539
+ the DB library interface to Sybase, and not the CT library.</simpara></note>'>
540
+
541
+ <!ENTITY sybase.linkid.description '<varlistentry><term><parameter>
542
+ link_identifier</parameter></term><listitem><para>The Sybase connection. If the
543
+ link identifier is not specified, the last link opened by
544
+ <function>sybase_connect</function> is assumed. If no such link is found, it
545
+ will try to create one as if <function>sybase_connect</function> was called
546
+ with no arguments. If by chance no connection is found or established, an
547
+ <constant>E_WARNING</constant> level warning is generated.</para></listitem>
548
+ </varlistentry>'>
549
+
550
+ <!-- CPDF Unit length -->
551
+ <!ENTITY cpdf.ul '<para>The optional parameter <parameter>mode</parameter>
552
+ determines the unit length. If it is 0 or omitted the default unit as specified
553
+ for the page is used. Otherwise the coordinates are measured in postscript
554
+ points disregarding the current unit.</para>'>
555
+
556
+ <!-- Xattr entities -->
557
+ <!ENTITY xattr.namespace '<para>Extended attributes have two different namespaces: user
558
+ and root namespace. User namespace is available for all users while root namespace
559
+ is available only for user with root privileges. xattr operates on user namespace
560
+ by default, but you can change that using <parameter>flags</parameter> argument.</para>'>
561
+
562
+ <!-- Notes for IPv6 -->
563
+ <!ENTITY ipv6.brackets '<note><simpara>When specifying a numerical IPv6 address
564
+ (e.g. fe80::1) you must enclose the IP in square brackets. For example,
565
+ <literal>tcp://[fe80::1]:80</literal>.</simpara></note>'>
566
+
567
+ <!ENTITY ipv6.php5 '<note><simpara>IPv6 Support was added with PHP 5.0.0.</simpara></note>'>
568
+
569
+ <!-- Notes for tidy -->
570
+ <!ENTITY note.tidy.ze2 '<note><simpara> This function is only available with Zend Engine 2,
571
+ this means PHP &gt;= 5.0.0.</simpara></note>'>
572
+
573
+ <!ENTITY note.tidy.1only '<note><simpara>This function is only avaliable in
574
+ Tidy 1.0. It became obsolete in Tidy 2.0 and thus has been removed.</simpara></note>'>
575
+
576
+ <!ENTITY note.tidy.2only '<note><simpara>The optional parameters
577
+ <parameter>config</parameter> and <parameter>encoding</parameter> were
578
+ added in Tidy 2.0.</simpara></note>'>
579
+
580
+ <!ENTITY tidy.conf-enc '<para>The <parameter>config</parameter> parameter
581
+ can be passed either as an array or as a string. If you pass it as a string,
582
+ it means the name of the configuration file, otherwise it is interpreted as
583
+ the options themselves. Check <ulink url="&url.tidy.conf;">&url.tidy.conf;</ulink>
584
+ for an explanation about each option.</para><para>The
585
+ <parameter>encoding</parameter> parameter sets the encoding for input/output
586
+ documents. The possible values for <parameter>encoding</parameter> are:
587
+ ascii, latin0, latin1, raw, utf8, iso2022, mac, win1252, ibm858, utf16,
588
+ utf16le, utf16be, big5 and shiftjis.</para>'>
589
+
590
+ <!-- Snippets for the installation section -->
591
+ <!ENTITY warn.apache2.compat '<warning><para>We do not recommend using a threaded MPM
592
+ in production with Apache2. Use the prefork MPM instead, or use Apache1. For information
593
+ on why, read the related FAQ entry on using
594
+ <link linkend="faq.installation.apache2">Apache2 with a threaded MPM</link></para></warning>'>
595
+
596
+ <!ENTITY note.apache.slashes '<note><simpara>Remember that when adding
597
+ path values in the Apache configuration files on Windows, all backslashes
598
+ such as <filename>c:\directory\file.ext</filename> must be converted to
599
+ forward slashes, as <filename>c:/directory/file.ext</filename>.</simpara></note>'>
600
+
601
+ <!-- classkit and runkit entities -->
602
+ <!ENTITY note.classkit.selfmanipulation '<note><simpara>This function cannot
603
+ be used to manipulate the currently running (or chained) method.</simpara>
604
+ </note>'>
605
+
606
+ <!ENTITY note.runkit.selfmanipulation '<note><simpara>This function cannot
607
+ be used to manipulate the currently running (or chained) method.</simpara>
608
+ </note>'>
609
+
610
+ <!ENTITY note.runkit.sandbox '<note><simpara>Sandbox support (required for
611
+ <function>runkit_lint</function>, <function>runkit_lint_file</function>,
612
+ and the Runkit_Sandbox class) is only available with PHP 5.1 or specially
613
+ patched versions of PHP 5.0 and requires that thread safety be enabled.
614
+ See the README file included in the runkit package for more information.
615
+ </simpara></note>'>
616
+
617
+ <!-- SSH2 Extension -->
618
+ <!ENTITY note.ssh2.subsystem.publickey '<note><simpara>The publickey subsystem
619
+ is used for managing publickeys on a server to which the client is
620
+ <emphasis>already</emphasis> authenticated. To authenticate to a remote system
621
+ using publickey authentication, use the <function>ssh2_auth_pubkey_file</function>
622
+ function instead.</simpara></note>'>