home *** CD-ROM | disk | FTP | other *** search
/ back2roots/padua / padua.7z / padua / misc / arpdoc13.lzh / LIST < prev    next >
Encoding:
Text File  |  1989-06-30  |  10.0 KB  |  331 lines
  1.  
  2.  
  3.  
  4.      List(V1.3)              ARP User's Manual              List(V1.3)
  5.  
  6.  
  7.  
  8.      NAME
  9.           List - List contents of a directory.
  10.  
  11.      SYNOPSIS
  12.           List Dir P=PAT/k KEYS/s DATES/s NODATES/s SUB/k SINCE/k
  13.                SORT/s TO/k UPTO/k QUICK/s BLOCK=BLOCKS/s NOHEAD/s
  14.                FILES/s DIRS/s LFORMAT/k
  15.  
  16.      DESCRIPTION
  17.           List displays the contents of a given directory.  By
  18.           contents, we mean the names of the subordinate files and
  19.           directories, not the file data.  Typing the List command by
  20.           itself with no parameters generates a listing of the current
  21.           directory.
  22.  
  23.      THE LISTING DISPLAY
  24.           List displays your files and directories one per line, with
  25.           more information about each file displayed to the right of
  26.           the filename.  The fields which may appear in a Listed file
  27.           are
  28.  
  29.           name [KEY] size/type protection date time
  30.           :comment
  31.  
  32.           Methods are provided for getting a selective listing of
  33.           files, as well as suppressing/adding most of the above
  34.           display elements.  A description of each one of the above
  35.           elements is given below:
  36.  
  37.           Name The name of the file or directory.
  38.  
  39.           [KEY]
  40.                This is the actual block number of the file or
  41.                directory block header.  This is not displayed by
  42.                default, you must use the KEYS switch to generate this
  43.                element of the listing.
  44.  
  45.           size/type
  46.                This element gives the size of the file in bytes, or
  47.                the string "empty" if the file is empty. If this is a
  48.                directory and not a file, then the directory indicator
  49.                ("Dir") will appear here.
  50.  
  51.           protection
  52.                The protection bits of the current file, in the order
  53.                hsparwed.  If any of these is disabled, a dash (-) will
  54.                appear in its place. The protection bits stand for
  55.                "hidden, script, pure, archived, read, write, execute
  56.                and delete", respectively.
  57.  
  58.           date time
  59.                The date and time of the last modification to the file
  60.  
  61.  
  62.  
  63.      Page 1                                          (printed 4/28/89)
  64.  
  65.  
  66.  
  67.  
  68.  
  69.  
  70.      List(V1.3)              ARP User's Manual              List(V1.3)
  71.  
  72.  
  73.  
  74.                or directory.  The format of the date display is
  75.                determined by the value of the environment variable
  76.                dateformat.  These elements of the listing appear by
  77.                default, but may be selectively added or subtracted by
  78.                using the DATES or NODATES keywords.
  79.  
  80.           comment
  81.                The comment as set by Filenote.  If no comment exists,
  82.                this field will not be displayed.  Note that it is
  83.                displayed on a line by itself, preceded by a colon.
  84.  
  85.      SELECTIVE LISTING OF FILES
  86.           The methods described in this section allow you to list a
  87.           portion of the files and directories on your disks. Ways
  88.           exist to generate a list of files that conform to a certain
  89.           pattern, or that were created/modified before or after a
  90.           certain date.  You may also combine these options, for
  91.           example, you may get a list of all files which end in .c and
  92.           were created or modified since a certain date. These options
  93.           are described below:
  94.  
  95.           Dir  List this directory instead of the current directory.
  96.                This parameter may be a filename, in which case the
  97.                single file is shown.  You may also use any legal ARP
  98.                pattern in this position, in which case the files and
  99.                directories listed will be those which match the
  100.                pattern, if any.  (This feature was added to the
  101.            BCPL List in the V1.3 enhancer.)
  102.  
  103.           PAT  List only files and directories which match the
  104.                pattern. You must specify the keyword PAT or its
  105.                abbreviation P.  This is no longer truly necessary with
  106.                the expanded capabilities of the ARP List, since it is
  107.                usually more convenient to simply include the pattern
  108.                in the directory specification as described above.  It
  109.                is included for BCPL compatibility.
  110.  
  111.           SUB  This searches for an occurence of the substring
  112.                anywhere within the directory name or filename.  Think
  113.                of this as a short form of "List PAT *substring*" or a
  114.                long form of "List *substring*".  List will reject any
  115.                attempts to combine the use of PAT and S.  Wildcards in
  116.                the initial DIR argument are matched and then checked
  117.            again to match against the substring.
  118.  
  119.           SINCE
  120.                While the pattern matching options above filter files
  121.                and directories on the basis of their names, this
  122.                option, and the following UPTO option, filter out files
  123.                based on their last modification date. SINCE displays
  124.  
  125.  
  126.  
  127.  
  128.  
  129.      Page 2                                          (printed 4/28/89)
  130.  
  131.  
  132.  
  133.  
  134.  
  135.  
  136.      List(V1.3)              ARP User's Manual              List(V1.3)
  137.  
  138.  
  139.  
  140.                only files which have been created or modified on or
  141.                later than the specified date.  All older files are not
  142.                displayed.  You may specify the date in the currently
  143.                defined dateformat (see Environment Variables) or you
  144.                may use a word such as SUNDAY, TODAY, YESTERDAY, etc.
  145.  
  146.           UPTO The inverse of SINCE, this option displays only files
  147.                and directories which have been modified or
  148.                created on or before the specified date.  Files younger
  149.                than this date are not displayed. See SINCE for a
  150.                description of the date format list expects.
  151.  
  152.           FILES
  153.                Display only files.
  154.  
  155.           DIRS Display only directories.
  156.  
  157.      CONTROLLING THE DISPLAY
  158.           The options below allow you to alter the format of the
  159.           display listing, or to send it to another file or output
  160.           display device (that's usually a printer).
  161.  
  162.           TO   You can specify a file or a device you wish the listing
  163.                to be sent to using this keyword.  If not specified,
  164.                the default of the current window will be used.
  165.  
  166.           DATES
  167.                Forces date and time information to be displayed in the
  168.                current dateformat.
  169.  
  170.           NODATES
  171.                Will not display time and date information, only the
  172.                filename, size, protection and comment fields will be
  173.                displayed.
  174.  
  175.           QUICK
  176.                Displays only the filename field, one filename per
  177.                line, with no trailing spaces.  You can combine this
  178.                with other options such as DATES and KEYS to
  179.                selectively enable these fields.
  180.  
  181.           KEYS Displays the block number of each file header or
  182.                directory header.
  183.  
  184.           SORT Sorts the file and directory names into ascending
  185.                alphabetical order.  Case is disregarded. Note that
  186.                this is an option available only with the ARP list.
  187.            Sorts by DATE if you include the DATES keyword.
  188.  
  189.           BLOCK=BLOCKS
  190.                Displays filesizes in blocks, rather than bytes.
  191.  
  192.           NOHEAD
  193.  
  194.  
  195.      Page 3                                          (printed 4/28/89)
  196.  
  197.  
  198.  
  199.  
  200.  
  201.  
  202.      List(V1.3)              ARP User's Manual              List(V1.3)
  203.  
  204.  
  205.  
  206.                Suppresses the default header and footer display.
  207.  
  208.           LFORMAT
  209.                LFORMAT can be used to control the output of list, and
  210.                especially to generate command lines to be fed to the
  211.                shell. LFORMAT takes a string as an argument which can
  212.                be any ascii string.  To include the output of List in
  213.                this string, you can use the "%S" sequence as follows:
  214.  
  215.                   "%S"       Filename
  216.                   "%S%S"     Pathname/Filename
  217.                   "%S%S%S"   Pathname/FilenamePathname
  218.                   "%S%S%S%S" Pathname/FilenamePathname/Filename
  219.  
  220.                The %S's may be separated by spaces, other ascii text
  221.                or nothing, as above.  Here is an example of LFORMAT
  222.                that will create a script to Type each file:
  223.  
  224.                List LFORMAT="Type %S%S"
  225.  
  226.                Of course, to use this, you must save it in a file
  227.                using TO or one of the IO Redirection operators ('>',
  228.                '>>').  If you are using Ash, the ARP Shell, you can
  229.                also pipe the output of List directly into its Builtin
  230.                Execute command.  The Ash Manual has some examples of
  231.                using List with its LFORMAT option.
  232.  
  233.      ENVIRONMENT VARIABLES
  234.           The ARP List uses the same dateformat variable as used by
  235.           the ARP Date command, and in essentially the same way.  If
  236.           it is not defined, or if it has an illegal value, the
  237.           default AmigaDOS display and input is used.  Otherwise, the
  238.           display and the input of dates is determined as follows:
  239.  
  240.           0    AmigaDOS format DD-MMM-YY.
  241.  
  242.           1    International format YY-MM-DD.
  243.  
  244.           2    U.S. format MM-DD-YY.
  245.  
  246.           3    Canada DD-MM-YY
  247.  
  248.           If you prefix the above numbers with a dash, then the
  249.           display of names like TODAY, MONDAY, FUTURE, etc., will be
  250.           disabled and the format string as defined above will be used
  251.           exclusively. Note that this governs the format that List
  252.           expects as input as well as the format List uses for
  253.           display.
  254.  
  255.      EXAMPLES
  256.           List df1:*.c SINCE WEDNESDAY
  257.  
  258.  
  259.  
  260.  
  261.      Page 4                                          (printed 4/28/89)
  262.  
  263.  
  264.  
  265.  
  266.  
  267.  
  268.      List(V1.3)              ARP User's Manual              List(V1.3)
  269.  
  270.  
  271.  
  272.           Displays all files in df1: ending with the characters "*.c"
  273.           which were modified later than TUESDAY at 00:00 hours.
  274.  
  275.  
  276.  
  277.  
  278.  
  279.  
  280.  
  281.  
  282.  
  283.  
  284.  
  285.  
  286.  
  287.  
  288.  
  289.  
  290.  
  291.  
  292.  
  293.  
  294.  
  295.  
  296.  
  297.  
  298.  
  299.  
  300.  
  301.  
  302.  
  303.  
  304.  
  305.  
  306.  
  307.  
  308.  
  309.  
  310.  
  311.  
  312.  
  313.  
  314.  
  315.  
  316.  
  317.  
  318.  
  319.  
  320.  
  321.  
  322.  
  323.  
  324.  
  325.  
  326.  
  327.      Page 5                                          (printed 4/28/89)
  328.  
  329.  
  330.  
  331.