aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorDrew DeVault <sir@cmpwn.com>2020-01-06 17:02:30 -0500
committerTimo Teräs <timo.teras@iki.fi>2020-01-26 09:01:26 +0200
commitc9e33ca851ec1cfec645b84a3f3f410c80335c1a (patch)
tree8ac07daaf1fd80c2d18ba607e6c8cc6b673b0942
parent01ac041bb94fa63fa9d41272f1e560a42b6cbbab (diff)
downloadapk-tools-c9e33ca851ec1cfec645b84a3f3f410c80335c1a.tar.bz2
apk-tools-c9e33ca851ec1cfec645b84a3f3f410c80335c1a.tar.xz
add apk-world(8)
-rw-r--r--doc/Makefile6
-rw-r--r--doc/apk-world.5.scd59
2 files changed, 64 insertions, 1 deletions
diff --git a/doc/Makefile b/doc/Makefile
index be37b7d..57b4e5f 100644
--- a/doc/Makefile
+++ b/doc/Makefile
@@ -1,7 +1,11 @@
+$(obj)/%.5: $(src)/%.5.scd
+ $(SCDOC) < $< > $@
+
$(obj)/%.8: $(src)/%.8.scd
$(SCDOC) < $< > $@
-docs: $(obj)/apk.8
+docs: $(obj)/apk.8 \
+ $(obj)/apk-world.5
targets += docs
install: docs
diff --git a/doc/apk-world.5.scd b/doc/apk-world.5.scd
new file mode 100644
index 0000000..3122d13
--- /dev/null
+++ b/doc/apk-world.5.scd
@@ -0,0 +1,59 @@
+apk-world(5)
+
+# NAME
+
+*/etc/apk/world* - list of explicitly installed packages
+
+# DESCRIPTION
+
+At /etc/apk/world, apk maintains the _world_, or list of explicitly installed
+packages. This is a plaintext file with one package spec per line.
+
+If you edit this file manually, you should run *apk-fix*(8) to apply the
+changes.
+
+# PACKAGE SPECIFICATION
+
+Specifying a package name with no other modifiers will install the latest
+version of that package from the first repository in which it is available.
+
+To pin a package to a tagged repository, use the format *pkgname@tagname*, e.g.
+*busybox@edge*. See *apk-repositories*(5) for details on tagged package
+repositories.
+
+To constrain the acceptable versions of the package, use the *=*, *<*, *>*,
+*>=*, or *~=* operators. Respectively, these require the package is equal to,
+less than, greater than, or greater than or equal to the specified version. The
+*~=* operator constrains the package to the version numbers specified, but will
+not constrain any unspecified version numbers.
+
+*busybox*
+ Installs busybox from the first repository from which it is available.
+
+*busybox@edge*
+ Installs busybox from the first repository tagged "edge" from which
+ it's available. If busybox is _not_ available in repositories with this
+ tag, it will cause an error. When resolving dependencies of tagged
+ requirements, untagged repositories are preferred, but repositories
+ sharing the same tag will be considered if necessary.
+
+*busybox=1.6.1*
+ Install busybox version 1.6.1.
+
+*busybox>1.6.1*
+ Install a busybox version greater than 1.6.1.
+
+*busybox>1.6.1*
+ Install a busybox version greater than or equal to 1.6.1.
+
+*busybox<1.6.1*
+ Install a busybox version less than 1.6.1.
+
+*busybox~=1.6*
+ Install any busybox version between 1.6.0 (inclusive) and 1.7.0
+ (exclusive).
+
+# AUTHORS
+
+Natanael Copa <ncopa@alpinelinux.org>++
+Timo Teräs <_timo.teras@iki.fi_>