1 10/20/86 describe_list, dls
 2 
 3 Syntax as a command:  dls path {-control_args}
 4 
 5 
 6 Syntax as an active function:  [dls path {-control_args}]
 7 
 8 
 9 Function:  displays information about a lister file.  As an active
10 function, return information about a lister file.
11 
12 
13 Arguments:
14 path
15    is the pathname of the lister file.  The suffix lister must be the
16    last component of the lister segment name; however, if path does not
17    have a suffix of lister, one is assumed.
18 
19 
20 Control arguments:
21 -delimiter {record|field}, -dm {record|field}
22    displays the value of the record or field delimiter.  If the record
23    and field keywords are omitted, then both delimiters are printed.
24 -field_name, -fn
25    displays the field_names in the lister file.
26 -header, -he
27    prints a heading line.  A header is normally printed if none of -dm,
28    -tt and -fn are specified.
29 -no_header
30    omits the heading line.
31 -select STR, -sel STR
32    specifies those records to be indicated by the -total control
33    argument.  If this control argument is not specified, then the total
34    number of records in the file is used.
35 
36 
37 -total, -tt
38    displays the total number of records.
39 
40 
41 Notes:  If no control arguments are given, or only the -select control
42 argument is given, then the record and field delimiters, total, and the
43 field names are displayed.
44 
45 
46 If none or more than one of -delimiter {record|field}, -total, or
47 -field_name are specified, the values are returned in the following
48 order:  record_delimiter, field_delimiter, total, and field_names.
49 
50 
51 The describe_list command sets the "lister" severity indicator.  A
52 severity of 2 is set when the information is not returned or the
53 invocation of describe_list terminates abnormally.  A severity of 1 is
54 set when the information is returned but no records match the selection
55 expression.  A severity of 0 is set when the information is returned
56 and at least one record matches the selection expression.