Merge branch 'refs/heads/t/doc-improvements'

[adu.git] / README

diff --git a/README b/README
index 5648ac5de9c9c12b0568243d6cea782a53ae45c3..9d2783068d798f9135e9d4e33cb458bb45c51b15 100644 (file)
--- a/README
+++ b/README
@@ -1,10 +1,30 @@
 adu creates a database containing disk usage statistics of a given
 directory. It allows to query that database to quickly retrieve usage
-patterns of subdirectories and/or files owned by a given user.
+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 or 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/