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

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

[Fabian Groffen]

commit:     3b1cb130c9d20ef0d1190d7b7baf25a910765167
Author:     Fabian Groffen <grobian <AT> gentoo <DOT> org>
AuthorDate: Sun Apr  1 13:47:10 2018 +0000
Commit:     Fabian Groffen <grobian <AT> gentoo <DOT> org>
CommitDate: Sun Apr  1 13:47:10 2018 +0000
URL:        https://gitweb.gentoo.org/proj/portage-utils.git/commit/?id=3b1cb130

man/qdepends: improve manpage

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

 man/include/qdepends-05-examples.include | 17 +++++++
 man/include/qdepends.desc                | 10 +++--
 man/include/qdepends.optdesc.yaml        | 29 ++++++++++++
 man/qdepends.1                           | 77 ++++++++++++++++++++++++--------
 4 files changed, 111 insertions(+), 22 deletions(-)

diff --git a/man/include/qdepends-05-examples.include b/man/include/qdepends-05-examples.include
index d4779ea..04fb92f 100644
--- a/man/include/qdepends-05-examples.include
+++ b/man/include/qdepends-05-examples.include
@@ -6,3 +6,20 @@ For finding out what a particular package depends on for building, you could do:
 .fi
 This tells us that we have \fIapp-editors/nano-2.3.2\fR installed and it depends
 on ncurses (among other things).
+
+Searching for packages that actually have nano in their RDEPEND:
+.nf
+	$ \fIqdepends -rQ nano\fR
+	virtual/editor-0
+.fi
+Tells us that \fIvirtual/editor\fR depends on nano.  However, if we
+wanted to know in what way a package specifically depends on another
+package, one can use \fB\-v\fR.
+.nf
+	$ \fIqdepends -vrQ logrotate\fR
+	sys-apps/portage-2.3.18: >=app-admin/logrotate-3.8.0
+.fi
+This way we can see there is a specific dependency expressed here.  If
+the above had used \fI<logrotate-3\fR, for example, no matches would be
+returned.  Not using any specifiers allows to reveal in what way a
+dependency is expressed.

diff --git a/man/include/qdepends.desc b/man/include/qdepends.desc
index b9713d0..0143847 100644
--- a/man/include/qdepends.desc
+++ b/man/include/qdepends.desc
@@ -1,11 +1,15 @@
-The qdepends applet has a couple different modes.  Normally it is geared towards
+The
+.I qdepends
+applet has a couple different modes.  Normally it is geared towards
 answering the queries "what does package X depend on" and "what packages depend
 on X".  Both can further be classified into build, run, and post dependencies.
 
 By default, it will tell you the build time dependencies only (DEPEND).
 
-Currently, qdepends will only query installed packages.  There is no support for
-querying packages not yet installed (the \fBequery\fR(1) tool can do that).
+Currently,
+.I qdepends
+will only query installed packages.  There is no support for
+querying packages not yet installed (see \fBequery\fR(1) for that).
 
 If there is no answer to your query (i.e. you've asked for a package that is not
 installed, or a version that does not match), then you will get back no output.

diff --git a/man/include/qdepends.optdesc.yaml b/man/include/qdepends.optdesc.yaml
new file mode 100644
index 0000000..51b1cc7
--- /dev/null
+++ b/man/include/qdepends.optdesc.yaml
@@ -0,0 +1,29 @@
+all: |
+    Show *DEPEND, alias for \fB\-drp\fR.
+key: |
+    Advanced option to allow querying the VDB.  This option overrides
+    \fB\-d\fR, \fB\-r\fR, \fB\-p\fR or \fB\-a\fR.  \fI<arg>\fR can be
+    any key from Portage's VDB, e.g.\ any file from
+    var/db/pkg/<cat>/<pkg>/.
+query: |
+    Query reverse deps.  This basically reverses the search to any
+    package that references \fI<arg>\fR in DEPEND, RDEPEND or PDEPEND.
+    This can be useful to find consumers of a given package, e.g.\ to
+    search for packages that have \fIlogwatch\fR in their DEPEND.
+name-only: |
+    Only show category/package, instead of category/package-version.
+format: |
+    Pretty-print DEPEND declaration to be used in an ebuild.  This
+    option initiates a very different mode of operation.  Instead of
+    printing searching through packages, it constructs a multi-line
+    statement in with shell syntax, to be used in an ebuild.  Each
+    argument is turned into a separate DEPEND variable declaration.  You
+    need to quote dependency strings in order for them to be printed as
+    a single dependency declaration.  When used with the \fB\-q\fR
+    option, only the pretty-printed dependency declaration is printed,
+    e.g.\ the DEPEND= part is skipped.
+verbose: |
+    When in reverse dep mode, print the package or packages that matched
+    the query from the dependency line being searched.  This includes
+    specifiers and versions.
+quiet: Suppress DEPEND= output for \fB\-f\fR.

diff --git a/man/qdepends.1 b/man/qdepends.1
index a0cac5b..c51a02d 100644
--- a/man/qdepends.1
+++ b/man/qdepends.1
@@ -1,64 +1,85 @@
-.TH qdepends "1" "Mar 2016" "Gentoo Foundation" "qdepends"
+.\" generated by mkman.py, please do NOT edit!
+.TH qdepends "1" "Apr 2018" "Gentoo Foundation" "qdepends"
 .SH NAME
 qdepends \- show dependency info
 .SH SYNOPSIS
 .B qdepends
 \fI[opts] <pkgname>\fR
 .SH DESCRIPTION
-The qdepends applet has a couple different modes.  Normally it is geared towards
+The
+.I qdepends
+applet has a couple different modes.  Normally it is geared towards
 answering the queries "what does package X depend on" and "what packages depend
 on X".  Both can further be classified into build, run, and post dependencies.
 
 By default, it will tell you the build time dependencies only (DEPEND).
 
-Currently, qdepends will only query installed packages.  There is no support for
-querying packages not yet installed (the \fBequery\fR(1) tool can do that).
+Currently,
+.I qdepends
+will only query installed packages.  There is no support for
+querying packages not yet installed (see \fBequery\fR(1) for that).
 
 If there is no answer to your query (i.e. you've asked for a package that is not
 installed, or a version that does not match), then you will get back no output.
 .SH OPTIONS
 .TP
 \fB\-d\fR, \fB\-\-depend\fR
-Show DEPEND info (default)
+Show DEPEND info (default).
 .TP
 \fB\-r\fR, \fB\-\-rdepend\fR
-Show RDEPEND info
+Show RDEPEND info.
 .TP
 \fB\-p\fR, \fB\-\-pdepend\fR
-Show PDEPEND info
+Show PDEPEND info.
 .TP
 \fB\-k\fR \fI<arg>\fR, \fB\-\-key\fR \fI<arg>\fR
-User defined vdb key
+Advanced option to allow querying the VDB.  This option overrides
+\fB\-d\fR, \fB\-r\fR, \fB\-p\fR or \fB\-a\fR.  \fI<arg>\fR can be
+any key from Portage's VDB, e.g.\ any file from
+var/db/pkg/<cat>/<pkg>/.
 .TP
 \fB\-Q\fR \fI<arg>\fR, \fB\-\-query\fR \fI<arg>\fR
-Query reverse deps
+Query reverse deps.  This basically reverses the search to any
+package that references \fI<arg>\fR in DEPEND, RDEPEND or PDEPEND.
+This can be useful to find consumers of a given package, e.g.\ to
+search for packages that have \fIlogwatch\fR in their DEPEND.
 .TP
 \fB\-N\fR, \fB\-\-name\-only\fR
-Only show package name
+Only show category/package, instead of category/package-version.
 .TP
 \fB\-a\fR, \fB\-\-all\fR
-Show all DEPEND info
+Show *DEPEND, alias for \fB\-drp\fR.
 .TP
 \fB\-f\fR, \fB\-\-format\fR
-Pretty format specified depend strings
+Pretty-print DEPEND declaration to be used in an ebuild.  This
+option initiates a very different mode of operation.  Instead of
+printing searching through packages, it constructs a multi-line
+statement in with shell syntax, to be used in an ebuild.  Each
+argument is turned into a separate DEPEND variable declaration.  You
+need to quote dependency strings in order for them to be printed as
+a single dependency declaration.  When used with the \fB\-q\fR
+option, only the pretty-printed dependency declaration is printed,
+e.g.\ the DEPEND= part is skipped.
 .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
+When in reverse dep mode, print the package or packages that matched
+the query from the dependency line being searched.  This includes
+specifiers and versions.
 .TP
 \fB\-q\fR, \fB\-\-quiet\fR
-Tighter output; suppress warnings
+Suppress DEPEND= output for \fB\-f\fR.
 .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 "EXAMPLES"
 For finding out what a particular package depends on for building, you could do:
 .nf
@@ -67,10 +88,28 @@ For finding out what a particular package depends on for building, you could do:
 .fi
 This tells us that we have \fIapp-editors/nano-2.3.2\fR installed and it depends
 on ncurses (among other things).
+
+Searching for packages that actually have nano in their RDEPEND:
+.nf
+	$ \fIqdepends -rQ nano\fR
+	virtual/editor-0
+.fi
+Tells us that \fIvirtual/editor\fR depends on nano.  However, if we
+wanted to know in what way a package specifically depends on another
+package, one can use \fB\-v\fR.
+.nf
+	$ \fIqdepends -vrQ logrotate\fR
+	sys-apps/portage-2.3.18: >=app-admin/logrotate-3.8.0
+.fi
+This way we can see there is a specific dependency expressed here.  If
+the above had used \fI<logrotate-3\fR, for example, no matches would be
+returned.  Not using any specifiers allows to reveal in what way a
+dependency is expressed.
 .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@gentoo.org
 .SH AUTHORS
 .nf
 Ned Ludd <solar@gentoo.org>

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

[Fabian Groffen]

commit:     b10334e70c272bb554228acea075011925f260fb
Author:     Fabian Groffen <grobian <AT> gentoo <DOT> org>
AuthorDate: Sun Apr  1 12:44:30 2018 +0000
Commit:     Fabian Groffen <grobian <AT> gentoo <DOT> org>
CommitDate: Sun Apr  1 12:44:30 2018 +0000
URL:        https://gitweb.gentoo.org/proj/portage-utils.git/commit/?id=b10334e7

man/qlop: regen manpage

commit fe42f2a99297fed36720e71ba2ed77cf7a9da804 changed the generated
file, this commit ensures that future regenerate operations don't lose
the changes

 man/include/qlop.desc         |  4 ++++
 man/include/qlop.optdesc.yaml | 15 +++++++++++++++
 man/qlop.1                    | 26 +++++++++++++++-----------
 3 files changed, 34 insertions(+), 11 deletions(-)

diff --git a/man/include/qlop.desc b/man/include/qlop.desc
new file mode 100644
index 0000000..d99cc94
--- /dev/null
+++ b/man/include/qlop.desc
@@ -0,0 +1,4 @@
+.I 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.

diff --git a/man/include/qlop.optdesc.yaml b/man/include/qlop.optdesc.yaml
new file mode 100644
index 0000000..7864d6e
--- /dev/null
+++ b/man/include/qlop.optdesc.yaml
@@ -0,0 +1,15 @@
+gauge: |
+    Gauge number of times a package has been merged.  This shows the
+    merge time for each individual merge of package.
+time: |
+    Calculate merge time for a specific package.  This is the average
+    time for all merges of package.
+human: |
+    Print seconds in human readable format (needs \fB\-t\fR), using
+    minutes, hours and days instead of just seconds.
+current: |
+    Show current emerging packages.  This relies on
+    .I FEATURES=sandbox
+    in order to detect running merges.
+verbose: |
+    Print package versions and revisions.

diff --git a/man/qlop.1 b/man/qlop.1
index 70fb411..c138054 100644
--- a/man/qlop.1
+++ b/man/qlop.1
@@ -1,26 +1,28 @@
-.TH qlop "1" "Mar 2018" "Gentoo Foundation" "qlop"
+.\" generated by mkman.py, please do NOT edit!
+.TH qlop "1" "Apr 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
+.I 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.  This shows the merge
-time for each individual merge of package.
+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.  This is the average time
-for all merges of 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), using minutes, hours
-and days instead of just seconds.
+Print seconds in human readable format (needs \fB\-t\fR), using
+minutes, hours and days instead of just seconds.
 .TP
 \fB\-l\fR, \fB\-\-list\fR
 Show merge history.
@@ -32,8 +34,9 @@ Show unmerge history.
 Show sync history.
 .TP
 \fB\-c\fR, \fB\-\-current\fR
-Show current emerging packages.  This relies on FEATURES=sandbox in
-order to detect running merges.
+Show current emerging packages.  This relies on
+.I 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).
@@ -62,7 +65,8 @@ 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@gentoo.org
 .SH AUTHORS
 .nf
 Ned Ludd <solar@gentoo.org>

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

[Fabian Groffen]

commit:     9164549006068637d060a23a9a24f657982bfbaf
Author:     Fabian Groffen <grobian <AT> gentoo <DOT> org>
AuthorDate: Mon Apr  2 17:26:35 2018 +0000
Commit:     Fabian Groffen <grobian <AT> gentoo <DOT> org>
CommitDate: Mon Apr  2 17:26:35 2018 +0000
URL:        https://gitweb.gentoo.org/proj/portage-utils.git/commit/?id=91645490

qatom: improve manpage

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

 man/include/qatom.desc         | 15 +++++++++
 man/include/qatom.optdesc.yaml | 43 ++++++++++++++++++++++++
 man/qatom.1                    | 74 ++++++++++++++++++++++++++++++++++++------
 3 files changed, 122 insertions(+), 10 deletions(-)

diff --git a/man/include/qatom.desc b/man/include/qatom.desc
new file mode 100644
index 0000000..10f0c1c
--- /dev/null
+++ b/man/include/qatom.desc
@@ -0,0 +1,15 @@
+\fIqatom\fR parses strings into atoms and optionally compares them.  The
+parsing into atoms results in CATEGORY, PN (package name), PV (package
+version), PR (package revision), SLOT and REPO.  Next to these version
+qualifiers (e.g.\ >, <, or =) and optional * suffix are extracted.  All
+but PN are optional.
+
+Comparison of atoms returns the relationship between two parsed atoms.
+\fIqatom\fR does not allow to test conditions.  It is possible to
+perform multiple comparisons by simply adding more arguments.
+Comparisons are, however, always performed two by two, so there must be
+an even count of arguments to the compare function.
+
+The \fIqatom\fR applet is a direct wrapper around the atom parsing
+functionalities used by various other applets.  As such this applet
+allows easy testing or atom parsing and comparison behaviour.

diff --git a/man/include/qatom.optdesc.yaml b/man/include/qatom.optdesc.yaml
new file mode 100644
index 0000000..e71dfb7
--- /dev/null
+++ b/man/include/qatom.optdesc.yaml
@@ -0,0 +1,43 @@
+format: |
+    Specify a custom  output  format.  The default format is
+    .nf
+    %{CATEGORY} %{PN} %{PV} %[PR] %[SLOT] %[pfx] %[sfx]
+    .fi
+    Conversion specifiers start with a \fI%\fR symbol and are followed
+    by either \fI{\fR or \fI[\fR.  Next is the name of the field to
+    expand, followed by a matching \fI}\fR or \fI]\fR.  The difference
+    between \fI{\fR and \fI[\fR is that the latter is only printed if
+    the field referred is set, while the former prints \fI<unset>\fR in
+    that case.
+
+    The following fields are supported, which are inline with the
+    variables from \fBebuild\fR(5).
+    .RS
+    .IP CATEGORY
+    The category of the package.
+    .IP P
+    The package name and version without the ebuild revision.
+    .IP PN
+    The package name.
+    .IP PV
+    The package version without the ebuild revision.
+    .IP PVR
+    The package version including ebuild revision, which is also printed
+    when zero, unlike for \fIPF\fR.
+    .IP PF
+    The package name, version and revision when not zero.  Thus, a zero
+    revision \fI\-r0\fR is not printed.
+    .IP PR
+    The ebuild revision, when force printed, outputs \fI\-r0\fR when unset.
+    .IP SLOT
+    The package slot, when force printed, outputs \fI\-\fR when unset.
+    .IP REPO
+    The package repository.
+    .IP pfx
+    The package prefixes, that is version specifiers.
+    .IP sfx
+    The package suffices, currently that is just the asterisk.
+    .RE
+verbose: Force all expansions, basically treat all \fI[\fR like \fI{\fR.
+quiet: Ignored for compatibility with other qapplets.
+nocolor: Ignored for compatibility with other qapplets.

diff --git a/man/qatom.1 b/man/qatom.1
index 4a30343..aeb9629 100644
--- a/man/qatom.1
+++ b/man/qatom.1
@@ -1,41 +1,95 @@
-.TH qatom "1" "Mar 2016" "Gentoo Foundation" "qatom"
+.\" generated by mkman.py, please do NOT edit!
+.TH qatom "1" "Apr 2018" "Gentoo Foundation" "qatom"
 .SH NAME
 qatom \- split atom strings
 .SH SYNOPSIS
 .B qatom
 \fI[opts] <pkg>\fR
 .SH DESCRIPTION
+\fIqatom\fR parses strings into atoms and optionally compares them.  The
+parsing into atoms results in CATEGORY, PN (package name), PV (package
+version), PR (package revision), SLOT and REPO.  Next to these version
+qualifiers (e.g.\ >, <, or =) and optional * suffix are extracted.  All
+but PN are optional.
 
+Comparison of atoms returns the relationship between two parsed atoms.
+\fIqatom\fR does not allow to test conditions.  It is possible to
+perform multiple comparisons by simply adding more arguments.
+Comparisons are, however, always performed two by two, so there must be
+an even count of arguments to the compare function.
+
+The \fIqatom\fR applet is a direct wrapper around the atom parsing
+functionalities used by various other applets.  As such this applet
+allows easy testing or atom parsing and comparison behaviour.
 .SH OPTIONS
 .TP
 \fB\-F\fR \fI<arg>\fR, \fB\-\-format\fR \fI<arg>\fR
-Custom output format (default: %{CATEGORY} %{PN} %{PV} %[PR] %[SLOT] %[pfx] %[sfx])
+Specify a custom  output  format.  The default format is
+.nf
+%{CATEGORY} %{PN} %{PV} %[PR] %[SLOT] %[pfx] %[sfx]
+.fi
+Conversion specifiers start with a \fI%\fR symbol and are followed
+by either \fI{\fR or \fI[\fR.  Next is the name of the field to
+expand, followed by a matching \fI}\fR or \fI]\fR.  The difference
+between \fI{\fR and \fI[\fR is that the latter is only printed if
+the field referred is set, while the former prints \fI<unset>\fR in
+that case.
+
+The following fields are supported, which are inline with the
+variables from \fBebuild\fR(5).
+.RS
+.IP CATEGORY
+The category of the package.
+.IP P
+The package name and version without the ebuild revision.
+.IP PN
+The package name.
+.IP PV
+The package version without the ebuild revision.
+.IP PVR
+The package version including ebuild revision, which is also printed
+when zero, unlike for \fIPF\fR.
+.IP PF
+The package name, version and revision when not zero.  Thus, a zero
+revision \fI\-r0\fR is not printed.
+.IP PR
+The ebuild revision, when force printed, outputs \fI\-r0\fR when unset.
+.IP SLOT
+The package slot, when force printed, outputs \fI\-\fR when unset.
+.IP REPO
+The package repository.
+.IP pfx
+The package prefixes, that is version specifiers.
+.IP sfx
+The package suffices, currently that is just the asterisk.
+.RE
 .TP
 \fB\-c\fR, \fB\-\-compare\fR
-Compare two atoms
+Compare two atoms.
 .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
+Force all expansions, basically treat all \fI[\fR like \fI{\fR.
 .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
+Ignored for compatibility with other qapplets.
 .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@gentoo.org
 .SH AUTHORS
 .nf
 Ned Ludd <solar@gentoo.org>

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

[Fabian Groffen]

commit:     f24b626027dceb5890b134837c6683f4593f6ce0
Author:     Fabian Groffen <grobian <AT> gentoo <DOT> org>
AuthorDate: Tue Apr  3 12:15:35 2018 +0000
Commit:     Fabian Groffen <grobian <AT> gentoo <DOT> org>
CommitDate: Tue Apr  3 12:15:35 2018 +0000
URL:        https://gitweb.gentoo.org/proj/portage-utils.git/commit/?id=f24b6260

qmerge: improve documentation

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

 man/include/qmerge.desc |  6 ++++++
 man/qmerge.1            | 43 +++++++++++++++++++++++++------------------
 2 files changed, 31 insertions(+), 18 deletions(-)

diff --git a/man/include/qmerge.desc b/man/include/qmerge.desc
new file mode 100644
index 0000000..08589ec
--- /dev/null
+++ b/man/include/qmerge.desc
@@ -0,0 +1,6 @@
+\fIqmerge\fR retrieves and installs Gentoo binary packages.  Simple
+dependency checking is performed, after which \fIqmerge\fR just unpacks
+the binpkg onto the filesystem and registers the package in the VDB.
+
+Retrieval of packages from a remote binhost is currently performed using
+\fBwget\fR(1).  More specifically, \fIFETCHCOMMAND\fR is ignored.

diff --git a/man/qmerge.1 b/man/qmerge.1
index f3d80db..f66908e 100644
--- a/man/qmerge.1
+++ b/man/qmerge.1
@@ -1,65 +1,72 @@
-.TH qmerge "1" "Mar 2016" "Gentoo Foundation" "qmerge"
+.\" generated by mkman.py, please do NOT edit!
+.TH qmerge "1" "Apr 2018" "Gentoo Foundation" "qmerge"
 .SH NAME
 qmerge \- fetch and merge binary package
 .SH SYNOPSIS
 .B qmerge
 \fI[opts] <pkgnames>\fR
 .SH DESCRIPTION
+\fIqmerge\fR retrieves and installs Gentoo binary packages.  Simple
+dependency checking is performed, after which \fIqmerge\fR just unpacks
+the binpkg onto the filesystem and registers the package in the VDB.
 
+Retrieval of packages from a remote binhost is currently performed using
+\fBwget\fR(1).  More specifically, \fIFETCHCOMMAND\fR is ignored.
 .SH OPTIONS
 .TP
 \fB\-f\fR, \fB\-\-fetch\fR
-Fetch package and newest Packages metadata
+Fetch package and newest Packages metadata.
 .TP
 \fB\-F\fR, \fB\-\-force\fR
-Fetch package (skipping Packages)
+Fetch package (skipping Packages).
 .TP
 \fB\-s\fR, \fB\-\-search\fR
-Search available packages
+Search available packages.
 .TP
 \fB\-K\fR, \fB\-\-install\fR
-Install package
+Install package.
 .TP
 \fB\-U\fR, \fB\-\-unmerge\fR
-Uninstall package
+Uninstall package.
 .TP
 \fB\-p\fR, \fB\-\-pretend\fR
-Pretend only
+Pretend only.
 .TP
 \fB\-u\fR, \fB\-\-update\fR
-Update only
+Update only.
 .TP
 \fB\-y\fR, \fB\-\-yes\fR
-Don't prompt before overwriting
+Don't prompt before overwriting.
 .TP
 \fB\-O\fR, \fB\-\-nodeps\fR
-Don't merge dependencies
+Don't merge dependencies.
 .TP
 \fB\-\-debug\fR
-Run shell funcs with `set -x`
+Run shell funcs with `set -x`.
 .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
+Make a lot of noise.
 .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/
 .br
-Product: Portage Development; Component: Tools
+Product: Portage Development; Component: Tools, Assignee:
+portage-utils@gentoo.org
 .SH AUTHORS
 .nf
 Ned Ludd <solar@gentoo.org>

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

[Fabian Groffen]

commit:     86085691d6a42e497c1a8902cf7c24212a2dd67d
Author:     Fabian Groffen <grobian <AT> gentoo <DOT> org>
AuthorDate: Tue Apr  3 12:56:17 2018 +0000
Commit:     Fabian Groffen <grobian <AT> gentoo <DOT> org>
CommitDate: Tue Apr  3 12:56:17 2018 +0000
URL:        https://gitweb.gentoo.org/proj/portage-utils.git/commit/?id=86085691

qpkg: improve documentation

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

 man/include/qpkg.desc         |  4 ++++
 man/include/qpkg.optdesc.yaml |  2 ++
 man/qpkg.1                    | 31 ++++++++++++++++++-------------
 3 files changed, 24 insertions(+), 13 deletions(-)

diff --git a/man/include/qpkg.desc b/man/include/qpkg.desc
new file mode 100644
index 0000000..2bba24b
--- /dev/null
+++ b/man/include/qpkg.desc
@@ -0,0 +1,4 @@
+\fIqpkg\fR creates or cleans up Gentoo binary packages.  The default
+action is to create a new binpkg for the given package names and store
+them in pkgdir, which can be set explicitly using the \fB\-\-pkgdir\fR
+option.

diff --git a/man/include/qpkg.optdesc.yaml b/man/include/qpkg.optdesc.yaml
new file mode 100644
index 0000000..2da2810
--- /dev/null
+++ b/man/include/qpkg.optdesc.yaml
@@ -0,0 +1,2 @@
+verbose: Check and report MD5 hash mismatches during install.
+quiet: Ignored for compatability with other qapplets.

diff --git a/man/qpkg.1 b/man/qpkg.1
index 8bb098a..930d15c 100644
--- a/man/qpkg.1
+++ b/man/qpkg.1
@@ -1,47 +1,52 @@
-.TH qpkg "1" "Mar 2016" "Gentoo Foundation" "qpkg"
+.\" generated by mkman.py, please do NOT edit!
+.TH qpkg "1" "Apr 2018" "Gentoo Foundation" "qpkg"
 .SH NAME
 qpkg \- manipulate Gentoo binpkgs
 .SH SYNOPSIS
 .B qpkg
 \fI[opts] <misc args>\fR
 .SH DESCRIPTION
-
+\fIqpkg\fR creates or cleans up Gentoo binary packages.  The default
+action is to create a new binpkg for the given package names and store
+them in pkgdir, which can be set explicitly using the \fB\-\-pkgdir\fR
+option.
 .SH OPTIONS
 .TP
 \fB\-c\fR, \fB\-\-clean\fR
-clean pkgdir of unused binary files
+clean pkgdir of unused binary files.
 .TP
 \fB\-E\fR, \fB\-\-eclean\fR
-clean pkgdir of files not in the tree anymore (slow)
+clean pkgdir of files not in the tree anymore (slow).
 .TP
 \fB\-p\fR, \fB\-\-pretend\fR
-pretend only
+pretend only.
 .TP
 \fB\-P\fR \fI<arg>\fR, \fB\-\-pkgdir\fR \fI<arg>\fR
-alternate package directory
+alternate package directory.
 .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
+Check and report MD5 hash mismatches during install.
 .TP
 \fB\-q\fR, \fB\-\-quiet\fR
-Tighter output; suppress warnings
+Ignored for compatability 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@gentoo.org
 .SH AUTHORS
 .nf
 Ned Ludd <solar@gentoo.org>

[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@gentoo.org
 .SH AUTHORS
 .nf
 Ned Ludd <solar@gentoo.org>

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

[Fabian Groffen]

commit:     4b27faa3832c62110573d4fa587a117047bf139c
Author:     Fabian Groffen <grobian <AT> gentoo <DOT> org>
AuthorDate: Thu Jul 18 18:38:46 2019 +0000
Commit:     Fabian Groffen <grobian <AT> gentoo <DOT> org>
CommitDate: Thu Jul 18 18:38:46 2019 +0000
URL:        https://gitweb.gentoo.org/proj/portage-utils.git/commit/?id=4b27faa3

man/qlop: q -> g

g is now best matched by t, q was never doing anything in particular

Signed-off-by: Fabian Groffen <grobian <AT> gentoo.org>

 man/include/qlop.desc | 2 +-
 man/qlop.1            | 2 +-
 2 files changed, 2 insertions(+), 2 deletions(-)

diff --git a/man/include/qlop.desc b/man/include/qlop.desc
index 3505173..e39f689 100644
--- a/man/include/qlop.desc
+++ b/man/include/qlop.desc
@@ -21,6 +21,6 @@ After version \fB0.74\fR of portage-utils, \fIqlop\fR was changed
 considerably to be more consistent and more advanced.  Most notably,
 this has changed default date output and commmand line flags.  Instead
 of reporting the time the operation finished, \fIqlop\fR now reports the
-time the operation started.  The behaviour of the old \fB-q\fR flag is
+time the operation started.  The behaviour of the old \fB-g\fR flag is
 best matched by the new \fB-t\fR flag.  Similar, the old \fB-t\fR flag
 is matched by the new \fB-a\fR flag.

diff --git a/man/qlop.1 b/man/qlop.1
index 909ebdc..baa5bf5 100644
--- a/man/qlop.1
+++ b/man/qlop.1
@@ -29,7 +29,7 @@ After version \fB0.74\fR of portage-utils, \fIqlop\fR was changed
 considerably to be more consistent and more advanced.  Most notably,
 this has changed default date output and commmand line flags.  Instead
 of reporting the time the operation finished, \fIqlop\fR now reports the
-time the operation started.  The behaviour of the old \fB-q\fR flag is
+time the operation started.  The behaviour of the old \fB-g\fR flag is
 best matched by the new \fB-t\fR flag.  Similar, the old \fB-t\fR flag
 is matched by the new \fB-a\fR flag.
 .SH OPTIONS

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

[Fabian Groffen]

commit:     3a525dc69bf6c74d901da80f13af689b0198557c
Author:     Emanuele Torre <torreemanuele6 <AT> gmail <DOT> com>
AuthorDate: Wed Sep  4 08:59:57 2024 +0000
Commit:     Fabian Groffen <grobian <AT> gentoo <DOT> org>
CommitDate: Thu Sep  5 11:28:38 2024 +0000
URL:        https://gitweb.gentoo.org/proj/portage-utils.git/commit/?id=3a525dc6

man: fix -S/--slots option description in qlist.1

I noticed that the qlist(1) man page did not mention that -S implies -I,
so I wanted to fix that.

The man page was actually supposed to mention it, but
man/include/qlist.optdesc.yaml was incorrectly using the "slot" key to
define --slots's long description, so the man page ended up using the
short description from  q list --help  instead of the longer description
that contains "This flag implies -I.".

Renaming the key in the yaml file from "slot" to "slots" fixed the
problem.

I have regenerated the man pages with man/mkman.py, but only included
the new version of qlist.1 in this commit.

Signed-off-by: Emanuele Torre <torreemanuele6 <AT> gmail.com>
Signed-off-by: Fabian Groffen <grobian <AT> gentoo.org>

 man/include/qlist.optdesc.yaml | 2 +-
 man/qlist.1                    | 3 ++-
 2 files changed, 3 insertions(+), 2 deletions(-)

diff --git a/man/include/qlist.optdesc.yaml b/man/include/qlist.optdesc.yaml
index 1145fa9..0ae0700 100644
--- a/man/include/qlist.optdesc.yaml
+++ b/man/include/qlist.optdesc.yaml
@@ -8,7 +8,7 @@ tree: |
 umap: |
     List USE-flags enabled when the package was installed.  This flag
     implies \fB\-I\fR.
-slot: |
+slots: |
     Display installed packages with slots (use twice for subslots).
     This flag implies \fB\-I\fR.
 repo: |

diff --git a/man/qlist.1 b/man/qlist.1
index 9fe7194..e0e9e81 100644
--- a/man/qlist.1
+++ b/man/qlist.1
@@ -1,5 +1,5 @@
 .\" generated by mkman.py, please do NOT edit!
-.TH qlist "1" "Jan 2024" "Gentoo Foundation" "qlist"
+.TH qlist "1" "Sep 2024" "Gentoo Foundation" "qlist"
 .SH NAME
 qlist \- list files owned by pkgname
 .SH SYNOPSIS
@@ -27,6 +27,7 @@ Used with \fB\-I\fR to list packages available in the tree.
 .TP
 \fB\-S\fR, \fB\-\-slots\fR
 Display installed packages with slots (use twice for subslots).
+This flag implies \fB\-I\fR.
 .TP
 \fB\-R\fR, \fB\-\-repo\fR
 Display installed packages with repository the ebuild originated from.