From f171a60d84f6fef4f7718b7bcebcec3d3ddcf197 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?=C3=89douard=20Lopez?= Date: Thu, 4 Feb 2016 12:12:46 +0100 Subject: [PATCH 1/4] improve build instruction formatting and other minor --- README.md | 19 ++++++++++++------- 1 file changed, 12 insertions(+), 7 deletions(-) diff --git a/README.md b/README.md index 32ea8a9..f7d9aab 100644 --- a/README.md +++ b/README.md @@ -8,9 +8,9 @@ http://nethogs.sf.net Introduction ------------ -NetHogs is a small 'net top' tool. Instead of breaking the traffic down per protocol or per subnet, like most tools do, it groups bandwidth by process. NetHogs does not rely on a special kernel module to be loaded. If there's suddenly a lot of network traffic, you can fire up NetHogs and immediately see which PID is causing this. This makes it easy to indentify programs that have gone wild and are suddenly taking up your bandwidth. +NetHogs is a small 'net top' tool. Instead of breaking the traffic down per protocol or per subnet, like most tools do, **it groups bandwidth by process**. NetHogs does not rely on a special kernel module to be loaded. If there's suddenly a lot of network traffic, you can fire up NetHogs and immediately see which PID is causing this. This makes it easy to indentify programs that have gone wild and are suddenly taking up your bandwidth. -Since NetHogs heavily relies on /proc, some functionalities are only available on Linux. +Since NetHogs heavily relies on `/proc`, some functionalities are only available on Linux. NetHogs can be built on Mac OS X, but it will only show connections, not processes. Status @@ -18,15 +18,20 @@ Status Nethogs is a mature piece of software included in most Linux distributions. -Ideas for features, as well as open bugs, can be found at https://github.com/raboof/nethogs/issues +Ideas for features, as well as open bugs, can be found on [issues' label:enhancement](https://github.com/raboof/nethogs/issues?q=is%3Aopen+is%3Aissue+label%3Aenhancement). ### Building from source -Nethogs depends on ncurses, so you need to install the ncurses development -libraries before building nethogs. For example on Debian, 'apt-get install -libncurses5-dev'. +Nethogs depends on `ncurses`, so you need to install the ncurses development +libraries before building nethogs. -After that, simply 'make && sudo make install' +#### Debian/Ubuntu + + apt-get install libncurses5-dev + +After that, simply + + make && sudo make install Coding standards ---------------- From 7c89f0d5e889fc4142960afd23be4cf4ea8d5883 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?=C3=89douard=20Lopez?= Date: Thu, 4 Feb 2016 12:18:15 +0100 Subject: [PATCH 2/4] add libpcap-dev dependency and improve introduction --- README.md | 7 +++++-- 1 file changed, 5 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index f7d9aab..fb58031 100644 --- a/README.md +++ b/README.md @@ -8,9 +8,12 @@ http://nethogs.sf.net Introduction ------------ -NetHogs is a small 'net top' tool. Instead of breaking the traffic down per protocol or per subnet, like most tools do, **it groups bandwidth by process**. NetHogs does not rely on a special kernel module to be loaded. If there's suddenly a lot of network traffic, you can fire up NetHogs and immediately see which PID is causing this. This makes it easy to indentify programs that have gone wild and are suddenly taking up your bandwidth. +NetHogs is a small 'net top' tool. Instead of breaking the traffic down per protocol or per subnet, like most tools do, **it groups bandwidth by process**. + +NetHogs does not rely on a special kernel module to be loaded. If there's suddenly a lot of network traffic, you can fire up NetHogs and immediately see which PID is causing this. This makes it easy to indentify programs that have gone wild and are suddenly taking up your bandwidth. Since NetHogs heavily relies on `/proc`, some functionalities are only available on Linux. + NetHogs can be built on Mac OS X, but it will only show connections, not processes. Status @@ -27,7 +30,7 @@ libraries before building nethogs. #### Debian/Ubuntu - apt-get install libncurses5-dev + apt-get install libncurses5-dev libpcap-dev After that, simply From a27e090b3d9d47bf549dfefefb14b9d3ef00c508 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?=C3=89douard=20Lopez?= Date: Mon, 8 Feb 2016 10:14:41 +0100 Subject: [PATCH 3/4] mention libpcap in building from source section --- README.md | 3 +-- 1 file changed, 1 insertion(+), 2 deletions(-) diff --git a/README.md b/README.md index fb58031..c29eb2e 100644 --- a/README.md +++ b/README.md @@ -25,8 +25,7 @@ Ideas for features, as well as open bugs, can be found on [issues' label:enhanc ### Building from source -Nethogs depends on `ncurses`, so you need to install the ncurses development -libraries before building nethogs. +Nethogs depends on `ncurses` for the text-based interface and `libpcap` for user-level packet capture. So you need to install both **development libraries** before building nethogs. #### Debian/Ubuntu From f7a50a617d2003e953deed21bc69e479e07f7ace Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?=C3=89douard=20Lopez?= Date: Mon, 8 Feb 2016 10:37:09 +0100 Subject: [PATCH 4/4] link to all issue If I link to `label:bug` the list is empty as none labeled as _bug_ which might give the wrong impression that there is no issue at all. --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index c29eb2e..2bb3ec9 100644 --- a/README.md +++ b/README.md @@ -21,7 +21,7 @@ Status Nethogs is a mature piece of software included in most Linux distributions. -Ideas for features, as well as open bugs, can be found on [issues' label:enhancement](https://github.com/raboof/nethogs/issues?q=is%3Aopen+is%3Aissue+label%3Aenhancement). +Ideas for features, as well as [open bugs](https://github.com/raboof/nethogs/issues?q=is%3Aopen+is%3Aissue), can be found on [issues' label:enhancement](https://github.com/raboof/nethogs/issues?q=is%3Aopen+is%3Aissue+label%3Aenhancement). ### Building from source