[gentoo-commits] proj/portage-utils:master commit in: man/

[Fabian Groffen]

commit:     fe42f2a99297fed36720e71ba2ed77cf7a9da804
Author:     Fabian Groffen <grobian <AT> gentoo <DOT> org>
AuthorDate: Sat Mar 31 19:04:20 2018 +0000
Commit:     Fabian Groffen <grobian <AT> gentoo <DOT> org>
CommitDate: Sat Mar 31 19:04:20 2018 +0000
URL:        https://gitweb.gentoo.org/proj/portage-utils.git/commit/?id=fe42f2a9

man/qlop: add some more/better documentation

Bug: https://bugs.gentoo.org/335453
Bug: https://bugs.gentoo.org/367199

 man/qlop.1 | 40 +++++++++++++++++++++++-----------------
 1 file changed, 23 insertions(+), 17 deletions(-)

diff --git a/man/qlop.1 b/man/qlop.1
index f8f0cdd..70fb411 100644
--- a/man/qlop.1
+++ b/man/qlop.1
@@ -1,57 +1,63 @@
-.TH qlop "1" "Mar 2016" "Gentoo Foundation" "qlop"
+.TH qlop "1" "Mar 2018" "Gentoo Foundation" "qlop"
 .SH NAME
 qlop \- emerge log analyzer
 .SH SYNOPSIS
 .B qlop
 \fI[opts] <pkgname>\fR
 .SH DESCRIPTION
-
+qlop reads from $EMERGE_LOG_DIR/emerge.log and tries to extract
+information about merges, unmerges and syncs.  For packages, it can
+calculate average merge times or just list them.
 .SH OPTIONS
 .TP
 \fB\-g\fR, \fB\-\-gauge\fR
-Gauge number of times a package has been merged
+Gauge number of times a package has been merged.  This shows the merge
+time for each individual merge of package.
 .TP
 \fB\-t\fR, \fB\-\-time\fR
-Calculate merge time for a specific package
+Calculate merge time for a specific package.  This is the average time
+for all merges of package.
 .TP
 \fB\-H\fR, \fB\-\-human\fR
-Print seconds in human readable format (needs -t)
+Print seconds in human readable format (needs -t), using minutes, hours
+and days instead of just seconds.
 .TP
 \fB\-l\fR, \fB\-\-list\fR
-Show merge history
+Show merge history.
 .TP
 \fB\-u\fR, \fB\-\-unlist\fR
-Show unmerge history
+Show unmerge history.
 .TP
 \fB\-s\fR, \fB\-\-sync\fR
-Show sync history
+Show sync history.
 .TP
 \fB\-c\fR, \fB\-\-current\fR
-Show current emerging packages
+Show current emerging packages.  This relies on FEATURES=sandbox in
+order to detect running merges.
 .TP
 \fB\-d\fR \fI<arg>\fR, \fB\-\-date\fR \fI<arg>\fR
-Limit selection to this time (1st -d is start, 2nd -d is end)
+Limit selection to this time (1st -d is start, 2nd -d is end).
 .TP
 \fB\-f\fR \fI<arg>\fR, \fB\-\-logfile\fR \fI<arg>\fR
-Read emerge logfile instead of $EMERGE_LOG_DIR/emerge.log
+Read emerge logfile instead of $EMERGE_LOG_DIR/emerge.log.
 .TP
 \fB\-\-root\fR \fI<arg>\fR
-Set the ROOT env var
+Set the ROOT env var.
 .TP
 \fB\-v\fR, \fB\-\-verbose\fR
-Make a lot of noise
+Print package versions and revisions.
 .TP
 \fB\-q\fR, \fB\-\-quiet\fR
-Tighter output; suppress warnings
+Tighter output; suppress warnings.
 .TP
 \fB\-C\fR, \fB\-\-nocolor\fR
-Don't output color
+Don't output color.
 .TP
 \fB\-h\fR, \fB\-\-help\fR
-Print this help and exit
+Print this help and exit.
 .TP
 \fB\-V\fR, \fB\-\-version\fR
-Print version and exit
+Print version and exit.
 
 .SH "REPORTING BUGS"
 Please report bugs via http://bugs.gentoo.org/