Samuel Onoja
e22f0ebef9
Panel appearance now applies to the whole panel, with seven styles: Floating, Capsules, Notch, Edge to edge, Fused islands, Adaptive and Morph. - Share composition, geometry, and motion through the renderer-independent `ferese-panel` crate, including native materials, input regions, and Settings previews. - Add the Morph hub with media, calendar, notifications, controls, workspace previews, hover feedback, and attached mode. Keep recording and low-battery status visible and respect window clearance. - Cache workspace preview geometry, draw thumbnails directly, centralize Morph transitions, and keep rendering settings local to each shell instance. - Put Record Screen in the Morph header and show the display control only when an external monitor is connected. Update panel documentation, the desktop screenshot, and native check style names. Local validation included 660 compositor tests, 191 shell tests, isolated preview-cache checks, GPU Morph captures at 1×/1.25×/1.5×, formatting, and Clippy with warnings denied. The final header change passed all 23 Morph tests. Release workflow jobs are skipped for this PR.
61 lines
2.7 KiB
Markdown
61 lines
2.7 KiB
Markdown
# Ferese handbook
|
|
|
|
Ferese combines a window manager and desktop shell with one configuration.
|
|
This handbook covers installation, settings and desktop controls.
|
|
|
|
[Browse screenshots](screenshots.md) to see the themes, layouts and desktop controls in
|
|
use.
|
|
|
|
## Get started
|
|
|
|
1. [Install Ferese](installation.md), or try a [nested preview](installation.md#preview-and-logs).
|
|
2. Choose Light, Dark, or Auto in **Control Center**. Open **Settings** for theme files and presets.
|
|
3. Use the [configuration reference](configuration.md) for shortcuts, gestures, window rules, and displays.
|
|
|
|
## Default shortcuts
|
|
|
|
Use `Super`, usually the Windows key, for the shortcuts below, and make them your own in
|
|
**Settings → Keyboard & mouse → Shortcuts**.
|
|
|
|
| Control | Action |
|
|
| --- | --- |
|
|
| Super + Enter | Open a terminal |
|
|
| Super + H / J / K / L | Focus left / down / up / right |
|
|
| Super + F | Maximize the window |
|
|
| Super + Shift + F | Toggle fullscreen |
|
|
| Super + Tab | Open overview |
|
|
| Super + M | Switch scrolling / tree layout |
|
|
| Print Screen | Capture the active monitor and open Satty |
|
|
| Super + Shift + S | Select a screenshot area |
|
|
| Super + Shift + E | Ask to log out |
|
|
| Super + left-button drag | Move a floating window |
|
|
| Super + right-button drag | Resize a floating window |
|
|
| Three-finger swipe up / down | Next / previous workspace |
|
|
| Three-finger swipe left / right | Focus the window to the right / left |
|
|
| Login shortcut guide | Appears at login; disable in Settings → Keyboard & mouse → Shortcuts |
|
|
|
|
The [shortcuts and mouse actions guide](shortcuts.md) covers the rest, including how to
|
|
group windows, resize them and move between workspaces.
|
|
|
|
## Desktop guides
|
|
|
|
- [Panel configuration](panel-configuration.md): choose a style, arrange controls, and configure Morph.
|
|
- [Lock screen](locking.md): appearance, automatic locking, and display sleep.
|
|
- [Screen sharing and recording](screen-sharing.md): share an app or display, or save a video.
|
|
- [Desktop portals](portals.md): integration with applications.
|
|
- [Animation model](animation-model.md): spring motion, geometry ownership, and resize presentation.
|
|
|
|
Configure the desktop in Settings or edit `~/.config/ferese/config.kdl` directly;
|
|
changes apply live, and an invalid edit leaves the last working configuration in
|
|
place.
|
|
|
|
## Troubleshooting
|
|
|
|
If you need to end a session, `feresectl request-logout` asks for confirmation and
|
|
`feresectl exit` exits immediately, so save your work first. The [logs and recovery
|
|
guide](installation.md#logout-and-recovery) helps when something stops responding.
|
|
|
|
To [report a problem](https://github.com/ferese-wm/ferese/issues), include the steps to
|
|
reproduce it, relevant logs and whether you were using a nested preview or a direct
|
|
session. See [Development](development.md) to contribute.
|