diff options
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/arch-chroot.8.asciidoc | 46 | ||||
| -rw-r--r-- | doc/asciidoc.conf | 37 | ||||
| -rw-r--r-- | doc/footer.asciidoc | 18 | ||||
| -rw-r--r-- | doc/genfstab.8.asciidoc | 50 | ||||
| -rw-r--r-- | doc/pacstrap.8.asciidoc | 47 |
5 files changed, 198 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[] diff --git a/doc/asciidoc.conf b/doc/asciidoc.conf new file mode 100644 index 0000000..c675a20 --- /dev/null +++ b/doc/asciidoc.conf @@ -0,0 +1,37 @@ +## linkman: macro +# Inspired by/borrowed from the GIT source tree at Documentation/asciidoc.conf +# +# Usage: linkman:command[manpage-section] +# +# Note, {0} is the manpage section, while {target} is the command. +# +# Show man link as: <command>(<section>); if section is defined, else just show +# the command. + +[macros] +(?su)[\\]?(?P<name>linkman):(?P<target>\S*?)\[(?P<attrlist>.*?)\]= + +[attributes] +asterisk=* +plus=+ +caret=^ +startsb=[ +endsb=] +backslash=\ +tilde=~ +apostrophe=' +backtick=` +litdd=-- + +ifdef::backend-docbook[] +[linkman-inlinemacro] +{0%{target}} +{0#<citerefentry>} +{0#<refentrytitle>{target}</refentrytitle><manvolnum>{0}</manvolnum>} +{0#</citerefentry>} +endif::backend-docbook[] + +ifdef::backend-xhtml11[] +[linkman-inlinemacro] +<a href="{target}.{0}.html">{target}{0?({0})}</a> +endif::backend-xhtml11[] diff --git a/doc/footer.asciidoc b/doc/footer.asciidoc new file mode 100644 index 0000000..4445b0c --- /dev/null +++ b/doc/footer.asciidoc @@ -0,0 +1,18 @@ + +Bugs +---- +Bugs can be reported on the bug tracker 'https://bugs.archlinux.org' in the Arch +Linux category and title prefixed with [arch-install-scripts] or via +mailto:arch-projects@archlinux.org[]. + + +Authors +------- + +Maintainers: + +* Dave Reisner <dreisner@archlinux.org> +* Eli Schwartz <eschwartz@archlinux.org> + +For additional contributors, use `git shortlog -s` on the arch-install-scripts.git +repository. diff --git a/doc/genfstab.8.asciidoc b/doc/genfstab.8.asciidoc new file mode 100644 index 0000000..73faa4e --- /dev/null +++ b/doc/genfstab.8.asciidoc @@ -0,0 +1,50 @@ +genfstab(8) +=========== + +Name +---- +genfstab - generate output suitable for addition to an fstab file + +Synopsis +-------- +genfstab [options] root + +Description +----------- +genfstab helps fill in an fstab file by autodetecting all the current mounts +below a given mountpoint and printing them in fstab-compatible format to +standard output. It can be used to persist a manually mounted filesystem +hierarchy and is often used during the initial install and configuration of an +OS. + +Options +------- + +*-f* <filter>:: + Restrict output to mountpoints matching the prefix 'filter'. + +*-L*:: + Use labels for source identifiers (shortcut for '-t LABEL'). + +*-p*:: + Exclude pseudofs mounts (default behavior). + +*-P*:: + Include pseudofs mounts. + +*-t* <tag>:: + Use 'tag' for source identifiers (should be one of: 'LABEL', 'UUID', + 'PARTLABEL', 'PARTUUID'). + +*-U*:: + Use UUIDs for source identifiers (shortcut for '-t UUID'). + +*-h*:: + Output syntax and command line options. + +See Also +-------- + +linkman:pacman[1] + +include::footer.asciidoc[] diff --git a/doc/pacstrap.8.asciidoc b/doc/pacstrap.8.asciidoc new file mode 100644 index 0000000..9f25792 --- /dev/null +++ b/doc/pacstrap.8.asciidoc @@ -0,0 +1,47 @@ +pacstrap(8) +=========== + +Name +---- +pacstrap - install packages to the specified new root directory + +Synopsis +-------- +pacstrap [options] root [packages...] + +Description +----------- +pacstrap is designed to create a new system installation from scratch. The +specified packages will be installed into a given directory after setting up +some basic mountpoints. By default, the host system's pacman signing keys +and mirrorlist will be used to seed the chroot. + +If no packages are specified to be installed, the 'base' group will be installed. + +Options +------- + +*-C* <config>:: + Use an alternate config file for pacman. + +*-c*:: + Use the package cache on the host, rather than the target. + +*-G*:: + Avoid copying the host's pacman keyring to the target. + +*-i*:: + Prompt for package confirmation when needed (run interactively). + +*-M*:: + Avoid copying the host's mirrorlist to the target. + +*-h*:: + Output syntax and command line options. + +See Also +-------- + +linkman:pacman[1] + +include::footer.asciidoc[] |