summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorChristian Heusel <christian@heusel.eu>2023-06-08 14:47:29 +0200
committerLevente Polyak <anthraxx@archlinux.org>2024-01-09 23:47:45 +0100
commit2b8033b91132d303603f370a54eef02949703750 (patch)
treeb1ac63fbeba77d66f9ff7a24bbb9dd6e2bccb29c /doc
parent8f45c65830fc32e6dbbff0233dea3356acc96e57 (diff)
downloaddevtools-2b8033b91132d303603f370a54eef02949703750.tar.xz
feat(aur): add subcommand to drop a package from the repos to the AUR
Add an aur command to interact with the Arch User Repository including the drop-from-repo subommand which allows to drop packages from the official repository to the Arch User Repository in one go. Related to #143 Component: pkgctl aur drop-from-repo Co-authored-by: Levente Polyak <anthraxx@archlinux.org> Signed-off-by: Christian Heusel <christian@heusel.eu>
Diffstat (limited to 'doc')
-rw-r--r--doc/man/pkgctl-aur-drop-from-repo.1.asciidoc41
-rw-r--r--doc/man/pkgctl-aur.1.asciidoc37
-rw-r--r--doc/man/pkgctl.1.asciidoc4
3 files changed, 82 insertions, 0 deletions
diff --git a/doc/man/pkgctl-aur-drop-from-repo.1.asciidoc b/doc/man/pkgctl-aur-drop-from-repo.1.asciidoc
new file mode 100644
index 0000000..a9d39c6
--- /dev/null
+++ b/doc/man/pkgctl-aur-drop-from-repo.1.asciidoc
@@ -0,0 +1,41 @@
+pkgctl-aur-drop-from-repo(1)
+============================
+
+Name
+----
+pkgctl-aur-drop-from-repo - Drop a package from the official repository to the AUR
+
+Synopsis
+--------
+pkgctl aur drop-from-repo [OPTIONS] [PATH]...
+
+Description
+-----------
+
+Drops a specified package from the official repositories to the Arch User
+Repository.
+
+This command requires a local Git clone of the package repository. It
+reconfigures the repository for AUR compatibility and pushes it to the
+AUR. Afterwards, the package is removed from the official repository.
+
+By default, the package is automatically disowned in the AUR.
+
+Options
+-------
+
+*--no-disown*::
+ Do not disown the package on the AUR
+
+*-f, --force*::
+ Force push to the AUR overwriting the remote repository
+
+*-h, --help*::
+ Show a help text
+
+See Also
+--------
+
+linkman:pkgctl-db-remove[1]
+
+include::include/footer.asciidoc[]
diff --git a/doc/man/pkgctl-aur.1.asciidoc b/doc/man/pkgctl-aur.1.asciidoc
new file mode 100644
index 0000000..d69124a
--- /dev/null
+++ b/doc/man/pkgctl-aur.1.asciidoc
@@ -0,0 +1,37 @@
+pkgctl-aur(1)
+=============
+
+Name
+----
+pkgctl-aur - Interact with the Arch User Repository (AUR)
+
+Synopsis
+--------
+pkgctl aur [OPTIONS] [SUBCOMMAND]
+
+Description
+-----------
+
+Provides a suite of tools designed for managing and interacting with the Arch
+User Repository (AUR). It simplifies various tasks related to AUR, including
+importing repositories, managing packages, and transitioning packages between
+the official repositories and the AUR.
+
+Options
+-------
+
+*-h, --help*::
+ Show a help text
+
+Subcommands
+-----------
+
+pkgctl aur drop-from-repo::
+ Drop a package from the official repository to the AUR
+
+See Also
+--------
+
+linkman:pkgctl-aur-drop-from-repo[1]
+
+include::include/footer.asciidoc[]
diff --git a/doc/man/pkgctl.1.asciidoc b/doc/man/pkgctl.1.asciidoc
index 1164561..24b0613 100644
--- a/doc/man/pkgctl.1.asciidoc
+++ b/doc/man/pkgctl.1.asciidoc
@@ -26,6 +26,9 @@ Options
Subcommands
-----------
+pkgctl aur::
+ Interact with the Arch User Repository
+
pkgctl auth::
Authenticate with services like GitLab
@@ -53,6 +56,7 @@ pkgctl version::
See Also
--------
+linkman:pkgctl-aur[1]
linkman:pkgctl-auth[1]
linkman:pkgctl-build[1]
linkman:pkgctl-db[1]