aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorDrew DeVault <sir@cmpwn.com>2020-01-06 22:40:54 -0500
committerTimo Teräs <timo.teras@iki.fi>2020-01-26 09:01:26 +0200
commit6d507b90727aa02fbe358d2bbe457e68121fcbd5 (patch)
treeb8960ae19481bc31b801bd6df088d2009594313b
parent8da102ccfff82066a71c055e35e1318112b16d02 (diff)
downloadapk-tools-6d507b90727aa02fbe358d2bbe457e68121fcbd5.tar.bz2
apk-tools-6d507b90727aa02fbe358d2bbe457e68121fcbd5.tar.xz
add apk-add(8)
-rw-r--r--doc/Makefile1
-rw-r--r--doc/apk-add.8.scd69
2 files changed, 70 insertions, 0 deletions
diff --git a/doc/Makefile b/doc/Makefile
index 310a4c3..b1fce65 100644
--- a/doc/Makefile
+++ b/doc/Makefile
@@ -5,6 +5,7 @@ $(obj)/%.8: $(src)/%.8.scd
$(SCDOC) < $< > $@
docs: $(obj)/apk.8 \
+ $(obj)/apk-add.8 \
$(obj)/apk-repositories.5 \
$(obj)/apk-world.5
targets += docs
diff --git a/doc/apk-add.8.scd b/doc/apk-add.8.scd
new file mode 100644
index 0000000..ab9ca49
--- /dev/null
+++ b/doc/apk-add.8.scd
@@ -0,0 +1,69 @@
+apk-add(8)
+
+# NAME
+
+apk add - add packages to _world_ and commit changes
+
+# SYNOPSIS
+
+*apk add* [<_options_>...] _packages_...
+
+# DESCRIPTION
+
+*apk add* adds the requested packages to _world_ and installs (or upgrades)
+them if not already present, ensuring all dependencies are met.
+
+# OPTIONS
+
+## COMMIT OPTIONS
+
+*apk add* commits the database, and supports the same options as other commit
+operations.
+
+*-s, --simulate*
+ Simulate the requested operation without making any changes.
+
+*--clean-protected*
+ Do not create .apk-new files in configuration directories.
+
+*--overlay-from-stdin*
+ Read list of overlay files from stdin.
+
+*--no-scripts*
+ Do not execute any scripts.
+
+*--no-commit-hooks*
+ Skip pre/post hook scripts (but not other scripts).
+
+*--initramfs-diskless-boot*
+ Enables options for diskless initramfs boot (e.g. skip hooks).
+
+## ADD OPTIONS
+
+The following options affect the *add* operation.
+
+*--initdb*
+ Initialize a new package database.
+
+*-l, --latest*
+ Disables normal heuristics for choosing which repository to install a
+ package from, preferring only repositories from which the latest
+ version is available. This has no effect on pinned packages.
+
+*-u, --upgrade*
+ When adding packages which are already installed, upgrade them rather
+ than considering the requirement fulfilled by the current installation.
+
+*-t, --virtual* _NAME_
+ Instead of adding the specified packages to _world_, create a new
+ virtual package with the listed packages as its dependencies, then add
+ that package to _world_.
+
+ The packages requested are added as transitive dependencies of the
+ virtual package, and by deleting that package the *apk add* operation
+ may be easily reverted later.
+
+# AUTHORS
+
+Natanael Copa <ncopa@alpinelinux.org>++
+Timo Teräs <_timo.teras@iki.fi_>