diff options
Diffstat (limited to 'pkg/system/doc/directory.hlp')
| -rw-r--r-- | pkg/system/doc/directory.hlp | 148 |
1 files changed, 148 insertions, 0 deletions
diff --git a/pkg/system/doc/directory.hlp b/pkg/system/doc/directory.hlp new file mode 100644 index 00000000..8c4382e9 --- /dev/null +++ b/pkg/system/doc/directory.hlp @@ -0,0 +1,148 @@ +.help directory Mar87 system +.ih +NAME +directory -- list the contents of a file directory +.ih +USAGE +directory [files] +.ih +PARAMETERS +.ls files +A file template specifying the files to be listed, or the name of the directory +whose contents are to be listed. If omitted entirely, the contents of the +current directory are listed. +.le +.ls long = no +Long format listing. The long format listing lists each file on a separate +line, noting the file permissions, file type, file size, modify date, owner, +etc. of each file. +.le +.ls ncols = 0 +If nonzero, the number of columns of output in multicolumn format. +.le +.ls maxch = 18 +The maximum number of characters to be displayed in each filename. +Truncation may be desirable when listing a directory containing one or two +files with very long filenames. +.le +.ls sort = yes +Sort the file list alphabetically. If sorting is disabled the directory +program lists the files in the order in which they are read from the +directory, which may or may not be sorted. The directory listing is produced +line by line as files are read from the directory, rather than accumulating +the entire file list in memory before composing the table, hence this is the +fastest method of listing a directory, particularly if the directory is very +large. +.le +.ls all = no +List all files, including the hidden ("." prefixed) files, and files with +reserved filename extensions used internally by the VOS. +.le +.ih +DESCRIPTION +The \fBdirectory\fR task lists or prints information describing some subset +of the files in a directory or directories. If no name template is given, +"." is assumed, i.e., all files in the current directory are listed. + +The long format listing gives a file type string, followed by +the name of the owner of the file, the file size, date and time at which +the file was last modified, and lastly the file name. +The file type string has fields noting if the file is a directory file (d), +an executable file (x), a text or binary file (t or b), a protected file (p), +and summarizing the file permissions (read or write, r or b) for the owner, +the group, and the rest of the world. A minus sign indicates that the file +does not have that particular attribute. + +All file names are printed in the IRAF virtual filename syntax, which is the +same on all host machines. IRAF filenames may be up to 32 characters in +length, may contain any combination of alphanumeric characters, underscore, +or period, and are case sensitive. Some of the common filename extensions +are listed below; these are mapped to and from the host filename extensions +when a file is accessed, a directory is listed, or a filename template is +expanded. + +.nf + .a object library + .c C source file + .cl CL source file + .e executable (runnable) file + .f Fortran source file + .gX generic source file (X=[cx]) + .h global header file + .hlp help file + .o object file + .par CL parameter file + .s assembler source file + .x SPP source file +.fi + +When listing large directories, the time required to accumulate and sort the +entire directory in memory before producing the output listing may become +significant (i.e., more than a few seconds). If this happens, try setting +the \fIsort\fR option to \fIno\fR, and the directory listing should appear +immediately. +.ih +EXAMPLES + +1. List all the files in the current directory in tabular format. + + cl> dir + +2. Print detailed information on all files in the current directory. + +.nf + cl> dir l+ + -t-rwr-r- iraf 269 Oct 16 1983 README + dt-rwrwr- iraf 1024 Feb 7 12:48 doc + -t-rwr-r- iraf 60 Jan 30 1984 files.par + -t-rwr-r- iraf 420 Jan 30 1984 files.x + -b-rwrwr- system 187338 Jan 29 19:27 libpkg.a + xb-rwr-r- iraf 363520 Jan 29 19:29 x_system.e + -b-rwrwr- system 5037 Jan 19 22:15 x_system.o + -t-rwr-r- iraf 633 Jan 19 22:01 x_system.x +.fi + +3. Print a single column listing of all the files with extension ".h" +in the logical directory "lib$". + +.nf + cl> dir lib$*.h l+ + lib$chars.h + lib$clio.h + lib$clpopn.h + (etc) +.fi + +4. While in the "system" directory, print the contents of the parallel +directory "dataio". + +.nf + cl> cd pkg$system + cl> dir ../dataio +.fi + +5. Test if the file "alpha" exists in the current directory. In the example, +the output given indicates that the file was not found. + +.nf + cl> dir alpha + no files found +.fi + +6. Print the contents of the directory USR$2:[IRAF.LOCAL] on the remote VMS +node "draco" (requires IRAF network access to the remote node). + +.nf + cl> dir draco!usr\$2:\[iraf.local] +.fi +.ih +BUGS +There is no provision for wildcarding directories, e.g., "dir */*.x". +The long format listing can currently only be sorted by filename (although +the \fIsort\fR program may be used in a pipe). The file existence test will +not be performed if individual files are named as list elements within +a filename template. +.ih +SEE ALSO +files, pathnames +.endhelp |