Add an example to README.
authorAndre Noll <maan@systemlinux.org>
Fri, 8 May 2009 11:20:30 +0000 (13:20 +0200)
committerAndre Noll <maan@systemlinux.org>
Fri, 8 May 2009 11:20:30 +0000 (13:20 +0200)
Suggested by Sebastian Stark.

README

diff --git a/README b/README
index 7e19d77..5f81f6e 100644 (file)
--- a/README
+++ b/README
@@ -8,3 +8,36 @@ via format strings.
 
 There's an interactive mode which allows to quickly launch many queries
 on the same database using different modes and different output files.
+
+The following example creates a database containing the disk usage patterns
+of the /var directory:
+
+       $ adu -C -d /root/adu-var -b /var
+
+Here's a simple query that uses the newly created database to print the
+user-summary:
+
+       $ adu -S -d /root/adu-var
+
+       User summary
+       root                0   605    12K  267m
+       mysql             103     8   144    81m
+       postgres          113    19   506    31m
+       man                 6    37    87     2m
+       syslog            101     1    54     1m
+       ntp               107     4    23   253k
+       gdm               112     3    20   184k
+       postfix           106     1    14    56k
+       statd             105     4     7    16k
+       sgeadmin          111     4     4    12k
+       daemon              1     3     4    12k
+       www-data           33     3     3     8k
+       news                9     2     2     8k
+       fetchmail         110     1     1     4k
+       libuuid           116     1     1     4k
+       localadmin       1000     1     1     1k
+       dhcp              100     1     1   992b
+       klog              102     2     2   105b
+       avahi             114     2     2   105b
+       messagebus        108     1     1    80b
+       polkituser        117     1     1    40b