Changeset 13790


Ignore:
Timestamp:
Jun 9, 2010, 2:19:13 AM (10 years ago)
Author:
gb
Message:

Mention (most of) DIRECTORY's keyword arguments. Closes ticket:692.

File:
1 edited

Legend:

Unmodified
Added
Removed
  • trunk/source/doc/src/using.xml

    r13573 r13790  
    484484  </sect1>
    485485
     486  <sect1 id="Directory"><title>Directory</title>
     487  <para>&CCL;'s <varname>DIRECTORY</varname> function accepts the following
     488implementation-dependent keyword arguments:</para>
     489  <variablelist>
     490  <varlistentry>
     491     <term><varname>:files</varname> <replaceable>boolean</replaceable></term>
     492     <listitem>
     493       <para> If true, includes regular (non-directory) files in DIRECTORY's output.  Defaults to T.</para>
     494     </listitem>
     495  </varlistentry>
     496  <varlistentry>
     497     <term><varname>:directories</varname> <replaceable>boolean</replaceable></term>
     498     <listitem>
     499       <para> If true, includes directories in DIRECTORY's output.  Defaults to NIL.</para>
     500     </listitem>
     501  </varlistentry>
     502  <varlistentry>
     503     <term><varname>:all</varname> <replaceable>boolean</replaceable></term>
     504     <listitem>
     505       <para> If true, includes files and directories whose names start with a dot character in DIRECTORY's output.  (Entries whose name is "." or ".." are never included.) Defaults to T.</para>
     506     </listitem>
     507  </varlistentry>
     508  <varlistentry>
     509     <term><varname>:follow-links</varname> <replaceable>boolean</replaceable></term>
     510     <listitem>
     511       <para> If true, includes the TRUENAMEs of symbolic or hard links in DIRECTORY's output; if false, includes the link filenames without attempting to resolve them. Defaults to T.</para>
     512       <para>Note that legacy HFS alias files are treated as plain files.</para>
     513     </listitem>
     514  </varlistentry>
     515  </variablelist>
     516  </sect1>
    486517  <sect1 id="Unicode"><title>Unicode</title>
    487518
Note: See TracChangeset for help on using the changeset viewer.