Send patches - preferably formatted by git format-patch - to patches at archlinux32 dot org.
summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
Diffstat (limited to 'doc')
-rw-r--r--doc/man/makechrootpkg.1.asciidoc4
-rw-r--r--doc/man/makerepropkg.1.asciidoc3
-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-build.1.asciidoc28
-rw-r--r--doc/man/pkgctl-db-move.1.asciidoc7
-rw-r--r--doc/man/pkgctl-db-update.1.asciidoc9
-rw-r--r--doc/man/pkgctl-release.1.asciidoc4
-rw-r--r--doc/man/pkgctl-repo-configure.1.asciidoc2
-rw-r--r--doc/man/pkgctl-repo-web.1.asciidoc3
-rw-r--r--doc/man/pkgctl-search.1.asciidoc71
-rw-r--r--doc/man/pkgctl-version-check.1.asciidoc66
-rw-r--r--doc/man/pkgctl-version-upgrade.1.asciidoc50
-rw-r--r--doc/man/pkgctl-version.1.asciidoc43
-rw-r--r--doc/man/pkgctl.1.asciidoc12
15 files changed, 363 insertions, 17 deletions
diff --git a/doc/man/makechrootpkg.1.asciidoc b/doc/man/makechrootpkg.1.asciidoc
index 12d32f1..3aa1be5 100644
--- a/doc/man/makechrootpkg.1.asciidoc
+++ b/doc/man/makechrootpkg.1.asciidoc
@@ -73,4 +73,8 @@ Options
*-U*::
Run makepkg as a specified user
+*-x* <when>::
+ Inspect chroot after build, possible modes are 'never' (default), 'always' or 'failure'
+
+
include::include/footer.asciidoc[]
diff --git a/doc/man/makerepropkg.1.asciidoc b/doc/man/makerepropkg.1.asciidoc
index 6044d7c..51a81ff 100644
--- a/doc/man/makerepropkg.1.asciidoc
+++ b/doc/man/makerepropkg.1.asciidoc
@@ -42,6 +42,9 @@ Options
*-d*::
If packages are not reproducible, compare them using diffoscope.
+*-n*::
+ Do not run the check() function in the PKGBUILD.
+
*-c*::
Set the pacman cache directory.
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-build.1.asciidoc b/doc/man/pkgctl-build.1.asciidoc
index f68e7cf..f7abdeb 100644
--- a/doc/man/pkgctl-build.1.asciidoc
+++ b/doc/man/pkgctl-build.1.asciidoc
@@ -21,7 +21,10 @@ Build Options
Specify architectures to build for (disables auto-detection)
*--repo* 'REPO'::
- Specify a target repository (disables auto-detection)
+ Specify target repository for new packages not in any official repo.
+ Fallback to `'extra'` when building packages that are not present in any
+ official repository yet. Using this option is disallowed if the package is
+ already released, as it would circumvent the auto-detection safeguard.
*-s, --staging*::
Build against the staging counterpart of the auto-detected repo
@@ -35,8 +38,9 @@ Build Options
*-c, --clean*::
Recreate the chroot before building
-*-I, --install* 'FILE'::
- Install a package into the working copy of the chroot
+*--inspect* 'WHEN'::
+ Spawn an interactive shell to inspect the chroot after building. Useful to ease the debugging of a package build. +
+ Possible values for 'WHEN' are `'never'`, `'always'` or `'failure'`
*-w, --worker* 'SLOT'::
Name of the worker slot, useful for concurrent builds. By default the slot
@@ -47,6 +51,17 @@ Build Options
*--nocheck*::
Do not run the check() function in the PKGBUILD
+Install Options
+---------------
+
+*-I, --install-to-chroot* 'FILE'::
+ Install a package to the working copy of the chroot
+
+*-i, --install-to-host* 'MODE'::
+ Install the built packages to the host system. Useful when one wants to verify that the package works as intended.
+ * When 'MODE' is 'all', this installs all built packages
+ * When 'MODE' is 'auto', this installs all built packages which are currently installed
+
PKGBUILD Options
----------------
@@ -59,6 +74,13 @@ PKGBUILD Options
*--rebuild*::
Increment the current pkgrel variable
+*--update-checksums*::
+ Force computation and update of the checksums by disabling auto-detection. +
+ Should only be used in special circumstances, like when adding new patch
+ files to the source array. During regular packaging operations, checksums
+ are either automatically updated when upgrading a package using `--pkgver`
+ or should remain immutable during rebuilds.
+
*-e, --edit*::
Edit the PKGBUILD before building
diff --git a/doc/man/pkgctl-db-move.1.asciidoc b/doc/man/pkgctl-db-move.1.asciidoc
index 1ee02f8..5c3b427 100644
--- a/doc/man/pkgctl-db-move.1.asciidoc
+++ b/doc/man/pkgctl-db-move.1.asciidoc
@@ -3,17 +3,16 @@ pkgctl-db-move(1)
Name
----
-pkgctl-db-update - Update the binary repository as final release step
+pkgctl-db-move - Move packages between binary repositories.
Synopsis
--------
-pkgctl db update [OPTIONS]
+pkgctl db move [OPTIONS] [SOURCE_REPO] [TARGET_REPO] [PKGBASE]...
Description
-----------
-Update the pacman database as final release step for packages that
-have been transfered and staged on 'repos.archlinux.org'.
+Move packages between binary repositories i.e. from 'extra-testing' to 'extra'.
Options
-------
diff --git a/doc/man/pkgctl-db-update.1.asciidoc b/doc/man/pkgctl-db-update.1.asciidoc
index fa7205e..ce73c01 100644
--- a/doc/man/pkgctl-db-update.1.asciidoc
+++ b/doc/man/pkgctl-db-update.1.asciidoc
@@ -1,18 +1,19 @@
-pkgctl-db-move(1)
+pkgctl-db-update(1)
=================
Name
----
-pkgctl-db-move - Move packages between binary repositories
+pkgctl-db-update - Update the binary repository as final release step
Synopsis
--------
-pkgctl db move [OPTIONS] [SOURCE_REPO] [TARGET_REPO] [PKGBASE]...
+pkgctl db update [OPTIONS]
Description
-----------
-Move packages between pacman repositories.
+Update the pacman database as final release step for packages that
+have been transfered and staged on 'repos.archlinux.org'.
Options
-------
diff --git a/doc/man/pkgctl-release.1.asciidoc b/doc/man/pkgctl-release.1.asciidoc
index c991db4..01a0c9e 100644
--- a/doc/man/pkgctl-release.1.asciidoc
+++ b/doc/man/pkgctl-release.1.asciidoc
@@ -27,7 +27,9 @@ Options
Use the given <msg> as the commit message
*-r, --repo* 'REPO'::
- Specify a target repository (disables auto-detection)
+ Specify target repository for new packages not in any official repo.
+ Using this option is disallowed if the package is already released, as it
+ would circumvent the auto-detection safeguard.
*-s, --staging*::
Build against the staging counterpart of the auto-detected repo
diff --git a/doc/man/pkgctl-repo-configure.1.asciidoc b/doc/man/pkgctl-repo-configure.1.asciidoc
index 6bdea93..12d879c 100644
--- a/doc/man/pkgctl-repo-configure.1.asciidoc
+++ b/doc/man/pkgctl-repo-configure.1.asciidoc
@@ -22,6 +22,8 @@ The remote protocol is automatically determined from the author email
address by choosing SSH for all official packager identities and
read-only HTTPS otherwise.
+Git default excludes and hooks are applied to the configured repo.
+
Options
-------
diff --git a/doc/man/pkgctl-repo-web.1.asciidoc b/doc/man/pkgctl-repo-web.1.asciidoc
index 8769be7..ba7106a 100644
--- a/doc/man/pkgctl-repo-web.1.asciidoc
+++ b/doc/man/pkgctl-repo-web.1.asciidoc
@@ -18,6 +18,9 @@ no arguments, open the package cloned in the current working directory.
Options
-------
+*--print*::
+ Print the url instead of opening it with xdg-open
+
*-h, --help*::
Show a help text
diff --git a/doc/man/pkgctl-search.1.asciidoc b/doc/man/pkgctl-search.1.asciidoc
new file mode 100644
index 0000000..8172b00
--- /dev/null
+++ b/doc/man/pkgctl-search.1.asciidoc
@@ -0,0 +1,71 @@
+pkgctl-search(1)
+================
+
+Name
+----
+pkgctl-search - Search for an expression across the GitLab packaging group
+
+Synopsis
+--------
+pkgctl search [OPTIONS] QUERY
+
+Description
+-----------
+
+Search for an expression across the GitLab packaging group.
+
+To use a filter, include it in your query. You may use wildcards (*) to
+use glob matching.
+
+Available filters for the blobs scope: path, extension
+
+Every usage of the search command must be authenticated. Consult the
+`'pkgctl auth'` command to authenticate with GitLab or view the authentication
+status.
+
+Search Tips
+-----------
+
+ Syntax Description Example
+ ───────────────────────────────────────
+ " Exact search "gem sidekiq"
+ ~ Fuzzy search J~ Doe
+ | Or display | banner
+ + And display +banner
+ - Exclude display -banner
+ * Partial bug error 50*
+ \ Escape \*md
+ # Issue ID #23456
+ ! Merge request !23456
+
+Options
+-------
+
+*-h, --help*::
+ Show a help text
+
+Filter Options
+--------------
+
+*--no-default-filter*::
+ Do not apply default filter (like -path:keys/pgp/*.asc)
+
+Output Options
+--------------
+
+*--json*::
+ Enable printing in JSON; Shorthand for `'--format json'`
+
+*-F, --format* 'FORMAT'::
+ Controls the formatting of the results; `FORMAT` is `'pretty'`, `'plain'`,
+ or `'json'` (default `pretty`)
+
+*-N, --no-line-number*::
+ Don't show line numbers when formatting results
+
+See Also
+--------
+
+linkman:pkgctl-auth[1]
+
+include::include/footer.asciidoc[]
diff --git a/doc/man/pkgctl-version-check.1.asciidoc b/doc/man/pkgctl-version-check.1.asciidoc
new file mode 100644
index 0000000..2543bcb
--- /dev/null
+++ b/doc/man/pkgctl-version-check.1.asciidoc
@@ -0,0 +1,66 @@
+pkgctl-version-check(1)
+=======================
+
+Name
+----
+pkgctl-version-check - Compares local package versions against upstream
+
+Synopsis
+--------
+pkgctl version check [OPTIONS] [PKGBASE...]
+
+Description
+-----------
+
+Compares the versions of packages in the local packaging repository against
+their latest upstream versions.
+
+Upon execution, it generates a grouped list that provides detailed insights
+into each package's status. For each package, it displays the current local
+version alongside the latest version available upstream.
+
+Outputs a summary of up-to-date packages, out-of-date packages, and any check
+failures.
+
+This simplifies the maintenance of PKGBUILD files, reducing the manual effort
+required to track version changes from upstream sources.
+
+Configuration
+-------------
+
+Uses linkman:nvchecker[1] and a `.nvchecker.toml` file located alongside the
+PKGBUILD. Refer to the configuration section in linkman:pkgctl-version[1].
+
+Options
+-------
+
+*-v, --verbose*::
+ Display results including up-to-date versions
+
+*-h, --help*::
+ Show a help text
+
+Exit Codes
+----------
+
+On exit, return one of the following codes:
+
+*0*::
+ Normal exit condition, all checked versions are up-to-date
+
+*1*::
+ Unknown cause of failure
+
+*2*::
+ Normal exit condition, but there are out-of-date versions
+
+*3*::
+ Failed to run some version checks
+
+See Also
+--------
+
+linkman:pkgctl-version[1]
+linkman:nvchecker[1]
+
+include::include/footer.asciidoc[]
diff --git a/doc/man/pkgctl-version-upgrade.1.asciidoc b/doc/man/pkgctl-version-upgrade.1.asciidoc
new file mode 100644
index 0000000..68e6369
--- /dev/null
+++ b/doc/man/pkgctl-version-upgrade.1.asciidoc
@@ -0,0 +1,50 @@
+pkgctl-version-upgrade(1)
+=========================
+
+Name
+----
+pkgctl-version-upgrade - Adjust the PKGBUILD to match the latest upstream version
+
+Synopsis
+--------
+pkgctl version upgrade [OPTIONS] [PKGBASE...]
+
+Description
+-----------
+
+Streamlines the process of keeping PKGBUILD files up-to-date with the latest
+upstream versions.
+
+Upon execution, it automatically adjusts the PKGBUILD file, ensuring that the
+pkgver field is set to match the latest version available from the upstream
+source. In addition to updating the pkgver, this command also resets the pkgrel
+to 1.
+
+Outputs a summary of upgraded packages, up-to-date packages, and any check
+failures.
+
+This simplifies the maintenance of PKGBUILD files, reducing the manual effort
+required to track and implement version changes from upstream sources.
+
+Configuration
+-------------
+
+Uses linkman:nvchecker[1] and a `.nvchecker.toml` file located alongside the
+PKGBUILD. Refer to the configuration section in linkman:pkgctl-version[1].
+
+Options
+-------
+
+*-v, --verbose*::
+ Display results including up-to-date versions
+
+*-h, --help*::
+ Show a help text
+
+See Also
+--------
+
+linkman:pkgctl-version[1]
+linkman:nvchecker[1]
+
+include::include/footer.asciidoc[]
diff --git a/doc/man/pkgctl-version.1.asciidoc b/doc/man/pkgctl-version.1.asciidoc
index 9beebf5..fa83314 100644
--- a/doc/man/pkgctl-version.1.asciidoc
+++ b/doc/man/pkgctl-version.1.asciidoc
@@ -3,16 +3,38 @@ pkgctl-version(1)
Name
----
-pkgctl-version - Show pkgctl version information
+pkgctl-version - Check and manage package versions against upstream
+
Synopsis
--------
-pkgctl version [OPTIONS]
+pkgctl version [OPTIONS] [SUBCOMMAND]
Description
-----------
-Shows the current version information of pkgctl.
+Commands related to package versions, including checks for outdated packages.
+
+Uses linkman:nvchecker[1] and a `.nvchecker.toml` file located alongside the
+PKGBUILD.
+
+Configuration
+-------------
+
+The `.nvchecker.toml` file must contain a section that matches the
+package's pkgbase. The pkgbase section within the `.nvchecker.toml` file
+specifies the source and method for checking the latest version of the
+corresponding package.
+
+For detailed information on the various configuration options available for the
+`.nvchecker.toml` file, refer to the configuration files section in
+linkman:nvchecker[1]. This documentation provides insights into the possible
+options that can be utilized to customize the version checking process.
+
+To supply GitHub or GitLab tokens to nvchecker, a `keyfile.toml` should be
+placed in the `$XDG_CONFIG_HOME`/nvchecker` directory. This keyfile is
+used for providing the necessary authentication tokens required for
+accessing the GitHub or GitLab API.
Options
-------
@@ -20,4 +42,19 @@ Options
*-h, --help*::
Show a help text
+Subcommands
+-----------
+
+pkgctl version check::
+ Compares local package versions against upstream
+
+pkgctl version upgrade::
+ Adjust the PKGBUILD to match the latest upstream version
+
+See Also
+--------
+
+linkman:pkgctl-version-check[1]
+linkman:pkgctl-version-upgrade[1]
+
include::include/footer.asciidoc[]
diff --git a/doc/man/pkgctl.1.asciidoc b/doc/man/pkgctl.1.asciidoc
index 72cda1e..d9a1d8c 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
@@ -33,7 +36,7 @@ pkgctl build::
Build packages inside a clean chroot
pkgctl db::
- Pacman database modification for packge update, move etc
+ Pacman database modification for package update, move etc
pkgctl diff::
Compare package files using different modes
@@ -44,18 +47,23 @@ pkgctl release::
pkgctl repo::
Manage Git packaging repositories and their configuration
+pkgctl search::
+ Search for an expression across the GitLab packaging group
+
pkgctl version::
- Show pkgctl version information
+ Check and manage package versions against upstream
See Also
--------
+linkman:pkgctl-aur[1]
linkman:pkgctl-auth[1]
linkman:pkgctl-build[1]
linkman:pkgctl-db[1]
linkman:pkgctl-diff[1]
linkman:pkgctl-release[1]
linkman:pkgctl-repo[1]
+linkman:pkgctl-search[1]
linkman:pkgctl-version[1]
include::include/footer.asciidoc[]