summaryrefslogtreecommitdiff
path: root/README
diff options
context:
space:
mode:
Diffstat (limited to 'README')
-rw-r--r--README75
1 files changed, 75 insertions, 0 deletions
diff --git a/README b/README
new file mode 100644
index 0000000..a24cb88
--- /dev/null
+++ b/README
@@ -0,0 +1,75 @@
+nload 0.7.3 (2011-06-12)
+real time monitor for network traffic
+Copyright (C) 2001 - 2011 by Roland Riegel <feedback@roland-riegel.de>
+
+1. Introduction
+ ------------
+
+This is version 0.7.3 of nload, a console application which monitors network
+traffic and bandwidth usage in real time.
+It visualizes the in- and outgoing traffic using two graphs and provides
+additional info like total amount of transfered data and min/max network
+usage.
+
+2. Installing / Compiling nload
+ ----------------------------
+
+Compiling is done by running
+
+./configure
+make
+
+in the directory where this README is.
+To install nload, you have to be root:
+
+su
+make install
+
+You can find more detailed information in the file INSTALL in this directory.
+
+3. Using nload
+ -----------
+
+To learn about the command line switches and the usage of nload in general,
+simply run:
+
+nload --help
+
+Alternatively, there is a nload man page available by typing:
+
+man nload
+
+4. Uninstalling nload
+ ------------------
+
+If you want to uninstall nload (I hope you never want to ;-), run:
+
+make uninstall
+
+in the build directory.
+
+5. Getting help
+ ------------
+
+If you have problems with compiling, installing or using nload, you may
+mail me to feedback@roland-riegel.de.
+
+6. Copyright / License
+ -------------------
+
+Copyright (C) 2001 - 2011 by Roland Riegel <feedback@roland-riegel.de>
+
+This program is free software; you can redistribute it and/or modify
+it under the terms of the GNU General Public License as published by
+the Free Software Foundation; either version 2 of the License, or
+(at your option) any later version.
+
+This program is distributed in the hope that it will be useful,
+but WITHOUT ANY WARRANTY; without even the implied warranty of
+MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+GNU General Public License for more details.
+
+You should have received a copy of the GNU General Public License
+along with this program; if not, write to the Free Software
+Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
+