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-07-23 14:56:52 +0300 |
| commit | 467cb7ca3647c7cddff873fc2a6b35eca628b077 (patch) | |
| tree | 1d7831f5b6c577aa0965acd329b2ff9b771d036e /doc | |
| parent | a4e2de2d6271b796efcdff3ae39b0ee0e09aa6f5 (diff) | |
| download | apk-tools-467cb7ca3647c7cddff873fc2a6b35eca628b077.tar.gz apk-tools-467cb7ca3647c7cddff873fc2a6b35eca628b077.tar.bz2 apk-tools-467cb7ca3647c7cddff873fc2a6b35eca628b077.tar.xz apk-tools-467cb7ca3647c7cddff873fc2a6b35eca628b077.zip | |
Document apk-search
Fixes #10746.
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/Makefile | 1 | ||||
| -rw-r--r-- | doc/apk-search.8.scd | 42 | ||||
| -rw-r--r-- | doc/apk.8.scd | 2 |
3 files changed, 45 insertions, 0 deletions
diff --git a/doc/Makefile b/doc/Makefile index 21d5e03..6650e8b 100644 --- a/doc/Makefile +++ b/doc/Makefile @@ -16,6 +16,7 @@ scdocs-y += \ apk-list.8 \ apk-manifest.8 \ apk-policy.8 \ + apk-search.8 \ apk-stats.8 \ apk-update.8 \ apk-upgrade.8 \ 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 7f2882f..ff3e93a 100644 --- a/doc/apk.8.scd +++ b/doc/apk.8.scd @@ -47,6 +47,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 |