Appimage: Difference between revisions

(8 intermediate revisions by 6 users not shown)

Line 4:

[https://appimage.org/ AppImage] is a monolithic packaging format for linux applications. It contains all dependencies in one file that is composed of an executable with a tacked on filesystem.

== Usage ==

== Usage ==

=== Run ===

=== Run ===

On most distros, all one has to do is download the <code>.AppImage</code> file, make it executable <code>chmod +x $AppImage</code>, and execute it. This doesn't work in NixOS out of the box though, as AppImage files usually (if not always) depend on certain system libraries in hardcoded paths.~~~~

On most distros, all one has to do is download the <code>.AppImage</code> file, make it executable <code>chmod +x $AppImage</code>, and execute it. This doesn't work in NixOS out of the box though, as AppImage files usually (if not always) depend on certain system libraries in hardcoded paths.

</translate>

$ nix-shell -p appimage-run

$ appimage-run ~~$AppImageFile~~

$ appimage-run path/to/application.AppImage

</syntaxhighlight>

=== Packaging ===

=== Packaging ===

See the [https://nixos.org/manual/nixpkgs/stable/#sec-pkgs-appimageTools nixpkgs manual on wrapping AppImage packages]. In short, the AppImage is extracted and any dependencies are added as ~~nix~~ build dependencies.

See the [https://nixos.org/manual/nixpkgs/stable/#sec-pkgs-appimageTools nixpkgs manual on wrapping AppImage packages]. In short, the AppImage is extracted and any dependencies are added as Nix build dependencies.

Following example is a derivation for the program Quba, which is also distributed as AppImage.<syntaxhighlight lang="nix">

Following example is a derivation for the program Quba, which is also distributed as AppImage.

</translate>

{

lib,

Line 30:

Line 34:

version = "1.4.0";

pname = "quba";

~~name = "${pname}-${version}";~~

src = fetchurl {

Line 39:

Line 42:

appimageContents = appimageTools.extractType1 { inherit name src; };

in

appimageTools.~~wrapType1~~ {

appimageTools.wrapType2 rec {

inherit ~~name~~ src;

inherit pname version src;

extraInstallCommands = ''

~~mv $out/bin/${name} $out/bin/${pname}~~

~~install -m 444 -D ${appimageContents}/${pname}.desktop -t $out/share/applications~~

substituteInPlace $out/share/applications/${pname}.desktop \

--replace 'Exec=AppRun' 'Exec=${~~pname~~}'

--replace-fail 'Exec=AppRun' 'Exec=${meta.mainProgram}'

~~cp -r ${appimageContents}/usr/share/icons $out/share~~

'';

meta = ~~with lib;~~ {

meta = {

description = "Viewer for electronic invoices ";

description = "Viewer for electronic invoices";

homepage = "https://github.com/ZUGFeRD/quba-viewer";

downloadPage = "https://github.com/ZUGFeRD/quba-viewer/releases";

license = licenses.asl20;

license = lib.licenses.asl20;

sourceProvenance = with sourceTypes; [ binaryNativeCode ];

sourceProvenance = with lib.sourceTypes; [ binaryNativeCode ];

maintainers = with maintainers; [ onny ];

maintainers = with lib.maintainers; [ onny ];

platforms = [ "x86_64-linux" ];

};

Line 62:

</syntaxhighlight>

== Configuration ==

== Configuration ==

=== Register AppImage files as a binary type to binfmt_misc ===

=== Register AppImage files as a binary type to binfmt_misc ===

You can tell the Linux kernel to use an interpreter (e.g. <code>appimage-run</code>) when executing certain binary files through the use of [https://en.wikipedia.org/wiki/Binfmt_misc#External_links binfmt_misc], either by filename extension or magic number matching. Below NixOS configuration registers AppImage files (ELF files with magic number "AI" + 0x02) to be run with <code>appimage-run</code> as interpreter.

You can tell the [[Linux kernel]] to use an interpreter (e.g. <code>appimage-run</code>) when executing certain binary files through the use of [https://en.wikipedia.org/wiki/Binfmt_misc#External_links binfmt_misc], either by filename extension or magic number matching. Below NixOS configuration registers AppImage files (ELF files with magic number "AI" + 0x02) to be run with <code>appimage-run</code> as interpreter:

~~~~

~~Since [https://nixos.org/manual/nixos/stable/release-notes#sec-release-24.05-new-services NixOS 24.05], there is a binfmt option~~:

</translate>

Line 85:

Line 83:

</translate>

[[Category:Software~~{{#translation:}}~~]]

[[Category:Software]]

@@ Line 4: / Line 4: @@
 [https://appimage.org/ AppImage] is a monolithic packaging format for linux applications. It contains all dependencies in one file that is composed of an executable with a tacked on filesystem.
-== Usage ==
+== Usage == <!--T:10-->
-=== Run ===<!--T:2-->
+=== Run === <!--T:2-->
-On most distros, all one has to do is download the <code>.AppImage</code> file, make it executable <code>chmod +x $AppImage</code>, and execute it. This doesn't work in NixOS out of the box though, as AppImage files usually (if not always) depend on certain system libraries in hardcoded paths.<!--T:3-->
+<!--T:3-->
+On most distros, all one has to do is download the <code>.AppImage</code> file, make it executable <code>chmod +x $AppImage</code>, and execute it. This doesn't work in NixOS out of the box though, as AppImage files usually (if not always) depend on certain system libraries in hardcoded paths.
 </translate>
 <syntaxhighlight lang="shell">
 $ nix-shell -p appimage-run
-$ appimage-run $AppImageFile
+$ appimage-run path/to/application.AppImage
 </syntaxhighlight>
 <translate>
-=== Packaging ===<!--T:8-->
+=== Packaging === <!--T:8-->
 <!--T:9-->
-See the [https://nixos.org/manual/nixpkgs/stable/#sec-pkgs-appimageTools nixpkgs manual on wrapping AppImage packages]. In short, the AppImage is extracted and any dependencies are added as nix build dependencies.
+See the [https://nixos.org/manual/nixpkgs/stable/#sec-pkgs-appimageTools nixpkgs manual on wrapping AppImage packages]. In short, the AppImage is extracted and any dependencies are added as Nix build dependencies.
-Following example is a derivation for the program Quba, which is also distributed as AppImage.<syntaxhighlight lang="nix">
+Following example is a derivation for the program Quba, which is also distributed as AppImage.
+</translate>
+<syntaxhighlight lang="nix">
 {
    lib,
@@ Line 30: / Line 34: @@
    version = "1.4.0";
    pname = "quba";
-  name = "${pname}-${version}";
    src = fetchurl {
@@ Line 39: / Line 42: @@
    appimageContents = appimageTools.extractType1 { inherit name src; };
 in
-appimageTools.wrapType1 {
+appimageTools.wrapType2 rec {
-   inherit name src;
+   inherit pname version src;
    extraInstallCommands = ''
-    mv $out/bin/${name} $out/bin/${pname}
-    install -m 444 -D ${appimageContents}/${pname}.desktop -t $out/share/applications
      substituteInPlace $out/share/applications/${pname}.desktop \
-       --replace 'Exec=AppRun' 'Exec=${pname}'
+       --replace-fail 'Exec=AppRun' 'Exec=${meta.mainProgram}'
-    cp -r ${appimageContents}/usr/share/icons $out/share
    '';
-   meta = with lib; {
+   meta = {
-     description = "Viewer for electronic invoices ";
+     description = "Viewer for electronic invoices";
      homepage = "https://github.com/ZUGFeRD/quba-viewer";
      downloadPage = "https://github.com/ZUGFeRD/quba-viewer/releases";
-     license = licenses.asl20;
+     license = lib.licenses.asl20;
-     sourceProvenance = with sourceTypes; [ binaryNativeCode ];
+     sourceProvenance = with lib.sourceTypes; [ binaryNativeCode ];
-     maintainers = with maintainers; [ onny ];
+     maintainers = with lib.maintainers; [ onny ];
      platforms = [ "x86_64-linux" ];
    };
@@ Line 62: / Line 62: @@
 </syntaxhighlight>
-== Configuration ==
+<translate>
+== Configuration == <!--T:16-->
-=== Register AppImage files as a binary type to binfmt_misc ===<!--T:4-->
+=== Register AppImage files as a binary type to binfmt_misc === <!--T:4-->
 <!--T:5-->
-You can tell the Linux kernel to use an interpreter (e.g. <code>appimage-run</code>) when executing certain binary files through the use of [https://en.wikipedia.org/wiki/Binfmt_misc#External_links binfmt_misc], either by filename extension or magic number matching. Below NixOS configuration registers AppImage files (ELF files with magic number "AI" + 0x02) to be run with <code>appimage-run</code> as interpreter.
+You can tell the [[Linux kernel]] to use an interpreter (e.g. <code>appimage-run</code>) when executing certain binary files through the use of [https://en.wikipedia.org/wiki/Binfmt_misc#External_links binfmt_misc], either by filename extension or magic number matching. Below NixOS configuration registers AppImage files (ELF files with magic number "AI" + 0x02) to be run with <code>appimage-run</code> as interpreter:
-<!--T:6-->
-Since [https://nixos.org/manual/nixos/stable/release-notes#sec-release-24.05-new-services NixOS 24.05], there is a binfmt option:
 </translate>
 <syntaxhighlight lang="nixos">
@@ Line 85: / Line 83: @@
 </translate>
-[[Category:Software{{#translation:}}]]
+[[Category:Software]]