From bedb75a8c39aa5f154ee4fc383374de3ef399e6d Mon Sep 17 00:00:00 2001 From: nl6720 Date: Mon, 12 Jun 2023 20:27:52 +0300 Subject: Add man page for mkarchiso --- man/mkarchiso.1.rst | 84 +++++++++++++++++++++++++++++++++++++++++++++++++++++ man/variables.rst | 9 ++++++ 2 files changed, 93 insertions(+) create mode 100644 man/mkarchiso.1.rst create mode 100644 man/variables.rst diff --git a/man/mkarchiso.1.rst b/man/mkarchiso.1.rst new file mode 100644 index 0000000..22d4c1b --- /dev/null +++ b/man/mkarchiso.1.rst @@ -0,0 +1,84 @@ +========= +mkarchiso +========= + +------------------------ +Arch Linux ISO generator +------------------------ + +:Version: archiso |version| +:Manual section: 1 + +Synopsis +======== + +mkarchiso *[options]* *profile_directory* + +Description +=========== + +mkarchiso create an ISO, netboot artifacts and a bootstrap tarball and optionally signs them. + +Options +======= + +-A application Set an application name for the ISO. + Default: |iso_application|. +-C file pacman configuration file. + Default: |pacman_conf|. +-D install_dir Set an install_dir. All files will be located here. + Default: |install_dir|. + NOTE: Max 8 characters, use only *a-z0-9*. +-L label Set the ISO volume label. + Default: |iso_label|. +-P publisher Set the ISO publisher. + Default: |iso_publisher|. +-c cert_and_key Provide certificates for codesigning of netboot artifacts as well as the rootfs artifact. + Multiple files are provided as quoted, space delimited list. + The first file is considered as the signing certificate, + the second as the key and the third as the optional certificate authority. +-g gpg_key Set the PGP key ID to be used for signing the rootfs image. + Passed to gpg as the value for **--default-key**. +-G mbox Set the PGP signer (must include an email address). + Passed to gpg as the value for **--sender**. +-h Help message. +-m mode Build mode(s) to use (valid modes are: *bootstrap*, *iso* and *netboot*). + Multiple build modes are provided as quoted, space delimited list. +-o out_dir Set the output directory. + Default: |out_dir|. +-p packages Package(s) to install. + Multiple packages are provided as quoted, space delimited list. +-r Delete the working directory at the end. +-v Enable verbose output. +-w work_dir Set the working directory. + Default: |work_dir|. + +Examples +======== + +Build the releng profile +------------------------ + + mkarchiso |profile_dir|/configs/releng + +Bugs +==== + +https://gitlab.archlinux.org/archlinux/archiso/-/issues + +Authors +======= + +archiso is maintained by the Arch Linux community. Refer to the *AUTHORS* file for a full list of contributors. + +Copyright +========= + +Copyright 🄯 archiso contributors. GPL-3.0-or-later. + +See also +======== + +* /usr/share/doc/archiso/README.profile.rst + +.. include:: variables.rst diff --git a/man/variables.rst b/man/variables.rst new file mode 100644 index 0000000..084c94d --- /dev/null +++ b/man/variables.rst @@ -0,0 +1,9 @@ +.. |iso_application| replace:: *mkarchiso iso* +.. |pacman_conf| replace:: */etc/pacman.conf* +.. |install_dir| replace:: *arch* +.. |iso_label| replace:: *MKARCHISO* +.. |iso_publisher| replace:: *mkarchiso* +.. |out_dir| replace:: *./out* +.. |work_dir| replace:: *./work* +.. |version| replace:: insert.version.here +.. |profile_dir| replace:: /usr/share/archiso -- cgit v1.2.3-70-g09d2