Send patches - preferably formatted by git format-patch - to patches at archlinux32 dot org.
summaryrefslogtreecommitdiff
path: root/doc/man
diff options
context:
space:
mode:
authorAndreas Baumann <mail@andreasbaumann.cc>2024-08-16 08:06:08 +0200
committerAndreas Baumann <mail@andreasbaumann.cc>2024-08-16 08:06:08 +0200
commitdeffc1b87e86fffa8e4758a76a1912c6c8f69a85 (patch)
tree0f61a152c4c49d40de5042df2b25cdb8e0b0a82d /doc/man
parent2994bca96781afd62104c1515532a9c479cb5bed (diff)
parent27eebe383d0b571c08cba991e4824768d7623602 (diff)
merged with upstreamHEADmaster
Diffstat (limited to 'doc/man')
-rw-r--r--doc/man/arch-nspawn.1.asciidoc5
-rw-r--r--doc/man/makechrootpkg.1.asciidoc7
-rw-r--r--doc/man/mkarchroot.1.asciidoc3
-rw-r--r--doc/man/pkgctl-build.1.asciidoc3
-rw-r--r--doc/man/pkgctl-db-remove.1.asciidoc18
-rw-r--r--doc/man/pkgctl-db.1.asciidoc43
-rw-r--r--doc/man/pkgctl-repo-clean.1.asciidoc40
-rw-r--r--doc/man/pkgctl-repo.1.asciidoc4
-rw-r--r--doc/man/pkgctl-version-upgrade.1.asciidoc5
-rw-r--r--doc/man/pkgctl.1.asciidoc7
10 files changed, 127 insertions, 8 deletions
diff --git a/doc/man/arch-nspawn.1.asciidoc b/doc/man/arch-nspawn.1.asciidoc
index a3e8ec1..ae6532b 100644
--- a/doc/man/arch-nspawn.1.asciidoc
+++ b/doc/man/arch-nspawn.1.asciidoc
@@ -28,8 +28,9 @@ Options
*-c* <dir>::
Set pacman cache, if no directory is specified the passed pacman.conf's cachedir is used with a fallback to '/etc/pacman.conf'
-*-f* <file>::
- Copy file from the host to the chroot
+*-f* <src>[:<dst>]::
+ Copy file from the host to the chroot.
+ If 'dst' is not provided, it defaults to 'src' inside of the chroot.
*-s*::
Do not run setarch
diff --git a/doc/man/makechrootpkg.1.asciidoc b/doc/man/makechrootpkg.1.asciidoc
index 3aa1be5..34ba199 100644
--- a/doc/man/makechrootpkg.1.asciidoc
+++ b/doc/man/makechrootpkg.1.asciidoc
@@ -45,6 +45,9 @@ Options
*-D* <dir>::
Bind directory into build chroot as read-only
+*-t* <dir>[:opts]::
+ Mount a tmpfs at 'dir'. See the '--tmpfs' argument in systemd-nspawn(1) for more details.
+
*-u*::
Update the working copy of the chroot before building
This is useful for rebuilds without dirtying the pristine
@@ -76,5 +79,9 @@ Options
*-x* <when>::
Inspect chroot after build, possible modes are 'never' (default), 'always' or 'failure'
+See Also
+--------
+
+systemd-nspawn(1)
include::include/footer.asciidoc[]
diff --git a/doc/man/mkarchroot.1.asciidoc b/doc/man/mkarchroot.1.asciidoc
index 99905c8..edbb17e 100644
--- a/doc/man/mkarchroot.1.asciidoc
+++ b/doc/man/mkarchroot.1.asciidoc
@@ -32,8 +32,9 @@ Options
*-c* <dir>::
Set pacman cache.
-*-f* <file>::
+*-f* <src>[:<dst>]::
Copy file from the host to the chroot.
+ If 'dst' is not provided, it defaults to 'src' inside of the chroot.
*-s*::
Do not run setarch.
diff --git a/doc/man/pkgctl-build.1.asciidoc b/doc/man/pkgctl-build.1.asciidoc
index d36daff..beb6ee4 100644
--- a/doc/man/pkgctl-build.1.asciidoc
+++ b/doc/man/pkgctl-build.1.asciidoc
@@ -12,7 +12,8 @@ pkgctl build [OPTIONS] [PATH...]
Description
-----------
-TODO
+Build packages in clean chroot environment, offering various options
+and functionalities to customize the package building process.
Build Options
-------------
diff --git a/doc/man/pkgctl-db-remove.1.asciidoc b/doc/man/pkgctl-db-remove.1.asciidoc
index a95766d..85f616b 100644
--- a/doc/man/pkgctl-db-remove.1.asciidoc
+++ b/doc/man/pkgctl-db-remove.1.asciidoc
@@ -12,13 +12,27 @@ pkgctl db remove [OPTIONS] [REPO] [PKGBASE]...
Description
-----------
-Remove packages from pacman repositories.
+Remove packages from pacman repositories. By default passing a pkgbase removes
+all split packages, debug packages as well as entries from the state repo for
+all existing architectures.
+
+Beware when using the `--partial` option, as it may most likely lead to
+undesired effects by leaving debug packages behind as well as dangling entries
+in the state repository.
Options
-------
+*--partial*::
+ Remove only partial pkgnames from a split package. This leaves debug
+ packages behind and pkgbase entries in the state repo.
+
*-a, --arch* 'ARCH'::
- Override the architecture (disables auto-detection)
+ Remove only one specific architecture (disables auto-detection).
+ By default all architectures are removed when this option is not used.
+
+*--noconfirm*::
+ Bypass any confirmation messages, should only be used with caution.
*-h, --help*::
Show a help text
diff --git a/doc/man/pkgctl-db.1.asciidoc b/doc/man/pkgctl-db.1.asciidoc
new file mode 100644
index 0000000..d3296c6
--- /dev/null
+++ b/doc/man/pkgctl-db.1.asciidoc
@@ -0,0 +1,43 @@
+pkgctl-db(1)
+============
+
+NAME
+----
+pkgctl-db - Pacman database modification utility for package updates, moves, and more.
+
+SYNOPSIS
+--------
+pkgctl db [OPTIONS] [SUBCOMMAND]
+
+DESCRIPTION
+-----------
+
+Managing the Pacman database and facilitate the modification of packages and their metadata
+within the database
+
+OPTIONS
+-------
+
+*-h, --help*::
+ Display usage information and available options.
+
+Subcommands
+-----------
+
+pkgctl db update::
+ Update the binary repository as final release step
+
+pkgctl db move::
+ Move packages between binary repositories
+
+pkgctl db remove::
+ Remove packages from binary repositories
+
+SEE ALSO
+--------
+
+pkgctl-db-update(1)
+pkgctl-db-move(1)
+pkgctl-db-remove(1)
+
+include::include/footer.asciidoc[]
diff --git a/doc/man/pkgctl-repo-clean.1.asciidoc b/doc/man/pkgctl-repo-clean.1.asciidoc
new file mode 100644
index 0000000..b39693c
--- /dev/null
+++ b/doc/man/pkgctl-repo-clean.1.asciidoc
@@ -0,0 +1,40 @@
+pkgctl-repo-clean(1)
+====================
+
+Name
+----
+
+pkgctl-repo-clean - Remove untracked files from the working tree
+
+Synopsis
+--------
+
+pkgctl repo clean [OPTION] [PATH]...
+
+Description
+-----------
+
+Cleans the working tree by recursively removing files that are not under
+version control, starting from the current directory.
+
+Files unknown to Git as well as ignored files are removed. This can, for
+example, be useful to remove all build products.
+
+Options
+-------
+
+*-i, --interactive*::
+ Show what would be done and clean files interactively
+
+*-n, --dry-run*::
+ Don't actually remove anything, just show what would be done
+
+*-h, --help*::
+ Show a help text
+
+See Also
+--------
+
+git-clean(1)
+
+include::include/footer.asciidoc[]
diff --git a/doc/man/pkgctl-repo.1.asciidoc b/doc/man/pkgctl-repo.1.asciidoc
index 3d0f3f1..c1fd298 100644
--- a/doc/man/pkgctl-repo.1.asciidoc
+++ b/doc/man/pkgctl-repo.1.asciidoc
@@ -32,6 +32,9 @@ Options
Subcommands
-----------
+pkgctl repo clean::
+ Remove untracked files from the working tree
+
pkgctl repo clone::
Clone a package repository
@@ -50,6 +53,7 @@ pkgctl repo web::
See Also
--------
+pkgctl-repo-clean(1)
pkgctl-repo-clone(1)
pkgctl-repo-configure(1)
pkgctl-repo-create(1)
diff --git a/doc/man/pkgctl-version-upgrade.1.asciidoc b/doc/man/pkgctl-version-upgrade.1.asciidoc
index 044545d..0cec0b6 100644
--- a/doc/man/pkgctl-version-upgrade.1.asciidoc
+++ b/doc/man/pkgctl-version-upgrade.1.asciidoc
@@ -18,7 +18,7 @@ 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.
+to 1 and updates checksums.
Outputs a summary of upgraded packages, up-to-date packages, and any check
failures.
@@ -35,6 +35,9 @@ PKGBUILD. Refer to the configuration section in pkgctl-version(1).
Options
-------
+*--no-update-checksums*::
+ Disable computation and update of the checksums
+
*-v, --verbose*::
Display results including up-to-date versions
diff --git a/doc/man/pkgctl.1.asciidoc b/doc/man/pkgctl.1.asciidoc
index e028e84..287a62a 100644
--- a/doc/man/pkgctl.1.asciidoc
+++ b/doc/man/pkgctl.1.asciidoc
@@ -12,7 +12,12 @@ pkgctl [SUBCOMMAND] [OPTIONS]
Description
-----------
-TODO
+Command-line utility serving as a unified interface for multiple development tools.
+This tool aims to simplify and optimize interactions with devtools by offering
+various subcommands for executing tasks related to package management, repository management,
+version control, among others.
+
+Utilizing pkgctl enables users to efficiently administer their development workflows.
Options
-------