commit: 454020200171d3d921b0f7e2229d4e527e1e6b2a Author: Fabian Groffen <grobian <AT> gentoo <DOT> org> AuthorDate: Tue Apr 3 15:19:43 2018 +0000 Commit: Fabian Groffen <grobian <AT> gentoo <DOT> org> CommitDate: Tue Apr 3 15:19:43 2018 +0000 URL: https://gitweb.gentoo.org/proj/portage-utils.git/commit/?id=45402020
quse: improve documentation Bug: https://bugs.gentoo.org/645554 man/include/quse.desc | 2 ++ man/include/quse.optdesc.yaml | 11 +++++++++++ man/quse.1 | 40 ++++++++++++++++++++++++---------------- quse.c | 4 ++-- 4 files changed, 39 insertions(+), 18 deletions(-) diff --git a/man/include/quse.desc b/man/include/quse.desc new file mode 100644 index 0000000..7492774 --- /dev/null +++ b/man/include/quse.desc @@ -0,0 +1,2 @@ +\fIquse\fR searches in ebuilds for a match in IUSE, KEYWORDS or LICENSE. +It can also search for USE-flags and show their descriptions. diff --git a/man/include/quse.optdesc.yaml b/man/include/quse.optdesc.yaml new file mode 100644 index 0000000..2a3675d --- /dev/null +++ b/man/include/quse.optdesc.yaml @@ -0,0 +1,11 @@ +exact: Search for exact string, e.g.\ do not use regular expression matching. +format: | + Advanced option to manually override the variable searched for in + ebuilds. By default, the search is \fIIUSE=\fR, the \fB\-K\fR and + \fB\-L\fR override that to \fIKEYWORDS=\fR and \fILICENSE=\fR + respectively. This option, sets the search to any variable. Note + that the equals sign is part of the search, and needs to be set. +verbose: | + Show problems encountered during parsing. These are mostly + diagnostic and indicate possible incorrectness in the results. +quiet: Ignored for compatibility with other qapplets. diff --git a/man/quse.1 b/man/quse.1 index e1e6db9..9b632b7 100644 --- a/man/quse.1 +++ b/man/quse.1 @@ -1,56 +1,64 @@ -.TH quse "1" "Mar 2016" "Gentoo Foundation" "quse" +.\" generated by mkman.py, please do NOT edit! +.TH quse "1" "Apr 2018" "Gentoo Foundation" "quse" .SH NAME quse \- find pkgs using useflags .SH SYNOPSIS .B quse \fI[opts] <useflag>\fR .SH DESCRIPTION - +\fIquse\fR searches in ebuilds for a match in IUSE, KEYWORDS or LICENSE. +It can also search for USE-flags and show their descriptions. .SH OPTIONS .TP \fB\-e\fR, \fB\-\-exact\fR -Show exact non regexp matching using strcmp +Search for exact string, e.g.\ do not use regular expression matching. .TP \fB\-a\fR, \fB\-\-all\fR -Show annoying things in IUSE +List all ebuilds, don't match anything. .TP \fB\-K\fR, \fB\-\-keywords\fR -Use the KEYWORDS vs IUSE +Use the KEYWORDS vs IUSE. .TP \fB\-L\fR, \fB\-\-license\fR -Use the LICENSE vs IUSE +Use the LICENSE vs IUSE. .TP \fB\-D\fR, \fB\-\-describe\fR -Describe the USE flag +Describe the USE flag. .TP \fB\-F\fR \fI<arg>\fR, \fB\-\-format\fR \fI<arg>\fR -Use your own variable formats. -F NAME= +Advanced option to manually override the variable searched for in +ebuilds. By default, the search is \fIIUSE=\fR, the \fB\-K\fR and +\fB\-L\fR override that to \fIKEYWORDS=\fR and \fILICENSE=\fR +respectively. This option, sets the search to any variable. Note +that the equals sign is part of the search, and needs to be set. .TP \fB\-N\fR, \fB\-\-name\-only\fR -Only show package name +Only show package name. .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 +Show problems encountered during parsing. These are mostly +diagnostic and indicate possible incorrectness in the results. .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-ut...@gentoo.org .SH AUTHORS .nf Ned Ludd <so...@gentoo.org> diff --git a/quse.c b/quse.c index ea8a326..05ba2f4 100644 --- a/quse.c +++ b/quse.c @@ -1,5 +1,5 @@ /* - * Copyright 2005-2014 Gentoo Foundation + * Copyright 2005-2018 Gentoo Foundation * Distributed under the terms of the GNU General Public License v2 * * Copyright 2005-2010 Ned Ludd - <so...@gentoo.org> @@ -26,7 +26,7 @@ static struct option const quse_long_opts[] = { }; static const char * const quse_opts_help[] = { "Show exact non regexp matching using strcmp", - "Show annoying things in IUSE", + "List all ebuilds, don't match anything", "Use the KEYWORDS vs IUSE", "Use the LICENSE vs IUSE", "Describe the USE flag",
