summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorMatthew Allum <breakfast@10.am>2003-12-20 11:56:07 +0000
committerMatthew Allum <breakfast@10.am>2003-12-20 11:56:07 +0000
commit0753fc20f6a3b71cd9ce3e7a7ef314330b8943df (patch)
treeb05f3f1890fd3c2fa9355fc48a723646a1d96e7f
parent817e5b605a18fb573b50a0c2e6ad8a7fca3e5a0f (diff)
added man page
-rw-r--r--ChangeLog9
-rw-r--r--Makefile.am2
-rw-r--r--configure.ac2
-rw-r--r--doc/Makefile.am1
-rw-r--r--doc/xrestop.138
5 files changed, 51 insertions, 1 deletions
diff --git a/ChangeLog b/ChangeLog
index 4a9af9c..9c438b4 100644
--- a/ChangeLog
+++ b/ChangeLog
@@ -1,5 +1,14 @@
2003-12-20 Matthew Allum <mallum@handhelds.org>
+ * Makefile.am:
+ * configure.ac:
+ * doc/Makefile.am:
+ * doc/xrestop.1:
+
+ Added a simple man page.
+
+2003-12-20 Matthew Allum <mallum@handhelds.org>
+
* xrestop.c: (xrestop_display), (xrestop_sort_compare):
Add totals to display. Change sort order to total bytes rather
than just pixmap bytes.
diff --git a/Makefile.am b/Makefile.am
index 4049702..333bf6b 100644
--- a/Makefile.am
+++ b/Makefile.am
@@ -1,3 +1,5 @@
+SUBDIRS = doc
+
AM_CFLAGS = @XLIBS_CFLAGS@
bin_PROGRAMS=xrestop
diff --git a/configure.ac b/configure.ac
index f9d38d9..b8cdaaa 100644
--- a/configure.ac
+++ b/configure.ac
@@ -64,4 +64,4 @@ AC_TYPE_PID_T
AC_CHECK_FUNCS([memset strdup])
-AC_OUTPUT([Makefile])
+AC_OUTPUT([Makefile doc/Makefile])
diff --git a/doc/Makefile.am b/doc/Makefile.am
new file mode 100644
index 0000000..1a4fc66
--- /dev/null
+++ b/doc/Makefile.am
@@ -0,0 +1 @@
+man_MANS = xrestop.1 \ No newline at end of file
diff --git a/doc/xrestop.1 b/doc/xrestop.1
new file mode 100644
index 0000000..4be98da
--- /dev/null
+++ b/doc/xrestop.1
@@ -0,0 +1,38 @@
+.TH "xrestop" 1
+.SH NAME
+xrestop \- A X11 client server resource usage monitor
+.SH SYNOPSIS
+.B xrestop
+-help
+.br
+.B xrestop
+[ \fB-display\fP display ] [ \fB--batch\fP ] [ \fB--delay-time\fP seconds ]
+.SH DESCRIPTION
+Xrestop uses the XRes extension to provide 'top' like statistics of
+each connected X11 client server side resource usage. It is intended
+as a developer tool to aid more efficient server resource usage and
+debug server side resource leakage.
+.SH OPTIONS
+.TP
+\fB\-\-help\fP
+Show usage.
+.TP
+\fB\-\-display, -d\fP <display>
+Specify X11 display to monitor.
+.TP
+\fB\-\--delay-time, -dt\fP <seconds>
+Time in seconds between taking samples. Default is 2 seconds.
+.TP
+\fB\-\--batch, -b\fP
+Run in batch mode. Slightly more detailed infomation is streamed to
+stdout rather than the usual curses interface. This mode is intended
+for debugging a single client with something like
+.br
+'xrestop -b | grep -A 14 appname
+.br
+.SH "SEE ALSO"
+X(7) TOP(1)
+.SH BUGS
+XRes extension is very new and may not be 100% accurate.
+.SH AUTHOR
+<mallum@handhelds.org> \ No newline at end of file