Seeing the forest with tree
In Full View
The tree command can provide a clear view of all your files and directories and offers a few advantages over the usual ls command.
The tree
command [1] is a tool that I'd overlooked until recently. After trying it for several weeks, however, I am starting to prefer its tree-like display of directories and files to the plain lists generated by ls
.
Part of the reason is that, in these GUI-oriented days, even a directory tree made with ASCII characters is more comfortable than no structural display at all. The functional differences between tree
and ls
are minimal. The two commands share a few options, such as -a
for displaying all files, and even when the options are different, the functionality remains similar. The largest exception I have noticed is that ls
offers an option for the number of columns in which to display results; the tree
display makes a single column unavoidable.
You have to look closely to see the differences, but tree
is consistently more versatile, starting with, unlike ls
, recursion. By default, tree
displays all files in all subdirectories.
Like ls
, tree is part of the standard installation for most distributions. If yours does not include it, or if you want the absolutely latest version, you can download the source code from the project site to compile.
Without any options or target directory to view, tree lists the current directory. Alternatively, you can specify a directory to be the top level in the display (Figure 1).
Unless you know that the directories you are viewing contain only a few files, you will almost certainly want to pipe it through less
, so that you can scroll back and forth in the results.
The basic command structure is:
tree OPTIONS TOP-DIRECTORY | less
However, this structure is only the beginning. Tree also includes extensive options for adjusting how results are displayed, how the command operates, how files are listed, and how files are sorted.
Display Options
If your environment includes LS_COLORS
, the display uses the same color codes as ls
(blue for directories, white for general files, red for archived files, green for an uncompiled script). One of the most obvious advantages over ls
is that an archived file is treated as subdirectory file, so you can read its files directly from tree
. The output ends with the total number of directories and files displayed.
You can modify this default display in several ways. Adding the -n
option after the basic command turns colorization off, whereas -C
restores it. Using -i
suppresses indentation for directories, giving similar results to ls
in a single column, and --noreport
removes the final count of directories and files.
Unmodified, tree
does not include the last time a file or directory was modified. However, you add the information with --timefmt FORMAT
. The --timefmt
option uses the formats defined in strftime
[2], a standard convention for displaying date and time. Strftime includes dozens of options, but %c
(the default time and date for the current system's locale) or %d/%m/%y
(day/month/year) are two of the most useful for the date, and %T
(for a 24-hour clock) for time. If none of these options are what you want, consult the strftime
man page for a complete list of options.
Operational Options
By default, tree
displays all non-hidden files and directories below the directory you specify. However, you can modify how tree
handles different aspects of the directory tree in several ways.
To start, you can add the -a
option to list hidden files, just as you can with ls
. At the opposite extreme, -d
lists only directories. Add --prune
, and results can become sparser yet, with no empty directories displayed. Other options limit the input to tree
. Using -L LEVEL
, you can limit the directory depth to display (Figure 2). The option --filelimit NUMBER
imposes a similar restriction, displaying only directories with more than the stated number of entries. If your hard drive is partitioned with LVM or uses RAID, -x
will restrict results only tho those on the current filesystem.
The tree
command also uses basic wildcards when the -P
option is used, such as *
for zero or more characters, ?
for any single character, and a list or range of characters within square brackets (e.g., [ABC]
or [5-6]
). When the contents of the brackets begin with a ^
, then the search is for a single character not listed in the brackets.
Whatever options you use, -o=FILENAME
saves the results to a file. Tree saves in XML format by default, but if necessary, -x
will turn XML output back on. Alternatively, -H BASEHREF
turns on HTML output, which can be handy for referencing an HTML or FTP site. When you do choose HTML output, --nolinks
turns off hyperlinks in the output file, and -T TITLE
sets the title and first level header in the output file to HTML.
Many of these options can be especially useful if you have some knowledge of the directory structure and want to eliminate large segments of the structure as you search for particular files and directories. In my experience, they are best used in separate sweeps of the directory tree so that one does not interfere with another.
File Output Options
Tree gives you the choice of substituting non-printable characters in results with a question mark (-q
) or printing them as is (-N
). You also have the option of printing file names with double-quotation marks around them (-Q
), which can be convenient if a file title uses spaces and you plan to copy and paste it for use in another command (Figure 3).
Colorblind users might also prefer to include -F
in the command, to print symbols to identify file types – for example, /
for directories.
However, most of tree
's file output options display meta-information. With -u
, tree
prints the user ID (UIF), and -g
prints the group ID (GID), as shown in Figure 4. If your interest is in file sizes, then -s
prints them in bytes, and -h
shows them in the most suitable unit readable for humans: K
specifying kilobytes, M
for megabytes, G
for gigabytes, and so on.
You can also include in the output the disk usage for each directory with -du
or show the device number for each result with --device
.
Buy this article as PDF
(incl. VAT)
Buy Linux Magazine
Subscribe to our Linux Newsletters
Find Linux and Open Source Jobs
Subscribe to our ADMIN Newsletters
Support Our Work
Linux Magazine content is made possible with support from readers like you. Please consider contributing when you’ve found an article to be beneficial.
News
-
New Slimbook EVO with Raw AMD Ryzen Power
If you're looking for serious power in a 14" ultrabook that is powered by Linux, Slimbook has just the thing for you.
-
The Gnome Foundation Struggling to Stay Afloat
The foundation behind the Gnome desktop environment is having to go through some serious belt-tightening due to continued financial problems.
-
Thousands of Linux Servers Infected with Stealth Malware Since 2021
Perfctl is capable of remaining undetected, which makes it dangerous and hard to mitigate.
-
Halcyon Creates Anti-Ransomware Protection for Linux
As more Linux systems are targeted by ransomware, Halcyon is stepping up its protection.
-
Valve and Arch Linux Announce Collaboration
Valve and Arch have come together for two projects that will have a serious impact on the Linux distribution.
-
Hacker Successfully Runs Linux on a CPU from the Early ‘70s
From the office of "Look what I can do," Dmitry Grinberg was able to get Linux running on a processor that was created in 1971.
-
OSI and LPI Form Strategic Alliance
With a goal of strengthening Linux and open source communities, this new alliance aims to nurture the growth of more highly skilled professionals.
-
Fedora 41 Beta Available with Some Interesting Additions
If you're a Fedora fan, you'll be excited to hear the beta version of the latest release is now available for testing and includes plenty of updates.
-
AlmaLinux Unveils New Hardware Certification Process
The AlmaLinux Hardware Certification Program run by the Certification Special Interest Group (SIG) aims to ensure seamless compatibility between AlmaLinux and a wide range of hardware configurations.
-
Wind River Introduces eLxr Pro Linux Solution
eLxr Pro offers an end-to-end Linux solution backed by expert commercial support.