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
|
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.10 $ -->
<refentry id="function.getopt">
<refnamediv>
<refname>getopt</refname>
<refpurpose>Gets options from the command line argument list</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<methodsynopsis>
<type>array</type><methodname>getopt</methodname>
<methodparam><type>string</type><parameter>options</parameter></methodparam>
<methodparam choice="opt"><type>array</type><parameter>longopts</parameter></methodparam>
</methodsynopsis>
<para>
Returns an associative array of option / argument pairs based on the
options format specified in <parameter>options</parameter>, or &false;
on an error.
</para>
<para>
On platforms that have the C function getopt_long, long options can be
specified with the parameter <parameter>longopts</parameter> (as of PHP 4.3.0).
</para>
<para>
<informalexample>
<programlisting role="php">
<![CDATA[
<?php
// parse the command line ($GLOBALS['argv'])
$options = getopt("f:hp:");
?>
]]>
</programlisting>
</informalexample>
</para>
<para>
The <parameter>options</parameter> parameter may contain the following
elements: individual characters, and characters followed by a colon to
indicate an option argument is to follow. For example, an option string
<literal>x</literal> recognizes an option <literal>-x</literal>, and an
option string <literal>x:</literal> recognizes an option and argument
<literal>-x argument</literal>. It does not matter if an argument has
leading white space.
</para>
<para>
This function will return an array of option / argument pairs. If an
option does not have an argument, the value will be set to &false;.
</para>
¬e.no-windows;
</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:"../../../../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
-->
|
