Skip to content

Commit

Permalink
Improve manual
Browse files Browse the repository at this point in the history
  • Loading branch information
cpina committed Oct 7, 2023
1 parent 69aa141 commit 13dc78c
Showing 1 changed file with 18 additions and 18 deletions.
36 changes: 18 additions & 18 deletions src/manual/qnetload.1
Original file line number Diff line number Diff line change
@@ -1,57 +1,57 @@
.TH QNETLOAD 1
.SH NAME
qnetload \- Display graphically your network speed and usage
qnetload \- Graphically display network speed and usage
.SH SYNOPSIS
\fBqnetload
.SH DESCRIPTION
Display graphically your network speed and usage.
Graphically display network speed and usage.

.TP
\fB-i\fR, \fB\-\-interface=\fI,INTERFACE\fR
Display INTERFACE. For example: eth0, wlan0. If unsure, do not specify.
\fB-i\fR, \fB\-\-interface=\fIINTERFACE\fR
Display network INTERFACE. For example: eth0, wlan0. If unsure, do not specify.

During the execution it is possible to change the interface clicking on it or right-click to list the interfaces.
When running the interface can be changed by clicking on it. Right-click on the interface to list the available interfaces.

.TP
\fB-h\fR, \fB\-\-help\fR
Displays help on commandline options.
Display help for commandline options.
.TP
\fB-v\fR, \fB\-\-version\fR
Displays version information.
Display version information.
.TP
\fB\-\-help\-all\fR
Display help including Qt specific options.
Display help including Qt-specific options.
.PP

.SH USING QNETLOAD
There are some features on qnetload that might not obvious:
Some features on qnetload might not obvious:
.RS 2
.IP \(bu 2
Click on the interface to change the interface.
Click on the interface to change it.
.IP \(bu 2
Right-click anywhere on qnetload to display a contextual menu with the list of interfaces, the IP and the version. The most common interfaces are in bold (ethX, wlanX, etc.).
.IP \(bu 2
There are two buttons: pause the accumulative counter of Downloaded and Uploaded data and reset it. To reset the counters, click twice.
There are two buttons: pause the accumulative counter of Downloaded and Uploaded data and reset the counter. To reset the counters, click twice.
.IP \(bu 2
If you click in the graph it will give you extra-information: how much data has been in (downloaded) and out (uploaded) since the position of the click and a projection for a hour usage.
Clicking in the graph will display how much data has been downloaded and uploaded since the position of the click and a projection for the next hour's usage.
.IP \(bu 2
Leave the mouse pointer over any of the numbers and get a description of what it is.
Hover the mouse pointer over any of the numbers to display the meaning of the value.

.SH ORIGINAL IDEA FROM XNETLOAD
\fBqnetload\fR has the same look and feel as \fBxnetload\fR, which is not maintained anymore. The \fIq\fP in the name is because \fBqnetload\fR is implemented using the Qt libraries.
\fBqnetload\fR has the same look and feel as \fBxnetload\fR, which is no longer maintained. The \fIq\fP in the name is because \fBqnetload\fR is implemented using the Qt libraries.

.SH FILES
.TP
.I ${HOME}/.config/qnetload/qnetload.conf
Where the latest used interface is saved. Next time running \fBqnetload\fR it will use that one.
The last-used interface is saved here. This will be used the next time \fBqnetload\fR is executed.
.TP
.I /proc/net/dev
Read this file to know the network usage.
This file, provided by the kernel, contains details of the network usage and is read by qnetload to provide the displayed data.
.SH BUG REPORTS
.PP
Bug tracker: <https://github.com/cpina/qnetload/issues>
.br
Email: Carles Pina i Estany <carles@pina.cat>
.SH COPYRIGHT
.SH COPYRIGHT AND LICENSE
.PP
Copyright \[co] 2017-2023 Carles Pina i Estany <carles@pina.cat>
Copyright \[co] 2017-2023 Carles Pina i Estany <carles@pina.cat>. License: GPLv3.

0 comments on commit 13dc78c

Please sign in to comment.