1 :Info: list: ls:  1985-02-14  list, ls
  2 
  3 Syntax as a command:  ls {entrynames} {-control_args}
  4 
  5 
  6 Function: prints information about the entries in a single directory.
  7 There are five entry types supported by list: segments, multisegment
  8 files (MSFs), data management (DM) files, directories, and links.
  9 Segments, DM files, and MSFs are referred to collectively as files;
 10 segments, MSFs, DM files, and directories are referred to collectively
 11 as branches.
 12 
 13 
 14 Arguments:
 15 entrynames
 16    are the names of entries to be listed.  The star convention
 17    can be used.  If no entrynames are given, all entries in the
 18    directory (of the default types or the types specified by
 19    control arguments) are listed.  A pathname can be given instead
 20    of an entryname, causing the entries specified by its entryname
 21    portion to be listed, in the directory specified by its
 22    directory portion.  It is an error to specify more than one
 23    directory to be listed in a single invocation of the list
 24    command.
 25 
 26 
 27 Control arguments (directory):
 28 -pathname path, -pn path
 29    list entries in the directory named path.  Note the restriction
 30    described above under "Arguments."
 31 
 32 
 33 Control arguments (entry type):
 34 -segment, -sm
 35    list segments.
 36 -multisegment_file, -msf
 37    list multisegment files.
 38 -data_management_file, -dmf
 39    lists data management files.
 40 -file, -f
 41    list information about files (i.e., segments, MSFs, and DM files).
 42    (Default)
 43 -directory, -dr
 44    list directories.
 45 -branch, -br
 46    list information about branches (i.e., segments, MSFs, DM files, and
 47    directories).
 48 
 49 
 50 -link, -lk
 51    list links.
 52 -all, -a
 53    list information about all entry types in the following order:
 54    segments, MSFs, DM files, directories, and links.
 55 
 56 
 57 Control arguments (column): (see also "Notes on columns" below)
 58 -date_time_entry_modified, -dtem
 59    print date-time-entry-modified in the modification-date column.
 60 -date_time_contents_modified, -dtcm
 61    print date-time-contents-modified in the modification-date column.
 62 -date_time_used, -dtu
 63    print date-time-used column.
 64 -mode, -md
 65    print mode column.
 66 -record, -rec
 67    print records used in size column.
 68 -length, -ln
 69    print length computed from bit count in size column.
 70 -name, -nm
 71    print names column.
 72 
 73 
 74 -count, -ct
 75    print name-count column, giving number of names.
 76 -link_path, -lp
 77    print link-path column.
 78 
 79 
 80 Control arguments (totals/header line):
 81 -total, -tt
 82    print only number of entries and sum of their sizes.
 83 -no_header, -nhe
 84    omit all heading lines and blank lines.
 85 
 86 
 87 Control arguments (multiple-name entry):
 88 -primary, -pri
 89    print only primary names in names column.
 90 -match
 91    print only names that match one of entryname arguments.
 92 
 93 
 94 Control arguments (entry order):
 95 -sort KEY, -sr KEY
 96    sort entries by specified key column (see "List of sorting keys").
 97    By default, entries are printed in the order they are found in the
 98    directory.
 99 -reverse, -rv
100    reverse order of listing (reverses either directory order, or
101    order of sorting if sorting was specified).
102 
103 
104 Control arguments (entry exclusion):
105 -exclude entryname, -ex entryname
106    excludes entries that match entryname; more than one instance of
107    this argument can be given.
108 -first N, -ft N
109    list only first N entries (after sorting, if it is specified) of
110    each entry type being listed.
111 -from DATE, -fm DATE
112    excludes entries having date/time (dtem, dtcm, dtu) before DATE
113    (see "Notes on dates" below).
114 -to DATE
115    excludes entries having date/time (dtem, dtcm, dtu) after DATE
116    (see "Notes on dates").
117 
118 
119 Control arguments (output format):
120 -brief, -bf
121    either overrides default columns (see "Notes on defaults")
122    or, if -tt given, prints totals information for all selected entry
123    types on single line.
124 -short, -sh
125    print link paths starting two spaces after their names.
126 
127 
128 List of sorting keys:
129    The KEY field in "-sort KEY" can be one of the following.
130    Links can only be sorted by dtem, dtcm, nm, or ct.  When
131    sorting by other columns, links are listed in the order in which
132    they are found in the directory.  (See also "Notes on defaults.")
133 name, nm
134    sort by primary name, in ASCII collating sequence.
135 date_time_entry_modified, dtem
136    sort by date-time-entry-modified, most recent first.
137 date_time_contents_modified, dtcm
138    sort by date-time-contents-modified, most recent first.
139 
140 
141 record, rec
142    sort by records, largest first.
143 length, ln
144    sort by bit count length, largest first.
145 mode, md
146    sort by mode; order:  null, r or s, rw or sm, re, rew or sma.
147 count, ct
148    sort by name count, entries with highest name count first.
149 
150 
151 Notes: Use of the -name, -mode, -record, -length, or -brief control
152 arguments overrides the default columns so that only the names column
153 and explicitly selected columns are printed.
154 
155 Only one of the two modification dates, and only one of the two size
156 figures can be used at any one time.  Any combination of arguments
157 that specifies both items from either pair (e.g., printing dtcm but
158 sorting on dtem) is an error.
159 
160 
161 Notes on columns: The column printing order is--modification date,
162 dtu, mode, size, names, name count, and (for links only) link
163 pathname.  Modification date can be either date-time-contents-modified
164 or date-time-entry-modified (dtm is accepted as dtem).  Size can be
165 either records used or length computed from the bit count (default).
166 
167 
168 Notes on dates: The -from and -to control arguments compare DATE and
169 date.  The DATE string must be acceptable to the
170 convert_date_to_binary_ subroutine.  The date value is
171 date-time-entry-modified (or date-time-contents-modified, if it is
172 being printed or sorted on) in all cases except when date-time-used is
173 the only date being printed or sorted on.
174 
175 
176 Notes on defaults: Invoking list without any arguments is the same as
177 typing:
178    list -pn [wd] -file -mode -length -name
179 
180 If the sort column, COL, is omitted after -sort, the default sorting
181 column is: modification-date, if it is being printed; otherwise
182 date-time-used, if it is being printed; otherwise names.
183 
184 
185 :hcom:
186 
187 
188 
189 /****^  HISTORY COMMENTS:
190   1) change(2020-12-15,GDixon), approve(2021-02-22,MCR10088),
191      audit(2021-05-27,Swenson), install(2021-05-27,MR12.6g-0056):
192       A) Fix problems found by verify_info command.
193       B) Move tag-along paragraph describing sort keys for link branches to the
194          "List of sorting keys:" introduction.
195                                                    END HISTORY COMMENTS */
196 
197 
198