1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
|
<?xml version='1.0'?> <!--*-nxml-*-->
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
"http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd">
<refentry id="flatpak-create-usb">
<refentryinfo>
<title>flatpak create-usb</title>
<productname>flatpak</productname>
<authorgroup>
<author>
<contrib>Developer</contrib>
<firstname>Matthew</firstname>
<surname>Leeds</surname>
<email>matthew.leeds@endlessm.com</email>
</author>
</authorgroup>
</refentryinfo>
<refmeta>
<refentrytitle>flatpak create-usb</refentrytitle>
<manvolnum>1</manvolnum>
</refmeta>
<refnamediv>
<refname>flatpak-create-usb</refname>
<refpurpose>Copy apps and/or runtimes onto removable media.</refpurpose>
</refnamediv>
<refsynopsisdiv>
<cmdsynopsis>
<command>flatpak create-usb</command>
<arg choice="opt" rep="repeat">OPTION</arg>
<arg choice="plain">MOUNT-PATH</arg>
<arg choice="plain" rep="repeat">REF</arg>
</cmdsynopsis>
</refsynopsisdiv>
<refsect1>
<title>Description</title>
<para>
Copies the specified apps and/or runtimes <arg choice="plain">REF</arg>s onto the removable
media mounted at <arg choice="plain">MOUNT-PATH</arg>, along with all the dependencies and
metadata needed for installing them. This is one way of transferring flatpaks
between computers that doesn't require an Internet connection. After using
this command, the USB drive can be connected to another computer which already has the
relevant remote(s) configured, and Flatpak will install or update from the drive offline
(see below). If online, the drive will be used as a cache, meaning some objects will be
pulled from it and others from the Internet. For this process to work a collection ID
must be configured on the relevant remotes on both the source and destination computers,
and on the remote server.
</para>
<para>
On the destination computer one can install from the USB (or any mounted filesystem)
using the <option>--sideload-repo</option> option with <command>flatpak install</command>.
It's also possible to configure sideload paths using symlinks; see
<citerefentry><refentrytitle>flatpak</refentrytitle><manvolnum>1</manvolnum></citerefentry>.
Flatpak also includes systemd units to automatically sideload from hot-plugged USB drives,
but these may or may not be enabled depending on your Linux distribution.
</para>
<para>
Each <arg choice="plain">REF</arg> argument is a full or partial identifier in the
flatpak ref format, which looks like "(app|runtime)/ID/ARCH/BRANCH". All elements
except ID are optional and can be left out, including the slashes,
so most of the time you need only specify ID. Any part left out will be matched
against what is installed, and if there are multiple matches an error message
will list the alternatives.
</para>
<para>
By default this looks for both installed apps and runtimes
with the given <arg choice="plain">REF</arg>, but you can
limit this by using the <option>--app</option> or <option>--runtime</option> option.
</para>
<para>
All <arg choice="plain">REF</arg>s must be in the same installation (user, system, or other).
Otherwise it's ambiguous which repository metadata refs to put on the USB drive.
</para>
<para>
By default <command>flatpak create-usb</command> uses <filename>.ostree/repo</filename>
as the destination directory under <arg choice="plain">MOUNT-PATH</arg> but if you
specify another location using <option>--destination-repo</option>
a symbolic link will be created for you in <filename>.ostree/repos.d</filename>.
This ensures that either way the repository will be found by flatpak (and other
consumers of libostree) for install/update operations.
</para>
<para>
Unless overridden with the <option>--system</option>, <option>--user</option>, or <option>--installation</option>
options, this command searches both the system-wide installation
and the per-user one for <arg choice="plain">REF</arg> and errors
out if it exists in more than one.
</para>
</refsect1>
<refsect1>
<title>Options</title>
<para>The following options are understood:</para>
<variablelist>
<varlistentry>
<term><option>-h</option></term>
<term><option>--help</option></term>
<listitem><para>
Show help options and exit.
</para></listitem>
</varlistentry>
<varlistentry>
<term><option>-u</option></term>
<term><option>--user</option></term>
<listitem><para>
Copy refs from the per-user installation.
</para></listitem>
</varlistentry>
<varlistentry>
<term><option>--system</option></term>
<listitem><para>
Copy refs from the default system-wide installation.
</para></listitem>
</varlistentry>
<varlistentry>
<term><option>--installation=NAME</option></term>
<listitem><para>
Copy refs from a system-wide installation specified by
<arg choice="plain">NAME</arg> among those defined in
<filename>/etc/flatpak/installations.d/</filename>. Using
<option>--installation=default</option> is
equivalent to using <option>--system</option>.
</para></listitem>
</varlistentry>
<varlistentry>
<term><option>--app</option></term>
<listitem><para>
Assume that all <arg choice="plain">REF</arg>s are apps if not explicitly specified.
</para></listitem>
</varlistentry>
<varlistentry>
<term><option>--runtime</option></term>
<listitem><para>
Assume that all <arg choice="plain">REF</arg>s are runtimes if not explicitly specified.
</para></listitem>
</varlistentry>
<varlistentry>
<term><option>--destination-repo</option>=DEST</term>
<listitem><para>
Create the repository in <arg choice="plain">DEST</arg> under <arg choice="plain">MOUNT-PATH</arg>, rather than
the default location.
</para></listitem>
</varlistentry>
<varlistentry>
<term><option>--allow-partial</option></term>
<listitem><para>
Don't print a warning when exporting partially installed commits, for example locale extensions without all
languages. These can cause problems when installing them, for example if the language config is different
on the installing side.
</para></listitem>
</varlistentry>
<varlistentry>
<term><option>-v</option></term>
<term><option>--verbose</option></term>
<listitem><para>
Print debug information during command processing.
</para></listitem>
</varlistentry>
<varlistentry>
<term><option>--ostree-verbose</option></term>
<listitem><para>
Print OSTree debug information during command processing.
</para></listitem>
</varlistentry>
</variablelist>
</refsect1>
<refsect1>
<title>Examples</title>
<para>
<command>$ flatpak create-usb /run/media/mwleeds/1a9b4cb2-a7ef-4d9b-91a5-6eaf8fdd2bf6/ com.endlessm.wiki_art.en</command>
</para>
</refsect1>
<refsect1>
<title>See also</title>
<para>
<citerefentry><refentrytitle>flatpak</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
<citerefentry><refentrytitle>flatpak remote-modify</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
<citerefentry><refentrytitle>flatpak-install</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
<citerefentry><refentrytitle>flatpak-list</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
<citerefentry><refentrytitle>ostree-create-usb</refentrytitle><manvolnum>1</manvolnum></citerefentry>
</para>
</refsect1>
</refentry>
|
