You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: source/contact.rst
+4-4Lines changed: 4 additions & 4 deletions
Original file line number
Diff line number
Diff line change
@@ -3,22 +3,22 @@
3
3
Contact
4
4
=======
5
5
6
-
The AppImage project documentation is brought to you by `the AppImage team <https://github.com/AppImage>`_. The source code is available `on GitHub <https://github.com/AppImage/docs.appimage.org>`_.
6
+
The AppImage project documentation is brought to you by `the AppImage team <https://github.com/AppImage>`__. The source code is available `on GitHub <https://github.com/AppImage/docs.appimage.org>`__.
7
7
8
8
This page outlines how you can contact the team behind AppImage, e.g., to get additional support or have questions answered.
9
9
10
10
11
11
IRC
12
12
---
13
13
14
-
If you have further questions, please feel free to contact the AppImage team. The easiest and fastest way is to join our `IRC channel #appimage <irc://chat.freenode.net/appimage>`_ on `Freenode <https://freenode.net>`_ (`webchat <https://webchat.freenode.net/?channels=appimage>`_).
14
+
If you have further questions, please feel free to contact the AppImage team. The easiest and fastest way is to join our `IRC channel #appimage <irc://chat.freenode.net/appimage>`__ on `Freenode <https://freenode.net>`__ (`webchat <https://webchat.freenode.net/?channels=appimage>`__).
15
15
16
16
.. note::
17
17
18
-
Please beware that it might take a few minutes/hours until someone will check the chat and might be able to help you, so don't give up too quickly, and leave e.g., the tab open in the background if you can. You can also try at other times again. Please read `this article <https://workaround.org/getting-help-on-irc/>`_ before joining the IRC chat if you are new to IRC.
18
+
Please beware that it might take a few minutes/hours until someone will check the chat and might be able to help you, so don't give up too quickly, and leave e.g., the tab open in the background if you can. You can also try at other times again. Please read `this article <https://workaround.org/getting-help-on-irc/>`__ before joining the IRC chat if you are new to IRC.
19
19
20
20
21
21
Forum
22
22
-----
23
23
24
-
A slower but more sustainable way is to use the `Discourse forum <https://discourse.appimage.org>`_. You can log in using your existing Google or GitHub account, or alternatively register a local account with your email address.
24
+
A slower but more sustainable way is to use the `Discourse forum <https://discourse.appimage.org>`__. You can log in using your existing Google or GitHub account, or alternatively register a local account with your email address.
Copy file name to clipboardExpand all lines: source/introduction/concepts.rst
+3-3Lines changed: 3 additions & 3 deletions
Original file line number
Diff line number
Diff line change
@@ -19,7 +19,7 @@ AppImages are simple to understand. Every AppImage is a regular file, and every
19
19
.. _ref-opinion-reusable-frameworks:
20
20
.. note::
21
21
22
-
On a regular basis, `users ask <https://github.com/AppImage/AppImageKit/issues/848>`_ about implementing support for some sort of "reusable/shared frameworks". These frameworks are supposed to contain bundles of libraries which are needed by more than one AppImage, and hence could save some disk space. For management, they suggest complex automagic systems that will automatically fetch the "frameworks" from the Internet if they're not available, or some complicated, mostly manual methods how to users could bundle frameworks together with the AppImages on portable disks like USB sticks.
22
+
On a regular basis, `users ask <https://github.com/AppImage/AppImageKit/issues/848>`__ about implementing support for some sort of "reusable/shared frameworks". These frameworks are supposed to contain bundles of libraries which are needed by more than one AppImage, and hence could save some disk space. For management, they suggest complex automagic systems that will automatically fetch the "frameworks" from the Internet if they're not available, or some complicated, mostly manual methods how to users could bundle frameworks together with the AppImages on portable disks like USB sticks.
23
23
24
24
These may be good ideas for some people, and even if they worked perfectly fine, they'd break with our most important concept: :ref:`one app = one file <one-app-one-file-principle>`. AppImages are so simple to understand *because* every application is a single file. There's no complexity in this approach, even grandma could understand it. And after all, disk space is cheap nowadays, right?
25
25
@@ -35,7 +35,7 @@ The author of an AppImage needs to decide for which target systems (Linux distri
35
35
36
36
To be able to run on any Linux distribution, an AppImage should bundle all the resources it needs at runtime that cannot be reasonably expected to be "there" in the default installation of all still-supported target systems (Linux distributions). The most common resources are the actual binaries, shared library dependencies, icons and other graphics and of course one or more desktop files for desktop integration.
37
37
38
-
This doesn't mean an AppImage must not use resources provided by the system, like for example basic libraries that can be assumed to be part of every target system (e.g., the C standard library or graphics libraries), user interface themes or the like. See the `excludelist <https://github.com/AppImage/pkg2appimage/blob/master/excludelist>`_ for a list of the libraries we consider to currently be part of each still-supported target system (distribution).
38
+
This doesn't mean an AppImage must not use resources provided by the system, like for example basic libraries that can be assumed to be part of every target system (e.g., the C standard library or graphics libraries), user interface themes or the like. See the `excludelist <https://github.com/AppImage/pkg2appimage/blob/master/excludelist>`__ for a list of the libraries we consider to currently be part of each still-supported target system (distribution).
39
39
40
40
41
41
.. _build-on-old-systems:
@@ -49,7 +49,7 @@ Applications should be built on the oldest possible system, allowing them to run
49
49
50
50
It may seem contradictory to :ref:`the previous section <no-external-dependencies>` to rely on distribution provided resources. This is a trade-off between trying to reduce redundancies while at the same time being as self-contained as possible.
51
51
52
-
In some cases, including the libraries might even break the AppImage on the target system. Those libraries involve, among others, hardware dependent libraries such as graphics card drivers provided libraries (e.g., :code:`libGL.so.1`, (`source <https://github.com/AppImage/pkg2appimage/blob/14c255b528dd88ef3e00ae0446ac6d84a20ac798/excludelist\#L38-L41>`_)), or libraries that are build and linked differently on different distributions (e.g., :code:`libharfbuzz.so.0` and :code:`libfreetype.so.6` (`source <https://github.com/AppImage/pkg2appimage/blob/14c255b528dd88ef3e00ae0446ac6d84a20ac798/excludelist\#L98-L102>`_).
52
+
In some cases, including the libraries might even break the AppImage on the target system. Those libraries involve, among others, hardware dependent libraries such as graphics card drivers provided libraries (e.g., :code:`libGL.so.1`, (`source <https://github.com/AppImage/pkg2appimage/blob/14c255b528dd88ef3e00ae0446ac6d84a20ac798/excludelist\#L38-L41>`__)), or libraries that are build and linked differently on different distributions (e.g., :code:`libharfbuzz.so.0` and :code:`libfreetype.so.6` (`source <https://github.com/AppImage/pkg2appimage/blob/14c255b528dd88ef3e00ae0446ac6d84a20ac798/excludelist\#L98-L102>`__).
53
53
54
54
The list of libraries that can resp. have to be excluded, the so-called :ref:`excludelist <excludelist>`, is carefully curated by the AppImage team, and is regularly updated.
Copy file name to clipboardExpand all lines: source/introduction/software-overview.rst
+4-4Lines changed: 4 additions & 4 deletions
Original file line number
Diff line number
Diff line change
@@ -20,7 +20,7 @@ AppImage project
20
20
AppImageKit
21
21
-----------
22
22
23
-
`AppImageKit <https://github.com/AppImage/AppImageKit>`_ is the reference implementation of the :ref:`AppImage specification <appimage-specification>`. It is split up into several components, which are described in this subsection.
23
+
`AppImageKit <https://github.com/AppImage/AppImageKit>`__ is the reference implementation of the :ref:`AppImage specification <appimage-specification>`. It is split up into several components, which are described in this subsection.
24
24
25
25
26
26
.. _ref-runtime:
@@ -42,7 +42,7 @@ appimagetool is the easiest way to create AppImages from existing directories on
42
42
43
43
appimagetool implements all optional features, like for instance :ref:`update information <update-information>`, :ref:`signing <signing>`, and some linting options to make sure the information in the AppImage is valid (for instance, it can validate :ref:`AppStream files <appstream-support>`).
44
44
45
-
**Download:** You can get it as an AppImage from https://github.com/AppImage/AppImageKit/releases/continuous.
45
+
**Download:** You can get it as an AppImage from https://github.com/AppImage/AppImageKit/releases/continuous.
46
46
47
47
48
48
AppRun
@@ -108,7 +108,7 @@ The project consists of two tools: :code:`appimageupdatetool`, a full-featured C
108
108
appimaged
109
109
---------
110
110
111
-
`appimaged <https://github.com/AppImage/appimaged>`_ is a daemon that monitors a predefined set of directories on the system, looking for AppImages. It automatically integrates all AppImages it can find during an initial search, and then live watches for new AppImage (or AppImages that were removed) and (de)integrates these immediately.
111
+
`appimaged <https://github.com/AppImage/appimaged>`__ is a daemon that monitors a predefined set of directories on the system, looking for AppImages. It automatically integrates all AppImages it can find during an initial search, and then live watches for new AppImage (or AppImages that were removed) and (de)integrates these immediately.
112
112
113
113
It is shipped in a few native distribution package formats as well as as AppImage.
114
114
@@ -142,7 +142,7 @@ linuxdeploy
142
142
143
143
linuxdeploy_ is a simple yet flexible, plugins-based to use tool that can be used to create AppDirs and AppImages. It has been developed in 2018, and describes itself as an "AppDir creation and maintenance tool".
144
144
145
-
linuxdeploy is planned to succeed of :ref:`linuxdeployqt`, and can be used in all projects that use :ref:`linuxdeployqt`. The list of plugins is continually growing, providing solutions for bundling frameworks such as `Qt <https://github.com/linuxdeploy/linuxdeploy-plugin-qt>`_ as well as complete environments for non-native programming languages such as `Python <https://github.com/linuxdeploy/linuxdeploy-plugin-conda>`_.
145
+
linuxdeploy is planned to succeed of :ref:`linuxdeployqt`, and can be used in all projects that use :ref:`linuxdeployqt`. The list of plugins is continually growing, providing solutions for bundling frameworks such as `Qt <https://github.com/linuxdeploy/linuxdeploy-plugin-qt>`__ as well as complete environments for non-native programming languages such as `Python <https://github.com/linuxdeploy/linuxdeploy-plugin-conda>`__.
Copy file name to clipboardExpand all lines: source/packaging-guide/converting-binary-packages/pkg2appimage.rst
+3-3Lines changed: 3 additions & 3 deletions
Original file line number
Diff line number
Diff line change
@@ -3,7 +3,7 @@
3
3
pkg2appimage
4
4
============
5
5
6
-
If you already have existing binaries (either in archive or :code:`.deb` format or a ppa) then the recommended way to convert these to an AppImage is to write a `.yml description file <https://github.com/AppImage/pkg2appimage/tree/master/recipes>`_ and run it with `pkg2appimage`_.
6
+
If you already have existing binaries (either in archive or :code:`.deb` format or a ppa) then the recommended way to convert these to an AppImage is to write a `.yml description file <https://github.com/AppImage/pkg2appimage/tree/master/recipes>`__ and run it with `pkg2appimage`_.
7
7
8
8
9
9
.. contents:: Contents
@@ -22,7 +22,7 @@ To build an AppImage from a :code:`.yml` description file, simply run:
22
22
bash -ex ./pkg2appimage recipes/XXX.yml
23
23
24
24
25
-
:code:`.yml` description files tell pkg2appimage where to get the ingredients from, and how to convert them to an AppImage (besides the general steps already included in pkg2appimage). Study some `examples <https://github.com/AppImage/pkg2appimage/tree/master/recipes>`_ to see how it works.
25
+
:code:`.yml` description files tell pkg2appimage where to get the ingredients from, and how to convert them to an AppImage (besides the general steps already included in pkg2appimage). Study some `examples <https://github.com/AppImage/pkg2appimage/tree/master/recipes>`__ to see how it works.
@@ -33,7 +33,7 @@ To build an AppImage from a :code:`.yml` description file, simply run:
33
33
- pkg2appimage uses distribution packages downloaded using the package managers, however, the packages are not authenticated, as most security functionality has been deactivated. This is a major security issue. pkg2appimage is therefore recommended for personal use only. Upstream authors should consider :ref:`packaging from source <ref-from-source>`.
34
34
35
35
.. seealso::
36
-
See `this GitHub issue <https://github.com/AppImage/pkg2appimage/issues/197>`_ for more information on the security issue.
36
+
See `this GitHub issue <https://github.com/AppImage/pkg2appimage/issues/197>`__ for more information on the security issue.
Copy file name to clipboardExpand all lines: source/packaging-guide/distribution.rst
+2-2Lines changed: 2 additions & 2 deletions
Original file line number
Diff line number
Diff line change
@@ -86,7 +86,7 @@ You can use a "Download as an AppImage" banner alongside other similar buttons:
86
86
87
87
Link this banner directly to the latest version of your AppImage, or to a download page containing the link to the latest version of your AppImage.
88
88
89
-
Banner by `Khushraj Rathod <https://github.com/KhushrajRathod/>`_ under the `CC0 license <https://creativecommons.org/share-your-work/public-domain/cc0/>`_
89
+
Banner by `Khushraj Rathod <https://github.com/KhushrajRathod/>`__ under the `CC0 license <https://creativecommons.org/share-your-work/public-domain/cc0/>`_
90
90
91
91
Social Media
92
92
''''''''''''
@@ -98,7 +98,7 @@ Also be sure to advertise your new AppImage on social media, for example on Twit
98
98
AppImageHub
99
99
'''''''''''
100
100
101
-
You may want to add your AppImage to `AppImageHub <https://appimage.github.io/apps/>`_, a crowd-sourced directory of available, automatically tested AppImages with data that 3rd party app stores and software centers can use. Given an URL to an AppImage, it inspects the AppImage and puts it into a community-maintained catalog.
101
+
You may want to add your AppImage to `AppImageHub <https://appimage.github.io/apps/>`__, a crowd-sourced directory of available, automatically tested AppImages with data that 3rd party app stores and software centers can use. Given an URL to an AppImage, it inspects the AppImage and puts it into a community-maintained catalog.
102
102
103
103
App stores and software centers can consume the metadata collected by this project. See `AppImage ecosystem`_.
Copy file name to clipboardExpand all lines: source/packaging-guide/from-source/linuxdeploy-user-guide.rst
+2-2Lines changed: 2 additions & 2 deletions
Original file line number
Diff line number
Diff line change
@@ -11,7 +11,7 @@ This page illustrates how linuxdeploy can be used.
11
11
12
12
linuxdeploy is capable of packaging dependencies of resources in an existing AppDir, or creating the AppDir from scratch, bundling resources into the right locations that the user passes to it.
13
13
14
-
linuxdeploy describes itself as an `"AppDir maintenance tool" <https://github.com/linuxdeploy/linuxdeploy/blob/master/README.md>`_. Its primary focus is on AppDirs, and it uses plugins to create output formats such as AppImages.
14
+
linuxdeploy describes itself as an `"AppDir maintenance tool" <https://github.com/linuxdeploy/linuxdeploy/blob/master/README.md>`__. Its primary focus is on AppDirs, and it uses plugins to create output formats such as AppImages.
15
15
16
16
17
17
.. contents:: Contents
@@ -49,7 +49,7 @@ linuxdeploy provides different flags to bundle different kinds of resources. Onl
49
49
Bundle a desktop file into the AppDir. These are required for desktop integration, and there must always be at least one of them in the AppDir. Please see :ref:`creating-desktop-file` for a guide how they can be created, and for best practices related to AppImages.
50
50
51
51
``--icon``/``-i``
52
-
Bundle icon file. Supported are all formats which the `Icon Theme Specification <https://standards.freedesktop.org/icon-theme-spec/icon-theme-spec-latest.html>`_ lists. linuxdeploy will automatically calculate the right output path, which depends on file format and resolution. You can specify multiple icons for multiple resolutions in the form of ``<resolution>/<app_name>.<ext>``.
52
+
Bundle icon file. Supported are all formats which the `Icon Theme Specification <https://standards.freedesktop.org/icon-theme-spec/icon-theme-spec-latest.html>`__ lists. linuxdeploy will automatically calculate the right output path, which depends on file format and resolution. You can specify multiple icons for multiple resolutions in the form of ``<resolution>/<app_name>.<ext>``.
53
53
54
54
.. |rpath-comment| replace:: Set up everything so that other libraries, executables etc. use this one instead of a system one.
0 commit comments