Skip to content

D
developer.puri.sm
Commit 1c229f60 authored by David Boddie's avatar David Boddie
Browse files
Options

Merge branch '120-describe-how-apps-are-installed-and-updated' into 'master' 

Add information about GNOME Software

Closes #120

See merge request !326
parents 9e24df6c c48fac78
Hide whitespace changes
Inline Side-by-side
Showing with 330 additions and 1 deletion
Package_Management/Graphical_Tools/images/org.gnome.Software.svg 0 → 100644
View file @ 1c229f60
<?xml version="1.0" encoding="UTF-8" standalone="no"?>
<svg
xmlns:dc="http://purl.org/dc/elements/1.1/"
xmlns:cc="http://creativecommons.org/ns#"
xmlns:rdf="http://www.w3.org/1999/02/22-rdf-syntax-ns#"
xmlns:svg="http://www.w3.org/2000/svg"
xmlns="http://www.w3.org/2000/svg"
xmlns:xlink="http://www.w3.org/1999/xlink"
viewBox="0 0 128 128"
style="display:inline;enable-background:new"
version="1.0"
id="svg11300"
height="128"
width="128">
<title
id="title4162">Adwaita Icon Template</title>
<defs
id="defs3">
<linearGradient
id="linearGradient1494">
<stop
id="stop1490"
offset="0"
style="stop-color:#babdb6;stop-opacity:1;" />
<stop
id="stop1492"
offset="1"
style="stop-color:#babdb6;stop-opacity:0;" />
</linearGradient>
<linearGradient
gradientUnits="userSpaceOnUse"
y2="20"
x2="280"
y1="172"
x1="280"
id="linearGradient1496"
xlink:href="#linearGradient1494" />
</defs>
<metadata
id="metadata4">
<rdf:RDF>
<cc:Work
rdf:about="">
<dc:format>image/svg+xml</dc:format>
<dc:type
rdf:resource="http://purl.org/dc/dcmitype/StillImage" />
<dc:creator>
<cc:Agent>
<dc:title>GNOME Design Team</dc:title>
</cc:Agent>
</dc:creator>
<dc:source />
<cc:license
rdf:resource="http://creativecommons.org/licenses/by-sa/4.0/" />
<dc:title>Adwaita Icon Template</dc:title>
<dc:subject>
<rdf:Bag />
</dc:subject>
<dc:date />
<dc:rights>
<cc:Agent>
<dc:title />
</cc:Agent>
</dc:rights>
<dc:publisher>
<cc:Agent>
<dc:title />
</cc:Agent>
</dc:publisher>
<dc:identifier />
<dc:relation />
<dc:language />
<dc:coverage />
<dc:description />
<dc:contributor>
<cc:Agent>
<dc:title />
</cc:Agent>
</dc:contributor>
</cc:Work>
<cc:License
rdf:about="http://creativecommons.org/licenses/by-sa/4.0/">
<cc:permits
rdf:resource="http://creativecommons.org/ns#Reproduction" />
<cc:permits
rdf:resource="http://creativecommons.org/ns#Distribution" />
<cc:requires
rdf:resource="http://creativecommons.org/ns#Notice" />
<cc:requires
rdf:resource="http://creativecommons.org/ns#Attribution" />
<cc:permits
rdf:resource="http://creativecommons.org/ns#DerivativeWorks" />
<cc:requires
rdf:resource="http://creativecommons.org/ns#ShareAlike" />
</cc:License>
</rdf:RDF>
</metadata>
<g
transform="translate(0,-172)"
style="display:inline"
id="layer1">
<g
style="display:inline"
id="layer9">
<rect
style="opacity:1;vector-effect:none;fill:#98c1f1;fill-opacity:1;stroke:none;stroke-width:8;stroke-linecap:round;stroke-linejoin:round;stroke-miterlimit:4;stroke-dasharray:none;stroke-dashoffset:0;stroke-opacity:0.6732283"
id="rect1127"
width="104"
height="44"
x="12"
y="244"
rx="8"
ry="8" />
<g
transform="rotate(-30,403.50258,307.81151)"
id="g1710" />
<rect
style="opacity:1;vector-effect:none;fill:#e7f0fc;fill-opacity:1;stroke:none;stroke-width:27.71278;stroke-linecap:butt;stroke-linejoin:round;stroke-miterlimit:4;stroke-dasharray:none;stroke-dashoffset:0;stroke-opacity:1;marker:none;marker-start:none;marker-mid:none;marker-end:none;paint-order:normal"
id="rect1051"
width="104"
height="88"
x="12"
y="192" />
<g
id="g1292">
<circle
style="opacity:1;fill:#1a5fb4;fill-opacity:1;stroke:none;stroke-width:4;stroke-linecap:round;stroke-linejoin:round;stroke-miterlimit:4;stroke-dasharray:none;stroke-dashoffset:0;stroke-opacity:1"
id="path1047"
cx="50"
cy="201"
r="5" />
<circle
r="5"
cy="201"
cx="78"
id="circle1049"
style="opacity:1;fill:#1a5fb4;fill-opacity:1;stroke:none;stroke-width:4;stroke-linecap:round;stroke-linejoin:round;stroke-miterlimit:4;stroke-dasharray:none;stroke-dashoffset:0;stroke-opacity:1" />
</g>
<path
id="rect1044"
d="m 50,200 v -8 c 0,-7.756 6.244,-14 14,-14 7.756,0 14,6.244 14,14 v 8"
style="opacity:1;fill:none;fill-opacity:1;stroke:#62a0ea;stroke-width:4;stroke-linecap:round;stroke-linejoin:round;stroke-miterlimit:4;stroke-dasharray:none;stroke-dashoffset:0;stroke-opacity:1" />
<path
style="display:inline;opacity:1;fill:#3584e4;fill-opacity:1;stroke:none;stroke-width:0.0112982px;stroke-linecap:butt;stroke-linejoin:miter;stroke-miterlimit:4;stroke-dasharray:none;stroke-dashoffset:0;stroke-opacity:1;marker:none;marker-start:none;marker-mid:none;marker-end:none;paint-order:normal;enable-background:new"
d="m 64,216 a 20,20.000002 0 0 0 -20,20 20,20.000002 0 0 0 20,20 20,20.000002 0 0 0 20,-20 20,20.000002 0 0 0 -20,-20 z m -8,10 a 1.9999997,2 0 0 1 2,2 1.9999997,2 0 0 1 -2,2 1.9999997,2 0 0 1 -2,-2 1.9999997,2 0 0 1 2,-2 z m 8,0 a 1.9999997,2 0 0 1 2,2 1.9999997,2 0 0 1 -2,2 1.9999997,2 0 0 1 -2,-2 1.9999997,2 0 0 1 2,-2 z m 8,0 a 1.9999997,2 0 0 1 2,2 1.9999997,2 0 0 1 -2,2 1.9999997,2 0 0 1 -2,-2 1.9999997,2 0 0 1 2,-2 z m -16,8 a 1.9999997,2 0 0 1 2,2 1.9999997,2 0 0 1 -2,2 1.9999997,2 0 0 1 -2,-2 1.9999997,2 0 0 1 2,-2 z m 8,0 a 1.9999997,2 0 0 1 2,2 1.9999997,2 0 0 1 -2,2 1.9999997,2 0 0 1 -2,-2 1.9999997,2 0 0 1 2,-2 z m 8,0 a 1.9999997,2 0 0 1 2,2 1.9999997,2 0 0 1 -2,2 1.9999997,2 0 0 1 -2,-2 1.9999997,2 0 0 1 2,-2 z m -16,8 a 1.9999997,2 0 0 1 2,2 1.9999997,2 0 0 1 -2,2 1.9999997,2 0 0 1 -2,-2 1.9999997,2 0 0 1 2,-2 z m 8,0 a 1.9999997,2 0 0 1 2,2 1.9999997,2 0 0 1 -2,2 1.9999997,2 0 0 1 -2,-2 1.9999997,2 0 0 1 2,-2 z m 8,0 a 1.9999997,2 0 0 1 2,2 1.9999997,2 0 0 1 -2,2 1.9999997,2 0 0 1 -2,-2 1.9999997,2 0 0 1 2,-2 z"
id="path920" />
</g>
<g
style="fill:url(#linearGradient1496);fill-opacity:1"
id="g1480" />
</g>
</svg>
Package_Management/Graphical_Tools/index.rst
View file @ 1c229f60
......@@ -5,6 +5,9 @@ Graphical Tools
Most users will prefer to use graphical applications and tools to manage the software on their phone. This page describes the default application for doing this as well as any alternatives.
.. contents::
:local:
Users and software developers may prefer to use other tools that they are more comfortable with, or those that give them more control over package management on their phone. The later sections in this chapter cover installation, uninstallation, updating and upgrading of packages from a command line user's perspective.
GNOME Software
......@@ -13,4 +16,177 @@ GNOME Software
Although there are two different types of package format used on the Librem 5, packaged software can be installed using the `GNOME Software`_ application, which provides an easy-to-use graphical interface for searching, installing and
uninstalling packages.
.. note:: This section will be expanded later to cover some common tasks, as well as describing some alternative tools for managing packages.
Launching GNOME Software
~~~~~~~~~~~~~~~~~~~~~~~~
Launch GNOME Software by locating its icon in the app drawer.
.. image:: images/org.gnome.Software.svg
:align: center
:alt: The GNOME Software icon
When it is run, GNOME Software should show a page like the one shown below, with a list of **Categories** above the **Recent Releases**.
.. figure:: images/gnome-software-categories.png
:align: center
:scale: 50%
:alt: The GNOME Software start page, giving access to all available applications
The starting page shows some common categories, as well as a collection of recent releases.
The header bar contains a search button that can be used to :ref:`search for applications <package_management_gnome_software_searching>` and a menu that allows you to :ref:`add new software sources <package_management_gnome_software_sources>`.
At the bottom of the screen, you can choose between three modes:
.. image:: images/gnome-software-modes.png
:align: center
:scale: 50%
:alt: The three modes that can be selected
These modes are used to perform different tasks:
1. **All** allows you to browse all the applications, including those you have installed and those that are available to download.
2. **Installed** shows only the :ref:`applications that have been installed <package_management_gnome_software_installed>`, either as system defaults or by you.
3. **Updates** shows the applications and other components that require updating, and allows you to :ref:`update them individually or as a whole <package_management_gnome_software_updating>`
The following sections describe how to perform some common package management tasks.
.. _package_management_gnome_software_installed:
Showing Installed Applications
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Select the tab for the **Installed** mode at the bottom of the screen.
.. figure:: images/gnome-software-installed.png
:align: center
:scale: 50%
:alt: The GNOME Software installed software page
The installed software page shows the applications and components that have been installed.
Each of the installed applications can be uninstalled by pressing the minus ``-`` button to the right of the application's name and icon. You will be asked to confirm that you wish to uninstall the application.
.. _package_management_gnome_software_searching:
Searching for Applications
~~~~~~~~~~~~~~~~~~~~~~~~~~
On the **All** page, you can find a search button at the left edge of the header bar. Pressing this button causes a search bar to appear. The on-screen keyboard should also appear, allowing you to enter keywords.
.. figure:: images/gnome-software-search-start.png
:align: center
:scale: 50%
:alt: Opening the search bar
The search bar is shown when the search button is pressed when the **All** page is shown.
Enter the search terms for the application you are looking for. The page will update to show appropriate matches as you enter text, finding applications based on their `AppStream metadata`_ (see the :ref:`Treasure example <examples_Treasure_data_dir>` for more information about this).
.. figure:: images/gnome-software-search-results.png
:align: center
:scale: 50%
:alt: Searching for an application
The search results are automatically updated as you enter search terms.
Once you have found a suitable application, select it in the list of result to show more information about it. You can always return to the search results by pressing the back button at the left edge of the header bar.
.. _package_management_gnome_installing:
Installing an Application
~~~~~~~~~~~~~~~~~~~~~~~~~
Once you have found an application you want to install, you can review the description, software license and other details on its information page.
.. figure:: images/gnome-software-install-app.png
:align: center
:scale: 50%
:alt: Viewing an application's information
Each application can be examined to show more information about it.
You may then choose to install the application by pressing the **Install** button, or press the back button at the left edge of the header bar to return to the search results.
When you decide to install the application, progress on the installation process is reported above the description of the application.
.. figure:: images/gnome-software-installing-app.png
:align: center
:scale: 50%
:alt: Installing an application
Progress is shown as an application is installed.
When the application has finished installing, you can launch it immediately by pressing the **Launch** button. If you changed your mind, you can also remove it by pressing the **Remove** button. You will be asked for confirmation before the application is uninstalled.
.. figure:: images/gnome-software-installed-app.png
:align: center
:scale: 50%
:alt: Viewing an installed application's information
An installed application can be launched or removed from its information page.
Installed applications are available in the shell's app drawer, so you do not need to use GNOME Software to launch them.
.. _package_management_gnome_software_updating:
Updating Applications
~~~~~~~~~~~~~~~~~~~~~
It is a good idea to update applications and other components regularly to ensure that you have the latest versions of them. These should contain fixes for any problems that have been reported by users and developers.
.. figure:: images/gnome-software-updates.png
:align: center
:scale: 50%
:alt: The GNOME Software updates page
The updates page shows the applications and components that require updating.
Each application that requires an update can be updated individually by pressing the button on the right hand side of its name. The amount of data that will be downloaded is shown below this button.
Alternatively, you can press the **Update All** button to update all applications that require updates. *Note that this may require large amounts of data to be downloaded.*
When you update an application, the button to the right of it becomes an update indicator which shows the progress being made to download new data.
.. figure:: images/gnome-software-updating-app.png
:align: center
:alt: Updating a component
When an application or component is updating, progress is shown underneath the update indicator.
The application or component will be removed from the list of updates after it has been updated.
You can configure how updates are handled by opening the application menu and selecting the **Update Preferences** item.
.. figure:: images/gnome-software-menu.png
:align: center
:alt: Opening the application menu
The application menu contains an option to change the update preferences.
Selecting this item opens a page that allows you to configure
.. figure:: images/gnome-software-update-preferences.png
:align: center
:alt: The Update Preferences page
The Update Preferences page contains options for managing software updates.
When you have adjusted the options, press the back button to return to the previous view.
.. _package_management_gnome_software_sources:
Adding New Software Sources
~~~~~~~~~~~~~~~~~~~~~~~~~~~
Packages can be downloaded from a variety of sources. To configure these, open the menu by pressing the button at the right hand edge of the header bar.
.. figure:: images/gnome-software-menu.png
:align: center
:alt: Opening the application menu
The application menu contains an option to configure the software repositories.
Select the **Software Repositories** item to launch a separate tool for adding, removing and configuring the remote repositories containing software that can be downloaded.
.. include:: /links.txt
links.txt
View file @ 1c229f60
.. _`Actions section`: https://python-gtk-3-tutorial.readthedocs.io/en/latest/application.html#actions
.. _`AppStream`: https://www.freedesktop.org/software/appstream/docs/
.. _`AppStream metadata`: https://www.freedesktop.org/software/appstream/docs/chap-Metadata.html
.. _`Building your first Flatpak`: http://docs.flatpak.org/en/latest/first-build.html
.. _`community/librem-5`: https://matrix.to/#/#community-librem-5:talk.puri.sm
.. _`community/librem-5-apps`: https://matrix.to/#/#community-librem-apps:talk.puri.sm
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment