Skip to content

Commit b3d2806

Browse files
committed
README: add pifconfig, Usage, and other minor changes
1 parent 6363c94 commit b3d2806

File tree

1 file changed

+26
-8
lines changed

1 file changed

+26
-8
lines changed

README.rst

Lines changed: 26 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -3,15 +3,12 @@ python-ethtool
33

44
*Python bindings for the ethtool kernel interface*
55

6+
``python-ethtool`` allows querying and changing of ethernet card settings,
7+
such as speed, port, autonegotiation, and PCI locations.
8+
69
**This is the new upstream for python-ethtool maintained by Fedora's
710
Python SIG.**
811

9-
About
10-
-----
11-
12-
Allows querying and changing of ethernet card settings, such as speed,
13-
port, autonegotiation, and PCI locations.
14-
1512
Usage
1613
-----
1714

@@ -24,7 +21,26 @@ e.g., to get driver information on the ``eth0`` interface::
2421
driver: cdc_ether
2522
bus-info: usb-0000:00:14.0-4.1.3
2623

27-
Further usage information may be found in the ``pethtool(8)`` manpage.
24+
Analogically, ``pifconfig`` mimics ``ifconfig`` in usage. It may be
25+
used to view information on an interface::
26+
27+
$ pifconfig lo
28+
lo
29+
inet addr:127.0.0.1 Mask:255.0.0.0
30+
inet6 addr: ::1/128 Scope: host
31+
UP LOOPBACK RUNNING
32+
33+
34+
Further usage information may be found in the respective manpages for
35+
`pethtool <https://github.com/fedora-python/python-ethtool/blob/master/man/pethtool.8.asciidoc>`_
36+
and
37+
`pifconfig <https://github.com/fedora-python/python-ethtool/blob/master/man/pifconfig.8.asciidoc>`_.
38+
39+
Tests
40+
-----
41+
42+
Tests may be run by ``tox``. However, they're currently failing, see
43+
`issue #11 <https://github.com/fedora-python/python-ethtool/issues/11>`_.
2844

2945
Authors
3046
-------
@@ -39,9 +55,11 @@ Current maintainers
3955
* Lumír Balhar <lbalhar@redhat.com>
4056
* Miro Hrončok <mhroncok@redhat.com>
4157
* Charalampos Stratakis <cstratak@redhat.com>
58+
* Sanqui <dlabsky@redhat.com>
4259

4360
Contributing
4461
------------
4562

4663
Feel free to help us with improving test coverage, porting to Python 3
47-
or anything else. Issues and PRs are welcome.
64+
or anything else.
65+
Issues and PRs `on GitHub <https://github.com/fedora-python/python-ethtool>`_ are welcome.

0 commit comments

Comments
 (0)