File: cbm.xml

package info (click to toggle)
cbm 0.1-9
  • links: PTS, VCS
  • area: main
  • in suites: wheezy
  • size: 1,520 kB
  • sloc: sh: 8,699; cpp: 665; xml: 76; makefile: 25
file content (112 lines) | stat: -rw-r--r-- 2,827 bytes parent folder | download | duplicates (5)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
<?xml version="1.0" encoding="utf-8"?>
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.4//EN"
  "http://www.oasis-open.org/docbook/xml/4.4/docbookx.dtd">
<refentry id="limit">
  <refmeta>
    <refentrytitle>cbm</refentrytitle>
    <manvolnum>1</manvolnum>
  </refmeta>

  <refnamediv>
    <refname>cbm</refname>
    <refpurpose>display the current traffic on all network devices</refpurpose>
  </refnamediv>
  
  <refsynopsisdiv>
    <cmdsynopsis>
      <command>cbm</command>

      <arg choice="opt"><option>--help</option></arg>

      <arg choice="opt"><option>--version</option></arg>
      
    </cmdsynopsis>
  </refsynopsisdiv>

  <refsect1><title>Description</title>

      <para><command>cbm</command> &mdash; the Color Bandwidth Meter &mdash;
	  displays the current traffic on all network devices.</para>

      <para>This program is so simple that it should be
	  self-explanatory.</para>
    
  </refsect1>

  <refsect1><title>Options</title>
    <variablelist>

      <varlistentry>
	<term><option>--help</option></term>

	<listitem><para>Display some help and exit.</para></listitem>
      </varlistentry>
      
      <varlistentry>
	<term><option>--version</option></term>

	<listitem><para>Display version information and 
	    exit.</para></listitem>
      </varlistentry>

    </variablelist>
  </refsect1>

  <refsect1><title>Interactive Control</title>

    <para><command>cbm</command> can be controlled with the following
	keys:</para>

    <variablelist>

      <varlistentry>
	<term>Up/Down</term>
	
	<listitem><para>Select an interface to show details
	    about.</para></listitem>
      </varlistentry>
      
      <varlistentry>
	<term><literal>q</literal></term>
	
	<listitem><para>Exit from the program.</para></listitem>
      </varlistentry>

      <varlistentry>
	<term><literal>b</literal></term>
	
	<listitem><para>Switch between bits per second and bytes per
	    second.</para></listitem>
      </varlistentry>

      <varlistentry>
	<term><literal>+</literal></term>
	
	<listitem><para>Increase the update delay by 100ms.</para></listitem>
      </varlistentry>

      <varlistentry>
	<term><literal>-</literal></term>
	
	<listitem><para>Decrease the update delay by 100ms.</para></listitem>
      </varlistentry>
      
    </variablelist>

  </refsect1>

  <refsect1><title>Author</title>
    
    <para><command>cbm</command> is copyright (C) 2006 Aaron Isotton
	  <email>aaron@isotton.com</email>. You may use it under the terms of
	  the GNU General Public License, version 2.</para>

    <para>Source code and newer versions are available from <ulink
	    url="http://www.isotton.com/utils/cbm/"/>.</para>
    
    <para>Report bugs to <email>aaron@isotton.com</email> with
      <quote>[cbm]</quote> as the first word of the subject.</para>

  </refsect1>
  
</refentry>