summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorMiroslav Suchý <msuchy@redhat.com>2011-02-04 17:41:45 +0100
committerDavid Sommerseth <davids@redhat.com>2011-04-11 17:01:40 +0200
commit9f0d17aa532f7c43e0d849b3d2fdd3488362a493 (patch)
tree6b92fa70ce92822bb36712aa5b5f5dd7da7a2fe7
parent508ffffbb3c48eeeb11eeab2bf971180fe4e1940 (diff)
downloadpython-ethtool-9f0d17aa532f7c43e0d849b3d2fdd3488362a493.tar.gz
python-ethtool-9f0d17aa532f7c43e0d849b3d2fdd3488362a493.tar.xz
python-ethtool-9f0d17aa532f7c43e0d849b3d2fdd3488362a493.zip
Added man pages for pethtool and pifconfig
Signed-off-by: David Sommerseth <davids@redhat.com>
-rw-r--r--man/pethtool.8.asciidoc81
-rw-r--r--man/pifconfig.8.asciidoc42
2 files changed, 123 insertions, 0 deletions
diff --git a/man/pethtool.8.asciidoc b/man/pethtool.8.asciidoc
new file mode 100644
index 0000000..167114a
--- /dev/null
+++ b/man/pethtool.8.asciidoc
@@ -0,0 +1,81 @@
+pethtool(8)
+===========
+
+NAME
+----
+pethtool - Display or change ethernet card settings
+
+
+SYNOPSIS
+--------
+pethtool [OPTIONS] [<INTERFACE>]
+
+
+DESCRIPTION
+-----------
+
+This script mimic ethtool behavior, but is written purely in python
+and python module ethtool.
+
+
+OPTIONS
+-------
+
+INTERFACE::
+Is the name of the ethernet device on which pethtool should operate.
+
+-h, --help::
+Show help message and exit.
+
+-c|--show-coalesce::
+Show coalesce options
+
+-C|--coalesce::
+Set coalesce options
+
+ adaptive-rx on|off
+ adaptive-tx on|off
+ rx-usecs N
+ rx-frames N
+ rx-usecs-irq N
+ rx-frames-irq N
+ tx-usecs N
+ tx-frames N
+ tx-usecs-irq N
+ tx-frames-irq N
+ stats-block-usecs N
+ pkt-rate-low N
+ rx-usecs-low N
+ rx-frames-low N
+ tx-usecs-low N
+ tx-frames-low N
+ pkt-rate-high N
+ rx-usecs-high N
+ rx-frames-high N
+ tx-usecs-high N
+ tx-frames-high N
+ sample-interval N
+
+
+-i|--driver::
+Show driver information
+
+-k|--show-offload::
+Get protocol offload information
+
+-K|--offload::
+ Set protocol offload;;
+ [ tso on|off ]
+
+
+
+SEE ALSO
+--------
+ethtool(8)
+
+
+AUTHORS
+-------
+Arnaldo Carvalho de Melo <acme@redhat.com>
+
+Man page written by Miroslav Suchý <msuchy@redhat.com>
diff --git a/man/pifconfig.8.asciidoc b/man/pifconfig.8.asciidoc
new file mode 100644
index 0000000..cbd48b8
--- /dev/null
+++ b/man/pifconfig.8.asciidoc
@@ -0,0 +1,42 @@
+pifconfig(8)
+============
+
+NAME
+----
+pifconfig - display information about a network interface
+
+
+SYNOPSIS
+--------
+pifconfig [INTERFACE]
+
+
+DESCRIPTION
+-----------
+
+This script mimic ifconfig behavior, but is written purely in python
+and python module ethtool.
+
+
+OPTIONS
+-------
+
+INTERFACE::
+Display information about only this interface. If no interface is given
+then all interfaces are displayed.
+
+-h, --help::
+Show help message and exit.
+
+
+SEE ALSO
+--------
+ifconfig(8)
+
+
+
+AUTHORS
+-------
+Arnaldo Carvalho de Melo <acme@redhat.com>
+
+Man page written by Miroslav Suchý <msuchy@redhat.com>