home *** CD-ROM | disk | FTP | other *** search
/ BCI NET 2 / BCI NET 2.iso / archives / utilities / text / man36.lha / Man3.6 / Pages / List.man < prev    next >
Encoding:
Text File  |  1995-02-13  |  5.2 KB  |  165 lines
  1.  
  2. NAME
  3.  
  4.     List
  5.  
  6.  
  7. FORMAT
  8.  
  9.     LIST [{<dir|pattern>}] [P|PAT <pattern>] [KEYS] [DATES] [NODATES]
  10.          [TO <name>] [SUB <string>] [SINCE <date>] [UPTO <date>]
  11.          [QUICK] [BLOCK] [NOHEAD] [FILES] [DIRS] [LFORMAT <string>]
  12.          [ALL]
  13.  
  14.  
  15. PURPOSE
  16.  
  17.     To list information about directories and files.
  18.  
  19.  
  20. SPECIFICATION
  21.  
  22.     LIST displays information about the contents of the current 
  23.     directory.  If you specify a <dir>, <pattern>, or <filename>
  24.     argument, LIST will display information about the specified
  25.     directory, all directories or files that match the pattern, or
  26.     the specified file, respectively.
  27.  
  28.  
  29. OPTIONS
  30.  
  31.     Unless other options are specified, LIST displays the following:
  32.  
  33.     name        The name of the file or directory.
  34.     size        The size of the file in bytes. If there is
  35.             nothing in this file, the field will read empty.
  36.             For directories, this entry reads Dir.
  37.     protection    The protection bits that are set for this file
  38.             are shown as letters. The clear (unset) bits are
  39.             shown as hyphens. Most files will show the
  40.             default protection bits, rwed for
  41.             readable/writable/executable/deleteable. See the
  42.             PROTECT command for more on protection bits.            
  43.     date and time    The date and time the file was created or last
  44.             altered.
  45.     comment        The comment, if any, placed on the file using the
  46.             FILENOTE command. It is preceded by a colon (:).
  47.  
  48.  
  49.     LIST has options which will change the way the output is displayed.
  50.     These options are explained below:
  51.  
  52.     KEYS        Displays the block number of each header or
  53.             directory.
  54.     DATES        Displays dates in the form DD-MMM-YY (the default
  55.             unless you use QUICK).
  56.     NODATES        Will not display date and time information.  
  57.     TO <name>    Specifies an output file or device by default,
  58.             LIST outputs to the current window.
  59.     SUB <string>    Lists only files containing the substring
  60.             <string>.
  61.     SINCE <date>    Lists only files created on or after a certain
  62.             date.
  63.     UPTO <date>    Lists only files created on or before a certain
  64.             date.
  65.     QUICK        Lists only the names of files and directories.
  66.     BLOCK        Displays file sizes in blocks, rather than in
  67.             bytes.
  68.     NOHEAD        Suppresses the printing of the header
  69.             information.
  70.     FILES        Lists files only (no directories).
  71.     DIRS        Lists directories only (no files.)
  72.     LFORMAT        Defines a string to specially format LIST output.
  73.     ALL        Lists all files in directories and sub-
  74.             directories.
  75.  
  76.     The LFORMAT option modifies the output of LIST and can be used as
  77.     a quick method of generating script files.  When LFORMAT is specified,
  78.     the QUICK and NOHEAD options are automatically selected.  When using
  79.     LFORMAT you must specify an output format specification string; this
  80.     string is incorporated into the resulting output.  If you want the
  81.     output to be saved, you must redirect it to a file by using the >
  82.     operator or specifying a TO file.
  83.  
  84.     The format for the output format specification string is
  85.     LFORMAT = <string>.  To include the output of LIST in this string,
  86.     use the substitution operator % S.  The path and filename can be made
  87.     part of the string this way.  Whether the path or the filename is
  88.     substituted for an occurrence of % S depends on how many occurrences
  89.     are in the LFORMAT line, and their order, as follows:
  90.  
  91.     Substituted with each occurrence
  92.     Occurrences of %S    1st       2nd       3rd       4th
  93.  
  94.         1         filename
  95.         2         path      filename
  96.         3            path      filename  filename
  97.         4            path      filename  path      filename
  98.  
  99.     Some new operators allow you to specify fields to be printed in
  100.     the LFORMAT output. These operators are:
  101.  
  102.            %A              Prints file attributes (protection bits.)
  103.           %B              Prints size of file in blocks.
  104.            %C             Prints any comments attached to the file.
  105.            %D              Prints the date associated with the file.
  106.            %F              Prints the complete file parent path,
  107.                            regardless of the current directory.
  108.            %K              Prints the file KEY block.
  109.            %L              Prints the length of file in bytes.
  110.            %N              Prints the name of the file.
  111.            %P              Prints the file parent path relative to
  112.                        the current directory.
  113.            %T              Prints the time associated with the file.
  114.  
  115.     You can put a length specifier and/or a justification specifier
  116.     between the percent sign % and the field specifier. 
  117.  
  118.     
  119. EXAMPLE
  120.  
  121.     1 > LIST Dirs
  122.      Monitors       Dir   rwed 27-June-90 11:43:59
  123.     T                 Dir   rwed Wednesday  11:37:43
  124.     Trashcan       Dir   rwed 21-Jun-90  17:54:20
  125.  
  126.     Only the directories in the current directory, in this case SYS: are
  127.     listed. (A shortened version of the output is shown above)
  128.  
  129.     1 > LIST Li#? TO RAM:Libs.file
  130.     LIST will search for any directories or files that start with LI.
  131.     The output of LIST will be sent to the Libs.file in RAM:
  132.  
  133.     1 > LIST DF0:Documents UPTO 09-Oct-90
  134.  
  135.     Only the files or directories in the Documents directory of DF0: that
  136.     have not been changed since October 9, 1990 will be listed.
  137.  
  138.  
  139. BUGS
  140.  
  141.     NONE.
  142.  
  143.  
  144. AUTHOR
  145.  
  146.     Commodore Business Machines.  This program is provided with your Amiga
  147.     Workbench disks.  It can be found in your C: directory.
  148.  
  149.  
  150. COPYRIGHT NOTICE
  151.  
  152.         This man page was written by:
  153.  
  154.     Markus Hillenbrand
  155.     Weserstrasse 9
  156.     36124 Eichenzell-Loeschenrod
  157.     Germany
  158.  
  159.     E-mail: m_hillen@informatik.uni-kl.de
  160.  
  161.  
  162. SEE ALSO
  163.  
  164.     Dir (AmigaDOS), Protect (AmigaDOS), FileNote (AmigaDOS), ls (UNIX-like)
  165.