doc: add manpages for all programs

This commit is contained in:
Eli Schwartz 2019-06-04 02:02:52 -04:00
parent aeab95dbab
commit da67c1906f
No known key found for this signature in database
GPG Key ID: CEB167EFB5722BD6
5 changed files with 137 additions and 0 deletions

1
.gitignore vendored
View File

@ -2,4 +2,5 @@
arch-chroot
genfstab
pacstrap
doc/*.8
arch-install-scripts-*.tar.gz*

View File

@ -7,6 +7,11 @@ BINPROGS = \
genfstab \
pacstrap
MANS = \
doc/arch-chroot.8 \
doc/genfstab.8 \
doc/pacstrap.8
BASH = bash
all: $(BINPROGS) man

View File

@ -0,0 +1,34 @@
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*.
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[]

50
doc/genfstab.8.asciidoc Normal file
View File

@ -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[]

47
doc/pacstrap.8.asciidoc Normal file
View File

@ -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[]