'\" t
.\"     Title: TREE
.\"    Author: [see the "AUTHOR" section]
.\" Generator: DocBook XSL-NS Stylesheets v1.76.1 <http://docbook.sf.net/>
.\"      Date: 04/13/2022
.\"    Manual: BRL-CAD MGED Commands
.\"    Source: BRL-CAD
.\"  Language: English
.\"
.TH "TREE" "nged" "04/13/2022" "BRL\-CAD" "BRL\-CAD MGED Commands"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.\" http://bugs.debian.org/507673
.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.\" -----------------------------------------------------------------
.\" * set default formatting
.\" -----------------------------------------------------------------
.\" disable hyphenation
.nh
.\" disable justification (adjust text to left margin only)
.ad l
.\" -----------------------------------------------------------------
.\" * MAIN CONTENT STARTS HERE *
.\" -----------------------------------------------------------------
.SH "NAME"
tree \- Lists the contents of the specified \fIobjects\fR in a tree\-like format that displays the hierarchical structure of the objects, and all objects referenced by them, down to the primitive shape level\&.
.SH "SYNOPSIS"
.HP \w'\fBtree\fR\ 'u
\fBtree\fR {\fIobjects(s)\fR} [\-a] [\-c] [\-i\fI#\fR] [\-o\fIoutfile\fR]
.SH "DESCRIPTION"
.PP
Lists the contents of the specified
\fIobjects\fR
in a tree\-like format that displays the hierarchical structure of the objects, and all objects referenced by them, down to the primitive shape level\&. If
\fI\-c\fR
is given, the shapes are not printed\&. The
\fI\-a\fR
option adds a list of any attributes for each object\&. Attributes are shown with a leading "@ " and are followed by their values\&. The
\fI\-o outfile\fR
option prints the results to
\fIoutfile\fR\&. The
\fI\-i #\fR
option allows the user to set the number of spaces to indent\&.
.SH "EXAMPLES"
.PP
The first example shows the use of the
\fBtree\fR
command to list the contents of specified objects hierarchically\&. The second and third examples show the use of the
\fBtree\fR
command with arguments\&.
.PP
\fBExample\ \&1.\ \&Show the structure of an object down to the primitive shape level.\fR
.PP

mged>\fBtree group1\fR
.PP
Shows the structure of the tree rooted at
\fIgroup1\fR
down to the primitive shape level\&.
.PP
\fBExample\ \&2.\ \&Specify the amount of indentation in the tree.\fR
.PP

mged>\fBtree \-i2 group1\fR
.PP
Uses two spaces for each level of indentation\&.
.PP
\fBExample\ \&3.\ \&Specify that no shapes are to be printed.\fR
.PP

mged>\fBtree \-c group1\fR
.PP
No shapes are printed\&.
.PP
\fBExample\ \&4.\ \&Specify that attributes are listed for each object printed.\fR
.PP

mged>\fBtree \-a \-c group1\fR
.PP
No shapes are printed, but attributes are shown for the printed objects\&.
.SH "AUTHOR"
.PP
BRL\-CAD Team
.SH "BUG REPORTS"
.PP
Reports of bugs or problems should be submitted via electronic mail to
devs@brlcad\&.org
