Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

doc: Add arch-nspawn man page #67

Closed
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -78,6 +78,7 @@ MANS = \
doc/mkarchroot.1 \
doc/find-libdeps.1 \
doc/find-libprovides.1 \
doc/arch-nspawn.1 \
doc/devtools.7


Expand Down
44 changes: 44 additions & 0 deletions doc/arch-nspawn.1.asciidoc
Original file line number Diff line number Diff line change
@@ -0,0 +1,44 @@
arch-nspawn(1)
==============

Name
----
arch-nspawn - Run a command or OS in a light-weight namespace container

Synopsis
--------
arch-nspawn [options] working-dir [systemd-nspawn arguments]

Description
-----------

'arch-nspawn' is a wrapper around systemd-nspawn to run command or OS in a
namespace container such as a directory including base utilities of a OS.
It is used to build package(s) in given clean and defined environment.

If some special settings of pacman or makepkg are needed, their config file
can be passed into the container through option(s) between 'arch-nspawn' and working-dir.
option(s) at the end will be passed to systemd-nspawn.

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*::
Show this usage message

include::footer.asciidoc[]
3 changes: 3 additions & 0 deletions doc/devtools.7.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -43,4 +43,7 @@ linkman:offload-build[1]
linkman:sogrep[1]
Find packages using a linked to a given shared library

linkman:arch-nspawn[1]
Run a command or OS in a light-weight namespace container

include::footer.asciidoc[]