diff options
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/Makefile.am | 11 | ||||
| -rw-r--r-- | docs/Makefile.in | 338 | ||||
| -rw-r--r-- | docs/nload.1.in | 213 |
3 files changed, 562 insertions, 0 deletions
diff --git a/docs/Makefile.am b/docs/Makefile.am new file mode 100644 index 0000000..646d438 --- /dev/null +++ b/docs/Makefile.am @@ -0,0 +1,11 @@ +## Helder Correia <helder.correia@netcabo.pt> + +man1_MAN = nload.1 + +install: + $(mkinstalldirs) $(DESTDIR)$(mandir)/man1 + $(INSTALL_DATA) $(top_srcdir)/docs/$(PACKAGE).1 $(DESTDIR)$(mandir)/man1 + gzip -f $(DESTDIR)$(mandir)/man1/$(PACKAGE).1 + +uninstall: + rm $(DESTDIR)$(mandir)/man1/$(PACKAGE).1.gz diff --git a/docs/Makefile.in b/docs/Makefile.in new file mode 100644 index 0000000..328652f --- /dev/null +++ b/docs/Makefile.in @@ -0,0 +1,338 @@ +# Makefile.in generated by automake 1.11.1 from Makefile.am. +# @configure_input@ + +# Copyright (C) 1994, 1995, 1996, 1997, 1998, 1999, 2000, 2001, 2002, +# 2003, 2004, 2005, 2006, 2007, 2008, 2009 Free Software Foundation, +# Inc. +# This Makefile.in is free software; the Free Software Foundation +# gives unlimited permission to copy and/or distribute it, +# with or without modifications, as long as this notice is preserved. + +# This program is distributed in the hope that it will be useful, +# but WITHOUT ANY WARRANTY, to the extent permitted by law; without +# even the implied warranty of MERCHANTABILITY or FITNESS FOR A +# PARTICULAR PURPOSE. + +@SET_MAKE@ +VPATH = @srcdir@ +pkgdatadir = $(datadir)/@PACKAGE@ +pkgincludedir = $(includedir)/@PACKAGE@ +pkglibdir = $(libdir)/@PACKAGE@ +pkglibexecdir = $(libexecdir)/@PACKAGE@ +am__cd = CDPATH="$${ZSH_VERSION+.}$(PATH_SEPARATOR)" && cd +install_sh_DATA = $(install_sh) -c -m 644 +install_sh_PROGRAM = $(install_sh) -c +install_sh_SCRIPT = $(install_sh) -c +INSTALL_HEADER = $(INSTALL_DATA) +transform = $(program_transform_name) +NORMAL_INSTALL = : +PRE_INSTALL = : +POST_INSTALL = : +NORMAL_UNINSTALL = : +PRE_UNINSTALL = : +POST_UNINSTALL = : +build_triplet = @build@ +host_triplet = @host@ +subdir = docs +DIST_COMMON = $(srcdir)/Makefile.am $(srcdir)/Makefile.in \ + $(srcdir)/nload.1.in +ACLOCAL_M4 = $(top_srcdir)/aclocal.m4 +am__aclocal_m4_deps = $(top_srcdir)/configure.in +am__configure_deps = $(am__aclocal_m4_deps) $(CONFIGURE_DEPENDENCIES) \ + $(ACLOCAL_M4) +mkinstalldirs = $(install_sh) -d +CONFIG_HEADER = $(top_builddir)/config.h +CONFIG_CLEAN_FILES = nload.1 +CONFIG_CLEAN_VPATH_FILES = +SOURCES = +DIST_SOURCES = +DISTFILES = $(DIST_COMMON) $(DIST_SOURCES) $(TEXINFOS) $(EXTRA_DIST) +ACLOCAL = @ACLOCAL@ +AMTAR = @AMTAR@ +AUTOCONF = @AUTOCONF@ +AUTOHEADER = @AUTOHEADER@ +AUTOMAKE = @AUTOMAKE@ +AWK = @AWK@ +CC = @CC@ +CCDEPMODE = @CCDEPMODE@ +CFLAGS = @CFLAGS@ +CPP = @CPP@ +CPPFLAGS = @CPPFLAGS@ +CXX = @CXX@ +CXXDEPMODE = @CXXDEPMODE@ +CXXFLAGS = @CXXFLAGS@ +CYGPATH_W = @CYGPATH_W@ +DEFS = @DEFS@ +DEPDIR = @DEPDIR@ +ECHO_C = @ECHO_C@ +ECHO_N = @ECHO_N@ +ECHO_T = @ECHO_T@ +EGREP = @EGREP@ +EXEEXT = @EXEEXT@ +GREP = @GREP@ +INCLUDES = @INCLUDES@ +INSTALL = @INSTALL@ +INSTALL_DATA = @INSTALL_DATA@ +INSTALL_PROGRAM = @INSTALL_PROGRAM@ +INSTALL_SCRIPT = @INSTALL_SCRIPT@ +INSTALL_STRIP_PROGRAM = @INSTALL_STRIP_PROGRAM@ +LDFLAGS = @LDFLAGS@ +LIBOBJS = @LIBOBJS@ +LIBS = @LIBS@ +LTLIBOBJS = @LTLIBOBJS@ +MAKEINFO = @MAKEINFO@ +MKDIR_P = @MKDIR_P@ +OBJEXT = @OBJEXT@ +PACKAGE = @PACKAGE@ +PACKAGE_BUGREPORT = @PACKAGE_BUGREPORT@ +PACKAGE_NAME = @PACKAGE_NAME@ +PACKAGE_STRING = @PACKAGE_STRING@ +PACKAGE_TARNAME = @PACKAGE_TARNAME@ +PACKAGE_URL = @PACKAGE_URL@ +PACKAGE_VERSION = @PACKAGE_VERSION@ +PATH_SEPARATOR = @PATH_SEPARATOR@ +SET_MAKE = @SET_MAKE@ +SHELL = @SHELL@ +STRIP = @STRIP@ +VERSION = @VERSION@ +abs_builddir = @abs_builddir@ +abs_srcdir = @abs_srcdir@ +abs_top_builddir = @abs_top_builddir@ +abs_top_srcdir = @abs_top_srcdir@ +ac_ct_CC = @ac_ct_CC@ +ac_ct_CXX = @ac_ct_CXX@ +am__include = @am__include@ +am__leading_dot = @am__leading_dot@ +am__quote = @am__quote@ +am__tar = @am__tar@ +am__untar = @am__untar@ +bindir = @bindir@ +build = @build@ +build_alias = @build_alias@ +build_cpu = @build_cpu@ +build_os = @build_os@ +build_vendor = @build_vendor@ +builddir = @builddir@ +datadir = @datadir@ +datarootdir = @datarootdir@ +docdir = @docdir@ +dvidir = @dvidir@ +exec_prefix = @exec_prefix@ +host = @host@ +host_alias = @host_alias@ +host_cpu = @host_cpu@ +host_os = @host_os@ +host_vendor = @host_vendor@ +htmldir = @htmldir@ +includedir = @includedir@ +infodir = @infodir@ +install_sh = @install_sh@ +libdir = @libdir@ +libexecdir = @libexecdir@ +localedir = @localedir@ +localstatedir = @localstatedir@ +mandir = @mandir@ +mkdir_p = @mkdir_p@ +oldincludedir = @oldincludedir@ +pdfdir = @pdfdir@ +prefix = @prefix@ +program_transform_name = @program_transform_name@ +psdir = @psdir@ +sbindir = @sbindir@ +sharedstatedir = @sharedstatedir@ +srcdir = @srcdir@ +sysconfdir = @sysconfdir@ +target_alias = @target_alias@ +top_build_prefix = @top_build_prefix@ +top_builddir = @top_builddir@ +top_srcdir = @top_srcdir@ +man1_MAN = nload.1 +all: all-am + +.SUFFIXES: +$(srcdir)/Makefile.in: $(srcdir)/Makefile.am $(am__configure_deps) + @for dep in $?; do \ + case '$(am__configure_deps)' in \ + *$$dep*) \ + ( cd $(top_builddir) && $(MAKE) $(AM_MAKEFLAGS) am--refresh ) \ + && { if test -f $@; then exit 0; else break; fi; }; \ + exit 1;; \ + esac; \ + done; \ + echo ' cd $(top_srcdir) && $(AUTOMAKE) --gnu docs/Makefile'; \ + $(am__cd) $(top_srcdir) && \ + $(AUTOMAKE) --gnu docs/Makefile +.PRECIOUS: Makefile +Makefile: $(srcdir)/Makefile.in $(top_builddir)/config.status + @case '$?' in \ + *config.status*) \ + cd $(top_builddir) && $(MAKE) $(AM_MAKEFLAGS) am--refresh;; \ + *) \ + echo ' cd $(top_builddir) && $(SHELL) ./config.status $(subdir)/$@ $(am__depfiles_maybe)'; \ + cd $(top_builddir) && $(SHELL) ./config.status $(subdir)/$@ $(am__depfiles_maybe);; \ + esac; + +$(top_builddir)/config.status: $(top_srcdir)/configure $(CONFIG_STATUS_DEPENDENCIES) + cd $(top_builddir) && $(MAKE) $(AM_MAKEFLAGS) am--refresh + +$(top_srcdir)/configure: $(am__configure_deps) + cd $(top_builddir) && $(MAKE) $(AM_MAKEFLAGS) am--refresh +$(ACLOCAL_M4): $(am__aclocal_m4_deps) + cd $(top_builddir) && $(MAKE) $(AM_MAKEFLAGS) am--refresh +$(am__aclocal_m4_deps): +nload.1: $(top_builddir)/config.status $(srcdir)/nload.1.in + cd $(top_builddir) && $(SHELL) ./config.status $(subdir)/$@ +tags: TAGS +TAGS: + +ctags: CTAGS +CTAGS: + + +distdir: $(DISTFILES) + @srcdirstrip=`echo "$(srcdir)" | sed 's/[].[^$$\\*]/\\\\&/g'`; \ + topsrcdirstrip=`echo "$(top_srcdir)" | sed 's/[].[^$$\\*]/\\\\&/g'`; \ + list='$(DISTFILES)'; \ + dist_files=`for file in $$list; do echo $$file; done | \ + sed -e "s|^$$srcdirstrip/||;t" \ + -e "s|^$$topsrcdirstrip/|$(top_builddir)/|;t"`; \ + case $$dist_files in \ + */*) $(MKDIR_P) `echo "$$dist_files" | \ + sed '/\//!d;s|^|$(distdir)/|;s,/[^/]*$$,,' | \ + sort -u` ;; \ + esac; \ + for file in $$dist_files; do \ + if test -f $$file || test -d $$file; then d=.; else d=$(srcdir); fi; \ + if test -d $$d/$$file; then \ + dir=`echo "/$$file" | sed -e 's,/[^/]*$$,,'`; \ + if test -d "$(distdir)/$$file"; then \ + find "$(distdir)/$$file" -type d ! -perm -700 -exec chmod u+rwx {} \;; \ + fi; \ + if test -d $(srcdir)/$$file && test $$d != $(srcdir); then \ + cp -fpR $(srcdir)/$$file "$(distdir)$$dir" || exit 1; \ + find "$(distdir)/$$file" -type d ! -perm -700 -exec chmod u+rwx {} \;; \ + fi; \ + cp -fpR $$d/$$file "$(distdir)$$dir" || exit 1; \ + else \ + test -f "$(distdir)/$$file" \ + || cp -p $$d/$$file "$(distdir)/$$file" \ + || exit 1; \ + fi; \ + done +check-am: all-am +check: check-am +all-am: Makefile +installdirs: +install-exec: install-exec-am +install-data: install-data-am + +install-am: all-am + @$(MAKE) $(AM_MAKEFLAGS) install-exec-am install-data-am + +installcheck: installcheck-am +install-strip: + $(MAKE) $(AM_MAKEFLAGS) INSTALL_PROGRAM="$(INSTALL_STRIP_PROGRAM)" \ + install_sh_PROGRAM="$(INSTALL_STRIP_PROGRAM)" INSTALL_STRIP_FLAG=-s \ + `test -z '$(STRIP)' || \ + echo "INSTALL_PROGRAM_ENV=STRIPPROG='$(STRIP)'"` install +mostlyclean-generic: + +clean-generic: + +distclean-generic: + -test -z "$(CONFIG_CLEAN_FILES)" || rm -f $(CONFIG_CLEAN_FILES) + -test . = "$(srcdir)" || test -z "$(CONFIG_CLEAN_VPATH_FILES)" || rm -f $(CONFIG_CLEAN_VPATH_FILES) + +maintainer-clean-generic: + @echo "This command is intended for maintainers to use" + @echo "it deletes files that may require special tools to rebuild." +clean: clean-am + +clean-am: clean-generic mostlyclean-am + +distclean: distclean-am + -rm -f Makefile +distclean-am: clean-am distclean-generic + +dvi: dvi-am + +dvi-am: + +html: html-am + +html-am: + +info: info-am + +info-am: + +install-data-am: + +install-dvi: install-dvi-am + +install-dvi-am: + +install-exec-am: + +install-html: install-html-am + +install-html-am: + +install-info: install-info-am + +install-info-am: + +install-man: + +install-pdf: install-pdf-am + +install-pdf-am: + +install-ps: install-ps-am + +install-ps-am: + +installcheck-am: + +maintainer-clean: maintainer-clean-am + -rm -f Makefile +maintainer-clean-am: distclean-am maintainer-clean-generic + +mostlyclean: mostlyclean-am + +mostlyclean-am: mostlyclean-generic + +pdf: pdf-am + +pdf-am: + +ps: ps-am + +ps-am: + +uninstall-am: + +.MAKE: install-am install-strip + +.PHONY: all all-am check check-am clean clean-generic distclean \ + distclean-generic distdir dvi dvi-am html html-am info info-am \ + install install-am install-data install-data-am install-dvi \ + install-dvi-am install-exec install-exec-am install-html \ + install-html-am install-info install-info-am install-man \ + install-pdf install-pdf-am install-ps install-ps-am \ + install-strip installcheck installcheck-am installdirs \ + maintainer-clean maintainer-clean-generic mostlyclean \ + mostlyclean-generic pdf pdf-am ps ps-am uninstall uninstall-am + + +install: + $(mkinstalldirs) $(DESTDIR)$(mandir)/man1 + $(INSTALL_DATA) $(top_srcdir)/docs/$(PACKAGE).1 $(DESTDIR)$(mandir)/man1 + gzip -f $(DESTDIR)$(mandir)/man1/$(PACKAGE).1 + +uninstall: + rm $(DESTDIR)$(mandir)/man1/$(PACKAGE).1.gz + +# Tell versions [3.59,3.63) of GNU make to not export all variables. +# Otherwise a system limit (for SysV at least) may be exceeded. +.NOEXPORT: diff --git a/docs/nload.1.in b/docs/nload.1.in new file mode 100644 index 0000000..d9f8ae7 --- /dev/null +++ b/docs/nload.1.in @@ -0,0 +1,213 @@ +.\" +.\" Man page for nload +.\" Copyright (C) 2001 - 2012 by Roland Riegel <feedback@roland.riegel.de> +.\" +.TH nload 1 "February 06, 2012" nload "Network monitoring tools" +.SH NAME +nload \- displays the current network usage + +.SH SYNOPSIS +.B nload +.RB [ \-a +.IR period ] +.RB [ \-i +.IR max_scaling ] +.RB [ \-m ] +.RB [ \-o +.IR max_scaling ] +.RB [ \-t +.IR interval ] +.RB [ \-u +.IR h|H|b|B|k|K|m|M|g|G ] +.RB [ \-U +.IR h|H|b|B|k|K|m|M|g|G ] +.RI [ devices ] + +.B nload \-\-help|\-h + +.SH DESCRIPTION +.B nload +is 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 the total amount of transfered data and min/max network usage. + +.SH USAGE +When running +.B nload, +you can switch between the devices (which you gave +.B nload +either on the command line or which were auto-detected) by pressing the left and right arrow keys. If the +.B \-m +command line parameter is given, the arrow keys switch as many devices back and forth as +there are shown on the screen. If you want to quit, do so by pressing 'q' or 'Ctrl+C'. + +For further key shortcuts, have a look at the sections +.B MAIN WINDOW +and +.B OPTION WINDOW +below. + +.SH OPTIONS +A summary of the options supported by +.B nload +is included below. + +.TP +.B \-a period +Sets the length in seconds of the time window for average calculation. +The default is 300. +.TP +.B \-i max_scaling +Specifies the 100% mark in kBit/s of the graph indicating the incoming bandwidth usage. +Ignored if max_scaling is 0 or the switch \-m is given. The default value for max_scaling +is 10240. +.TP +.B \-m +Show multiple devices at a time; do not show the traffic graphs. +.TP +.B \-o max_scaling +Same as \-i but for the graph indicating the outgoing bandwidth usage. +.TP +.B \-t interval +Determines the refresh interval of the display in milliseconds. +The default value of interval is 500. + +PLEASE NOTE: +Specifying refresh intervals shorter than about 100 milliseconds makes traffic +calculation very unprecise. Also the display may flicker using such short +refresh intervals. +.B nload +tries to balance this out by doing extra time measurements, but this may +not always succeed. +.TP +.B \-u h|H|b|B|k|K|m|M|g|G +Sets the type of unit used for the display of traffic numbers. +h means human readable (auto), b Bit/s, k kBit/s, m MBit/s and g GBit/s. +The upper case letters mean the corresponding units in Bytes (instead of Bits). +The default is k. +.TP +.B \-U h|H|b|B|k|K|m|M|g|G +Same as \-u, but for an amount of data, e.g. Bit, kByte, GBit etc. (without "/s"). +The default is M. +.TP +.B devices +Network devices to use. The default is "all", which means to display all auto-detected devices. +.TP +.B \-h, \-\-help +Show a short summary of these command line options. + +.SH MAIN WINDOW +After starting, +.B nload +begins to monitor the network devices given on the +command line, or, if none where specified, the default device. In this mode, +the following key shortcuts are available. + +.TP +.B 'ArrowRight', 'ArrowDown', 'PageDown', 'Enter', 'Tab' +Switch the display to the next network device, or, when started with the +.B \-m +flag, to the next page of devices. + +.TP +.B 'ArrowLeft', 'ArrowUp', 'PageUp' +Switch the display to the previous network device, or, when started with +the +.B \-m +flag, to the previous page of devices. + +.TP +.B 'F2' +Show the option window (see section +.B OPTION WINDOW +below). + +.TP +.B 'F5' +Save current settings to the user's config file. + +.TP +.B 'F6' +Reload settings from the config files. + +.TP +.B 'q', 'Ctrl+C' +Quit +.BR nload . + +.SH OPTION WINDOW +The parameters given to +.B nload +on the command line can be adjusted during run time by pressing the 'F2' key. A +small window appears on the top of the screen, listing the available settings. + +.TP +.B 'F2' +Show/hide the option window. + +.TP +.B 'ArrowLeft', 'ArrowRight', 'Home', 'End' +Navigate within the edit fields. + +.TP +.B 'ArrowUp', 'ArrowDown', 'Enter' +Navigate between the settings. + +.TP +.B 'PageUp', 'PageDown', 'Tab' +Toggle between the different values possible for the current field. + +.TP +.B '+' / '-' +Switch to the next / previous page of settings. + +.SH FILES + +.TP +.I /etc/nload.conf +System-wide configuration file. + +.TP +.I $(HOME)/.nload +User-specific configuration file (overrides system-wide settings). + +.TP +.I /sys/class/net/*/* /proc/net/dev +are read by +.B nload +when running on Linux to get the network traffic data. + +.SH VERSION +This manual page describes version @VERSION@ of +.BR nload . + +For updates, look at the nload homepage: +.br +.B http://www.roland-riegel.de/nload/ + +.SH HELP +If you need help, either contact me directly (see below) or write to the +nload-user mailing list at +.br +.B nload-user@lists.sourceforge.net +.br +after having subscribed at +.br +.BR https://lists.sourceforge.net/lists/listinfo/nload-user . + +.SH AUTHOR +Copyright (C) 2001 - 2012 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. |