repo_zf1/documentation/manual/zh/module_specs/Zend_Console_Getopt-Introduction.xml

<sect1 id="zend.console.getopt.introduction">
    <title> Getopt 简介 </title>
    <para>
        <code>Zend_Console_Getopt</code> 类帮助命令行程序解析它们的选项和参数。
    </para>
    <para>
        当执行你的程序时，用户可以指定命令行参数。这些参数对程序时有意义的，或改变程序的行为，或选择资源，或详细说明参数。许多选项有传统的意义，例如 "<code>--verbose</code>" 对大多数的程序都是允许输出执行细节。一些选项可能对不同的程序有不同的意义。例如 "<code>-c</code>" 在 <command>grep</command>、 <command>ls</command> 和 <command>tar</command> 里有不同的功能。
    </para>
    <para>
        下面时一些术语的定义。术语的基本用法变化多样，但本文档使用下面的定义。
    </para>
    <itemizedlist>
        <listitem>
            <para>
                "argument"：在命令之后的字符串。Arguments 可以时选项或其它不带选项的形式，在命令操作时指出资源。
            </para>
        </listitem>
        <listitem>
            <para>
                "option"：表示命令应该改变其缺省行为的参数。
            </para>
        </listitem>
        <listitem>
            <para>
                "flag"：选项的第一部分，确定选项的意图。传统上 flag 前面有一个或两个短横线 ("<code>-</code>" 或 "<code>--</code>")。一个单个的短横引导一个单字符的 flag 或 一组单字符的 flags。双横线引导一个多字符的 flag。长的 flags 不能组合。
            </para>
        </listitem>
        <listitem>
            <para>
                "parameter"：选项的第二部分，如果它适用于给定的选项，就是随 flag 带的数据值。例如，许多命令接受 "<code>--verbose</code>" 选项，但一般这个选项没有参数（parameter）。但象 "<code>--user</code>" 的选项几乎总是有一个参数（ parameter ）。
            </para>
            <para>
                parameter 可以作为在 flag 参数之后的分离的参数，或作为同一参数串的一部分，从 flag 里用等号（"<code>=</code>"）分开。后者只被长的 flags 支持。例如，<code>-u username</code>、 <code>--user username</code> 和 <code>--user=username</code> 是被 <code>Zend_Console_Getopt</code> 支持的格式。
            </para>
        </listitem>
        <listitem>
            <para>
                "cluster"：在一个单字串参数里的多个单字符 flags 组合，由单个短横线引导。例如，"<command>ls -1str</command>" 使用一组四个短 flags 。这个命令和 "<command>ls -1 -s -t -r</command>" 相同。只有单个字符 flags 可以被组成组，对长的 flags 不可以组合。
            </para>
        </listitem>
    </itemizedlist>
    <para>
        例如，在 "<code>mysql --user=root mydatabase</code>" 里，"<code>mysql</code>" 是<emphasis> 命令 </emphasis>，"<code>--user=root</code>" 是 <emphasis>option</emphasis>，"<code>--user</code>" 是 <emphasis>flag</emphasis>，"<code>root</code>" 是 option 的 <emphasis>parameter</emphasis>，根据我们的定义 "<code>mydatabase</code>" 是 argument 而不是 option 。
    </para>
    <para>
        <code>Zend_Console_Getopt</code> 提供了接口来声明哪个 flags 对你的程序有效，如果使用了无效的flag，则输出错误和用法信息，并报告给你的程序代码。
    </para>
    <note>
        <title>Getopt 不是应用程序框架 </title>
        <para>
            <code>Zend_Console_Getopt</code> <emphasis> 不 </emphasis> 不翻译 flags 和 parameters 的意思，这个类也不实现程序流程或调用程序代码。你必需在你自己的程序代码中实现这些动作。你可以使用 <code>Zend_Console_Getopt</code> 来解析命令行和提供面向对象的方法来查询由用户给定的 options ，但使用这些信息去调用程序的部分应当在其它 PHP 类里。
        </para>
    </note>
    <para>
        后面的章节描述 <code>Zend_Console_Getopt</code> 的用法。
    </para>
</sect1>