tree - list contents of directories in a tree-like format.
SYNOPSIS
tree [ -adfgilnpqstuxACDFN ] [ -P pattern ] [ -I pattern ]
[ directory ... ]
DESCRIPTION
Tree is a recursive directory listing program that pro
duces a depth indented listing of files, which is col
orized ala dircolors if the LS_COLORS environment variable
is set and output is to tty. With no arguments, tree
lists the files in the current directory. When directory
arguments are given, tree lists all the files and/or
directories found in the given directories each in turn.
Upon completion of listing all files/directories found,
tree returns the total number of files and/or directories
listed.
By default, when a symbolic link is encountered, the path
that the symbolic link refers to is printed after the name
of the link in the format:
name -> real-path
If the `-l' option is given and the symbolic link refers
to an actual directory, then tree will follow the path of
the symbolic link as if it were a real directory.
OPTIONS
Tree understands the following command line switches:
-a All files are printed. By default tree does not
print hidden files (those beginning with a dot
`.'). In no event does tree print the file system
constructs `.' (current directory) and `..' (previ
ous directory).
-d List directories only.
-f Prints the full path prefix for each file.
-i Makes tree not print the indentation lines, useful
when used in conjunction with the -f option.
-l Follows symbolic links if they point to directo
ries, as if they were directories.
-xdev.
-P pattern
List only those files that match the wild-card pat
tern. Note: you must use the -a option to also
consider those files beginning with a dot `.' for
matching. Valid wildcard operators are `*' (any
zero or more characters), `?' (any single charac
ter), `[...]' (any single character listed between
brackets (optional - (dash) for character range may
be used: ex: [A-Z]), and `[^...]' (any single char
acter not listed in brackets).
-I pattern
Do not list those files that match the wild-card
pattern.
-p Print the protections for each file (as per ls -l).
-s Print the size of each file along with the name.
-u Print the username, or UID # if no username is
available, of the file.
-g Print the group name, or GID # if no group name is
available, of the file.
-D Print the date of the last modification time for
the file listed.
-F Append a `/' for directories, a `=' for socket
files, a `*' for executable files and a `|' for
FIFO's, as per ls -F
-q Print non-printable characters in filenames as
question marks instead of the default caret nota
tion.
-N Print non-printable characters as is instead of the
default caret notation.
-t Sort the output by last modification time instead
-n Turn colorization off always, over-ridden by the -C
option.
-C Turn colorization on always, unless the LS_COLORS
environment variable is not set. Useful to col
orize output to a pipe.
-A Turn on ANSI line graphics hack when printing the
indentation lines.
FILES
/etc/DIR_COLORS System color database.
~/.dircolors Users color database.
ENVIRONMENT
LS_COLORS Color information created by dircolors
AUTHOR
Steve Baker (ice@mama.indstate.edu)
BUGS
None known. Not heavily tested. Needs a few more
options, ala ls.
SEE ALSO
dircolors(1L), ls(1L)
Man(1) output converted with
man2html