| 1 |
<?xml version="1.0"?> |
| 2 |
|
| 3 |
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN" |
| 4 |
"http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd"> |
| 5 |
|
| 6 |
<refentry id="statgrab"> |
| 7 |
|
| 8 |
<refentryinfo> |
| 9 |
<date>$Date$</date> |
| 10 |
<releaseinfo>$Id$</releaseinfo> |
| 11 |
</refentryinfo> |
| 12 |
|
| 13 |
<refmeta> |
| 14 |
<refentrytitle>statgrab</refentrytitle> |
| 15 |
<manvolnum>1</manvolnum> |
| 16 |
<refmiscinfo>i-scream</refmiscinfo> |
| 17 |
</refmeta> |
| 18 |
|
| 19 |
<refnamediv> |
| 20 |
<refname>statgrab</refname> |
| 21 |
<refpurpose>sysctl-style interface to system statistics</refpurpose> |
| 22 |
</refnamediv> |
| 23 |
|
| 24 |
<refsynopsisdiv> |
| 25 |
<cmdsynopsis> |
| 26 |
<command>statgrab</command> |
| 27 |
<arg rep='repeat' choice='opt'>OPTION</arg> |
| 28 |
<arg rep='repeat' choice='opt'>STAT</arg> |
| 29 |
</cmdsynopsis> |
| 30 |
</refsynopsisdiv> |
| 31 |
|
| 32 |
<refsect1> |
| 33 |
<title>Description</title> |
| 34 |
<para> |
| 35 |
<command>statgrab</command> provides a sysctl-style interface to all |
| 36 |
the system statistics available through libstatgrab. This is useful |
| 37 |
for applications that don't want to make library calls, but still |
| 38 |
want to access the statistics. |
| 39 |
</para> |
| 40 |
<para> |
| 41 |
An example of such an application is mrtg, for which scripts are |
| 42 |
provided to generate configuration files. |
| 43 |
</para> |
| 44 |
</refsect1> |
| 45 |
|
| 46 |
<refsect1> |
| 47 |
<title>Options</title> |
| 48 |
<para> |
| 49 |
The following options are supported. |
| 50 |
</para> |
| 51 |
<variablelist> |
| 52 |
<varlistentry> |
| 53 |
<term><option>-l</option></term> |
| 54 |
<listitem> |
| 55 |
<para> |
| 56 |
Linux sysctl-style output (default) |
| 57 |
</para> |
| 58 |
</listitem> |
| 59 |
</varlistentry> |
| 60 |
<varlistentry> |
| 61 |
<term><option>-b</option></term> |
| 62 |
<listitem> |
| 63 |
<para> |
| 64 |
BSD sysctl-style output |
| 65 |
</para> |
| 66 |
</listitem> |
| 67 |
</varlistentry> |
| 68 |
<varlistentry> |
| 69 |
<term><option>-m</option></term> |
| 70 |
<listitem> |
| 71 |
<para> |
| 72 |
MRTG-compatible output |
| 73 |
</para> |
| 74 |
</listitem> |
| 75 |
</varlistentry> |
| 76 |
<varlistentry> |
| 77 |
<term><option>-u</option></term> |
| 78 |
<listitem> |
| 79 |
<para> |
| 80 |
Plain output (only show values) |
| 81 |
</para> |
| 82 |
</listitem> |
| 83 |
</varlistentry> |
| 84 |
<varlistentry> |
| 85 |
<term><option>-n</option></term> |
| 86 |
<listitem> |
| 87 |
<para> |
| 88 |
Display cumulative stats once (default) |
| 89 |
</para> |
| 90 |
</listitem> |
| 91 |
</varlistentry> |
| 92 |
<varlistentry> |
| 93 |
<term><option>-s</option></term> |
| 94 |
<listitem> |
| 95 |
<para> |
| 96 |
Display stat differences repeatedly |
| 97 |
</para> |
| 98 |
</listitem> |
| 99 |
</varlistentry> |
| 100 |
<varlistentry> |
| 101 |
<term><option>-o</option></term> |
| 102 |
<listitem> |
| 103 |
<para> |
| 104 |
Display stat differences once |
| 105 |
</para> |
| 106 |
</listitem> |
| 107 |
</varlistentry> |
| 108 |
<varlistentry> |
| 109 |
<term><option>-t</option> <replaceable>DELAY</replaceable></term> |
| 110 |
<listitem> |
| 111 |
<para> |
| 112 |
When repeating, wait DELAY seconds between updates (default 1) |
| 113 |
</para> |
| 114 |
</listitem> |
| 115 |
</varlistentry> |
| 116 |
<varlistentry> |
| 117 |
<term><option>-p</option></term> |
| 118 |
<listitem> |
| 119 |
<para> |
| 120 |
Display CPU usage differences as percentages rather than |
| 121 |
absolute values |
| 122 |
</para> |
| 123 |
</listitem> |
| 124 |
</varlistentry> |
| 125 |
<varlistentry> |
| 126 |
<term><option>-f</option> <replaceable>FACTOR</replaceable></term> |
| 127 |
<listitem> |
| 128 |
<para> |
| 129 |
Display floating-point values as integers scaled by FACTOR |
| 130 |
</para> |
| 131 |
</listitem> |
| 132 |
</varlistentry> |
| 133 |
<varlistentry> |
| 134 |
<term><option>-K</option></term> |
| 135 |
<listitem> |
| 136 |
<para> |
| 137 |
Display byte counts in kibibytes |
| 138 |
</para> |
| 139 |
</listitem> |
| 140 |
</varlistentry> |
| 141 |
<varlistentry> |
| 142 |
<term><option>-M</option></term> |
| 143 |
<listitem> |
| 144 |
<para> |
| 145 |
Display byte counts in mebibytes |
| 146 |
</para> |
| 147 |
</listitem> |
| 148 |
</varlistentry> |
| 149 |
<varlistentry> |
| 150 |
<term><option>-G</option></term> |
| 151 |
<listitem> |
| 152 |
<para> |
| 153 |
Display byte counts in gibibytes |
| 154 |
</para> |
| 155 |
</listitem> |
| 156 |
</varlistentry> |
| 157 |
</variablelist> |
| 158 |
<para> |
| 159 |
If no <option>STAT</option> options are given, all will be displayed. |
| 160 |
Specify 'STAT.' to display all statistics starting with that prefix. |
| 161 |
</para> |
| 162 |
</refsect1> |
| 163 |
|
| 164 |
<refsect1> |
| 165 |
<title>See Also</title> |
| 166 |
|
| 167 |
<simplelist type="inline"> |
| 168 |
<member> |
| 169 |
<citerefentry> |
| 170 |
<refentrytitle>statgrab-make-mrtg-config</refentrytitle> |
| 171 |
<manvolnum>1</manvolnum> |
| 172 |
</citerefentry> |
| 173 |
<citerefentry> |
| 174 |
<refentrytitle>statgrab-make-mrtg-index</refentrytitle> |
| 175 |
<manvolnum>1</manvolnum> |
| 176 |
</citerefentry> |
| 177 |
<citerefentry> |
| 178 |
<refentrytitle>saidar</refentrytitle> |
| 179 |
<manvolnum>1</manvolnum> |
| 180 |
</citerefentry> |
| 181 |
<citerefentry> |
| 182 |
<refentrytitle>statgrab</refentrytitle> |
| 183 |
<manvolnum>3</manvolnum> |
| 184 |
</citerefentry> |
| 185 |
</member> |
| 186 |
</simplelist> |
| 187 |
</refsect1> |
| 188 |
|
| 189 |
<refsect1> |
| 190 |
<title>Authors</title> |
| 191 |
<para> |
| 192 |
This man page was derived from the man page written by Bartosz |
| 193 |
Fenski for the Debian GNU/Linux distribution. |
| 194 |
</para> |
| 195 |
</refsect1> |
| 196 |
|
| 197 |
<refsect1> |
| 198 |
<title>Website</title> |
| 199 |
|
| 200 |
<simplelist type="vert"> |
| 201 |
<member> |
| 202 |
<ulink url="http://www.i-scream.org/libstatgrab/"> |
| 203 |
http://www.i-scream.org/libstatgrab/ |
| 204 |
</ulink> |
| 205 |
</member> |
| 206 |
</simplelist> |
| 207 |
</refsect1> |
| 208 |
|
| 209 |
</refentry> |
