Andrew Geissler | 517393d | 2023-01-13 08:55:19 -0600 | [diff] [blame^] | 1 | From 689c65fb050976d5a548a5b9a0f5d2c14eaa3301 Mon Sep 17 00:00:00 2001 |
| 2 | From: Alexander Stein <alexander.stein@tq-group.com> |
| 3 | Date: Thu, 8 Dec 2022 14:11:46 +0100 |
| 4 | Subject: [PATCH 1/1] Fix rename in docs |
| 5 | |
| 6 | The content of dool.1.adoc is completly unchanged from dstat.1.adoc. |
| 7 | Unfortunately the 'NAME' specifies the created file name. So |
| 8 | building/cleaning docs is currently broken |
| 9 | |
| 10 | Upstream-Status: Pending |
| 11 | https://github.com/scottchiefbaker/dool/pull/30 |
| 12 | |
| 13 | Signed-off-by: Alexander Stein <alexander.stein@tq-group.com> |
| 14 | --- |
| 15 | docs/dool.1.adoc | 108 +++++++++++++++++++++++------------------------ |
| 16 | 1 file changed, 54 insertions(+), 54 deletions(-) |
| 17 | |
| 18 | diff --git a/docs/dool.1.adoc b/docs/dool.1.adoc |
| 19 | index 24c4a54..921df1f 100644 |
| 20 | --- a/docs/dool.1.adoc |
| 21 | +++ b/docs/dool.1.adoc |
| 22 | @@ -1,35 +1,35 @@ |
| 23 | -= dstat(1) |
| 24 | += dool(1) |
| 25 | Dag Wieers <dag@wieers.com> |
| 26 | v0.7.3, August 2014 |
| 27 | |
| 28 | |
| 29 | == NAME |
| 30 | -dstat - versatile tool for generating system resource statistics |
| 31 | +dool - versatile tool for generating system resource statistics |
| 32 | |
| 33 | |
| 34 | == SYNOPSIS |
| 35 | -dstat [-afv] [options..] [delay [count]] |
| 36 | +dool [-afv] [options..] [delay [count]] |
| 37 | |
| 38 | |
| 39 | == DESCRIPTION |
| 40 | -Dstat is a versatile replacement for vmstat, iostat and ifstat. Dstat |
| 41 | +Dool is a versatile replacement for vmstat, iostat and ifstat. Dool |
| 42 | overcomes some of the limitations and adds some extra features. |
| 43 | |
| 44 | -Dstat allows you to view all of your system resources instantly, you |
| 45 | +Dool allows you to view all of your system resources instantly, you |
| 46 | can eg. compare disk usage in combination with interrupts from your |
| 47 | IDE controller, or compare the network bandwidth numbers directly with |
| 48 | the disk throughput (in the same interval). |
| 49 | |
| 50 | -Dstat also cleverly gives you the most detailed information in columns |
| 51 | +Dool also cleverly gives you the most detailed information in columns |
| 52 | and clearly indicates in what magnitude and unit the output is displayed. |
| 53 | Less confusion, less mistakes, more efficient. |
| 54 | |
| 55 | -Dstat is unique in letting you aggregate block device throughput for a |
| 56 | +Dool is unique in letting you aggregate block device throughput for a |
| 57 | certain diskset or network bandwidth for a group of interfaces, ie. |
| 58 | you can see the throughput for all the block devices that make up a |
| 59 | single filesystem or storage system. |
| 60 | |
| 61 | -Dstat allows its data to be directly written to a CSV file to be |
| 62 | +Dool allows its data to be directly written to a CSV file to be |
| 63 | imported and used by OpenOffice, Gnumeric or Excel to create graphs. |
| 64 | |
| 65 | [NOTE] |
| 66 | @@ -187,13 +187,13 @@ Possible internal stats are:: |
| 67 | write CSV output to file |
| 68 | |
| 69 | --profile:: |
| 70 | - show profiling statistics when exiting dstat |
| 71 | + show profiling statistics when exiting dool |
| 72 | |
| 73 | |
| 74 | == PLUGINS |
| 75 | -While anyone can create their own dstat plugins (and contribute them) dstat |
| 76 | +While anyone can create their own dool plugins (and contribute them) dool |
| 77 | ships with a number of plugins already that extend its capabilities greatly. |
| 78 | -Here is an overview of the plugins dstat ships with: |
| 79 | +Here is an overview of the plugins dool ships with: |
| 80 | |
| 81 | --battery:: |
| 82 | battery in percentage (needs ACPI) |
| 83 | @@ -225,17 +225,17 @@ Here is an overview of the plugins dstat ships with: |
| 84 | --disk-wait:: |
| 85 | average time (in milliseconds) for I/O requests issued to the device to be served |
| 86 | |
| 87 | ---dstat:: |
| 88 | - show dstat cputime consumption and latency |
| 89 | +--dool:: |
| 90 | + show dool cputime consumption and latency |
| 91 | |
| 92 | ---dstat-cpu:: |
| 93 | - show dstat advanced cpu usage |
| 94 | +--dool-cpu:: |
| 95 | + show dool advanced cpu usage |
| 96 | |
| 97 | ---dstat-ctxt:: |
| 98 | - show dstat context switches |
| 99 | +--dool-ctxt:: |
| 100 | + show dool context switches |
| 101 | |
| 102 | ---dstat-mem:: |
| 103 | - show dstat advanced memory usage |
| 104 | +--dool-mem:: |
| 105 | + show dool advanced memory usage |
| 106 | |
| 107 | --fan:: |
| 108 | fan speed (needs ACPI) |
| 109 | @@ -250,7 +250,7 @@ Here is an overview of the plugins dstat ships with: |
| 110 | GPFS filesystem operations (needs mmpmon) |
| 111 | |
| 112 | --helloworld:: |
| 113 | - Hello world example dstat plugin |
| 114 | + Hello world example dool plugin |
| 115 | |
| 116 | --innodb-buffer:: |
| 117 | show innodb buffer stats |
| 118 | @@ -340,22 +340,22 @@ Here is an overview of the plugins dstat ships with: |
| 119 | show sendmail queue size (needs sendmail) |
| 120 | |
| 121 | --snmp-cpu:: |
| 122 | - show CPU stats using SNMP from DSTAT_SNMPSERVER |
| 123 | + show CPU stats using SNMP from DOOL_SNMPSERVER |
| 124 | |
| 125 | --snmp-load:: |
| 126 | - show load stats using SNMP from DSTAT_SNMPSERVER |
| 127 | + show load stats using SNMP from DOOL_SNMPSERVER |
| 128 | |
| 129 | --snmp-mem:: |
| 130 | - show memory stats using SNMP from DSTAT_SNMPSERVER |
| 131 | + show memory stats using SNMP from DOOL_SNMPSERVER |
| 132 | |
| 133 | --snmp-net:: |
| 134 | - show network stats using SNMP from DSTAT_SNMPSERVER |
| 135 | + show network stats using SNMP from DOOL_SNMPSERVER |
| 136 | |
| 137 | --snmp-net-err: |
| 138 | - show network errors using SNMP from DSTAT_SNMPSERVER |
| 139 | + show network errors using SNMP from DOOL_SNMPSERVER |
| 140 | |
| 141 | --snmp-sys:: |
| 142 | - show system stats (interrupts and context switches) using SNMP from DSTAT_SNMPSERVER |
| 143 | + show system stats (interrupts and context switches) using SNMP from DOOL_SNMPSERVER |
| 144 | |
| 145 | --snooze:: |
| 146 | show number of ticks per second |
| 147 | @@ -463,7 +463,7 @@ The default delay is 1 and count is unspecified (unlimited) |
| 148 | |
| 149 | |
| 150 | == INTERMEDIATE UPDATES |
| 151 | -When invoking dstat with a *delay* greater than 1 and without the |
| 152 | +When invoking dool with a *delay* greater than 1 and without the |
| 153 | *--noupdate* option, it will show intermediate updates, ie. the first |
| 154 | time a 1 sec average, the second update a 2 second average, etc. until |
| 155 | the delay has been reached. |
| 156 | @@ -475,34 +475,34 @@ average on a new line, just like with vmstat. |
| 157 | |
| 158 | |
| 159 | == EXAMPLES |
| 160 | -Using dstat to relate disk-throughput with network-usage (eth0), total CPU-usage and system counters: |
| 161 | +Using dool to relate disk-throughput with network-usage (eth0), total CPU-usage and system counters: |
| 162 | ---- |
| 163 | -dstat -dnyc -N eth0 -C total -f 5 |
| 164 | +dool -dnyc -N eth0 -C total -f 5 |
| 165 | ---- |
| 166 | |
| 167 | -Checking dstat's behaviour and the system impact of dstat: |
| 168 | +Checking dool's behaviour and the system impact of dool: |
| 169 | ---- |
| 170 | -dstat -taf --debug |
| 171 | +dool -taf --debug |
| 172 | ---- |
| 173 | |
| 174 | Using the time plugin together with cpu, net, disk, system, load, proc and |
| 175 | top_cpu plugins: |
| 176 | ---- |
| 177 | -dstat -tcndylp --top-cpu |
| 178 | +dool -tcndylp --top-cpu |
| 179 | ---- |
| 180 | this is identical to |
| 181 | ---- |
| 182 | -dstat --time --cpu --net --disk --sys --load --proc --top-cpu |
| 183 | +dool --time --cpu --net --disk --sys --load --proc --top-cpu |
| 184 | ---- |
| 185 | |
| 186 | -Using dstat to relate advanced cpu stats with interrupts per device: |
| 187 | +Using dool to relate advanced cpu stats with interrupts per device: |
| 188 | ---- |
| 189 | -dstat -t --cpu-adv -yif |
| 190 | +dool -t --cpu-adv -yif |
| 191 | ---- |
| 192 | |
| 193 | |
| 194 | == BUGS |
| 195 | -Since it is practically impossible to test dstat on every possible |
| 196 | +Since it is practically impossible to test dool on every possible |
| 197 | permutation of kernel, python or distribution version, I need your |
| 198 | help and your feedback to fix the remaining problems. If you have |
| 199 | improvements or bugreports, please send them to: |
| 200 | @@ -513,40 +513,40 @@ Please see the TODO file for known bugs and future plans. |
| 201 | |
| 202 | |
| 203 | == FILES |
| 204 | -Paths that may contain external dstat_*.py plugins: |
| 205 | +Paths that may contain external dool_*.py plugins: |
| 206 | |
| 207 | - ~/.dstat/ |
| 208 | + ~/.dool/ |
| 209 | (path of binary)/plugins/ |
| 210 | - /usr/share/dstat/ |
| 211 | - /usr/local/share/dstat/ |
| 212 | + /usr/share/dool/ |
| 213 | + /usr/local/share/dool/ |
| 214 | |
| 215 | == ENVIRONMENT VARIABLES |
| 216 | |
| 217 | -Dstat will read additional command line arguments from the environment |
| 218 | -variable *DSTAT_OPTS*. You can use this to configure Dstat's default |
| 219 | +Dool will read additional command line arguments from the environment |
| 220 | +variable *DOOL_OPTS*. You can use this to configure Dool's default |
| 221 | behavior, e.g. if you have a black-on-white terminal: |
| 222 | |
| 223 | - export DSTAT_OPTS="--bw --noupdate" |
| 224 | + export DOOL_OPTS="--bw --noupdate" |
| 225 | |
| 226 | Other internal or external plugins have their own environment variables |
| 227 | to influence their behavior, e.g. |
| 228 | |
| 229 | |
| 230 | - DSTAT_NTPSERVER |
| 231 | + DOOL_NTPSERVER |
| 232 | |
| 233 | - DSTAT_MYSQL |
| 234 | - DSTAT_MYSQL_HOST |
| 235 | - DSTAT_MYSQL_PORT |
| 236 | - DSTAT_MYSQL_SOCKET |
| 237 | - DSTAT_MYSQL_USER |
| 238 | - DSTAT_MYSQL_PWD |
| 239 | + DOOL_MYSQL |
| 240 | + DOOL_MYSQL_HOST |
| 241 | + DOOL_MYSQL_PORT |
| 242 | + DOOL_MYSQL_SOCKET |
| 243 | + DOOL_MYSQL_USER |
| 244 | + DOOL_MYSQL_PWD |
| 245 | |
| 246 | - DSTAT_SNMPSERVER |
| 247 | - DSTAT_SNMPCOMMUNITY |
| 248 | + DOOL_SNMPSERVER |
| 249 | + DOOL_SNMPCOMMUNITY |
| 250 | |
| 251 | - DSTAT_SQUID_OPTS |
| 252 | + DOOL_SQUID_OPTS |
| 253 | |
| 254 | - DSTAT_TIMEFMT |
| 255 | + DOOL_TIMEFMT |
| 256 | |
| 257 | == SEE ALSO |
| 258 | |
| 259 | -- |
| 260 | 2.34.1 |
| 261 | |