1Clamdtop(1) Clam AntiVirus Clamdtop(1)
2
6 clamdtop - monitor the Clam AntiVirus Daemon
7
9 clamdtop [options] [clamdspec ...]
10
12 clamdtop is a tool to monitor one or multiple clamd(s). It has a
13 (color) ncurses interface, that shows the jobs in clamd's queue, memory
14 usage, and information about the loaded signature database. You can
15 specify on the command-line to which clamd(s) it should connect to. By
16 default it will attempt to connect to the local clamd as defined in
17 clamd.conf.
18
21 -h, --help
22 Display help information and exit.
23 -V, --version
25 Print version number and exit.
26 --config-file=FILE
28 Read clamd settings from FILE, to determine how to connect to
29 it.
30 clamdspec
32 Specifies the clamd to connect to: either a path to the local
33 (unix domain) socket of clamd, or an IP address and an port num‐
34 ber (that defaults to 3310) to connect to a local or remote
35 clamd using TCP/IP.
36
39 KEYS:
40 H
41 Displays a short helpscreen, describing the meaning of various
43 elements on the display.
44 Q
46 Quits clamdtop
48 R
50 Resets the maximum values.
52 up arrow, down arrow
54 If you are monitoring multiple clamds then clamdtop will show an
56 overview screen by default. You can use the up arrow and down
57 arrow keys to cycle through each clamd individually, and the
58 overview screen. A blue bar will highlight the clamd that is
59 currently shown in detail. On the overview screen none of the
60 clamds is selected (hence no blue bar), and you can see the
61 items from the queue of all clamds.
62 The top bar
65 Shows the version of clamdtop and the current time. Clamdtop updates
66 the display once every 2 seconds.
67 The list of clamds
70 Shows the clamds that clamdtop is connected to, and statistics about
71 them.
72 NO Unique clamd number
75 CONNTIME
77 How long clamdtop has been connected (reset upon a reconnect)
78 LIV Total number of live threads
80 IDL Total number of idle threads
82 QUEUE Number of items in queue
84 MAXQ Maximum number of items observed in the queue
86 MEM Total memory usage (if available)
88 HOST Which clamd, local means unix socket
90 ENGINE Engine version
92 DBVER Database version
94 DBTIME Database publish time
96 Clamd detailed view
98 Primary threads live
99 The number of threads that are executing commands or scanning.
100 Primary threads idle
102 The number of threads that are idle, waiting for commands. They
103 will exit after IdleTimeout (30 seconds).
104 Primary threads max
106 The maximum number of threads configured.
107 Queue items
109 The number of items (scanjobs) in clamd's queue that are waiting
110 for a free thread to be processed.
111 Queue max
113 The maximum number of items observed in clamd's queue.
114 The memory usage view
116 If available, it will show details on clamd's memory usage:
117 Mem heap
119 The amount of memory used by libc from the heap in MegaBytes.
120 Mem mmap
122 The amount of memory used by libc from mmap-allocated memory in
123 MegaBytes.
124 Mem unused
126 The amount of memory that can be reclaimed by libc.
127 Libc used
129 The amount of useful memory allocated by libc.
130 Libc free
132 The amount of memory allocated by libc, that can't be freed due
133 to fragmentation.
134 Libc total
136 The amount of memory allocated by libc from the system in total.
137 Pool count
139 The number of mmap regions allocated by clamd' memory pool allo‐
140 cator (for the signature database).
141 Pool used
143 The amount of memory used by clamd's memory pool allocator (for
144 the signature database).
145 Total The total amount of memory allocated by clamd's memory pool
147 allocator.
148 The clamd job queue
150 COMMAND
151 Kind of command being executed, STATS is clamdtop, SCAN/CON‐
152 TSCAN/FILDES/MULTISCAN is scan of a file/directory, MULTISCAN‐
153 FILE is scan of one item by a MULTISCAN job.
154 QUEUEDSINCE
156 The time since the command got queued, until now.
157 FILE The name of the file being processed (if applicable).
159
161 (1) To connect to the clamd configured in the default clamd.conf:
162 clamdtop
164 (2) To connect to the clamd configured in another clamd.conf:
166 clamdtop --config-file=/path/to/clamd.conf
168 [1m(3) To connect to a clamd running on another machine (192.168.0.3) on
171 the LAN:
172 clamdtop 192.168.0.3
174 (4) To connect to a clamd running on another machine (192.168.0.3) on a
177 non-default port (3410):
178 clamdtop 192.168.0.3:3410
180 (5) To monitor the local clamd and 2 other remote clamds over TCP/IP:
182 clamdtop localhost 192.168.0.3 192.168.0.4
184
186 clamdtop uses colors if the terminal is capable of colors. If you know
187 your terminal is capable of colors, yet you aren't seeing any, then
188 check that your TERM environment variable is set correctly. For exam‐
189 ple try setting it to TERM=xterm-color if you are in an xterm-like
190 environment. IPv6 support has been added. If specifying an IPv6
191 address, please use the normal IPv6 addressing rules. If specifying
192 both an IPv6 address and a port combination, encapsulate the IPv6
193 address in square brackets (e.g. [::1]:3410).
194
196 0 : Normal termination
197 >0: Error occurred.
199
201 Please check the full documentation for credits.
202
204 Török Edvin <edwin@clamav.net>
205
207 clamd(8), clamd.conf(5)
208ClamAV 0.102.2 February 22, 2009 Clamdtop(1)