diff --git a/doc/flatpak-build-bundle.xml b/doc/flatpak-build-bundle.xml index eb69e62b..5209a80f 100644 --- a/doc/flatpak-build-bundle.xml +++ b/doc/flatpak-build-bundle.xml @@ -107,7 +107,7 @@ - The URL for a .flatpakrepo file that contains + The URL for a .flatpakrepo file that contains the information about the repository that supplies the runtimes required by the app. @@ -117,7 +117,7 @@ - Add the GPG key from FILE (use - for stdin). + Add the GPG key from FILE (use - for stdin). diff --git a/doc/flatpak-build-export.xml b/doc/flatpak-build-export.xml index 1ee766da..a24e0a42 100644 --- a/doc/flatpak-build-export.xml +++ b/doc/flatpak-build-export.xml @@ -135,7 +135,7 @@ - Exclude files matching PATTERN from the commit. + Exclude files matching PATTERN from the commit. This option can be used multiple times. @@ -144,7 +144,7 @@ - Don't exclude files matching PATTERN from the commit, even if they match the --export patterns. + Don't exclude files matching PATTERN from the commit, even if they match the patterns. This option can be used multiple times. @@ -156,7 +156,7 @@ Use the specified filename as metadata in the exported app instead of the default file (called metadata). This is useful if you want to commit multiple things from a single build tree, typically - used in combination with --files and --exclude. + used in combination with and . diff --git a/doc/flatpak-build-finish.xml b/doc/flatpak-build-finish.xml index efe39521..d2d43544 100644 --- a/doc/flatpak-build-finish.xml +++ b/doc/flatpak-build-finish.xml @@ -280,8 +280,8 @@ key=v1;v2; - Allow the application to own the well known name NAME on the session bus. - If NAME ends with .*, it allows the application to own all matching names. + Allow the application to own the well known name NAME on the session bus. + If NAME ends with .*, it allows the application to own all matching names. This updates the [Session Bus Policy] group in the metadata. This option can be used multiple times. @@ -292,8 +292,8 @@ key=v1;v2; - Allow the application to talk to the well known name NAME on the session bus. - If NAME ends with .*, it allows the application to talk to all matching names. + Allow the application to talk to the well known name NAME on the session bus. + If NAME ends with .*, it allows the application to talk to all matching names. This updates the [Session Bus Policy] group in the metadata. This option can be used multiple times. @@ -303,8 +303,8 @@ key=v1;v2; - Allow the application to own the well known name NAME on the system bus. - If NAME ends with .*, it allows the application to own all matching names. + Allow the application to own the well known name NAME on the system bus. + If NAME ends with .*, it allows the application to own all matching names. This updates the [System Bus Policy] group in the metadata. This option can be used multiple times. @@ -314,8 +314,8 @@ key=v1;v2; - Allow the application to talk to the well known name NAME on the system bus. - If NAME ends with .*, it allows the application to talk to all matching names. + Allow the application to talk to the well known name NAME on the system bus. + If NAME ends with .*, it allows the application to talk to all matching names. This updates the [System Bus Policy] group in the metadata. This option can be used multiple times. @@ -326,7 +326,7 @@ key=v1;v2; If the application doesn't have access to the real homedir, make the (homedir-relative) path - FILENAME a bind mount to the corresponding path in the per-application directory, + FILENAME a bind mount to the corresponding path in the per-application directory, allowing that location to be used for persistent data. This updates the [Context] group in the metadata. This option can be used multiple times. @@ -391,7 +391,7 @@ key=v1;v2; Adds information about extra data uris to the app. These will be downloaded and verified by the client when the app is installed and placed in the - /app/extra directory. You can also supply an /app/bin/apply_extra script + /app/extra directory. You can also supply an /app/bin/apply_extra script that will be run after the files are downloaded. diff --git a/doc/flatpak-build-init.xml b/doc/flatpak-build-init.xml index eaa06b8c..dc477457 100644 --- a/doc/flatpak-build-init.xml +++ b/doc/flatpak-build-init.xml @@ -121,7 +121,7 @@ - When using --writable-sdk, in addition to the sdk, also install the specified extension. + When using , in addition to the sdk, also install the specified extension. This option can be used multiple times. @@ -138,7 +138,7 @@ - Specify a custom subdirectory to use instead of usr for --writable-sdk. + Specify a custom subdirectory to use instead of usr for . @@ -162,7 +162,7 @@ - Specify the version to use for --base. If not specified, will default to + Specify the version to use for . If not specified, will default to "master". @@ -170,7 +170,7 @@ - When using --base, also install the specified extension from the app. + When using , also install the specified extension from the app. This option can be used multiple times. diff --git a/doc/flatpak-build.xml b/doc/flatpak-build.xml index 539314e1..55dc9d49 100644 --- a/doc/flatpak-build.xml +++ b/doc/flatpak-build.xml @@ -126,7 +126,7 @@ Share a subsystem with the host session. This overrides the Context section from the application metadata. - SUBSYSTEM must be one of: network, ipc. + SUBSYSTEM must be one of: network, ipc. This option can be used multiple times. @@ -137,7 +137,7 @@ Don't share a subsystem with the host session. This overrides the Context section from the application metadata. - SUBSYSTEM must be one of: network, ipc. + SUBSYSTEM must be one of: network, ipc. This option can be used multiple times. @@ -148,7 +148,7 @@ Expose a well-known socket to the application. This overrides to the Context section from the application metadata. - SOCKET must be one of: x11, wayland, fallback-x11, pulseaudio, system-bus, session-bus, ssh-auth. + SOCKET must be one of: x11, wayland, fallback-x11, pulseaudio, system-bus, session-bus, ssh-auth. This option can be used multiple times. @@ -159,7 +159,7 @@ Don't expose a well-known socket to the application. This overrides to the Context section from the application metadata. - SOCKET must be one of: x11, wayland, fallback-x11, pulseaudio, system-bus, session-bus, ssh-auth. + SOCKET must be one of: x11, wayland, fallback-x11, pulseaudio, system-bus, session-bus, ssh-auth. This option can be used multiple times. @@ -170,7 +170,7 @@ Expose a device to the application. This overrides to the Context section from the application metadata. - DEVICE must be one of: dri, kvm, all. + DEVICE must be one of: dri, kvm, all. This option can be used multiple times. @@ -181,7 +181,7 @@ Don't expose a device to the application. This overrides to the Context section from the application metadata. - DEVICE must be one of: dri, kvm, all. + DEVICE must be one of: dri, kvm, all. This option can be used multiple times. @@ -192,7 +192,7 @@ Allow access to a specific feature. This updates the [Context] group in the metadata. - FEATURE must be one of: devel, multiarch, bluetooth, canbus. + FEATURE must be one of: devel, multiarch, bluetooth, canbus. This option can be used multiple times. See flatpak-build-finish1 @@ -206,7 +206,7 @@ Disallow access to a specific feature. This updates the [Context] group in the metadata. - FEATURE must be one of: devel, multiarch, bluetooth, canbus. + FEATURE must be one of: devel, multiarch, bluetooth, canbus. This option can be used multiple times. @@ -217,7 +217,7 @@ Allow the application access to a subset of the filesystem. This overrides to the Context section from the application metadata. - FILESYSTEM can be one of: home, host, xdg-desktop, xdg-documents, xdg-download + FILESYSTEM can be one of: home, host, xdg-desktop, xdg-documents, xdg-download xdg-music, xdg-pictures, xdg-public-share, xdg-templates, xdg-videos, xdg-run, xdg-config, xdg-cache, xdg-data, an absolute path, or a homedir-relative path like ~/dir or paths relative to the xdg dirs, like xdg-download/subdir. @@ -234,7 +234,7 @@ Remove access to the specified subset of the filesystem from the application. This overrides to the Context section from the application metadata. - FILESYSTEM can be one of: home, host, xdg-desktop, xdg-documents, xdg-download + FILESYSTEM can be one of: home, host, xdg-desktop, xdg-documents, xdg-download xdg-music, xdg-pictures, xdg-public-share, xdg-templates, xdg-videos, an absolute path, or a homedir-relative path like ~/dir. This option can be used multiple times. @@ -245,7 +245,7 @@ - Expose and configure access to the per-app storage directory in $HOME/.var/app. This is + Expose and configure access to the per-app storage directory in $HOME/.var/app. This is not normally useful when building, but helps when testing built apps. @@ -328,7 +328,7 @@ key=v1;v2; If the application doesn't have access to the real homedir, make the (homedir-relative) path - FILENAME a bind mount to the corresponding path in the per-application directory, + FILENAME a bind mount to the corresponding path in the per-application directory, allowing that location to be used for persistent data. This overrides to the Context section from the application metadata. This option can be used multiple times. @@ -340,9 +340,9 @@ key=v1;v2; Normally if there is a usr directory in the build dir, this is used - for the runtime files (this can be created by --writable-sdk or --type=runtime arguments - to build-init). If you specify --sdk-dir this directoryname will be used instead. - Use this if you passed --sdk-dir to build-init. + for the runtime files (this can be created by or arguments + to build-init). If you specify , this directory will be used instead. + Use this if you passed to build-init. diff --git a/doc/flatpak-config.xml b/doc/flatpak-config.xml index 5f40603a..822e30c4 100644 --- a/doc/flatpak-config.xml +++ b/doc/flatpak-config.xml @@ -41,7 +41,17 @@ Description - Show and modify current configuration + Show and modify the configuration of a flatpak installation. + + + + For configuration of individual remotes, see + flatpak-remote-modify1. + + + + For configuration of individual applications, see + flatpak-override1. @@ -65,7 +75,7 @@ - Print all keys and their values + Print all keys and their values. @@ -73,7 +83,7 @@ - Set key KEY to VALUE + Set key KEY to VALUE. @@ -81,7 +91,7 @@ - Unset key KEY + Unset key KEY. @@ -89,7 +99,7 @@ - Print value of KEY. + Print value of KEY. @@ -116,8 +126,8 @@ Configure the system-wide installation specified by NAME among those defined in /etc/flatpak/installations.d/. Using - --installation=default is equivalent to using - --system. + is equivalent to using + . @@ -154,6 +164,8 @@ flatpak1, + flatpak-remote-modify1, + flatpak-override1 diff --git a/doc/flatpak-create-usb.xml b/doc/flatpak-create-usb.xml index 9b5ededc..13ca223d 100644 --- a/doc/flatpak-create-usb.xml +++ b/doc/flatpak-create-usb.xml @@ -62,7 +62,7 @@ By default this looks for both installed apps and runtimes with the given REF, but you can - limit this by using the --app or --runtime option. + limit this by using the or option. All REFs must be in the same installation (user, system, or other). @@ -77,7 +77,7 @@ consumers of libostree) for install/update operations. - Unless overridden with the --system, --user, or --installation + Unless overridden with the , , or options, this command searches both the system-wide installation and the per-user one for REF and errors out if it exists in more than one. @@ -123,8 +123,8 @@ Copy refs from a system-wide installation specified by NAME among those defined in /etc/flatpak/installations.d/. Using - --installation=default is - equivalent to using --system. + is + equivalent to using . @@ -147,7 +147,7 @@ =DEST - Create the repository in DEST under MOUNT-PATH, rather than + Create the repository in DEST under MOUNT-PATH, rather than the default location. diff --git a/doc/flatpak-document-export.xml b/doc/flatpak-document-export.xml index 3704e7d4..c17eb506 100644 --- a/doc/flatpak-document-export.xml +++ b/doc/flatpak-document-export.xml @@ -43,7 +43,7 @@ Creates a document id for a local file that can be exposed to sandboxed applications, allowing them access to files that they would not otherwise see. The exported files are exposed in a - fuse filesystem at /run/user/$UID/doc/. + fuse filesystem at /run/user/$UID/doc/. @@ -104,8 +104,8 @@ Grant read access to the specified application. The - --allow and --forbid options can be used to grant - or remove additional privileges. + and options + can be used to grant or remove additional privileges. This option can be used multiple times. @@ -115,7 +115,7 @@ - Grant read access to the applications specified with --app. + Grant read access to the applications specified with . This defaults to TRUE. @@ -124,7 +124,7 @@ - Revoke read access for the applications specified with --app. + Revoke read access for the applications specified with . @@ -133,7 +133,7 @@ - Grant write access to the applications specified with --app. + Grant write access to the applications specified with . @@ -141,7 +141,7 @@ - Revoke write access for the applications specified with --app. + Revoke write access for the applications specified with . @@ -150,7 +150,7 @@ - Grant the ability to remove the document from the document portal to the applications specified with --app. + Grant the ability to remove the document from the document portal to the applications specified with . @@ -158,7 +158,7 @@ - Revoke the ability to remove the document from the document portal from the applications specified with --app. + Revoke the ability to remove the document from the document portal from the applications specified with . @@ -167,7 +167,7 @@ - Grant the ability to grant further permissions to the applications specified with --app. + Grant the ability to grant further permissions to the applications specified with . @@ -175,7 +175,7 @@ - Revoke the ability to grant further permissions for the applications specified with --app. + Revoke the ability to grant further permissions for the applications specified with . diff --git a/doc/flatpak-document-info.xml b/doc/flatpak-document-info.xml index 9cfb22b5..9740e8ad 100644 --- a/doc/flatpak-document-info.xml +++ b/doc/flatpak-document-info.xml @@ -45,7 +45,7 @@ filesystem, and the per-application permissions. - FILE can either be a file in the fuse filesystem at /run/user/$UID/doc/, + FILE can either be a file in the fuse filesystem at /run/user/$UID/doc/, or a file anywhere else. diff --git a/doc/flatpak-document-list.xml b/doc/flatpak-document-list.xml index 714109f0..3ea594c3 100644 --- a/doc/flatpak-document-list.xml +++ b/doc/flatpak-document-list.xml @@ -41,7 +41,7 @@ Lists exported files, with their document id and the - full path to their origin. If an APPID is specified, + full path to their origin. If an APPID is specified, only the files exported to this app are listed. diff --git a/doc/flatpak-history.xml b/doc/flatpak-history.xml index 8c0549d1..772178b2 100644 --- a/doc/flatpak-history.xml +++ b/doc/flatpak-history.xml @@ -44,7 +44,7 @@ By default, both per-user and system-wide installations are shown. Use the - --user, --installation or --system options to change this. + , or options to change this. The information for the history command is taken from the systemd journal, @@ -90,8 +90,8 @@ Show changes to the installation specified by NAME among those defined in /etc/flatpak/installations.d/. - Using --installation=default is equivalent to using - --system. + Using is equivalent to using + . @@ -142,14 +142,6 @@ - - - - - Show the available values for the option. - - - diff --git a/doc/flatpak-info.xml b/doc/flatpak-info.xml index 1c5f6128..53866e95 100644 --- a/doc/flatpak-info.xml +++ b/doc/flatpak-info.xml @@ -45,24 +45,14 @@ By default, the output is formatted in a friendly format. - If you specify one of the options - --show-ref, - --show-origin, - --show-commit, - --show-size, - --show-metadata, - --show-permissions, - --file-access, - --show-location, - --show-runtime or - --show-sdk, - the output is instead formatted - in a machine-readable format. + If you specify any of the or + options, the output is instead + formatted in a machine-readable format. - By default, both per-user and system-wide installations - are queried. Use the --user, --system or --installation - options to change this. + By default, both per-user and system-wide installations are queried. + Use the , + or options to change this. @@ -104,8 +94,8 @@ Query a system-wide installation by NAME among those defined in /etc/flatpak/installations.d/. - Using --installation=default is equivalent to using - --system. + Using is equivalent to using + . diff --git a/doc/flatpak-install.xml b/doc/flatpak-install.xml index 992027ed..59fb8835 100644 --- a/doc/flatpak-install.xml +++ b/doc/flatpak-install.xml @@ -29,27 +29,18 @@ - Install from a configured remote: flatpak install OPTION REMOTE REF - Install from a .flatpakref file: flatpak install OPTION - --from + --from|--bundle LOCATION - Install from a .flatpak bundle: - - flatpak install - OPTION - --bundle - FILENAME - @@ -57,57 +48,59 @@ Installs an application or runtime. The primary way to - install is to specify a REMOTE - name as the source and one ore more REFs to specify the - application or runtime to install. If REMOTE is omitted, - the configured remotes are searched for the first REF + install is to specify a REMOTE + name as the source and one ore more REFs to specify the + application or runtime to install. If REMOTE is omitted, + the configured remotes are searched for the first REF and the user is asked to confirm the resulting choice. - Each REF argument is a full or partial indentifier 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 in the remote, and if there are multiple matches you will be - prompted to choose one of them. You will also be prompted with choices if - REF doesn't match anything in the remote exactly but is - similar to one or more refs in the remote (e.g. "devhelp" is similar to - "org.gnome.Devhelp"). + Each REF argument is a full or partial indentifier 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 in the remote, and if there are multiple matches you will be + prompted to choose one of them. You will also be prompted with choices if + REF doesn't match anything in the remote exactly but is + similar to one or more refs in the remote (e.g. "devhelp" is similar to + "org.gnome.Devhelp"). - By default this looks for both apps and runtimes with the given REF in - the specified REMOTE, but you can limit this by using the --app or - --runtime option, or by supplying the initial element in the REF. + By default this looks for both apps and runtimes with the given + REF in the specified REMOTE, + but you can limit this by using the or + option, or by supplying the initial element in the REF. - If REMOTE is a uri or a path (absolute or relative starting with ./) - to a local repository, then that repository will be used as the source, and a temporary remote - will be created for the lifetime of the REF. + If REMOTE is a uri or a path (absolute or relative starting + with ./) to a local repository, then that repository will be used as the source, and + a temporary remote will be created for the lifetime of the REF. - If the specified REMOTE has a collection ID configured on it, - flatpak will search mounted filesystems such as USB drives as well as Avahi services - advertised on the local network for the needed refs, in order to support - offline updates. See ostree-find-remotes1 - for more information. + If the specified REMOTE has a collection ID configured on it, + flatpak will search mounted filesystems such as USB drives as well as Avahi services + advertised on the local network for the needed refs, in order to support + offline updates. See ostree-find-remotes1 + for more information. - The alternative form of the command (--from or - --bundle allows you to - install directly from a source such as a .flatpak - single-file bundle, a .flatpakref app description. The options are optional if the first - argument has the right extension. + The alternative form of the command (with or + ) allows to install directly from a source such as a + .flatpak single-file bundle or a .flatpakref + application description. The options are optional if the first argument has the expected + filename extension. - Note that flatpak allows one to have multiple branches of an application and runtimes - installed and used at the same time. However, only one version of an application can be current, - meaning its exported files (for instance desktop files and icons) are - visible to the host. The last installed version is made current by - default, but you can manually change with make-current. + Note that flatpak allows to have multiple branches of an application and runtimes + installed and used at the same time. However, only one version of an application + can be current, meaning its exported files (for instance desktop files and icons) + are visible to the host. The last installed version is made current by default, but + this can manually changed with flatpak make-current. - Unless overridden with the --user or the --installation option, this command installs - the application or runtime in the default system-wide installation. + Unless overridden with the or the + option, this command installs the application or runtime in the default system-wide + installation. @@ -131,8 +124,8 @@ - Assume LOCATION is a .flatpak single-bundle file. - This is optional if the arguments ends with .flatpak. + Treat LOCATION as a single-bundle file. + This is assumed if the argument ends with .flatpak. @@ -140,8 +133,8 @@ - Assume LOCATION is a .flatpakref file containing the details of the app to be installed. - This is optional if the arguments ends with .flatpakref. + Treat LOCATION as an application description file. + This is assumed if the argument ends with .flatpakref. @@ -176,8 +169,8 @@ Install the application or runtime in a system-wide installation specified by NAME among those defined in /etc/flatpak/installations.d/. Using - --installation=default is equivalent to using - --system. + is equivalent to using + . @@ -193,8 +186,9 @@ - Install only a subpath of the ref. This is mainly used to install a subset of locales. - This can be added multiple times to install multiple subpaths., + Install only a subpath of REF. This is mainly used to + install a subset of locales. This can be added multiple times to install multiple + subpaths. @@ -202,7 +196,7 @@ - Check bundle signatures with GPG key from FILE (- for stdin). + Check bundle signatures with GPG key from FILE (- for stdin). @@ -306,7 +300,9 @@ flatpak-update1, flatpak-list1, flatpak-build-bundle1, - flatpak-flatpakref1 + flatpak-flatpakref1, + flatpak-make-current1, + ostree-find-remotes1 diff --git a/doc/flatpak-kill.xml b/doc/flatpak-kill.xml index b44f964c..19b70a4c 100644 --- a/doc/flatpak-kill.xml +++ b/doc/flatpak-kill.xml @@ -39,7 +39,11 @@ Description - Kill a running sandbox. INSTANCE can be + Stop a running Flatpak instance. + + + + INSTANCE can be either the numeric instance ID or the application ID of a running Flatpak. diff --git a/doc/flatpak-list.xml b/doc/flatpak-list.xml index 13224777..70cb500a 100644 --- a/doc/flatpak-list.xml +++ b/doc/flatpak-list.xml @@ -39,20 +39,21 @@ Description - Lists the names of the installed applications and/or runtimes. + Lists the names of the installed applications and runtimes. - By default, both per-user and system-wide installations - are shown. Use the --user, --installation or --system - options to change this. + By default, both apps and runtimes are shown, but you can + change this by using the or + options. - By default this lists both installed apps and runtimes, but you can - change this by using the --app or --runtime option. + By default, both per-user and system-wide installations are shown. + Use the , or + options to change this. The list command can also be used to find installed apps that - use a certain runtime, with the --app-runtime option. + use a certain runtime, with the option. @@ -94,8 +95,8 @@ List a system-wide installation specified by NAME among those defined in /etc/flatpak/installations.d/. - Using --installation=default is equivalent to using - --system. + Using is equivalent to using + . diff --git a/doc/flatpak-make-current.xml b/doc/flatpak-make-current.xml index a4c8bc78..931362a5 100644 --- a/doc/flatpak-make-current.xml +++ b/doc/flatpak-make-current.xml @@ -50,7 +50,7 @@ command is often not needed. - Unless overridden with the --user or --installation options, this command + Unless overridden with the or options, this command changes the default system-wide installation. @@ -93,8 +93,8 @@ Updates a system-wide installation specified by NAME among those defined in /etc/flatpak/installations.d/. - Using --installation=default is equivalent to using - --system. + Using is equivalent to using + . diff --git a/doc/flatpak-override.xml b/doc/flatpak-override.xml index c91875cc..a634770e 100644 --- a/doc/flatpak-override.xml +++ b/doc/flatpak-override.xml @@ -54,7 +54,7 @@ but the per-application overrides can override the global overrides. - Unless overridden with the --user or --installation options, this command + Unless overridden with the or options, this command changes the default system-wide installation. @@ -97,8 +97,8 @@ Updates a system-wide installation specified by NAME among those defined in /etc/flatpak/installations.d/. - Using --installation=default is equivalent to using - --system. + Using is equivalent to using + . @@ -108,7 +108,7 @@ Share a subsystem with the host session. This overrides the Context section from the application metadata. - SUBSYSTEM must be one of: network, ipc. + SUBSYSTEM must be one of: network, ipc. This option can be used multiple times. @@ -119,7 +119,7 @@ Don't share a subsystem with the host session. This overrides the Context section from the application metadata. - SUBSYSTEM must be one of: network, ipc. + SUBSYSTEM must be one of: network, ipc. This option can be used multiple times. @@ -130,7 +130,7 @@ Expose a well-known socket to the application. This overrides to the Context section from the application metadata. - SOCKET must be one of: x11, wayland, fallback-x11, pulseaudio, system-bus, session-bus, ssh-auth. + SOCKET must be one of: x11, wayland, fallback-x11, pulseaudio, system-bus, session-bus, ssh-auth. This option can be used multiple times. @@ -141,7 +141,7 @@ Don't expose a well-known socket to the application. This overrides to the Context section from the application metadata. - SOCKET must be one of: x11, wayland, fallback-x11, pulseaudio, system-bus, session-bus, ssh-auth. + SOCKET must be one of: x11, wayland, fallback-x11, pulseaudio, system-bus, session-bus, ssh-auth. This option can be used multiple times. @@ -152,7 +152,7 @@ Expose a device to the application. This overrides to the Context section from the application metadata. - DEVICE must be one of: dri, kvm, all. + DEVICE must be one of: dri, kvm, all. This option can be used multiple times. @@ -163,7 +163,7 @@ Don't expose a device to the application. This overrides to the Context section from the application metadata. - DEVICE must be one of: dri, kvm, all. + DEVICE must be one of: dri, kvm, all. This option can be used multiple times. @@ -174,7 +174,7 @@ Allow access to a specific feature. This updates the [Context] group in the metadata. - FEATURE must be one of: devel, multiarch, bluetooth, canbus. + FEATURE must be one of: devel, multiarch, bluetooth, canbus. This option can be used multiple times. See flatpak-build-finish1 @@ -188,18 +188,18 @@ Disallow access to a specific feature. This updates the [Context] group in the metadata. - FEATURE must be one of: devel, multiarch, bluetooth, canbus. + FEATURE must be one of: devel, multiarch, bluetooth, canbus. This option can be used multiple times. - + Allow the application access to a subset of the filesystem. This overrides to the Context section from the application metadata. - FS can be one of: home, host, xdg-desktop, xdg-documents, xdg-download + FILESYSTEM can be one of: home, host, xdg-desktop, xdg-documents, xdg-download xdg-music, xdg-pictures, xdg-public-share, xdg-templates, xdg-videos, xdg-run, xdg-config, xdg-cache, xdg-data, an absolute path, or a homedir-relative path like ~/dir or paths @@ -217,7 +217,7 @@ Remove access to the specified subset of the filesystem from the application. This overrides to the Context section from the application metadata. - FILESYSTEM can be one of: home, host, xdg-desktop, xdg-documents, xdg-download + FILESYSTEM can be one of: home, host, xdg-desktop, xdg-documents, xdg-download xdg-music, xdg-pictures, xdg-public-share, xdg-templates, xdg-videos, an absolute path, or a homedir-relative path like ~/dir. This option can be used multiple times. @@ -261,7 +261,7 @@ key=v1;v2; - Allow the application to own the well-known name NAME on the session bus. + Allow the application to own the well-known name NAME on the session bus. This overrides to the Context section from the application metadata. This option can be used multiple times. @@ -271,7 +271,7 @@ key=v1;v2; - Allow the application to talk to the well-known name NAME on the session bus. + Allow the application to talk to the well-known name NAME on the session bus. This overrides to the Context section from the application metadata. This option can be used multiple times. @@ -281,8 +281,8 @@ key=v1;v2; - Allow the application to own the well known name NAME on the system bus. - If NAME ends with .*, it allows the application to own all matching names. + Allow the application to own the well known name NAME on the system bus. + If NAME ends with .*, it allows the application to own all matching names. This overrides to the Context section from the application metadata. This option can be used multiple times. @@ -292,8 +292,8 @@ key=v1;v2; - Allow the application to talk to the well known name NAME on the system bus. - If NAME ends with .*, it allows the application to talk to all matching names. + Allow the application to talk to the well known name NAME on the system bus. + If NAME ends with .*, it allows the application to talk to all matching names. This overrides to the Context section from the application metadata. This option can be used multiple times. @@ -304,7 +304,7 @@ key=v1;v2; If the application doesn't have access to the real homedir, make the (homedir-relative) path - FILENAME a bind mount to the corresponding path in the per-application directory, + FILENAME a bind mount to the corresponding path in the per-application directory, allowing that location to be used for persistent data. This overrides to the Context section from the application metadata. This option can be used multiple times. @@ -315,7 +315,7 @@ key=v1;v2; - Remove overrides. If an APP is given, remove the overrides for that + Remove overrides. If an APP is given, remove the overrides for that application, otherwise remove the global overrides. @@ -324,7 +324,7 @@ key=v1;v2; - Shows overrides. If an APP is given, shows the overrides for that + Shows overrides. If an APP is given, shows the overrides for that application, otherwise shows the global overrides. diff --git a/doc/flatpak-permission-list.xml b/doc/flatpak-permission-list.xml index 46823d7c..96400c05 100644 --- a/doc/flatpak-permission-list.xml +++ b/doc/flatpak-permission-list.xml @@ -50,7 +50,7 @@ the entries in all permission store tables. When called with one argument, lists all the entries in the named table. When called with two arguments, lists the entry - in the named table for the given object ID. + in the named table for the given object ID. @@ -103,7 +103,7 @@ flatpak1, flatpak-permission-show1, flatpak-permission-remove1, - flatpak-permission-reset1, + flatpak-permission-reset1 diff --git a/doc/flatpak-permission-remove.xml b/doc/flatpak-permission-remove.xml index c9df7981..13a6770f 100644 --- a/doc/flatpak-permission-remove.xml +++ b/doc/flatpak-permission-remove.xml @@ -41,8 +41,8 @@ Description - Removes an entry for the object with id ID to the permission - store table TABLE. The ID must be in a suitable format + Removes an entry for the object with id ID to the permission + store table TABLE. The ID must be in a suitable format for the table. @@ -95,7 +95,7 @@ flatpak1, flatpak-permission-list1, flatpak-permission-show1, - flatpak-permission-reset1, + flatpak-permission-reset1 diff --git a/doc/flatpak-permission-reset.xml b/doc/flatpak-permission-reset.xml index 4e58d853..2cc8745b 100644 --- a/doc/flatpak-permission-reset.xml +++ b/doc/flatpak-permission-reset.xml @@ -94,7 +94,7 @@ flatpak1, flatpak-permission-list1, flatpak-permission-show1, - flatpak-permission-remove1, + flatpak-permission-remove1 diff --git a/doc/flatpak-permission-show.xml b/doc/flatpak-permission-show.xml index a0872b12..59e171ec 100644 --- a/doc/flatpak-permission-show.xml +++ b/doc/flatpak-permission-show.xml @@ -102,7 +102,7 @@ flatpak1, flatpak-permission-list1, flatpak-permission-remove1, - flatpak-permission-reset1, + flatpak-permission-reset1 diff --git a/doc/flatpak-ps.xml b/doc/flatpak-ps.xml index a84326d6..08b50bc9 100644 --- a/doc/flatpak-ps.xml +++ b/doc/flatpak-ps.xml @@ -43,7 +43,7 @@ To see full details of a running instance, you can open the file - /run/user/$UID/.flatpak/$INSTANCE/info, where $INSTANCE is the instance + /run/user/$UID/.flatpak/$INSTANCE/info, where $INSTANCE is the instance ID reported by flatpak ps. diff --git a/doc/flatpak-remote-add.xml b/doc/flatpak-remote-add.xml index d2ef456b..b25e5f51 100644 --- a/doc/flatpak-remote-add.xml +++ b/doc/flatpak-remote-add.xml @@ -29,15 +29,6 @@ - Add from a .flatpakrepo file: - - flatpak remote-add - OPTION - --from - NAME - LOCATION - - Manually specify repo uri and options: flatpak remote-add OPTION @@ -50,16 +41,16 @@ Description - Adds a remote repository to the flatpak repository - configuration. NAME is the name for the new - remote, and LOCATION is a url or pathname. The - LOCATION is either a flatpak repository, or a - .flatpakrepo file which describes a repository. In the - former case you may also have to specify extra options, - such as the gpg key for the repo. + Adds a remote repository to the flatpak repository configuration. + NAME is the name for the new remote, and + LOCATION is a url or pathname. + The LOCATION is either a flatpak repository, + or a .flatpakrepo file which + describes a repository. In the former case you may also have to specify + extra options, such as the gpg key for the repo. - Unless overridden with the --user or --installation options, this command + Unless overridden with the or options, this command changes the default system-wide installation. @@ -111,8 +102,8 @@ Modify a system-wide installation specified by NAME among those defined in /etc/flatpak/installations.d/. - Using --installation=default is equivalent to using - --system. + Using is equivalent to using + . @@ -232,7 +223,7 @@ flatpak-remote-modify1, flatpak-remote-delete1, flatpak-remotes1, - flatpak-flatpakrepo1 + flatpak-flatpakrepo5 diff --git a/doc/flatpak-remote-delete.xml b/doc/flatpak-remote-delete.xml index 8a0a63b1..38d16b43 100644 --- a/doc/flatpak-remote-delete.xml +++ b/doc/flatpak-remote-delete.xml @@ -44,7 +44,7 @@ NAME is the name of an existing remote. - Unless overridden with the --system, --user, or --installation options, + Unless overridden with the , , or options, this command uses either the default system-wide installation or the per-user one, depending on which has the specified REMOTE. @@ -89,8 +89,8 @@ Modify a system-wide installation specified by NAME among those defined in /etc/flatpak/installations.d/. - Using --installation=default is equivalent to using - --system. + Using is equivalent to using + . diff --git a/doc/flatpak-remote-info.xml b/doc/flatpak-remote-info.xml index ffd9bb56..c6ff80a1 100644 --- a/doc/flatpak-remote-info.xml +++ b/doc/flatpak-remote-info.xml @@ -47,12 +47,11 @@ By default, the output is formatted in a friendly format. - If you specify one of the options --show-ref, --show-commit, - --show-parent, or --show-metadata, the output is instead formatted - in a machine-readable format. + If you specify one of the options, + the output is instead formatted in a machine-readable format. - Unless overridden with the --system, --user, or --installation options, + Unless overridden with the , , or options, this command uses either the default system-wide installation or the per-user one, depending on which has the specified REMOTE. @@ -97,8 +96,8 @@ Use a system-wide installation specified by NAME among those defined in /etc/flatpak/installations.d/. - Using --installation=default is equivalent to using - --system. + Using is equivalent to using + . diff --git a/doc/flatpak-remote-ls.xml b/doc/flatpak-remote-ls.xml index 54c1adcf..af63e4db 100644 --- a/doc/flatpak-remote-ls.xml +++ b/doc/flatpak-remote-ls.xml @@ -43,14 +43,14 @@ Shows runtimes and applications that are available in the remote repository with the name REMOTE, or all remotes if one isn't specified. You can find all configured - remote repositories with flatpak-remotes1. + remote repositories with flatpak remotes. REMOTE can be a file:// URI pointing to a local repository instead of a remote name. - Unless overridden with the --system, --user, or --installation options, + Unless overridden with the , , or options, this command uses either the default system-wide installation or the per-user one, depending on which has the specified REMOTE. @@ -95,8 +95,8 @@ Use a system-wide installation specified by NAME among those defined in /etc/flatpak/installations.d/. - Using --installation=default is equivalent to using - --system. + Using is equivalent to using + . @@ -149,7 +149,7 @@ Show only those matching the specied architecture. By default, only - supported architectures are shown. Use --arch=* to show all archtectures. + supported architectures are shown. Use to show all architectures. diff --git a/doc/flatpak-remote-modify.xml b/doc/flatpak-remote-modify.xml index 75cbdd5d..18f72a29 100644 --- a/doc/flatpak-remote-modify.xml +++ b/doc/flatpak-remote-modify.xml @@ -44,7 +44,7 @@ NAME is the name for the remote. - Unless overridden with the --system, --user, or --installation options, + Unless overridden with the , , or options, this command uses either the default system-wide installation or the per-user one, depending on which has the specified REMOTE. @@ -89,8 +89,8 @@ Modify a system-wide installation specified by NAME among those defined in /etc/flatpak/installations.d/. - Using --installation=default is equivalent to using - --system. + Using is equivalent to using + . diff --git a/doc/flatpak-remote.xml b/doc/flatpak-remote.xml index 1883ab0e..4d331b0a 100644 --- a/doc/flatpak-remote.xml +++ b/doc/flatpak-remote.xml @@ -41,7 +41,7 @@ Normally, it is not necessary to edit remote config files directly, the - flatpak remote-modify command should be used to change properties of remotes. + flatpak remote-modify command should be used to change properties of remotes. diff --git a/doc/flatpak-remotes.xml b/doc/flatpak-remotes.xml index cd973296..1de4f6aa 100644 --- a/doc/flatpak-remotes.xml +++ b/doc/flatpak-remotes.xml @@ -43,7 +43,7 @@ By default, both per-user and system-wide installations - are shown. Use the --user, --system or --installation + are shown. Use the , or options to change this. @@ -86,8 +86,8 @@ Show a system-wide installation by NAME among those defined in /etc/flatpak/installations.d/. - Using --installation=default is equivalent to using - --system. + Using is equivalent to using + . diff --git a/doc/flatpak-repo.xml b/doc/flatpak-repo.xml index c00b2a6b..19abfe8b 100644 --- a/doc/flatpak-repo.xml +++ b/doc/flatpak-repo.xml @@ -44,8 +44,8 @@ If you need to modify a local repository, see the - flatpak build-update-repo command, or use the - ostree tool. + flatpak build-update-repo command, or use the + ostree tool. diff --git a/doc/flatpak-run.xml b/doc/flatpak-run.xml index 23503e11..f6a24d95 100644 --- a/doc/flatpak-run.xml +++ b/doc/flatpak-run.xml @@ -130,8 +130,8 @@ Look for the application and runtime in the system-wide installation specified by NAME among those defined in /etc/flatpak/installations.d/. - Using --installation=default is equivalent to using - --system. + Using is equivalent to using + . @@ -211,7 +211,7 @@ Share a subsystem with the host session. This overrides the Context section from the application metadata. - SUBSYSTEM must be one of: network, ipc. + SUBSYSTEM must be one of: network, ipc. This option can be used multiple times. @@ -222,7 +222,7 @@ Don't share a subsystem with the host session. This overrides the Context section from the application metadata. - SUBSYSTEM must be one of: network, ipc. + SUBSYSTEM must be one of: network, ipc. This option can be used multiple times. @@ -233,7 +233,7 @@ Expose a well known socket to the application. This overrides to the Context section from the application metadata. - SOCKET must be one of: x11, wayland, fallback-x11, pulseaudio, system-bus, session-bus, ssh-auth. + SOCKET must be one of: x11, wayland, fallback-x11, pulseaudio, system-bus, session-bus, ssh-auth. This option can be used multiple times. @@ -244,7 +244,7 @@ Don't expose a well known socket to the application. This overrides to the Context section from the application metadata. - SOCKET must be one of: x11, wayland, fallback-x11, pulseaudio, system-bus, session-bus, ssh-auth. + SOCKET must be one of: x11, wayland, fallback-x11, pulseaudio, system-bus, session-bus, ssh-auth. This option can be used multiple times. @@ -255,7 +255,7 @@ Expose a device to the application. This overrides to the Context section from the application metadata. - DEVICE must be one of: dri, kvm, all. + DEVICE must be one of: dri, kvm, all. This option can be used multiple times. @@ -266,7 +266,7 @@ Don't expose a device to the application. This overrides to the Context section from the application metadata. - DEVICE must be one of: dri, kvm, all. + DEVICE must be one of: dri, kvm, all. This option can be used multiple times. @@ -277,7 +277,7 @@ Allow access to a specific feature. This overrides to the Context section from the application metadata. - FEATURE must be one of: devel, multiarch, bluetooth. + FEATURE must be one of: devel, multiarch, bluetooth. This option can be used multiple times. See flatpak-build-finish1 @@ -291,18 +291,18 @@ Disallow access to a specific feature. This overrides to the Context section from the application metadata. - FEATURE must be one of: devel, multiarch, bluetooth. + FEATURE must be one of: devel, multiarch, bluetooth. This option can be used multiple times. - + Allow the application access to a subset of the filesystem. This overrides to the Context section from the application metadata. - FS can be one of: home, host, xdg-desktop, xdg-documents, xdg-download, + FILESYSTEM can be one of: home, host, xdg-desktop, xdg-documents, xdg-download, xdg-music, xdg-pictures, xdg-public-share, xdg-templates, xdg-videos, xdg-run, xdg-config, xdg-cache, xdg-data, an absolute path, or a homedir-relative path like ~/dir or paths @@ -320,7 +320,7 @@ Remove access to the specified subset of the filesystem from the application. This overrides to the Context section from the application metadata. - FILESYSTEM can be one of: home, host, xdg-desktop, xdg-documents, xdg-download + FILESYSTEM can be one of: home, host, xdg-desktop, xdg-documents, xdg-download xdg-music, xdg-pictures, xdg-public-share, xdg-templates, xdg-videos, an absolute path, or a homedir-relative path like ~/dir. This option can be used multiple times. @@ -364,8 +364,8 @@ key=v1;v2; - Allow the application to own the well known name NAME on the session bus. - If NAME ends with .*, it allows the application to own all matching names. + Allow the application to own the well known name NAME on the session bus. + If NAME ends with .*, it allows the application to own all matching names. This overrides to the Context section from the application metadata. This option can be used multiple times. @@ -375,8 +375,8 @@ key=v1;v2; - Allow the application to talk to the well known name NAME on the session bus. - If NAME ends with .*, it allows the application to talk to all matching names. + Allow the application to talk to the well known name NAME on the session bus. + If NAME ends with .*, it allows the application to talk to all matching names. This overrides to the Context section from the application metadata. This option can be used multiple times. @@ -386,8 +386,8 @@ key=v1;v2; - Allow the application to own the well known name NAME on the system bus. - If NAME ends with .*, it allows the application to own all matching names. + Allow the application to own the well known name NAME on the system bus. + If NAME ends with .*, it allows the application to own all matching names. This overrides to the Context section from the application metadata. This option can be used multiple times. @@ -397,8 +397,8 @@ key=v1;v2; - Allow the application to talk to the well known name NAME on the system bus. - If NAME ends with .*, it allows the application to talk to all matching names. + Allow the application to talk to the well known name NAME on the system bus. + If NAME ends with .*, it allows the application to talk to all matching names. This overrides to the Context section from the application metadata. This option can be used multiple times. @@ -409,7 +409,7 @@ key=v1;v2; If the application doesn't have access to the real homedir, make the (homedir-relative) path - FILENAME a bind mount to the corresponding path in the per-application directory, + FILENAME a bind mount to the corresponding path in the per-application directory, allowing that location to be used for persistent data. This overrides to the Context section from the application metadata. This option can be used multiple times. diff --git a/doc/flatpak-search.xml b/doc/flatpak-search.xml index c9c3a3f7..e06c5d83 100644 --- a/doc/flatpak-search.xml +++ b/doc/flatpak-search.xml @@ -41,7 +41,7 @@ Searches for applications and runtimes matching TEXT. Note that this uses appstream data - that can be updated with flatpak-update1. + that can be updated with the flatpak update command. The appstream data is updated automatically only if it's at least a day old. @@ -74,8 +74,8 @@ Show a system-wide installation by NAME among those defined in /etc/flatpak/installations.d/. - Using --installation=default is equivalent to using - --system. + Using is equivalent to using + . diff --git a/doc/flatpak-uninstall.xml b/doc/flatpak-uninstall.xml index 1ba8fef5..9a5e397c 100644 --- a/doc/flatpak-uninstall.xml +++ b/doc/flatpak-uninstall.xml @@ -53,22 +53,22 @@ By default this looks for both installed apps and runtimes with the given - REF, but you can limit this by using the --app - or --runtime option, or by supplying the initial element in the REF. + REF, but you can limit this by using the + or option, or by supplying the initial element in the REF. Normally, this command removes the ref for this application/runtime from the local OSTree repository and purges any objects that are no longer needed to free up disk space. If the same application is later reinstalled, the objects will be pulled from the remote repository - again. The --keep-ref option can be used to prevent this. + again. The option can be used to prevent this. If all branches of the application/runtime are removed, this command also purges the data directory for the application. - Unless overridden with the --system, --user, or --installation + Unless overridden with the , , or options, this command searches both the system-wide installation and the per-user one for REF and errors out if it exists in more than one. @@ -123,8 +123,8 @@ Uninstalls from a system-wide installation specified by NAME among those defined in /etc/flatpak/installations.d/. Using - --installation=default is - equivalent to using --system. + is + equivalent to using . diff --git a/doc/flatpak-update.xml b/doc/flatpak-update.xml index 205202e3..9622b0c4 100644 --- a/doc/flatpak-update.xml +++ b/doc/flatpak-update.xml @@ -60,8 +60,8 @@ By default this looks for both apps and runtimes with the given REF, - but you can limit this by using the --app or --runtime option, or by supplying the initial - element in the REF. + but you can limit this by using the or option, or by supplying the initial + element in the REF. Normally, this command updates the application to the tip @@ -80,10 +80,10 @@ a different branch, and runtime updates are expected to keep strict compatibility. If an application update does cause a problem, it is possible to go back to the previous - version, with the --commit option. + version, with the option. - Unless overridden with the --user, --system or --installation option, this command updates + Unless overridden with the , or option, this command updates any matching refs in the standard system-wide installation and the per-user one. @@ -126,8 +126,8 @@ Updates a system-wide installation specified by NAME among those defined in /etc/flatpak/installations.d/. - Using --installation=default is equivalent to using - --system. + Using is equivalent to using + . @@ -263,7 +263,8 @@ flatpak1, flatpak-install1, - flatpak-list1 + flatpak-list1, + ostree-find-remotes1