DBP file format: Difference between revisions
Line 39: | Line 39: | ||
! style="width:40%;" |Description | ! style="width:40%;" |Description | ||
! style="width:30%;" |Example | ! style="width:30%;" |Example | ||
|- | |||
|Type | |||
|[https://dev.pyra-handheld.com/packages/dbp/-/blob/e0e58fe10a07ce1deb598dc5a6f794aaad9f10f1/dbp-validate-extracted/validate.c#L203 R] | |||
|N | |||
|Type of desktop file (Possible values: Application, Link, Directory) | |||
|Type=Application | |||
|- | |- | ||
|Name | |Name | ||
|R | |[https://dev.pyra-handheld.com/packages/dbp/-/blob/e0e58fe10a07ce1deb598dc5a6f794aaad9f10f1/dbp-validate-extracted/validate.c#L219 R] | ||
|[https://dev.pyra-handheld.com/sebt3/pyraRepo/-/blob/566a9ffbbf914247654c63b7dc688018d96a2fcb/classes/UploadPage.php#L163 R] | |[https://dev.pyra-handheld.com/sebt3/pyraRepo/-/blob/566a9ffbbf914247654c63b7dc688018d96a2fcb/classes/UploadPage.php#L163 R] | ||
|Name of the app | |Name of the app | ||
Line 47: | Line 53: | ||
|- | |- | ||
|Comment | |Comment | ||
| | |[https://dev.pyra-handheld.com/packages/dbp/-/blob/e0e58fe10a07ce1deb598dc5a6f794aaad9f10f1/dbp-validate-extracted/validate.c#L221 O] | ||
|[https://dev.pyra-handheld.com/sebt3/pyraRepo/-/blob/566a9ffbbf914247654c63b7dc688018d96a2fcb/classes/UploadPage.php#L159 O] | |[https://dev.pyra-handheld.com/sebt3/pyraRepo/-/blob/566a9ffbbf914247654c63b7dc688018d96a2fcb/classes/UploadPage.php#L159 O] | ||
|Description of the app | |Description of the app | ||
Line 53: | Line 59: | ||
|- | |- | ||
|Categories | |Categories | ||
| | |[https://dev.pyra-handheld.com/packages/dbp/-/blob/e0e58fe10a07ce1deb598dc5a6f794aaad9f10f1/dbp-validate-extracted/validate.c#L234 R] | ||
|[https://dev.pyra-handheld.com/sebt3/pyraRepo/-/blob/566a9ffbbf914247654c63b7dc688018d96a2fcb/classes/UploadPage.php#L172 O] | |[https://dev.pyra-handheld.com/sebt3/pyraRepo/-/blob/566a9ffbbf914247654c63b7dc688018d96a2fcb/classes/UploadPage.php#L172 O] | ||
|Categories | |Categories | ||
Line 59: | Line 65: | ||
|- | |- | ||
|Exec | |Exec | ||
|R | |[https://dev.pyra-handheld.com/packages/dbp/-/blob/e0e58fe10a07ce1deb598dc5a6f794aaad9f10f1/dbp-validate-extracted/validate.c#L207 R] | ||
|N | |N | ||
|The binary in the squashfs part to start | |The binary in the squashfs part to start | ||
Line 65: | Line 71: | ||
|- | |- | ||
|Icon | |Icon | ||
|O | |[https://dev.pyra-handheld.com/packages/dbp/-/blob/e0e58fe10a07ce1deb598dc5a6f794aaad9f10f1/dbp-validate-extracted/validate.c#L223 O] | ||
|[https://dev.pyra-handheld.com/sebt3/pyraRepo/-/blob/566a9ffbbf914247654c63b7dc688018d96a2fcb/classes/UploadPage.php#L160 O] | |[https://dev.pyra-handheld.com/sebt3/pyraRepo/-/blob/566a9ffbbf914247654c63b7dc688018d96a2fcb/classes/UploadPage.php#L160 O] | ||
|The icon in the "icons" directory (expect .png) | |The icon in the "icons" directory (expect .png) | ||
Line 75: | Line 81: | ||
|Version of the app | |Version of the app | ||
|Version=0.74+svn20200103 | |Version=0.74+svn20200103 | ||
|- | |- | ||
|Terminal | |Terminal |
Revision as of 19:57, 19 March 2021
Please note: we're not going to describe something as painful as the pxml file here :P
file structure
a .dbp files is composed of 2 concatenated files :
- a squashfs file
- an *uncompressed* zip
The squashfs part contain your application(s) and everything it might need to run.
The zip part contain the meta-data related to the DBP.
Sample session to build a dbp
Say you have a your application in a "rootfs" directory and a meta" directory containing the metadata.
$ ls icons meta rootfs $ mksquashfs rootfs target.squash -all-root -force-gid 0 Creating 4.0 filesystem on target.squash, block size 131072. .... $ zip -r target.zip meta icons adding: meta/ (stored 0%) ... $ cat target.squash target.zip > target.dbp
meta-data structure
the desktop file(s)
This file format is normed by the free-desktop community. The specs can be found here.
Desktop Entry
In a dbp file, none to many [Desktop Entry] can be create. Each of them will be an application from withing the dbp package. Each [Desktop Entry] section need to be a dedicated file. Here is the standard fields the dbp system reuse.
LABEL | dbpd | Repo | Description | Example |
---|---|---|---|---|
Type | R | N | Type of desktop file (Possible values: Application, Link, Directory) | Type=Application |
Name | R | R | Name of the app | Name=dosbox |
Comment | O | O | Description of the app | Comment=A DOS emulator |
Categories | R | O | Categories | Categories=Game;Emulator |
Exec | R | N | The binary in the squashfs part to start | Exec=dosbox |
Icon | O | O | The icon in the "icons" directory (expect .png) | Icon=dosbox.png |
Version | N | N | Version of the app | Version=0.74+svn20200103 |
Terminal | N | N | Spawn a terminal for this app to run in, if set. | Terminal=false |
Package Entry
This section doesnt exist in the free-desktop specification (So this is dbp exclusive stuff here). One and only one of this section should be found per dbp package. Here are the fields :
LABEL | dbpd | Repo | Description | Example |
---|---|---|---|---|
Id | R | R | Unique identifier for the dbp file. | Id=dosbox |
Name | N | R | Name of the package | Name=DOSbox |
Arch | O | R | Binary architecture of that package | Arch=armhf |
Appdata | O | N | Name of the appdata to use (default: name of the package) | Appdata=dosbox |
Icon | O | O | Icon of the package (found in the "icons" directory) | Icon=dosbox.png |
Version | N | R | Version of the package | Version=0.74+svn20200103 |
Exec | O | N | List of executables to export With environment override | Exec=bin/dosbox;dosbox.launch |
NoEnvExec | O | N | List of executables to export Without environment override | |
Dependency[deb] | O | O | Debian packages requiered. | Dependency[deb]=libsdl2-image-2 |
Dependency[dbp] | O | O | dbp package requiered to run this one. | Dependency[dbp]=dosbox |
legend
letter | meaning |
---|---|
R | Required |
O | Optionnal |
N | Not used |