summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorDrew DeVault <sir@cmpwn.com>2020-01-07 22:40:56 -0500
committerTimo Teräs <timo.teras@iki.fi>2020-01-26 09:01:26 +0200
commit44a79db90e234c7869b012d07769790aab866457 (patch)
tree9e83c1afea16538d47350537031ce13d8b8b4780 /doc
parentad68a79d41cc03ea9faad48f34559aa3bd178902 (diff)
downloadapk-tools-44a79db90e234c7869b012d07769790aab866457.tar.gz
apk-tools-44a79db90e234c7869b012d07769790aab866457.tar.bz2
apk-tools-44a79db90e234c7869b012d07769790aab866457.tar.xz
apk-tools-44a79db90e234c7869b012d07769790aab866457.zip
add apk-index(8)
Diffstat (limited to 'doc')
-rw-r--r--doc/Makefile1
-rw-r--r--doc/apk-index.8.scd36
2 files changed, 37 insertions, 0 deletions
diff --git a/doc/Makefile b/doc/Makefile
index ba1cfef..16ad22b 100644
--- a/doc/Makefile
+++ b/doc/Makefile
@@ -10,6 +10,7 @@ docs: $(obj)/apk.8 \
$(obj)/apk-del.8 \
$(obj)/apk-dot.8 \
$(obj)/apk-fix.8 \
+ $(obj)/apk-index.8 \
$(obj)/apk-info.8 \
$(obj)/apk-list.8 \
$(obj)/apk-policy.8 \
diff --git a/doc/apk-index.8.scd b/doc/apk-index.8.scd
new file mode 100644
index 0000000..37c416e
--- /dev/null
+++ b/doc/apk-index.8.scd
@@ -0,0 +1,36 @@
+apk-index(8)
+
+# NAME
+
+apk index - create repository index file from packages
+
+# SYNOPSIS
+
+*apk index* [<_options_>...] _packages_...
+
+# DESCRIPTION
+
+*apk index* creates a repository index from a list of package files. See
+*apk-repositories*(8) for more information on repository indicies.
+
+Generally, the resulting index must be cryptographically signed before *apk*
+will accept it. See *abuild-sign*(1) for details.
+
+# OPTIONS
+
+*-d, --description* _TEXT_
+ Add a description to the index. Upstream, this is used to add version
+ information based on the git commit SHA of aports HEAD at the time of
+ index generation.
+
+*-o, --output* _FILE_
+ Output generated index to _FILE_.
+
+*-x, --index* _INDEX_
+ Read an existing index from _INDEX_ to speed up the creation of the new
+ index by reusing data when possible.
+
+# AUTHORS
+
+Natanael Copa <ncopa@alpinelinux.org>++
+Timo Teräs <_timo.teras@iki.fi_>