summaryrefslogtreecommitdiff
path: root/doc/apk-search.8.scd
diff options
context:
space:
mode:
Diffstat (limited to 'doc/apk-search.8.scd')
-rw-r--r--doc/apk-search.8.scd42
1 files changed, 42 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).