1nload(1)                   Network monitoring tools                   nload(1)
2
3
4

NAME

6       nload - displays the current network usage
7
8

SYNOPSIS

10       nload  [-a period] [-i max_scaling] [-m] [-o max_scaling] [-t interval]
11       [-u h|H|b|B|k|K|m|M|g|G] [-U h|H|b|B|k|K|m|M|g|G] [devices]
12
13       nload --help|-h
14
15

DESCRIPTION

17       nload is a console application which monitors network traffic and band‐
18       width  usage  in real time.  It visualizes the in- and outgoing traffic
19       using two graphs and provides additional info like the total amount  of
20       transfered data and min/max network usage.
21
22

USAGE

24       When  running nload, you can switch between the devices (which you gave
25       nload either on the command line or which were auto-detected) by press‐
26       ing  the left and right arrow keys. If the -m command line parameter is
27       given, the arrow keys switch as many devices back and  forth  as  there
28       are  shown on the screen. If you want to quit, do so by pressing 'q' or
29       'Ctrl+C'.
30
31       For further key shortcuts, have a look at the sections MAIN WINDOW  and
32       OPTION WINDOW below.
33
34

OPTIONS

36       A summary of the options supported by nload is included below.
37
38
39       -a period
40              Sets the length in seconds of the time window for average calcu‐
41              lation.  The default is 300.
42
43       -i max_scaling
44              Specifies the 100% mark in kBit/s of the  graph  indicating  the
45              incoming  bandwidth  usage.   Ignored if max_scaling is 0 or the
46              switch -m is given. The default value for max_scaling is 10240.
47
48       -m     Show multiple devices at a time; do not show the traffic graphs.
49
50       -o max_scaling
51              Same as -i but for the graph indicating the  outgoing  bandwidth
52              usage.
53
54       -t interval
55              Determines  the refresh interval of the display in milliseconds.
56              The default value of interval is 500.
57
58              PLEASE NOTE: Specifying refresh intervals shorter than about 100
59              milliseconds  makes traffic calculation very unprecise. Also the
60              display may flicker using such short refresh  intervals.   nload
61              tries  to balance this out by doing extra time measurements, but
62              this may not always succeed.
63
64       -u h|H|b|B|k|K|m|M|g|G
65              Sets the type of unit used for the display of  traffic  numbers.
66              h means human readable (auto), b Bit/s, k kBit/s, m MBit/s and g
67              GBit/s.  The upper case letters mean the corresponding units  in
68              Bytes (instead of Bits).  The default is k.
69
70       -U h|H|b|B|k|K|m|M|g|G
71              Same  as  -u,  but  for an amount of data, e.g. Bit, kByte, GBit
72              etc. (without "/s").  The default is M.
73
74       devices
75              Network devices to use. The default is  "all",  which  means  to
76              display all auto-detected devices.
77
78       -h, --help
79              Show a short summary of these command line options.
80
81

MAIN WINDOW

83       After  starting,  nload  begins to monitor the network devices given on
84       the command line, or, if none where specified, the default  device.  In
85       this mode, the following key shortcuts are available.
86
87
88       'ArrowRight', 'ArrowDown', 'PageDown', 'Enter', 'Tab'
89              Switch  the display to the next network device, or, when started
90              with the -m flag, to the next page of devices.
91
92
93       'ArrowLeft', 'ArrowUp', 'PageUp'
94              Switch the display to the  previous  network  device,  or,  when
95              started with the -m flag, to the previous page of devices.
96
97
98       'F2'   Show the option window (see section OPTION WINDOW below).
99
100
101       'F5'   Save current settings to the user's config file.
102
103
104       'F6'   Reload settings from the config files.
105
106
107       'q', 'Ctrl+C'
108              Quit nload.
109
110

OPTION WINDOW

112       The  parameters given to nload on the command line can be adjusted dur‐
113       ing run time by pressing the 'F2' key. A small window  appears  on  the
114       top of the screen, listing the available settings.
115
116
117       'F2'   Show/hide the option window.
118
119
120       'ArrowLeft', 'ArrowRight', 'Home', 'End'
121              Navigate within the edit fields.
122
123
124       'ArrowUp', 'ArrowDown', 'Enter'
125              Navigate between the settings.
126
127
128       'PageUp', 'PageDown', 'Tab'
129              Toggle  between  the  different  values possible for the current
130              field.
131
132
133       '+' / '-'
134              Switch to the next / previous page of settings.
135
136

FILES

138       /etc/nload.conf
139              System-wide configuration file.
140
141
142       $(HOME)/.nload
143              User-specific configuration  file  (overrides  system-wide  set‐
144              tings).
145
146
147       /sys/class/net/*/* /proc/net/dev
148              are read by nload when running on Linux to get the network traf‐
149              fic data.
150
151

VERSION

153       This manual page describes version 0.7.4 of nload.
154
155       For updates, look at the nload homepage:
156       http://www.roland-riegel.de/nload/
157
158

HELP

160       If you need help, either contact me directly (see below)  or  write  to
161       the nload-user mailing list at
162       nload-user@lists.sourceforge.net
163       after having subscribed at
164       https://lists.sourceforge.net/lists/listinfo/nload-user.
165
166

AUTHOR

168       Copyright (C) 2001 - 2012 Roland Riegel <feedback@roland-riegel.de>
169
170       This program is free software; you can redistribute it and/or modify it
171       under the terms of the GNU General Public License as published  by  the
172       Free  Software Foundation; either version 2 of the License, or (at your
173       option) any later version.
174
175       This program is distributed in the hope that it  will  be  useful,  but
176       WITHOUT  ANY  WARRANTY;  without  even  the  implied  warranty  of MER‐
177       CHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU  General
178       Public License for more details.
179
180       You should have received a copy of the GNU General Public License along
181       with this program; if not, write to the Free Software Foundation, Inc.,
182       59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
183
184
185
186nload                          February 06, 2012                      nload(1)
Impressum