[devtools] doc: add man page for mkarchroot

Message ID 20190218125341.8572-1-jelle@vdwaa.nl
State Accepted
Delegated to: Levente Polyak
Headers show
Series
  • [devtools] doc: add man page for mkarchroot
Related show

Commit Message

Jelle van der Waa Feb. 18, 2019, 12:53 p.m. UTC
---
 Makefile                  |  3 ++-
 doc/mkarchroot.1.asciidoc | 46 +++++++++++++++++++++++++++++++++++++++
 2 files changed, 48 insertions(+), 1 deletion(-)
 create mode 100644 doc/mkarchroot.1.asciidoc

Patch

diff --git a/Makefile b/Makefile
index e812936..870b523 100644
--- a/Makefile
+++ b/Makefile
@@ -64,7 +64,8 @@  BASHCOMPLETION_LINKS = \
 
 MANS = \
 	doc/lddd.1 \
-	doc/checkpkg.1
+	doc/checkpkg.1 \
+	doc/mkarchroot.1
 
 
 all: $(BINPROGS) bash_completion zsh_completion man
diff --git a/doc/mkarchroot.1.asciidoc b/doc/mkarchroot.1.asciidoc
new file mode 100644
index 0000000..6f35562
--- /dev/null
+++ b/doc/mkarchroot.1.asciidoc
@@ -0,0 +1,46 @@ 
+mkarchroot(1)
+===============
+
+Name
+----
+mkarchroot - Creates an arch chroot in a specified location with a specified set of packages
+
+Synopsis
+--------
+mkarchroot [options] [location] [packages]
+
+Description
+-----------
+
+'mkarchroot' is a script to create an Arch Linux chroot at a specified location
+with specified packages. Typically used by 'makechrootpkg' to create build
+chroots. Apart from installing specified packages the chroot is created with an
+en_US.UTF-8 and de_DE.UTF-8 locale and a generated machine-id.
+
+Options
+-------
+
+*-C* <file>::
+	Location of a pacman config file.
+
+*-M* <file>::
+	Location of a makepkg config file.
+	
+*-c* <dir>::
+	Set pacman cache.
+	
+*-f* <file>::
+	Copy file from the host to the chroot.
+
+*-s*::
+	Do not run setarch.
+
+*-h*::
+	Output command line options.
+	
+See Also
+--------
+
+linkman:pacman[1]
+
+include::footer.asciidoc[]