aboutsummaryrefslogtreecommitdiffstats
path: root/doc/arch-chroot.8.asciidoc
diff options
context:
space:
mode:
Diffstat (limited to 'doc/arch-chroot.8.asciidoc')
-rw-r--r--doc/arch-chroot.8.asciidoc46
1 files changed, 46 insertions, 0 deletions
diff --git a/doc/arch-chroot.8.asciidoc b/doc/arch-chroot.8.asciidoc
new file mode 100644
index 0000000..ada7d40
--- /dev/null
+++ b/doc/arch-chroot.8.asciidoc
@@ -0,0 +1,46 @@
+arch-chroot(8)
+==============
+
+Name
+----
+arch-chroot - enhanced chroot command
+
+Synopsis
+--------
+arch-chroot [options] chroot-dir [command]
+
+Description
+-----------
+arch-chroot wraps the linkman:chroot[1] command while ensuring that important
+functionality is available, e.g. mounting '/dev/', '/proc' and other API
+filesystems, or exposing linkman:resolv.conf[5] to the chroot.
+
+If 'command' is unspecified, arch-chroot will launch */bin/bash*.
+
+[NOTE]
+======
+The target chroot-dir *should* be a mountpoint. This ensures that tools such as
+linkman:pacman[8] or linkman:findmnt[8] have an accurate hierarchy of the
+mounted filesystems within the chroot. If your chroot target is not a
+mountpoint, you can bind mount the directory on itself to make it a mountpoint,
+i.e.:
+
+'mount --bind /your/chroot /your/chroot'
+======
+
+
+Options
+-------
+
+*-u <user>[:group]*::
+ Specify non-root user and optional group to use.
+
+*-h*::
+ Output syntax and command line options.
+
+See Also
+--------
+
+linkman:pacman[1]
+
+include::footer.asciidoc[]