summaryrefslogtreecommitdiff
path: root/doc/repo-add.8.txt
diff options
context:
space:
mode:
Diffstat (limited to 'doc/repo-add.8.txt')
-rw-r--r--doc/repo-add.8.txt57
1 files changed, 41 insertions, 16 deletions
diff --git a/doc/repo-add.8.txt b/doc/repo-add.8.txt
index 75f49ef5..79b5a7ef 100644
--- a/doc/repo-add.8.txt
+++ b/doc/repo-add.8.txt
@@ -1,5 +1,5 @@
/////
-vim:set ts=4 sw=4 syntax=asciidoc noet:
+vim:set ts=4 sw=4 syntax=asciidoc noet spell spelllang=en_us:
/////
repo-add(8)
==========
@@ -10,26 +10,55 @@ repo-add - package database maintenance utility
Synopsis
--------
-repo-add [-d] [-f] [-q] <path-to-db> <package1> [<package2> ...]
+'repo-add' [options] <path-to-db> <package|delta> [<package|delta> ...]
-repo-remove [-q] <path-to-db> <packagename> [<packagename2> ...]
+'repo-remove' [options] <path-to-db> <packagename|delta> [<packagename|delta> ...]
Description
-----------
-repo-add and repo-remove are two scripts to help build a package database for
+'repo-add' and 'repo-remove' are two scripts to help build a package database for
packages built with linkman:makepkg[8] and installed with linkman:pacman[8].
+They also handle package deltas produced by linkman:pkgdelta[8].
-repo-add will update a package database by reading a built package file.
-Multiple packages to add can be specified on the command line.
+'repo-add' will update a package database by reading a built package or package
+delta file. Multiple packages and/or deltas to add can be specified on the
+command line.
-repo-remove will update a package database by removing the package name
-specified on the command line. Multiple packages to remove can be specified
-on the command line.
+'repo-remove' will update a package database by removing the package name or
+delta specified on the command line. Multiple packages and/or delta to remove
+can be specified on the command line.
+A package database is a tar file, optionally compressed. Valid extensions are
+``.db'' or ``.files'' followed by an archive extension of ``.tar'',
+``.tar.gz'', ``.tar.bz2'', ``.tar.xz'', or ``.tar.Z''. The file does not need
+to exist, but all parent directories must exist.
-Options
--------
+
+Common Options
+--------------
+*-q, \--quiet*::
+ Force this program to keep quiet and run silent except for warning and
+ error messages.
+
+*-s, \--sign*::
+ Generate a PGP signature file using GnuPG. This will execute `gpg
+ --detach-sign --use-agent` on the generated database to generate a detached
+ signature file, using the GPG agent if it is available. The signature file
+ will be the entire filename of the database with a ``.sig'' extension.
+
+*-k, \--key* <key>::
+ Specify a key to use when signing packages. Can also be specified using
+ the GPGKEY environmental variable. If not specified in either location, the
+ default key from the keyring will be used.
+
+*-v, \--verify*::
+ Verify the PGP signature of the database before updating the database.
+ If the signature is invalid, an error is produced and the update does not
+ proceed.
+
+repo-add Options
+----------------
*-d, \--delta*::
Automatically generate and add a delta file between the old entry and the
new one, if the old package file is found next to the new one.
@@ -39,12 +68,8 @@ Options
specified packages. This is useful for creating databases listing all files
in a given sync repository for tools that may use this information.
-*-q, \--quiet*::
- Force this program to keep quiet and run silent except for warning and
- error messages.
-
See Also
--------
-linkman:makepkg[8], linkman:pacman[8]
+linkman:makepkg[8], linkman:pacman[8], linkman:pkgdelta[8]
include::footer.txt[]