From f40fc1f2b06a7fcadd047a1b5b9c186447f729d7 Mon Sep 17 00:00:00 2001 From: Mike Yuan Date: Tue, 20 Dec 2022 18:06:12 +0800 Subject: [PATCH] doc: several cleanups (follow previous changes) --- doc/arch-chroot.8.asciidoc | 20 +++++++++----------- doc/genfstab.8.asciidoc | 8 ++++---- 2 files changed, 13 insertions(+), 15 deletions(-) diff --git a/doc/arch-chroot.8.asciidoc b/doc/arch-chroot.8.asciidoc index 8291a97..8a8b320 100644 --- a/doc/arch-chroot.8.asciidoc +++ b/doc/arch-chroot.8.asciidoc @@ -7,28 +7,26 @@ arch-chroot - enhanced chroot command Synopsis -------- -arch-chroot [options] chroot-dir [command] [arguments...] +arch-chroot [options] chroot_dir [command [arguments...]] Description ----------- arch-chroot wraps the linkman:chroot[1] command while ensuring that important -functionality is available, e.g. mounting '/dev/', '/proc' and other API +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.: +The target chroot directory *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 one, i.e. -'mount --bind /your/chroot /your/chroot' +'mount --bind chroot_dir chroot_dir' ====== - Options ------- @@ -38,7 +36,7 @@ Options installations. *-u [:group]*:: - Specify non-root user and optional group to use. + Specify non-root user and group (optional) to use. *-h*:: Output syntax and command line options. @@ -46,4 +44,4 @@ Options See Also -------- -linkman:pacman[8] +linkman:chroot[1], linkman:proc[5], linkman:sysfs[5] diff --git a/doc/genfstab.8.asciidoc b/doc/genfstab.8.asciidoc index 028a0c8..d5ec8cd 100644 --- a/doc/genfstab.8.asciidoc +++ b/doc/genfstab.8.asciidoc @@ -26,12 +26,12 @@ Options *-L*:: Use labels for source identifiers (shortcut for '-t LABEL'). -*-p*:: - Exclude pseudofs mounts (default behavior). - *-P*:: Include pseudofs mounts. +*-p*:: + Exclude pseudofs mounts (default behavior). + *-t* :: Use 'tag' for source identifiers (should be one of: 'LABEL', 'UUID', 'PARTLABEL', 'PARTUUID'). @@ -45,4 +45,4 @@ Options See Also -------- -linkman:pacman[8] +linkman:fstab[5], linkman:file-hierarchy[7], linkman:filesystems[5]