core/builtins/ls.cif
changeset 0 7f656887cf89
child 26 5d370dafea69
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/core/builtins/ls.cif	Wed Jun 23 15:52:26 2010 +0100
@@ -0,0 +1,76 @@
+# ls.cif
+# 
+# Copyright (c) 2010 Accenture. All rights reserved.
+# This component and the accompanying materials are made available
+# under the terms of the "Eclipse Public License v1.0"
+# which accompanies this distribution, and is available
+# at the URL "http://www.eclipse.org/legal/epl-v10.html".
+# 
+# Initial Contributors:
+# Accenture - Initial contribution
+#
+
+==name ls
+
+==short-description
+
+List the contents of a directory.
+
+==long-description
+
+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.
+
+==argument filename dir_name optional
+
+The directory to list (defaults to the current working directory).
+
+==option bool a all
+
+Display all files, including those with hidden and system attributes.
+
+==option bool l long
+
+Display verbose file information, including attributes, file size and last-modified date. The attributes have the following format:
+
+=over 5
+
+=item d
+
+directory
+
+=item r
+
+read only
+
+=item h
+
+hidden
+
+=item s
+
+system
+
+=item a
+
+archived
+
+=back
+
+For example, C<d--s-> indicates a drectory with the system bit set.
+
+==option bool H human
+
+Display file sizes in human readable form.
+
+==option bool 1 one
+
+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.
+
+==option bool r recurse
+
+Recursively list any directories that are encountered. Currently only supported for C<--long> listings.
+
+==copyright
+
+Copyright (c) 2006-2010 Accenture. All rights reserved.
+