50 Commits

Author SHA1 Message Date
Phaedrus Leeds
c932a57f4f doc: Tweak a few man pages
Make it clear what the current behavior is for sideloading from local
sources as well as for uninstalling unused EOL runtimes.
2022-02-17 10:37:25 -06:00
Phaedrus Leeds
79a91b5cf6 Make flatpak --help output use consistent verbiage
Use present tense consistently rather than gerunds for some headings in
"flatpak --help". Also tweak flatpak(1) to use similar wording but with
gerunds.
2021-03-10 10:27:31 +01:00
Philip Withnall
9411fe2bca flatpak: Add --print-updated-env option to print environment
This is the environment needed to use flatpaks; a following commit will
hook this up to the systemd environment generator.

Signed-off-by: Philip Withnall <pwithnall@endlessos.org>
2020-12-22 14:21:54 +01:00
Phaedrus Leeds
2325b81401 Minor fixes for mask command 2020-08-31 16:29:03 +02:00
Matthew Leeds
d2d5397cc1 Add pin command to keep unused runtimes
As discussed here [1], we want a way to mark runtimes to be kept even
when they are unused by any apps and we are removing such runtimes.
Currently this is a command that can be run manually; a subsequent
commit will pin runtimes automatically if they are installed
independently of any app.

A unit test is included.

[1] https://github.com/flatpak/flatpak/issues/2639#issuecomment-662311756
2020-08-31 16:29:03 +02:00
Jan Tojnar
eb57c7c07b Unify DocBook DTDs
Previously, there were three different DTDs used. Let's switch to a single one.

We will go with 4.5, since it is latest version that does not have any backwards incompatible changes.
2020-08-10 15:14:38 +02:00
Matthew Leeds
5a646117c9 Don't mention $FLATPAK_RUN_DIR in docs
We only want the run dir to be overridable in unit tests because we
depend on it being /run/flatpak in flatpak-create-sideload-symlinks.sh,
so don't mention it in the flatpak man page.
2020-06-23 09:37:10 +02:00
Matthew Leeds
e84b75629d Allow sideload-repos to link to the root of a USB
Currently we only support links in /var/lib/flatpak/sideload-repos,
/run/flatpak/sideload-repos, etc. to be actual ostree repos, but this
commit makes it so you can also link to the root directory of a USB,
and Flatpak will check the subpaths "ostree/repo", ".ostree/repo", and
".ostree/repos.d" for compatibility with "flatpak create-usb". This will
allow the logic in the following commit to be much simpler, where we're
linking to hot-plugged drives in a script run by systemd.

Note that we still only allow actual repos in the other places where a
sideload path can be specified, such as the --sideload-repo CLI option.
2020-06-23 09:37:10 +02:00
Alexander Larsson
bae8eef87d docs: Tweaks to sideload repo docs 2020-03-30 15:37:45 +02:00
Alexander Larsson
15c761d482 Use symlinks instead of xa.sideload-repos config option
Instead of having a global config option we scan a directory for
symlinks into the sideload repos. These come from
/var/lib/flatpak/sideload-repos and /run/flatpak/sideload-repos (for
default system installation).

This is much easier to update atomically, and the two different
options are useful for persistant (the first) or dynamic (the second)
usescase.

Fixes https://github.com/flatpak/flatpak/issues/3494
2020-03-26 11:50:54 +01:00
Matthias Clasen
959d71f7dc docs: Add flatpak permissions-set to command list
This new command was missing from flatpak(1) and
from the references in other permission commands.
2019-12-01 16:26:14 -05:00
Matthias Clasen
8a338dff32 Fix a doc typo
The docs refer to flatpakref files in /etc/flatpak/remotes.d,
but the code is looking for flatpakrepo files there.
2019-10-03 22:23:30 -04:00
Alexander Larsson
9c715096aa man: Reference flatpak-mask.1 from flatpak.1 2019-09-30 10:52:06 +02:00
Alexander Larsson
39946c3959 Support .flatpakrepo files in /etc/flatpak/remotes.d
A *.flatpakrepo file in this directory will be automatically
added as a system remote with the basename (sans extension) as the
name unless that name already exist. Also, once this is done we
record the name in the repo config so that it is not applied again if
the remote is removed.

Closes: #2884
Approved by: alexlarsson
2019-05-08 08:13:52 +00:00
Alexander Larsson
6ee61a29fd Remove support for /etc/flatpak/remotes.d config files
This kind of remotes don't work very well, because they are not modifiable
or removable and can cause conflicts with pre-existing remotes.

We instead want to switch to a way to define default remotes that
is applied to the regular ostree repo config, allowing later changes.

Closes: #2884
Approved by: alexlarsson
2019-05-08 08:13:52 +00:00
Matthew Leeds
5e710cb995 doc/flatpak: Document FLATPAK_SYSTEM_CACHE_DIR
This environment variable has been used for a while; it's just
undocumented. Copy some information from a comment in flatpak-dir.c.

Closes: #2841
Approved by: matthiasclasen
2019-04-20 17:41:34 +00:00
Rafael Fontenelle
95e692794b Fix misspellings
Closes: #2807
Approved by: matthiasclasen
2019-04-08 12:50:42 +00:00
Matthias Clasen
4f915388a5 Document --installations
Closes: #2122
Approved by: matthiasclasen
2019-01-08 00:26:17 +00:00
Matthew Leeds
5238dd4f4b doc: Update wording for verbose options
This more closely matches the recently changed --help output for these
options, and distinguishes them from the options that only print some
information and exit.

Closes: #2537
Approved by: matthiasclasen
2019-01-04 03:53:19 +00:00
Matthias Clasen
5bb7d9aec6 docs: Small improvements
Make it clear that flatpak(1) only lists global options,
and individual commands have their own.

Add a reference to flatpak-installation(5)

Closes: #2513
Approved by: mwleeds
2019-01-03 22:38:55 +00:00
Matthias Clasen
dc5a451389 Add docs for flatpak-spawn
Add a flatpak-spawn(1) man page. While it is not ideal
to have the docs live separately from the code, having
it here ensures that it will be available everywhere
all the other flatpak documentation is.

Closes: #2437
Approved by: alexlarsson
2018-12-17 08:29:52 +00:00
Matthias Clasen
d613bc0532 Minor revisions of flatpak(1)
Capitalize Flatpak in text, add a paragraph about building
that references flatpak-builder, and add a reference to
www.flatpak.org.

Closes: #2410
Approved by: alexlarsson
2018-12-10 07:15:12 +00:00
Matthias Clasen
754d68c74a Rename list commands
Rename permission-list and document-list to
permissions and documents, for consistency with
how we handle remotes. The old command names
are kept as hidden aliases.

Closes: #2131

Closes: #2366
Approved by: mwleeds
2018-12-03 19:46:09 +00:00
Matthias Clasen
afc87ad1e5 Add a history command
The history command pulls the transaction log entries
out of the journal, and presents them nicely.

We use the sd-journal api for this, so we need to
link against libsystemd now, but we make the dependency
optional. If libsystemd is not available, the history
command will simply print an error.
2018-10-11 14:51:51 +02:00
Matthias Clasen
9c84b88e46 Add a kill command
This sends SIGKILL to a running sandbox process.
The command has completion for running applications,
for both application IDs and instance IDs.

Closes: #2180

Closes: #2181
Approved by: alexlarsson
2018-10-10 06:28:28 +00:00
Matthias Clasen
e03c61ebbc Add file format docs to flatpak.1
The flatpak.1 man page serves as an overview page that lists
all the individual command man pages. Make it a complete
overview by listing the file format man pages as well.

Closes: #1944
Approved by: alexlarsson
2018-08-07 09:30:30 +00:00
Matthew Leeds
e959fd3db0 WIP: Add a create-usb command
Fixes https://github.com/flatpak/flatpak/issues/1672

Closes: #1828
Approved by: alexlarsson
2018-07-07 15:25:50 +00:00
Matthew Leeds
ed4dba55a3 doc/flatpak.xml: Add permission-* commands 2018-06-29 10:25:56 -07:00
Matthew Leeds
0c27279895 doc: Add missing commands to flatpak(1) 2018-06-25 22:02:06 -07:00
Matthew Leeds
32723a2b1d doc: Fix build-bundle docs
The build-bundle command takes a repository directory, not a build
directory.

Closes https://github.com/flatpak/flatpak/issues/1382

Closes: #1385
Approved by: alexlarsson
2018-02-06 09:10:42 +00:00
Matthew Leeds
3a14aef1d2 doc: Document -vv option
Closes: #1377
Approved by: alexlarsson
2018-02-05 15:58:29 +00:00
Alexander Larsson
0a9ae464f6 Add remote-info command
This shows information about a ref in a remote. Of particular interest
is the --log option which gives you a history which can be used
with update --commit=XXX to roll back an update.

Closes: #1174
Approved by: alexlarsson
2017-11-21 11:16:06 +00:00
Patrick Griffis
61daf53674 docs: Add flatpak-search man page
Closes: #1176
Approved by: mwleeds
2017-11-16 07:26:28 +00:00
Alexander Larsson
9e1e982bf8 Add flatpak config option
This is currenly only used to configure the languages to install.

Closes: #1098
Approved by: alexlarsson
2017-10-11 12:48:07 +00:00
Matthias Clasen
1137c64bf6 Document some environment variables (#754)
* Document some environment variables

These are only the most 'official' looking ones.
2017-05-02 14:52:51 +02:00
Matthias Clasen
9bec505464 doc: Add a manpage for the repo config format
We support dropping files in this format into /etc/flatpak/remotes.d/,
so we should document the file format.
2017-04-10 08:12:37 +02:00
Matthias Clasen
40fde38232 docs: Add a / to all mentions of installations.d
This is how we indicate other config drop-in directories,
so be consistent about this.
2017-04-10 08:12:37 +02:00
Matthias Clasen
ebb1155541 doc: Align build commands with --help
Move build-sign to the same position it has in --help output,
and add build-commit-from to the list of commands.
2017-04-10 08:12:37 +02:00
Matthias Clasen
c768d39ea9 docs: Add flatpak make-current to the list of commands
This was missing.
2017-04-10 08:12:37 +02:00
Alexander Larsson
8f62e46265 Add flatpak --gl-drivers to show the active drivers 2017-02-06 14:37:27 +01:00
Alexander Larsson
f0cad76ff8 Rename flatpak remote-list to flatpak remotes
The old name is deprecated and not documented, but still
works.

Fixes https://github.com/flatpak/flatpak/issues/482
2017-01-26 10:41:18 +01:00
Mario Sanchez Prada
40eb7fb07d Add bits to document the multiple installations feature
Documented the --installation parameter for all the CLI commands
that accept it, and added a small generic description in the main
flatpak document.
2016-12-19 15:12:06 +01:00
Matthias Clasen
6062987162 Document who remotes can be preconfigured
This is interesting information for distributors.
2016-10-26 20:17:51 +02:00
Tiago Gomes
847fdc657f Docs: update system-wide directory used by flatpak 2016-10-07 15:51:38 +01:00
Alexander Larsson
8fa7f7fe09 Add --ostree-verbose
This enables debug logging for OSTree
2016-09-27 11:37:11 +02:00
Alexander Larsson
8740a9ded3 Add flatpak --supported-arches 2016-06-23 11:12:28 +02:00
Matthias Clasen
c35d7d141a Update overview man page
Group the document-related commands together, and add the new ones.
2016-06-16 15:05:18 -04:00
Matthias Clasen
98a66ce6d8 Rename export-file to document-export
This fits better with the naming scheme for commands in general, and
will let us add more document portal related commands in the future.
2016-06-15 14:07:36 -04:00
Josh Soref
4dad6b458e spelling: repositories 2016-05-27 06:45:39 +00:00
Alexander Larsson
8abbc0186e Rename everything but the on-disk location to flatpak 2016-05-09 11:11:55 +02:00