Changeset 27766 for trunk/doc


Ignore:
Timestamp:
Aug 14, 2007, 1:58:27 AM (12 years ago)
Author:
markd@…
Message:

Fill out the variants section.

File:
1 edited

Legend:

Unmodified
Added
Removed
  • trunk/doc/guide/new/xml/using.xml

    r27730 r27766  
    285285    variants, if any, use this command:</para>
    286286
    287     <programlisting><prompt>%%</prompt> <userinput>port variants nmap</userinput></programlisting>
    288 
    289     <screen>nmap has the variants:
     287    <programlisting><prompt>%%</prompt> <userinput>port variants fetchmail</userinput></programlisting>
     288
     289    <screen>fetchmail has the variants:
    290290        universal
    291         gtk2
    292         no_ssl
    293         no_pcre</screen>
     291        ssl: Support secure connections using OpenSSL
     292        fetchmailconf: Install a graphical configurator
     293        ntlm: Enable NTLM authentication</screen>
     294
     295    <note>
     296      <para>Variant descriptions are optional, so you may not see descriptions
     297      for all variants.</para>
     298    </note>
    294299
    295300    <section>
    296301      <title>Invoking Variants</title>
    297302
    298       <para></para>
     303      <para>A variant can only be invoked when a port is installed. After you
     304      have determined what variants a given port has, if any, you may install
     305      a port using the variant as shown.</para>
     306
     307      <programlisting><prompt>%%</prompt> <userinput>port install fetchmail +ssl</userinput></programlisting>
     308
     309      <para>Port variant execution may be verified using the
     310      <command>port</command> command with the verbose switch.</para>
     311
     312      <programlisting><prompt>%%</prompt> <userinput>port -v install fetchmail +ssl</userinput></programlisting>
     313
     314      <para>When a port is installed using a valid variant and specified
     315      correctly, the verbose output will contain:</para>
     316
     317      <screen>DEBUG: Executing variant ssl provides ssl</screen>
    299318    </section>
    300319
     
    302321      <title>Negating Default Variants</title>
    303322
    304       <para></para>
     323      <para>For an explanation of default variants, see the "Port Development"
     324      section. Default variants are optional, and not all ports using variants
     325      have them. For ports with default variants, you may install a port
     326      without them by negating default variants using "-" as shown.</para>
     327
     328      <programlisting><prompt>%%</prompt> <userinput>port install fetchmail -ssl</userinput></programlisting>
     329
     330      <para>To verify that you have properly negated a default variant, you
     331      may want to use verbose mode. But negated variants are simply not
     332      reported in any way by the <command>port</command> command, as if they
     333      did not exist. You will know you have successfully negated the default
     334      variant in the example above if you do NOT see this line in the verbose
     335      output.</para>
     336
     337      <screen>DEBUG: Executing variant ssl provides ssl</screen>
    305338    </section>
    306339  </section>
Note: See TracChangeset for help on using the changeset viewer.