X-Git-Url: http://www.chiark.greenend.org.uk/ucgi/~ianmdlvl/git?a=blobdiff_plain;f=man%2Fsystemd-nspawn.xml;h=777e0a3a77ba0ead624e29111ade46477892c9da;hb=aa7cb2098302d45c8768ca08bf1e433a19aa46b9;hp=f63f72c18d80b70cbf7f6b0caed00344051fea1c;hpb=40c32a4ad488256e934ce9ecc05ebfac04851711;p=elogind.git

diff --git a/man/systemd-nspawn.xml b/man/systemd-nspawn.xml
index f63f72c18..777e0a3a7 100644
--- a/man/systemd-nspawn.xml
+++ b/man/systemd-nspawn.xml
@@ -93,9 +93,12 @@
                 container.</para>
 
                 <para>Use a tool like
-                <citerefentry><refentrytitle>debootstrap</refentrytitle><manvolnum>8</manvolnum></citerefentry> or <citerefentry><refentrytitle>mock</refentrytitle><manvolnum>1</manvolnum></citerefentry>
+                <citerefentry><refentrytitle>yum</refentrytitle><manvolnum>8</manvolnum></citerefentry>
+                or
+                <citerefentry><refentrytitle>debootstrap</refentrytitle><manvolnum>8</manvolnum></citerefentry>
                 to set up an OS directory tree suitable as file system
-                hierarchy for <command>systemd-nspawn</command> containers.</para>
+                hierarchy for <command>systemd-nspawn</command>
+                containers.</para>
 
                 <para>Note that <command>systemd-nspawn</command> will
                 mount file systems private to the container to
@@ -111,6 +114,11 @@
                 two containers is complete and the containers will
                 share very few runtime objects except for the
                 underlying file system.</para>
+
+                <para><command>systemd-nspawn</command> implements the
+                <ulink
+                url="http://www.freedesktop.org/wiki/Software/systemd/ContainerInterface">Container
+                Interface</ulink> specification.</para>
         </refsect1>
 
         <refsect1>
@@ -130,6 +138,13 @@
                                 text and exits.</para></listitem>
                         </varlistentry>
 
+                        <varlistentry>
+                                <term><option>--version</option></term>
+
+                                <listitem><para>Prints a version string
+                                and exits.</para></listitem>
+                        </varlistentry>
+
                         <varlistentry>
                                 <term><option>--directory=</option></term>
                                 <term><option>-D</option></term>
@@ -141,6 +156,16 @@
                                 used.</para></listitem>
                         </varlistentry>
 
+                        <varlistentry>
+                                <term><option>--boot</option></term>
+                                <term><option>-b</option></term>
+
+                                <listitem><para>Automatically search
+                                for an init binary and invoke it
+                                instead of a shell or a user supplied
+                                program.</para></listitem>
+                        </varlistentry>
+
                         <varlistentry>
                                 <term><option>--user=</option></term>
                                 <term><option>-u</option></term>
@@ -154,12 +179,23 @@
                                 </para></listitem>
                         </varlistentry>
 
+                        <varlistentry>
+                                <term><option>--uuid=</option></term>
+
+                                <listitem><para>Set the specified uuid
+                                for the container. The init system
+                                will initialize
+                                <filename>/etc/machine-id</filename>
+                                from this if this file is not set yet.
+                                </para></listitem>
+                        </varlistentry>
+
                         <varlistentry>
                                 <term><option>--controllers=</option></term>
                                 <term><option>-C</option></term>
 
                                 <listitem><para>Makes the container appear in
-                                other hierarchies that the name=systemd:/ one.
+                                other hierarchies than the name=systemd:/ one.
                                 Takes a comma-separated list of controllers.
                                 </para></listitem>
                         </varlistentry>
@@ -174,6 +210,87 @@
                                 loopback device.</para></listitem>
                         </varlistentry>
 
+                        <varlistentry>
+                                <term><option>--read-only</option></term>
+
+                                <listitem><para>Mount the root file
+                                system read only for the
+                                container.</para></listitem>
+                        </varlistentry>
+
+                        <varlistentry>
+                                <term><option>--capability=</option></term>
+
+                                <listitem><para>List one or more
+                                additional capabilities to grant the
+                                container. Takes a comma separated
+                                list of capability names, see
+                                <citerefentry><refentrytitle>capabilities</refentrytitle><manvolnum>7</manvolnum></citerefentry>
+                                for more information. Note that the
+                                following capabilities will be granted
+                                in any way: CAP_CHOWN,
+                                CAP_DAC_OVERRIDE, CAP_DAC_READ_SEARCH,
+                                CAP_FOWNER, CAP_FSETID, CAP_IPC_OWNER,
+                                CAP_KILL, CAP_LEASE,
+                                CAP_LINUX_IMMUTABLE,
+                                CAP_NET_BIND_SERVICE,
+                                CAP_NET_BROADCAST, CAP_NET_RAW,
+                                CAP_SETGID, CAP_SETFCAP, CAP_SETPCAP,
+                                CAP_SETUID, CAP_SYS_ADMIN,
+                                CAP_SYS_CHROOT, CAP_SYS_NICE,
+                                CAP_SYS_PTRACE, CAP_SYS_TTY_CONFIG,
+                                CAP_SYS_RESOURCE, CAP_SYS_BOOT,
+                                CAP_AUDIT_WRITE,
+                                CAP_AUDIT_CONTROL.</para></listitem>
+                        </varlistentry>
+
+                        <varlistentry>
+                                <term><option>--link-journal=</option></term>
+
+                                <listitem><para>Control whether the
+                                container's journal shall be made
+                                visible to the host system. If enabled
+                                allows viewing the container's journal
+                                files from the host (but not vice
+                                versa). Takes one of
+                                <literal>no</literal>,
+                                <literal>host</literal>,
+                                <literal>guest</literal>,
+                                <literal>auto</literal>. If
+                                <literal>no</literal>, the journal is
+                                not linked. If <literal>host</literal>,
+                                the journal files are stored on the
+                                host file system (beneath
+                                <filename>/var/log/journal/&lt;machine-id&gt;</filename>)
+                                and the subdirectory is bind-mounted
+                                into the container at the same
+                                location. If <literal>guest</literal>,
+                                the journal files are stored on the
+                                guest file system (beneath
+                                <filename>/var/log/journal/&lt;machine-id&gt;</filename>)
+                                and the subdirectory is symlinked into the host
+                                at the same location. If
+                                <literal>auto</literal> (the default),
+                                and the right subdirectory of
+                                <filename>/var/log/journal</filename>
+                                exists, it will be bind mounted
+                                into the container. If the
+                                subdirectory doesn't exist, no
+                                linking is performed. Effectively,
+                                booting a container once with
+                                <literal>guest</literal> or
+                                <literal>host</literal> will link the
+                                journal persistently if further on
+                                the default of <literal>auto</literal>
+                                is used.</para></listitem>
+                        </varlistentry>
+
+                        <varlistentry>
+                                <term><option>-j</option></term>
+
+                                <listitem><para>Equivalent to
+                                <option>--link-journal=guest</option>.</para></listitem>
+                        </varlistentry>
                 </variablelist>
 
         </refsect1>
@@ -181,27 +298,25 @@
         <refsect1>
                 <title>Example 1</title>
 
-                <programlisting># debootstrap --arch=amd64 unstable debian-tree/
-# systemd-nspawn -D debian-tree/</programlisting>
-
-                <para>This installs a minimal Debian unstable
-                distribution into the directory
-                <filename>debian-tree/</filename> and then spawns a
-                shell in a namespace container in it.</para>
+                <programlisting># yum -y --releasever=19 --nogpg --installroot=/srv/mycontainer --disablerepo='*' --enablerepo=fedora install systemd passwd yum fedora-release vim-minimal
+# systemd-nspawn -bD /srv/mycontainer</programlisting>
 
+                <para>This installs a minimal Fedora distribution into
+                the directory <filename>/srv/mycontainer/</filename> and
+                then boots an OS in a namespace container in
+                it.</para>
         </refsect1>
 
         <refsect1>
                 <title>Example 2</title>
 
-                <programlisting># mock --init
-# systemd-nspawn -D /var/lib/mock/fedora-rawhide-x86_64/root/ /sbin/init systemd.log_level=debug</programlisting>
+                <programlisting># debootstrap --arch=amd64 unstable ~/debian-tree/
+# systemd-nspawn -D ~/debian-tree/</programlisting>
 
-                <para>This installs a minimal Fedora distribution into
-                a subdirectory of <filename>/var/lib/mock/</filename>
-                and then boots an OS in a namespace container in it,
-                with systemd as init system, configured for debug
-                logging.</para>
+                <para>This installs a minimal Debian unstable
+                distribution into the directory
+                <filename>~/debian-tree/</filename> and then spawns a
+                shell in a namespace container in it.</para>
 
         </refsect1>
 
@@ -217,8 +332,8 @@
                 <para>
                         <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
                         <citerefentry><refentrytitle>chroot</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
-                        <citerefentry><refentrytitle>debootstrap</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
-                        <citerefentry><refentrytitle>mock</refentrytitle><manvolnum>1</manvolnum></citerefentry>
+                        <citerefentry><refentrytitle>yum</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
+                        <citerefentry><refentrytitle>debootstrap</refentrytitle><manvolnum>8</manvolnum></citerefentry>
                 </para>
         </refsect1>