Files
waydock/doc/usage.md
claude bc2fa65558
Some checks failed
check / check (push) Failing after 52s
waydock v0.1: panel, pins, fönstergrupper, menyer, settings-GUI, live-config
M0–M5 ur doc/plan.md: layer-shell-dock per skärm med transparent
#222222-ö, pins + körande appar (gruppering, badges, indikatorer),
klick/skroll/mittklick, konfigurerbar högerklicksmeny, tomyta-meny,
settings-GUI som redigerar JSON-configen live, filewatcher,
Wayfire-IPC-stubbar (scale, flytta-till-skärm), CI + release-flöde.

Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
2026-08-29 23:24:29 +02:00

110 lines
4.1 KiB
Markdown
Raw Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

# waydock — användning
## Starta
```bash
waydock # normal start
waydock --log debug # pratigare logg till stderr
waydock --log-file ~/.cache/waydock.log
waydock --config /annan/väg.json
```
Vid första start skapas `~/.config/waydock/config.json` med defaults.
Alla ändringar i filen slår igenom **live** — ingen omstart behövs.
## Dagligt bruk
- **Vänsterklick** på ikon: fokusera appen; klick igen minimerar
(Plasma-beteende, konfigurerbart)
- **Skroll** på ikon: växla mellan appens fönster
- **Mittklick**: starta ny instans (konfigurerbart)
- **Högerklick** på ikon: kontextmeny (innehållet väljs i configen) —
minimera, maximera, flytta till skärm ▸, pinna/släpp, stäng
- **Högerklick på tom yta**: Inställningar…, Ladda om config, Avsluta
- **Visa skrivbord-knappen** minimerar allt; klick igen återställer
- **Översikt-knappen** togglar Wayfires scale-vy (kräver ipc-pluginen)
- Grupp-ikoner får en siffra och accentprickar; hovra för fönsterlistan
## Settings-GUI
Högerklick på tom yta → **Inställningar…** Ändringar skrivs direkt till
JSON-filen och appliceras live. GUI:t och handredigering kan blandas fritt.
## Configreferens (`config.json`)
```jsonc
{
"position": "bottom", // bottom | top | left | right
"centered": true, // ö i mitten i stället för hela kanten
"margin": 8, // px från skärmkant (0 = kant i kant)
"layer": "top", // top | overlay | bottom (always-on-top = overlay)
"avoid_windows": false, // true = reservera plats (exclusive zone)
"appearance": {
"background": "#222222", // panelfärg
"opacity": 0.72, // paneltransparens 01
"corner_radius": 14,
"border": { "color": "#ffffff", "opacity": 0.08, "width": 1 },
"shadow": { "enabled": true, "blur": 18, "opacity": 0.45 },
"accent": "#c9545d", // indikatorer, hover, urgency
"icon_size": 36,
"icon_spacing": 6, // px mellan ikoner
"padding": 6, // px innanför panelkanten
"hover_zoom": true, // liten zoom vid hover
"animations": true, // false stänger alla animationer
"indicator": { "style": "dot", "max": 3 } // dot | line | none
},
"behavior": {
"click": "focus_or_minimize", // focus_or_minimize | focus | cycle
"middle_click": "launch_new", // launch_new | close | none
"scroll": "cycle_windows", // cycle_windows | none
"group_apps": true,
"tooltips": true,
"urgent_pulse": true
},
"context_menu": ["minimize", "maximize", "move_to_output",
"pin", "close"], // ordning & urval styr menyn
"pins": ["firefox", "org.kde.konsole", "org.kde.dolphin"],
"special_buttons": { "show_desktop": true, "overview": true },
"outputs": { // per-skärm-överstyrning (nyckel = connector)
"DP-1": {
"enabled": true,
"only_this_output": true, // visa bara fönster på den här skärmen
"pins": ["steam", "discord"] // null/utelämnad = ärver globala pins
}
},
"autohide": {
"enabled": false,
"mode": "dodge", // dodge (göm vid överlapp, kräver wayfire-ipc)
// | always (göm alltid, hot edge väcker)
"hide_delay_ms": 500,
"reveal_px": 2, // sensorbredd vid skärmkanten
"animation_ms": 200
},
"hotspots": { // action: {"exec": "kommando"} eller {"ipc": "scale/toggle"}
"dwell_ms": 300,
"corners": { "top_left": null, "top_right": null,
"bottom_left": null, "bottom_right": null },
"edges": { "top": null, "bottom": null, "left": null, "right": null }
},
"log": { "level": "info", "file": null }
}
```
## Tips
- Wayfires **blur-plugin** kan ge frostat glas bakom panelen —
transparensen i `appearance.opacity` räcker för blur-effekten.
- Trasig JSON? waydock loggar felet och kör vidare på defaults utan att
röra din fil — rätta filen så laddas den om automatiskt.
- `pins` använder `.desktop`-id (filnamnet utan `.desktop`,
t.ex. `org.kde.konsole`). Hitta rätt id:
`ls /usr/share/applications | grep -i <app>`.