.\" Man page written by Michael Weers
.TH NDir 1 "2001-06-07" "" "Michael's File Utilities" \" -*- nroff -*-
.SH NAME
ndir, lv, lw \- list contents of directories
.SH SYNOPSIS
.B ndir
.RB [ \-a ] 
.RB [ \-A ] 
.RB [ \-c ] 
.RB [ \-d ]
.RB [ \-g ]
.RB [ \-l ]
.RB [ \-r ]
.RB [ \-R ]
.RB [ \-S ]
.RB [ \-t ]
.RB [ \-u ]
.RB [ \-U ]
.RB [ \-X ] 
.RB [ \-ca ] 
.RB [ \-cn ]
.RB [ \-\-utc ]
.RB [ \-? ]
.RI [ directories/files ...]
.PP
.B "ndir \-\-info" 
.RI [ files ...]
.PP
.B lv
and
.B lw 
with the above arguments
.SH DESCRIPTION
NDir is a console-based tool to display the contents of directories. 
It can both provide a brief overview on the present files and display 
all interesting information associated with the files. 
NDir is designed to display the files in a legible and informative way.
.PP
NDir lists the contents of directories that appear on the command line. 
Separate files can be given as well, these files are displayed within
the directory they are contained in.  For every directory, the full directory
path is printed, as well as  
a summary line stating how many files have been listed and how many disk
space they need in total. 
.PP
To get the directory listing in a brief format, just invoke NDir as 'ndir' or
\'lw'. Only the file names are printed. Multiple coloumns are used if possible.
Subdirectories have a forward slash after their name.
.PP
The long format can be selected with the '-l' option or by invokeing NDir as 
\'lv'. It includes additional information: file mode, ownership, last
modificaton date, size and finally, in the rightmost coloumn, the name. 
.PP
For a directory, subdirectories are displayed above all
other files. The files are displayed in alphabetical, case-insensitive
order (requires correct setup, see below). 
NDir is able to do colourized output of file names, depending on
the file's type. By default, colorization is in effect if output goes onto a
terminal.
.PP
The file-info mode (\-\-info) provides detailed information on
individial files.
.IP \fIdirectories/files\fR...
The directories and/or files to be listed, separated by white space. If omitted, the current directory is
used.
.SH OPTIONS
Options can be given in any order, but always separated by white space. 
Most options are compatible with GNU ls.
.PP
.B General options
.IP \-l 
Use the verbose (long) output format. This is the default if NDir is invoked as
\'lv'.
.IP \-\-info
Print properties of given files and directories verbosely, do not do any directory listing.
.IP "\-?, \-\-help"
Show NDir's version number, do not do any directory listing.
.PP
.\"
.B File selection
.IP \-a
List hidden files as well (as other files). Hidden files that appear
on the command line are displayed regardless of this option.
.IP \-A
List hidden files but omit '.' and '..'.
.IP \-d
Directories that appear on the command line are displayed within the directory 
they are contained in; their own contents is not listed. 
(In brief: they are just treated as ordinary files).
.IP \-R
Display the contents of all subdirectories.
.PP 
.\"
.B File order options
.PP
Default order is alphabetical.
.IP \-S
Display files ordered by their size (biggest first).
.IP \-t
Display files ordered by time (newest first). Default is the last modification time.
If used with -u or -c, that time (last access time / status change) is used 
instead.
Subdirectories are mixed with other files.
.IP \-U
Display files unordered.
.IP \-X
Display files ordered by their name extension.
.IP \-r
Reverse the files' order.
.PP
.B Presentation options
.IP \-g
The file's group is displayed as well (Verbose format only).
.IP \-u
Display the time the files were last used (Verbose format only).
.IP \-c 
Display the the file's status change time instead of last modification time 
(Verbose format).
.IP \--utc
Display dates in world time (UTC) instead of local time.
.IP \-ca
Force NDir to do display colourization regardless of the output device.
.IP \-cn
Force NDir not to do display colourization at all.
.SH CUSTOMIZING
NDir respects the user's language conventions in some aspects.
To make this work properly, ensure the 'LC_COLLATE' and 'LC_NUMERIC (or 'LANG')
environment variable is set to your locale. Affected is the ability to do a
case-insensitive file order and number display with thousands separator.
Contact your system administrator if in doubt.
.PP
NDir is able to do display colorization just like 'GNU ls' and expects 
the LS_COLORS environment variable to hold the color setup. If this variable
is not set, NDir has a built-in setup. By default, colorization is only done
if output goes directly onto a terminal (see the -ca and -cn option).
.SH ADVANCED ISSUES, BUGS
NDir has a special treatment of symbolic links that link to a directory. In
general, they are treated very similar to real directories, e.g. regarding
formatting. In verbose output format, links to directories are specially marked
as such, but in brief format they cannot be distinguished from real directories.
Other symbolic links are treated as links, as expected.
.PP
Dates are displayed in ISO 8601 format. Locale settings for dates are ignored.
.PP
The
combination of giving directories and separate files from these directories
in some specific order may make it seem that NDir has forgotten about the 
separate files. 
.PP
With '-R', only those subdirectories are displayed that were either displayed
in their containing directory or given directly on the command line.
.PP
The problem with '-R' and symbolic links to a parent directory, that
lead to infinite loops, 
should be fixed as of version 0.8.5. Such links will not be followed to avoid
infinite loops. Such a directory is silently omitted, and also does not show up
in the summary line of the directory tree.
.PP
If case-insensitive file order and/or number display with thousands separator
does not work even though the locale is set up correctly, the reason may be that
the selected locale doesn't have that information, either intentionally or by error.
.PP
Display colourization works fine with terminals that understand the ISO 6429
codes. The implementation is certainly not portable enough for some other
terminals.
.SH AUTHOR
NDir was written by Michael Weers (michael.weers@gmx.de).
.br
Copyright (C) 1997-2001 by Michael Weers.
.br
NDir is distributed under the terms of the GNU General Public License.
.SH SEE ALSO
.BR ls (1),
.BR dircolors (1),
.BR locale (1),
.BR locale (7)