Documenatation improvements.

This patch adds an illustration of the user-list mode to README and an
examples section to the man page. Thanks to Klaus Kopec who suggested
this improvement.

diff --git a/README b/README
index 5f81f6ebbf624e72cf6850bf74400ce470ec97ba..d72bd6d0de17d1cb43f8488370077f8ca4fe5c54 100644 (file)
--- a/README
+++ b/README
@@ -3,21 +3,14 @@ directory. It allows to query that database to quickly retrieve usage
 patterns of subdirectories containing files owned by a given user.
 
 Four different output modes are available: global list, global summary,
 patterns of subdirectories containing files owned by a given user.
 
 Four different output modes are available: global list, global summary,

-user list, user summary. The format of the output may be customized
+user list and user summary. The format of the output may be customized

 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.
 
 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
+By default, adu uses the user-summary output format which looks like
+this:

 
        User summary
        root                0   605    12K  267m
 
        User summary
        root                0   605    12K  267m


@@ -25,19 +18,13 @@ user-summary:
        postgres          113    19   506    31m
        man                 6    37    87     2m
        syslog            101     1    54     1m
        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
+       ...
+
+The user-list mode prints the largest directories of one more more users:
+
+       uid 0 (root):
+         55m    8  /var/cache/apt/apt-file/
+         43m   35  /var/lib/apt/lists/
+         27m    6K /var/lib/dpkg/info/
+         25m    4  /var/cache/apt/
+         20m  118  /var/lib/gconf/defaults/

diff --git a/adu.1.inc b/adu.1.inc
index 9faf62d1d3426f5b45e2823287a08f5ea6e67c40..b8be2e178af076472aa9e5620cf7d5ad2fb7ead5 100644 (file)
--- a/adu.1.inc
+++ b/adu.1.inc
@@ -1,4 +1,24 @@
 [NAME]
 adu \- advanced disk usage
 [NAME]
 adu \- advanced disk usage

+[EXAMPLES]
+
+.PP
+The following example creates a database containing the disk usage
+patterns of the /var directory:
+.IP
+       $ adu --create --database-dir /root/adu-var --base-dir /var
+
+.PP
+Here's a simple query that uses the newly created database to print
+the user-summary:
+.IP
+       $ adu --select --database-dir /root/adu-var
+
+.PP
+The command below prints the five largest directories of the users root and
+mysql:
+.IP
+       $ time adu --select --database-dir /root/adu-var --select-options '--select-mode user_list --user root --user mysql --limit 5'
+

 [SEE ALSO]
 .BR du (1)
 [SEE ALSO]
 .BR du (1)