1 # ls.cif

     2 # 

     3 # Copyright (c) 2010 Accenture. All rights reserved.

     4 # This component and the accompanying materials are made available

     5 # under the terms of the "Eclipse Public License v1.0"

     6 # which accompanies this distribution, and is available

     7 # at the URL "http://www.eclipse.org/legal/epl-v10.html".

     8 # 

     9 # Initial Contributors:

    10 # Accenture - Initial contribution

    11 #

    12 

    13 ==name ls

    14 

    15 ==short-description

    16 

    17 List the contents of a directory.

    18 

    19 ==long-description

    20 

    21 Note, C<cd> can be used to navigate between drives, but the DOS approach of switching between drives with commands like C<c:> and C<e:> is also supported.

    22 

    23 ==argument filename dir_name optional

    24 

    25 The directory to list (defaults to the current working directory).

    26 

    27 ==option bool a all

    28 

    29 Display all files, including those with hidden and system attributes.

    30 

    31 ==option bool l long

    32 

    33 Display verbose file information, including attributes, file size and last-modified date. The attributes have the following format:

    34 

    35 =over 5

    36 

    37 =item d

    38 

    39 directory

    40 

    41 =item r

    42 

    43 read only

    44 

    45 =item h

    46 

    47 hidden

    48 

    49 =item s

    50 

    51 system

    52 

    53 =item a

    54 

    55 archived

    56 

    57 =back

    58 

    59 For example, C<d--s-> indicates a drectory with the system bit set.

    60 

    61 ==option bool H human

    62 

    63 Display file sizes in human readable form.

    64 

    65 ==option bool 1 one

    66 

    67 Outputs one entry per line rather than trying to columnise the output. Is implied if C<stdout> is redirected or if C<--long> is specified.

    68 

    69 ==option bool r recurse

    70 

    71 Recursively list any directories that are encountered. Currently only supported for C<--long> listings.

    72 

    73 ==copyright

    74 

    75 Copyright (c) 2006-2010 Accenture. All rights reserved.

    76