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. --config-file=FILE Read clamd
26 settings from FILE, to determine how to connect to it.
27 clamdspec
29 Specifies the clamd to connect to: either a path to the local
30 (unix domain) socket of clamd, or an IP address and an port num‐
31 ber (that defaults to 3310) to connect to a local or remote
32 clamd using TCP/IP.
33
36 KEYS:
37 H
38 Displays a short helpscreen, describing the meaning of various
40 elements on the display.
41 Q
43 Quits clamdtop
45 R
47 Resets the maximum values.
49 up arrow, down arrow
51 If you are monitoring multiple clamds then clamdtop will show an
53 overview screen by default. You can use the up arrow and down
54 arrow keys to cycle through each clamd individually, and the
55 overview screen. A blue bar will highlight the clamd that is
56 currently shown in detail. On the overview screen none of the
57 clamds is selected (hence no blue bar), and you can see the
58 items from the queue of all clamds.
59 The top bar
62 Shows the version of clamdtop and the current time. Clamdtop updates
63 the display once every 2 seconds.
64 The list of clamds
67 Shows the clamds that clamdtop is connected to, and statistics about
68 them.
69 NO Unique clamd number
72 CONNTIME
74 How long clamdtop has been connected (reset upon a reconnect)
75 LIV Total number of live threads
77 IDL Total number of idle threads
79 QUEUE Number of items in queue
81 MAXQ Maximum number of items observed in the queue
83 MEM Total memory usage (if available)
85 HOST Which clamd, local means unix socket
87 ENGINE Engine version
89 DBVER Database version
91 DBTIME Database publish time
93 Clamd detailed view
95 Primary threads live
96 The number of threads that are executing commands or scanning.
97 Primary threads idle
99 The number of threads that are idle, waiting for commands. They
100 will exit after IdleTimeout (30 seconds).
101 Primary threads max
103 The maximum number of threads configured.
104 Queue items
106 The number of items (scanjobs) in clamd's queue that are waiting
107 for a free thread to be processed.
108 Queue max
110 The maximum number of items observed in clamd's queue.
111 The memory usage view
113 If available, it will show details on clamd's memory usage:
114 Mem heap
116 The amount of memory used by libc from the heap in MegaBytes.
117 Mem mmap
119 The amount of memory used by libc from mmap-allocated memory in
120 MegaBytes.
121 Mem unused
123 The amount of memory that can be reclaimed by libc.
124 Libc used
126 The amount of useful memory allocated by libc.
127 Libc free
129 The amount of memory allocated by libc, that can't be freed due
130 to fragmentation.
131 Libc total
133 The amount of memory allocated by libc from the system in total.
134 Pool count
136 The number of mmap regions allocated by clamd' memory pool allo‐
137 cator (for the signature database).
138 Pool used
140 The amount of memory used by clamd's memory pool allocator (for
141 the signature database).
142 Total The total amount of memory allocated by clamd's memory pool
144 allocator.
145 The clamd job queue
147 COMMAND
148 Kind of command being executed, STATS is clamdtop, SCAN/CON‐
149 TSCAN/FILDES/MULTISCAN is scan of a file/directory, MULTISCAN‐
150 FILE is scan of one item by a MULTISCAN job.
151 QUEUEDSINCE
153 The time since the command got queued, until now.
154 FILE The name of the file being processed (if applicable).
156
158 (1) To connect to the clamd configured in the default clamd.conf:
159 clamdtop
161 (2) To connect to the clamd configured in another clamd.conf:
163 clamdtop --config-file=/path/to/clamd.conf
165 [1m(3) To connect to a clamd running on another machine (192.168.0.3) on
168 the LAN:
169 clamdtop 192.168.0.3
171 (4) To connect to a clamd running on another machine (192.168.0.3) on a
174 non-default port (3410):
175 clamdtop 192.168.0.3:3410
177 (5) To monitor the local clamd and 2 other remote clamds over TCP/IP:
179 clamdtop localhost 192.168.0.3 192.168.0.4
181
183 clamdtop uses colors if the terminal is capable of colors. If you know
184 your terminal is capable of colors, yet you aren't seeing any, then
185 check that your TERM environment variable is set correctly. For exam‐
186 ple try setting it to TERM=xterm-color if you are in an xterm-like
187 environment.
188
190 0 : Normal terminator
191 >0: Error occured.
193
195 Please check the full documentation for credits.
196
198 Török Edvin <edwin@clamav.net>
199
201 clamd(8), clamd.conf(5)
202ClamAV 0.97.3 February 22, 2009 Clamdtop(1)