Skip to content

Commit 3406f84

Browse files
committed
Update variables' docs in the README
1 parent cbfc4cd commit 3406f84

File tree

1 file changed

+10
-7
lines changed

1 file changed

+10
-7
lines changed

README.md

+10-7
Original file line numberDiff line numberDiff line change
@@ -33,10 +33,13 @@ The official linuxdeploy AppImage ships with a fairly recent version of the plug
3333

3434
linuxdeploy-plugin-appimage can be configured using environment variables.
3535

36-
- `UPDATE_INFORMATION="..."`: embed [update information](https://github.com/AppImage/AppImageSpec/blob/master/draft.md#update-information) in the AppImage, and generate corresponding `.zsync` file
37-
- `SIGN=1`: set this variable to any value to enable signing of the AppImage
38-
- `SIGN_KEY=key_id`: GPG Key ID to use for signing. This environment variable is only used if `SIGN` is set.
39-
- `VERBOSE=1`: set this variable to any value to enable verbose output
40-
- `OUTPUT=filename`: change filename of resulting AppImage
41-
- `NO_APPSTREAM=1`: skip checking AppStream metadata for issues
42-
- `APPIMAGE_COMP=...`: compression algorithm appimagetool/mksquashfs should use (e.g., `xz`, `gzip`), see [appimagetool's repository](https://github.com/AppImage/AppImageKit/) for more information
36+
- `LDAI_UPDATE_INFORMATION="..."`: embed [update information](https://github.com/AppImage/AppImageSpec/blob/master/draft.md#update-information) in the AppImage, and generate corresponding `.zsync` file
37+
- `LDAI_GUESS_UPDATE_INFORMATION`: make appimagetool try to guess some update information (may or may not work, requires specific workflow and setup)
38+
- `LDAI_SIGN=1`: set this variable to any value to enable signing of the AppImage
39+
- `LDAI_SIGN_KEY=key_id`: GPG Key ID to use for signing. This environment variable is only used if `SIGN` is set.
40+
- `LDAI_VERBOSE=1`: set this variable to any value to enable verbose output
41+
- `LDAI_OUTPUT=filename`: change filename of resulting AppImage
42+
- `LDAI_NO_APPSTREAM=1`: skip checking AppStream metadata for issues
43+
- `LDAI_APPIMAGE_COMP=...`: compression algorithm appimagetool/mksquashfs should use (e.g., `xz`, `gzip`), see [appimagetool's repository](https://github.com/AppImage/AppImageKit/) for more information
44+
- `LINUXDEPLOY_OUTPUT_APP_NAME`: sets `APPIMAGETOOL_APP_NAME` to configure appimagetool's autogenerated filename prefix
45+
- `LINUXDEPLOY_OUTPUT_VERSION` or `LDAI_VERSION`: version number to pass to appimagetool (will be included in the root desktop file to be picked up by desktop integration tools and, if `$LDAI_OUTPUT` is not set, will be included in appimagetool's autogenerated output filename)

0 commit comments

Comments
 (0)