====
rtls
====

--------------------------------
list directories in the RTC Tree
--------------------------------

.. include:: ../common/docinfo_block.txt

Synopsis
========

rtls [options] [path]

Description
===========

List the contents of the a directory in the RTC Tree. The default is to
list the contents of the current working directory.

The long display shows the following information in columns for
RT-Components:

 - State

 - Total number of ports/Total connected

 - Input ports/Inputs connected

 - Output ports/Outputs connected

 - Service ports/Service connected

 - Name

Options
=======

-l
  Use a long listing format.

-R, --recurse
  List recursively.

.. include:: ../common/common_opts.txt

.. include:: ../common/common_body.txt

Examples
========

::

  $ rtls

List the contents of the current working directory.

::

  $ rtls /

List the contents of the root directory of the RTC Tree. This will show
a list of known name servers.

::

  $ rtls /localhost

List the objects registered directly to the ``localhost`` name server.

::

  $ rtls -R /localhost

List all objects in the ``localhost`` name server, even those registered
to other naming contexts and managers below the name server.

::

  $ rtls -l /localhost

Get a long listing of the objects registered below ``/localhost``,
showing information such as the status of components.

::

  $ rtls -lR /localhost

Get a long listing of all objects in the ``localhost`` name server.

::

  $ watch -n 1 rtls -l

(POSIX only) Display the status of all components in the current working
directory, updating the display once per second.


See Also
========

  ``rtcat`` (1),
  ``rtcwd`` (1),
  ``rtpwd`` (1)

