From 2932a9def38fbe03c3727c6f5ca4f8e888826c78 Mon Sep 17 00:00:00 2001 From: nl6720 Date: Mon, 12 Jun 2023 20:55:08 +0300 Subject: Makefile: build and install the mkarchiso(1) man page rst2man from python-docutils is required to convert the man page from reStructuredText. --- man/mkarchiso.1.rst | 60 +++++++++++++++++++++++++---------------------------- man/variables.rst | 5 +++-- 2 files changed, 31 insertions(+), 34 deletions(-) (limited to 'man') diff --git a/man/mkarchiso.1.rst b/man/mkarchiso.1.rst index 22d4c1b..c54d2bb 100644 --- a/man/mkarchiso.1.rst +++ b/man/mkarchiso.1.rst @@ -12,46 +12,42 @@ Arch Linux ISO generator Synopsis ======== -mkarchiso *[options]* *profile_directory* +**mkarchiso** [options] *profile_directory* Description =========== -mkarchiso create an ISO, netboot artifacts and a bootstrap tarball and optionally signs them. +**mkarchiso** creates 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|. +-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 ======== diff --git a/man/variables.rst b/man/variables.rst index 084c94d..152f154 100644 --- a/man/variables.rst +++ b/man/variables.rst @@ -1,9 +1,10 @@ -.. |iso_application| replace:: *mkarchiso iso* +.. |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 + +.. include:: version.rst -- cgit v1.2.3-70-g09d2