Documenatation improvements.

[adu.git] / README

diff --git a/README b/README
index 7e19d779fb0b576b989291b7422fdf24028d2f3d..d72bd6d0de17d1cb43f8488370077f8ca4fe5c54 100644 (file)
--- a/README
+++ b/README
@@ -3,8 +3,28 @@ 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,
-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.
+
+By default, adu uses the user-summary output format which looks like
+this:
+
+       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
+       ...
+
+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/