Permalink
Browse files

asciidoc manual page added

  • Loading branch information...
1 parent 08e5b61 commit 63db32b81f6ade4340e4b0fe16175593fb2c802f @dagwieers committed Aug 12, 2005
Showing with 217 additions and 187 deletions.
  1. +1 −0 ChangeLog
  2. +10 −2 Makefile
  3. +0 −185 dstat.1
  4. +206 −0 dstat.1.txt
View
@@ -7,6 +7,7 @@
- Exclude md-devices from total (Peter Cordes)
- Now accept 'total' keyword with -C (like -D and -N)
- Rewrote the path-inserting code
+- Added asciidoc based manual page
* 0.6.0 - Bettiesbaai - released 29/05/2005
- Removed keyboard input prevention patch. (Dbt 304673, Marc Lehmann)
View
@@ -7,7 +7,15 @@ mandir = $(datadir)/man
all:
@echo "No build phase."
-install:
+%.html: %.txt
+ asciidoc -b xhtml11 -d manpage $<
+%: %.xml
+ xmlto man $<
+
+%.xml: %.txt
+ asciidoc -b docbook -d manpage $<
+
+install: dstat.1 dstat.html
# -[ ! -f $(DESTDIR)$(sysconfdir)/dstat.conf ] && install -D -m0644 dstat.conf $(DESTDIR)$(sysconfdir)/dstat.conf
install -Dp -m0755 dstat $(DESTDIR)$(bindir)/dstat
install -Dp -m0644 dstat.1 $(DESTDIR)$(mandir)/man1/dstat.1
@@ -18,7 +26,7 @@ install:
# install -Dp -m0755 examples/*.py $(DESTDIR)$(datadir)/dstat/examples/
clean:
- rm -f dstat15.tr examples/*.pyc stats/*.pyc
+ rm -f dstat15.tr examples/*.pyc plugins/*.pyc dstat.1 dstat.1.html dstat.1.xml
#### Imperfect translation to dstat15
tr:
View
185 dstat.1
@@ -1,185 +0,0 @@
-.\" DO NOT MODIFY THIS FILE! It was generated by help2man 1.33.
-.TH DSTAT "1" "April 2005" "dstat 0.6.0" "User Commands"
-
-.SH NAME
-Dstat \- Versatile tool for generating system resource statistics
-
-.SH SYNOPSIS
-dstat [-afv] [-cdgilmnpsty] [-D..] [-I..] [-N..] [delay [count]]
-
-.SH DESCRIPTION
-Dstat is a versatile replacement for vmstat, iostat and ifstat. Dstat overcomes some of the limitations and adds some extra features.
-
-Dstat allows you to view all of your system resources instantly, you can eg. compare disk usage in combination with interrupts from your IDE controller, or compare the network bandwidth numbers directly with the disk throughput (in the same interval).
-
-Dstat also cleverly gives you the most detailed information in columns and clearly indicates in what magnitude and unit the output is displayed. Less confusion, less mistakes, more efficient.
-
-Dstat is unique in letting you aggregate block device throughput for a certain diskset or network bandwidth for a group of interfaces, ie. you can see the throughput for all the block devices that make up a single filesystem or storage system.
-
-Dstat allows its data to be directly written to a CSV file to be imported and used by OpenOffice, Gnumeric or Excel to create graphs.
-
-Users of Sleuthkit might find Sleuthkit's dstat being renamed to datastat to avoid a name conflict. See Debian bug #283709 for more information.
-
-.SH OPTIONS
-.TP
-\fB\-c\fR, \fB\-\-cpu\fR
-enable cpu stats
-.TP
-\fB\-C\fR 0,3,total
-include cpu0, cpu3 and total
-.TP
-\fB\-d\fR, \fB\-\-disk\fR
-enable disk stats
-.TP
-\fB\-D\fR total,hda
-include hda and total
-.TP
-\fB\-g\fR, \fB\-\-page\fR
-enable page stats
-.TP
-\fB\-i\fR, \fB\-\-int\fR
-enable interrupt stats
-.TP
-\fB\-I\fR 5,eth2
-include int5 and interrupt used by eth2
-.TP
-\fB\-l\fR, \fB\-\-load\fR
-enable load stats
-.TP
-\fB\-m\fR, \fB\-\-mem\fR
-enable memory stats
-.TP
-\fB\-n\fR, \fB\-\-net\fR
-enable network stats
-.TP
-\fB\-N\fR eth1,total
-include eth1 and total
-.TP
-\fB\-p\fR, \fB\-\-proc\fR
-enable process stats
-.TP
-\fB\-s\fR, \fB\-\-swap\fR
-enable swap stats
-.TP
-\fB\-t\fR, \fB\-\-time\fR
-enable time counter
-.TP
-\fB\-u\fR, \fB\-\-user\fR
-enable user stats
-.TP
-\fB\-y\fR, \fB\-\-sys\fR
-enable system stats
-.TP
-\fB\-\-ipc\fR
-enable ipc stats
-.TP
-\fB\-\-lock\fR
-enable lock stats
-.TP
-\fB\-\-raw\fR
-enable raw stats
-.TP
-\fB\-\-tcp\fR
-enable tcp stats
-.TP
-\fB\-\-udp\fR
-enable udp stats
-.TP
-\fB\-\-unix\fR
-enable unix stats
-.TP
-\fB\-M\fR stat1,stat2
-enable internal and external stats
-
-Possible internal stats are:
- cpu, disk, int, ipc, load, lock, mem, net, page,
- proc, raw, swap, sys, tcp, time, udp, unix
-
-Possible external stats can be listed using:
- dstat -M list
-.TP
-\fB\-a\fR, \fB\-\-all\fR
-equals \fB\-cdngy\fR (default)
-.TP
-\fB\-f\fR, \fB\-\-full\fR
-expand -D, -I and -N discovery lists
-.TP
-\fB\-v\fR, \fB\-\-vmstat\fR
-equals \fB\-pmgdsc\fR \fB\-D\fR total
-.TP
-\fB\-\-integer\fR
-show integer values
-.TP
-\fB\-\-nocolor\fR
-disable colors (implies --noupdate)
-.TP
-\fB\-\-noheaders\fR
-disable repetitive headers
-.TP
-\fB\-\-noupdate\fR
-disable intermediate updates when delay > 1
-.TP
-\fB\-\-output\fR file
-write CSV output to file
-
-.SH ARGUMENTS
-\fBdelay\fR is the delay in seconds between each update
-
-\fBcount\fR is the number of updates to display before exiting
-
-The default delay is 1 and count is unspecified (unlimited)
-
-.SH INTERMEDIATE UPDATES
-When invoking dstat with a \fBdelay\fR greater than 1 and without the \fB--noupdate\fR option, it will show intermediate updates, ie. the first time a 1 sec average, the second update a 2 second average, etc. until the delay has been reached.
-
-So in case you specified a delay of 10, \fBthe 9 intermediate updates are NOT snapshots\fR, they are averages over the time that passed since the last final update. The end result is that you get a 10 second average on a new line, just like with vmstat.
-
-.SH BUGS
-Since it's practically impossible to test dstat on every possible permutation of kernel , python or distribution version, I need your help and your feedback to fix the remaining problems. If you have improvements or bugreports, please send them to: \fBdag@wieers.com\fR
-
-Please see the TODO file for known bugs and future plans.
-
-.SH FILES
-.SS ~/.dstat/
-.SS ./
-.SS ./plugins/
-.SS /usr/share/dstat/
-paths that may contain external dstat_* modules
-
-.SH SEE ALSO
-.SS Performance tools
-ifstat(1), iftop(8), iostat(1), mpstat(1), netstat(1), nfsstat(1), nstat, vmstat(1), xosview(1)
-
-.SS Debugging tools
-htop, lslk(1), lsof(8), top(1)
-
-.SS Process tracing
-ltrace(1), pmap(1), ps(1), pstack(1), strace(1)
-
-.SS Binary debugging
-ldd(1), file(1), nm(1), objdump(1), readelf(1)
-
-.SS Memory usage tools
-free(1), memusage, memusagestat, slabtop(1)
-
-.SS Accounting tools
-dump-acct, dump-utmp, sa(8)
-
-.SS Hardware debugging tools
-dmidecode, ifinfo(1), lsdev(1), lshal(1), lshw(1), lsmod(8), lspci(8), lsusb(8), smartctl(8), x86info(1)
-
-.SS Application debugging
-mailstats(8), qshape(1)
-
-.SS Xorg related tools
-xdpyinfo(1), xrestop(1)
-
-.SS Other useful info
-proc(5)
-
-.SH AUTHOR
-Written by Dag Wieers <dag@wieers.com>
-
-Homepage at http://dag.wieers.com/home-made/dstat/
-
-This manpage was initially written by Andrew Pollock <apollock@debian.org> for the Debian GNU/Linux system, and updated by Dag Wieers <dag@wieers.com>
Oops, something went wrong.

0 comments on commit 63db32b

Please sign in to comment.