diff options
| author | Rodrigo Lourenço <rzl@rzl.ooo> | 2021-06-10 20:05:35 +0100 |
|---|---|---|
| committer | Timo Teräs <timo.teras@iki.fi> | 2021-06-19 11:06:32 +0000 |
| commit | b980ed85221e5694f69070945661ad9b1f4f0e2d (patch) | |
| tree | 4c18533aa2df2be74a6089cb83433e3f0ffb928b | |
| parent | ee216258399f1b58e972dd8c32a024cd1978622c (diff) | |
| download | apk-tools-b980ed85221e5694f69070945661ad9b1f4f0e2d.tar.gz apk-tools-b980ed85221e5694f69070945661ad9b1f4f0e2d.tar.bz2 apk-tools-b980ed85221e5694f69070945661ad9b1f4f0e2d.tar.xz apk-tools-b980ed85221e5694f69070945661ad9b1f4f0e2d.zip | |
Document apk-search
Fixes #10746.
| -rw-r--r-- | doc/apk-search.8.scd | 42 | ||||
| -rw-r--r-- | doc/apk.8.scd | 2 | ||||
| -rw-r--r-- | doc/meson.build | 1 |
3 files changed, 45 insertions, 0 deletions
diff --git a/doc/apk-search.8.scd b/doc/apk-search.8.scd new file mode 100644 index 0000000..890dac1 --- /dev/null +++ b/doc/apk-search.8.scd @@ -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). diff --git a/doc/apk.8.scd b/doc/apk.8.scd index 1a9b697..f119313 100644 --- a/doc/apk.8.scd +++ b/doc/apk.8.scd @@ -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 diff --git a/doc/meson.build b/doc/meson.build index f6d4878..6e2173a 100644 --- a/doc/meson.build +++ b/doc/meson.build @@ -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', |