Add an example to README.
[adu.git] / README
1 adu creates a database containing disk usage statistics of a given
2 directory. It allows to query that database to quickly retrieve usage
3 patterns of subdirectories containing files owned by a given user.
4
5 Four different output modes are available: global list, global summary,
6 user list, user summary. The format of the output may be customized
7 via format strings.
8
9 There's an interactive mode which allows to quickly launch many queries
10 on the same database using different modes and different output files.
11
12 The following example creates a database containing the disk usage patterns
13 of the /var directory:
14
15 $ adu -C -d /root/adu-var -b /var
16
17 Here's a simple query that uses the newly created database to print the
18 user-summary:
19
20 $ adu -S -d /root/adu-var
21
22 User summary
23 root 0 605 12K 267m
24 mysql 103 8 144 81m
25 postgres 113 19 506 31m
26 man 6 37 87 2m
27 syslog 101 1 54 1m
28 ntp 107 4 23 253k
29 gdm 112 3 20 184k
30 postfix 106 1 14 56k
31 statd 105 4 7 16k
32 sgeadmin 111 4 4 12k
33 daemon 1 3 4 12k
34 www-data 33 3 3 8k
35 news 9 2 2 8k
36 fetchmail 110 1 1 4k
37 libuuid 116 1 1 4k
38 localadmin 1000 1 1 1k
39 dhcp 100 1 1 992b
40 klog 102 2 2 105b
41 avahi 114 2 2 105b
42 messagebus 108 1 1 80b
43 polkituser 117 1 1 40b