Commit Graph

32 Commits

Author SHA1 Message Date
Phaedrus Leeds
ff8490a91e app: Add -u alias for --user
Save folks a few keystrokes. There is a command which already has a '-u'
option, document-export, but it doesn't support --user so there should
be no conflict. However '-s' is used by the info command among others,
so we can't use that for --system.
2022-08-16 10:50:29 +02:00
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
3f19950936 doc/update: Fix formatting 2020-08-31 16:26:12 +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
6397200247 Update documentation for sideload-repos
It is no longer a config option; it was changed to be a directory.
2020-06-18 13:51:16 -07:00
Alexander Larsson
a843d2d594 sideload: Add api and CLI support to specify sideload repos dynamically 2020-03-24 14:01:20 +01:00
Matthew Leeds
d8853f424c doc: Improve docs for --arch options
It's not obvious what values are valid, so add a hint.

Closes: #2930
Approved by: matthiasclasen
2019-05-30 12:12:12 +00:00
Rafael Fontenelle
95e692794b Fix misspellings
Closes: #2807
Approved by: matthiasclasen
2019-04-08 12:50:42 +00:00
Matthew Leeds
d3b7bfa92d doc: Fix capitalization of gedit
It's gedit not GEdit[1][2].

[1] https://wiki.gnome.org/Apps/Gedit
[2] https://flathub.org/apps/details/org.gnome.gedit

Closes: #2788
Approved by: matthiasclasen
2019-03-30 13:02:10 +00:00
Matthias Clasen
51a7643d41 Document the new options
Closes: #2556
Approved by: alexlarsson
2019-01-11 11:42:13 +00:00
Matthias Clasen
bf7af547aa Small fixes to many man pages
Make synopses more concise in various place, improve
consistency of formatting, and fix some small mistakes
and oversights.

Closes: #2307
Approved by: matthiasclasen
2018-11-12 14:28:41 +00:00
Matthew Leeds
7decfe39ae doc: Fix my typos 2018-07-10 19:30:58 +02:00
Matthew Leeds
c9a9b3a1ee doc: Mention P2P capabilities of install/update
Fixes https://github.com/flatpak/flatpak/issues/1329
2018-07-10 19:26:06 +02:00
Matthew Leeds
f16caf23af doc: Fix typos 2018-07-10 17:54:39 +02:00
Matthew Leeds
d5606cd43a doc: Fix documentation of shared options
The --verbose and --ostree-verbose options are global to all
subcommands, but --version can only be used with the main "flatpak"
command, so fix the man pages to reflect that.
2018-06-26 00:10:55 -07:00
Matthew Leeds
8e861a854f doc: Add a hint about how to use update --commit
Closes: #1568
Approved by: alexlarsson
2018-04-12 14:30:53 +00:00
Alexander Larsson
e769cdd489 update: Update apps from both system and user installations
Unless you manually specify an installation it looks for updates
in all the standard installations.

This fixes https://github.com/flatpak/flatpak/issues/282

Closes: #1246
Approved by: alexlarsson
2017-12-13 10:03:47 +00:00
Matthew Leeds
b73e8476a7 docs: Fix a few mistakes
Some of these are grammatical errors, and some are mistakes caused by
copying phrases from the flatpak-install manpage.

Closes: #1177
Approved by: alexlarsson
2017-11-16 08:00:05 +00:00
Matthew Leeds
a218bdb282 docs: Document "flatpak update --appstream" better
The manpage description for flatpak-update's --appstream option says it
updates appstream data for the remote, but it's unclear that the remote
should be passed on the command line instead of a ref. This commit
updates the manpage to document that form of the command.

Closes: #1177
Approved by: alexlarsson
2017-11-16 08:00:05 +00:00
Alexander Larsson
105f00b918 Update appstream data on "flatpak update" (#1169)
* Update appstream data on "flatpak update"

This is especially useful since we now have flatpak search which uses
this data.

* fixup! Update appstream data on "flatpak update"
2017-11-15 21:23:55 -08: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
Matthew Leeds
66f0efda41 doc: Add docs for undocumented options
A few options aren't documented in the manpages. This commit adds
documentation for them based on the --help output and relevant commit
messages. Some of it could probably use more elaboration.
2017-03-07 21:19:02 +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
Alexander Larsson
28261d839e update/install: Install/Update runtime dependencies as needed
When an application requires a runtime that is not installed, search
for it and prompt for permissions to install it. Also, update required
runtimes when the app is being updated.
2016-10-19 12:40:49 +02:00
Alexander Larsson
70e9b2c737 update: Support specifying multiple arguments 2016-10-14 16:39:10 +02:00
Alexander Larsson
8fa7f7fe09 Add --ostree-verbose
This enables debug logging for OSTree
2016-09-27 11:37:11 +02:00
Matthew Leeds
0640491e40 doc: Fix a few mistakes
- Fix typos in doc/flatpak-install and doc/flatpak-update.

- The commands ending in -app were deprecated in commit f7a1fdaa,
so update a few remaining references to them.

- flatpak-update is used for runtimes and applications, so fix its short
description.
2016-08-10 23:06:39 -04:00
Matthias Clasen
e8599bb869 Clarify flatpak update docs
NAME is optional.
2016-08-04 18:40:09 -04:00
Matthias Clasen
414cd0afce Document --appstream option
This option of flatpak update was undocumented.
2016-08-04 14:08:09 -04:00
Alexander Larsson
5ab628d0ee Install/update/uninstall related refs
Any "related" references from the same remote are automatically
handled when installing, unless you specify --no-related.

The set of related refs is based on the declared extensions for
the main ref. By default, all such extensions are automatically
installed/updated unless they have "no-autodownload" set to false
in the extension info, and its not already installed locally.

Only extensions marked as "autodelete" will be automatically deleted
when you remove the main ref.

There is some special handling:

Any *.Debug or *.Locale extension is automatically treated as "autodelete".

A *.Locale extension that is autodownloaded will be subsetted using subpaths
such that existing subpaths are kept, and the current locale is added.
2016-06-30 16:55:32 +02:00
Josh Soref
794c62cc44 spelling: available 2016-05-27 06:37:37 +00:00
Alexander Larsson
8abbc0186e Rename everything but the on-disk location to flatpak 2016-05-09 11:11:55 +02:00