summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
Diffstat (limited to 'doc')
-rw-r--r--doc/Makefile1
-rw-r--r--doc/apk-list.8.scd43
-rw-r--r--doc/apk.8.scd2
3 files changed, 45 insertions, 1 deletions
diff --git a/doc/Makefile b/doc/Makefile
index 4425e83..416da23 100644
--- a/doc/Makefile
+++ b/doc/Makefile
@@ -10,6 +10,7 @@ docs: $(obj)/apk.8 \
$(obj)/apk-del.8 \
$(obj)/apk-fix.8 \
$(obj)/apk-info.8 \
+ $(obj)/apk-list.8 \
$(obj)/apk-update.8 \
$(obj)/apk-upgrade.8 \
$(obj)/apk-repositories.5 \
diff --git a/doc/apk-list.8.scd b/doc/apk-list.8.scd
new file mode 100644
index 0000000..06412f4
--- /dev/null
+++ b/doc/apk-list.8.scd
@@ -0,0 +1,43 @@
+apk-list(8)
+
+# NAME
+
+apk list - list packages matching a pattern or other criteria
+
+# SYNOPSIS
+
+*apk list* [<_options_>...] _pattern_...
+
+# DESCRIPTION
+
+*apk list* searches package indicies for packages matching the given patterns
+and prints any matching packages. The patterns are matched with *fnmatch*(3),
+which behaves similarly to shell globbing.
+
+# OPTIONS
+
+*-I, --installed*
+ Consider only installed packages.
+
+*-O, --orphaned*
+ Consider only orphaned packages.
+
+*-a, --available*
+ Consider only available packages.
+
+*-u, --upgradable*
+ Consider only upgradable packages.
+
+*-o, --origin*
+ List packages by origin.
+
+*-d, --depends*
+ List packages by dependency.
+
+*-P, --depends*
+ List packages by provider.
+
+# AUTHORS
+
+Natanael Copa <ncopa@alpinelinux.org>++
+Timo Teräs <_timo.teras@iki.fi_>
diff --git a/doc/apk.8.scd b/doc/apk.8.scd
index 2ae3d3b..2ec3b80 100644
--- a/doc/apk.8.scd
+++ b/doc/apk.8.scd
@@ -41,7 +41,7 @@ Each command is documented in detail on its manual page.
|[ *apk-info*(8)
:< Give detailed information about packages or repositories
| *apk-list*(8)
-: List packages by patterns or other criteria
+: List packages matching a pattern or other criteria
| *apk-dot*(8)
: Generate graphviz graphs
| *apk-policy*(8)