summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorPhaedrus Leeds <matthew.leeds@endlessm.com>2020-08-07 21:35:27 -0700
committerAlexander Larsson <alexander.larsson@gmail.com>2020-08-11 15:22:57 +0200
commit2612e9df1870dfe9ee0a30d6731c1a57933c1b4c (patch)
tree79deb1931c33c86f5c0ceeafa2f4e5f0a1caaab8
parent73644b00c9b332ebba6be4cc5701dfb0ff0bc395 (diff)
downloadflatpak-2612e9df1870dfe9ee0a30d6731c1a57933c1b4c.tar.gz
doc: Update create-usb for sideloading
Update the create-usb man page to reflect the re-worked implementation that landed in 1.7.1.
-rw-r--r--doc/flatpak-create-usb.xml22
1 files changed, 12 insertions, 10 deletions
diff --git a/doc/flatpak-create-usb.xml b/doc/flatpak-create-usb.xml
index cbc2e14f..f687f4dd 100644
--- a/doc/flatpak-create-usb.xml
+++ b/doc/flatpak-create-usb.xml
@@ -45,18 +45,20 @@
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 and
- <command>flatpak install</command> will prefer to install from it rather than
- the Internet if (a) each ref comes from a configured remote whose GPG keyring will be
- used for verification and (b) the refs on the drive are at least as new as what's
- available elsewhere (e.g. the Internet if you're online). 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.
+ 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) the
- same way you would install from the Internet, e.g. with
- <command>flatpak install flathub org.gnome.Builder</command> or using a GUI.
+ 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