Browse Source

Add README.md

Douglas Thrift 8 years ago
parent
commit
8a344264e9
1 changed files with 125 additions and 0 deletions
  1. 125 0
      README.md

+ 125 - 0
README.md

@@ -0,0 +1,125 @@
+# DT PS Tree
+
+`dtpstree` shows running processes as a tree. It is a reimplementation of
+`pstree` from [PSmisc] for [FreeBSD], [NetBSD], [OpenBSD], [DragonFly BSD], and
+possibly other modern BSD variants. It also works without `/proc` and will show
+the full set of processes in a jail even if `init` is not present.
+
+It is released under the [Apache License, Version 2.0].
+
+## Download
+
+* [dtpstree-1.0.3.tar.bz2] 50.5 kB
+* [dtpstree-1.0.3.tar.xz] 46.7 kB
+
+### FreeBSD
+
+On FreeBSD, you can install it from the port
+[sysutils/dtpstree](https://svnweb.freebsd.org/ports/head/sysutils/dtpstree/):
+
+```bash
+cd /usr/ports/sysutils/dtpstree
+make
+make install
+```
+
+Or you can use `pkg` instead:
+
+```bash
+pkg install dtpstree
+```
+
+### pkgsrc (NetBSD)
+
+On NetBSD or other systems using pkgsrc, you can install it from the port
+[sysutils/dtpstree](http://cvsweb.netbsd.org/bsdweb.cgi/pkgsrc/sysutils/dtpstree/):
+
+```bash
+cd /usr/pkgsrc/sysutils/dtpstree
+make
+make install
+```
+
+Or, if there is a binary package, you can use `pkg_add` instead:
+
+```bash
+pkg_add dtpstree
+```
+
+### OpenBSD
+
+On OpenBSD, you can install it from the port
+[sysutils/dtpstree](http://cvsweb.openbsd.org/cgi-bin/cvsweb/ports/sysutils/dtpstree/):
+
+```bash
+cd /usr/ports/sysutils/dtpstree
+make
+make install
+```
+
+Or you can use `pkg_add` instead:
+
+```bash
+pkg_add dtpstree
+```
+
+### DragonFly BSD
+
+On DragonFly BSD, you can install it from the port
+[sysutils/dtpstree](https://github.com/DragonFlyBSD/DPorts/tree/master/sysutils/dtpstree):
+
+```bash
+cd /usr/dports/sysutils/dtpstree
+make
+make install
+```
+
+Or you can use `pkg` instead:
+
+```bash
+pkg install dtpstree
+```
+
+### Debian GNU/kFreeBSD
+
+On [Debian GNU/kFreeBSD] you can install it [apt.douglasthrift.net]:
+
+```bash
+apt-get install dtpstree
+```
+
+## Documentation
+
+```nohighlight
+Usage: dtpstree [options] [PID|USER]
+
+Options:
+  -a, --arguments             show command line arguments
+  -A, --ascii                 use ASCII line drawing characters
+  -c, --no-compact            don't compact identical subtrees
+  -h, --help                  show this help message and exit
+  -H[PID], --highlight[=PID]  highlight the current process (or PID) and its
+                              ancestors
+  -G, --vt100                 use VT100 line drawing characters
+  -k, --show-kernel           show kernel processes
+  -l, --long                  don't truncate long lines
+  -n, --numeric-sort          sort output by PID
+  -p, --show-pids             show PIDs; implies -c
+  -t, --show-titles           show process titles
+  -u, --uid-changes           show uid transitions
+  -U, --unicode               use Unicode line drawing characters
+  -V, --version               show version information and exit
+  PID, --pid=PID              show only the tree rooted at the process PID
+  USER, --user=USER           show only trees rooted at processes of USER
+```
+
+[PSmisc]: http://psmisc.sourceforge.net/
+[FreeBSD]: https://www.freebsd.org/
+[NetBSD]: https://www.netbsd.org/
+[OpenBSD]: http://www.openbsd.org/
+[DragonFly BSD]: https://www.dragonflybsd.org/
+[Apache License, Version 2.0]: https://www.apache.org/licenses/LICENSE-2.0
+[dtpstree-1.0.3.tar.bz2]: http://code.douglasthrift.net/files/dtpstree/dtpstree-1.0.3.tar.bz2
+[dtpstree-1.0.3.tar.xz]: http://code.douglasthrift.net/files/dtpstree/dtpstree-1.0.3.tar.xz
+[Debian GNU/kFreeBSD]: https://www.debian.org/ports/kfreebsd-gnu/
+[apt.douglasthrift.net]: https://apt.douglasthrift.net/