devtree/devtree.1

   1 .\" Copyright (C) 2014 Steven McDonald <steven@steven-mcdonald.id.au>
   2 .\"
   3 .\" This work is free. You can redistribute it and/or modify it under
   4 .\" the terms of the Do What The Fuck You Want To Public License,
   5 .\" Version 2, as published by Sam Hocevar. See the COPYING file or
   6 .\" visit http://www.wtfpl.net/ for more details.
   7 .\"
   8 .Dd $Mdocdate$
   9 .Dt DEVTREE 1
  10 .Os
  11 .Sh NAME
  12 .Nm devtree
  13 .Nd display a tree representing system hardware
  14 .Sh SYNOPSIS
  15 .Nm devtree
  16 .Op Fl d
  17 .Sh DESCRIPTION
  18 The
  19 .Nm
  20 utility accepts output from
  21 .Xr dmesg 8
  22 on standard input, and produces a human-friendly ASCII tree
  23 representing the currently attached system devices on standard output.
  24 .Pp
  25 If the
  26 .Sy -d
  27 option is provided, it will also include devices which have
  28 been detached from the system, appending
  29 .Em [DETACHED]
  30 to any such entries. All other options are ignored.
  31 .Sh EXAMPLES
  32 Display a tree of all attached devices on the current system:
  33 .Pp
  34 .Dl $ dmesg | devtree
  35 .Sh SEE ALSO
  36 .Xr dmesg 8