Document apk-search

Fixes #10746.
cute-signatures
Rodrigo Lourenço 2021-06-10 20:05:35 +01:00 committed by Timo Teräs
parent ee21625839
commit b980ed8522
3 changed files with 45 additions and 0 deletions

42
doc/apk-search.8.scd Normal file
View File

@ -0,0 +1,42 @@
apk-search(8)
# NAME
apk search - search for packages by name or description
# SYNOPSIS
*apk search* [<_options_>...] _pattern_...
# DESCRIPTION
*apk search* searches all repositories for packages matching at least one
pattern. If no pattern is given, it lists all packages in the repository. A
pattern matches if it is a case-sensitive substring of the package name.
# OPTIONS
In addition to the global options (see *apk*(8)), *apk search* supports the
following options:
*-a, --all*
Print all matching package versions. By default, *apk* only shows the
latest version.
*-d, --description*
Also search for _pattern_ in the package description. By default, *apk*
does not search package descriptions.
*-e, -x, --exact*
Match package names exactly.
*--has-origin*
Match by package origin. Shows all packages whose base package name
matches _pattern_ exactly. Implies *--all* and *--exact*.
*-o, --origin*
Print base package name.
*-r, --rdepends*
Print reverse dependencies (other packages which depend on the
package).

View File

@ -49,6 +49,8 @@ Each command is documented in detail on its manual page.
: Render dependencies as graphviz graphs
| *apk-policy*(8)
: Show repository policy for packages
| *apk-search*(8)
: Search for packages by name or description
## REPOSITORY MAINTENANCE

View File

@ -15,6 +15,7 @@ man_files = files(
'apk-manifest.8.scd',
'apk-policy.8.scd',
'apk-repositories.5.scd',
'apk-search.8.scd',
'apk-stats.8.scd',
'apk-update.8.scd',
'apk-upgrade.8.scd',