Debian Codegraph @

docs/debspawn-create.1.xml

raw
1 <?xml version='1.0' encoding='ISO-8859-1'?>
2 <!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
3 "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
4
5 <!ENTITY date "<date>18 August, 2018</date>">
6
7 <!ENTITY pagename "debspawn-create">
8 <!ENTITY command "debspawn create">
9 ]>
10
11 <refentry>
12 <refentryinfo>
13 <title>&command;</title>
14 <copyright>
15 <year>2018-2022</year>
16 <holder>Matthias Klumpp</holder>
17 </copyright>
18 <productname>Debspawn</productname>
19 &date;
20 </refentryinfo>
21
22 <refmeta>
23 <refentrytitle>&pagename;</refentrytitle>
24 <manvolnum>1</manvolnum>
25 </refmeta>
26 <refnamediv>
27 <refname>&pagename;</refname>
28 <refpurpose>Create new container images</refpurpose>
29 </refnamediv>
30
31 <refsynopsisdiv>
32 <cmdsynopsis>
33 <command>&command;</command>
34 @CREATE_FLAGS_SYNOPSIS@
35 <arg choice="req">NAME</arg>
36 </cmdsynopsis>
37 </refsynopsisdiv>
38
39 <refsect1>
40 <title>Description</title>
41 <para>
42 Create a new base image for a suite known to <command>debootstrap(1)</command> or
43 <command>mmdebstrap(1)</command>. The image will later be used to spawn
44 ephemeral containers in which packages can be built.
45 If <command>mmdebstrap</command> is installed on the system it will be preferred
46 over <command>debootstrap</command> unless a specific bootstrap tool is set in the
47 global configuration.
48 </para>
49 </refsect1>
50
51 <refsect1>
52 <title>Examples</title>
53 <para>
54 You can easily create images for any suite that has a script in <command>debootstrap</command>. For example, to create a Debian Unstable image for
55 your current machine architecture, you can use:
56 </para>
57 <para>
58 <prompt>$</prompt> <command>&command;</command> unstable
59 </para>
60 <para>
61 A more advanced example, for building on Ubuntu 18.10 on the x86 architecture:
62 </para>
63 <para>
64 <prompt>$</prompt> <command>&command;</command> --arch=i386 cosmic
65 </para>
66 <para>
67 The suite name is inferred from the container image name given as positional parameter. If it can not be inferred,
68 you will need to pass the <option>--suite</option> parameter with the primary suite name for this image.
69 If a <option>--base-suite</option> is passed and no <option>--suite</option> is set, the image name will automatically
70 be assumed to be for an overlay suite, which may not always be the desired result.
71 </para>
72 </refsect1>
73
74 <refsect1>
75 <title>Options</title>
76
77 <variablelist>
78 <varlistentry>
79 <term>NAME</term>
80 <listitem><para>The name of the container image to create (usually the name of the suite).</para></listitem>
81 </varlistentry>
82
83 @CREATE_FLAGS_ENTRIES@
84 </variablelist>
85 </refsect1>
86
87 <refsect1>
88 <title>See Also</title>
89 <para>debspawn-build(1), debootstrap(1), systemd-nspawn(1).</para>
90 </refsect1>
91 <refsect1>
92 <title>AUTHOR</title>
93 <para>
94 This manual page was written by Matthias Klumpp <email>[email protected]</email>.
95 </para>
96 </refsect1>
97 </refentry>