1
Fork 0
mirror of https://github.com/RGBCube/serenity synced 2025-07-28 11:57:36 +00:00

Documentation: Better file formats documentation

This commit is contained in:
sfdd 2022-07-11 02:58:10 +03:00 committed by Linus Groh
parent b8cfec7b1f
commit d1671d4f86
5 changed files with 184 additions and 16 deletions

View file

@ -1,6 +1,6 @@
## Name
af - Application File format
af - Application File format (.af)
## Synopsis
@ -8,11 +8,40 @@ The Application Files define System Menu entries and launcher file types / proto
## Description
.af files are human-readable and are a subset of the INI-format, have no easily detectable filemagic. These files define System Menu entries and launcher file types / protocols.
Application files are a subset of the INI format.
They have no easily detectable filemagic and contain application information (App group):
They are stored in [`/res/apps`](../../../../res/apps).
| Key | Description |
|---------------|----------------------------------|
| Name | name |
| Executable | executable path |
| Category | category (optional) |
| Description | description (optional) |
| IconPath | application icon path (optional) |
| RunInTerminal | run in terminal flag (optional) |
## See Also
and launcher information (Launcher group, optional):
| Key | Description |
|-----------|---------------------------------------|
| FileTypes | supported file types separated by ',' |
| Protocols | protocols separated by ',' |
All application files are stored in [`/res/apps`](../../../../res/apps).
## Examples
[`/res/apps/Calendar.af`](../../../../res/apps/Calendar.af)
```ini
[App]
Name=Calendar
Executable=/bin/Calendar
Category=Utilities
```
## See also
- [ini(5)](help://man/5/ini)
- [`Userland/Services/Taskbar/main.cpp`](../../../../../Userland/Services/Taskbar/main.cpp)
- `Launcher::load_handlers` in [`Userland/Services/LaunchServer/Launcher.cpp`](../../../../../Userland/Services/LaunchServer/Launcher.cpp).
- `Launcher::load_handlers` in [`Userland/Services/LaunchServer/Launcher.cpp`](../../../../../Userland/Services/LaunchServer/Launcher.cpp)