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

[Fabian Groffen]

commit:     23b810c84c02a29f3b2766cf0fd005c53e668816
Author:     Fabian Groffen <grobian <AT> gentoo <DOT> org>
AuthorDate: Tue Apr  3 13:51:42 2018 +0000
Commit:     Fabian Groffen <grobian <AT> gentoo <DOT> org>
CommitDate: Tue Apr  3 13:51:42 2018 +0000
URL:        https://gitweb.gentoo.org/proj/portage-utils.git/commit/?id=23b810c8

qtbz2: improve documentation

Bug: https://bugs.gentoo.org/645554

 man/include/qsize.desc         |  3 +++
 man/include/qsize.optdesc.yaml |  5 +++++
 man/include/qtbz2.desc         |  2 ++
 man/include/qtbz2.optdesc.yaml |  2 ++
 man/qtbz2.1                    | 33 ++++++++++++++++++---------------
 5 files changed, 30 insertions(+), 15 deletions(-)

diff --git a/man/include/qsize.desc b/man/include/qsize.desc
new file mode 100644
index 0000000..e4edce0
--- /dev/null
+++ b/man/include/qsize.desc
@@ -0,0 +1,3 @@
+\fIqsize\fR calculates the storage size taken by an installed package.
+The reported sizes can be the recorded exact sizes of all files, or the
+storage space they consume given the underlying filesystem.

diff --git a/man/include/qsize.optdesc.yaml b/man/include/qsize.optdesc.yaml
new file mode 100644
index 0000000..8dd58e4
--- /dev/null
+++ b/man/include/qsize.optdesc.yaml
@@ -0,0 +1,5 @@
+ignore: |
+    Filter out entries matching \fI<arg>\fR, which is a regular
+    expression, before calculating size.
+verbose: Ignored for compatibility with other qapplets.
+quiet: Ignored for compatibility with other qapplets.

diff --git a/man/include/qtbz2.desc b/man/include/qtbz2.desc
new file mode 100644
index 0000000..2ba37db
--- /dev/null
+++ b/man/include/qtbz2.desc
@@ -0,0 +1,2 @@
+\fIqtbz2\fR joins and splits combined xpak+tarbz2 files.  Gentoo binary
+packages are such combined files.

diff --git a/man/include/qtbz2.optdesc.yaml b/man/include/qtbz2.optdesc.yaml
new file mode 100644
index 0000000..c1ebcd1
--- /dev/null
+++ b/man/include/qtbz2.optdesc.yaml
@@ -0,0 +1,2 @@
+verbose: Print some files and sizes while joining and splitting.
+quiet: Ignored for compatibility with other qapplets.

diff --git a/man/qtbz2.1 b/man/qtbz2.1
index b22c70c..94db0d8 100644
--- a/man/qtbz2.1
+++ b/man/qtbz2.1
@@ -1,53 +1,56 @@
-.TH qtbz2 "1" "Mar 2016" "Gentoo Foundation" "qtbz2"
+.\" generated by mkman.py, please do NOT edit!
+.TH qtbz2 "1" "Apr 2018" "Gentoo Foundation" "qtbz2"
 .SH NAME
 qtbz2 \- manipulate tbz2 packages
 .SH SYNOPSIS
 .B qtbz2
 \fI[opts] <misc args>\fR
 .SH DESCRIPTION
-
+\fIqtbz2\fR joins and splits combined xpak+tarbz2 files.  Gentoo binary
+packages are such combined files.
 .SH OPTIONS
 .TP
 \fB\-d\fR \fI<arg>\fR, \fB\-\-dir\fR \fI<arg>\fR
-Change to specified directory
+Change to specified directory.
 .TP
 \fB\-j\fR, \fB\-\-join\fR
-Join: <tar.bz2> <xpak> <tbz2>
+Join: <tar.bz2> <xpak> <tbz2>.
 .TP
 \fB\-s\fR, \fB\-\-split\fR
-Split a tbz2 into a tar.bz2 + xpak
+Split a tbz2 into a tar.bz2 + xpak.
 .TP
 \fB\-t\fR, \fB\-\-tarbz2\fR
-Just split the tar.bz2
+Just split the tar.bz2.
 .TP
 \fB\-x\fR, \fB\-\-xpak\fR
-Just split the xpak
+Just split the xpak.
 .TP
 \fB\-O\fR, \fB\-\-stdout\fR
-Write files to stdout
+Write files to stdout.
 .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 some files and sizes while joining and splitting.
 .TP
 \fB\-q\fR, \fB\-\-quiet\fR
-Tighter output; suppress warnings
+Ignored for compatibility with other qapplets.
 .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/
 .br
-Product: Portage Development; Component: Tools
+Product: Portage Development; Component: Tools, Assignee:
+portage-utils@g.o
 .SH AUTHORS
 .nf
 Ned Ludd <solar@g.o>