shikane(1)

💖 shikane(1) 💖

okay so bestie, welcome to shikane — that's pronounced /ʃiˈkaːnə/ btw, say it with me — and it's a general commands manual page, which is just fancy speak for "here's how to use this thing from ur terminal." buckle up, she's iconic ✨

---

🌸 NAME 🌸

shikane — deterministic dynamic output configuration. yes. all of those words. she's giving accuracy, she's giving determinism, she's giving main character energy 💅

---

🦋 SYNOPSIS 🦋

shikane
shikane [-hV] [-o] [-c file]
shikane [--oneshot] [--config file]

---

✨ DESCRIPTION ✨

so shikane (/ʃiˈkaːnə/) is a dynamic output configuration tool and her whole personality is accuracy and determinism. no cap.

she automatically detects and configures ur connected displays based on a set of profiles. each profile specifies a set of outputs plus extra parameters (like mode, position, scale — the works). a profile gets applied automatically if all the specified outputs and modes can be perfectly matched to whatever displays are currently connected and what they're capable of. (peep shikane(5) for the deets, iykyk 🫶)

basically she's the Wayland equivalent of tools like autorandr. her goal? fully replace kanshi, surpass its inaccuracies, and add new features while she's at it. queen behavior honestly 👑. shikane works with Wayland compositors that support versions >=3 of the wlr-output-management protocol (e.g., compositors using wlroots v0.16).

---

🎀 OPTIONS 🎀

• -h, --help — prints help information. ur little "what does this do again" button 💖
• -c, --config file — the path to a config file. tell her where ur settings live.
• -o, --oneshot — turns on oneshot mode. she exits after a profile has been applied, or if no profile was matched at all. one and done, periodt ✨
• -s, --socket path — overrides the default path of the IPC socket. for when u wanna be picky about where the socket lives 🔥
• -T, --timeout timeout — waits for timeout milliseconds before processing changes [default: 0]. patience is a virtue ig 🌸
• -V, --version — prints version information. know ur queen's era 💅

---

🌈 ENVIRONMENT 🌈

• SHIKANE_LOG — controls at what log level shikane and her modules print messages to stderr. the available log levels are error, warn, info, debug and trace; sorted from highest to lowest priority. a lower log level includes messages from higher ones. setting SHIKANE_LOG to trace will let you see everything. setting it to off disables all logging entirely.

this variable also lets u filter by modules, and it accepts a comma-separated list:

SHIKANE_LOG=shikane=warn,shikane::matching=debug

the example above will only show warnings and errors from shikane except for the matching module, where log messages of level debug and above are shown. very demure, very mindful 🧚

Note: the logging output and filtering is not a stable interface and may be subject to change at any time. so don't get too attached bestie 😭

• SHIKANE_LOG_STYLE — controls if colors and styles with ANSI characters are used for log output. possible values are auto, always and never. defaults to auto. aesthetic choices are valid 💜
• SHIKANE_LOG_TIME — enables logging of prefixed timestamps if set to 1. time stamps for the girlies ⭐

---

🍓 FILES 🍓

shikane reads her configuration from $XDG_CONFIG_HOME/shikane/config.toml by default. the program exits with an error if no config file is found — so like, she needs her config, don't leave her hanging 🙈. the config file format is documented in shikane(5).

---

💀 BUGS 💀

hopefully less than 4.

(i'm not kidding, that's genuinely what it says. iconic.)

---

👑 AUTHORS 👑

Hendrik Wolff hendrik.wolff@agdsn.me

---

💖 SEE ALSO 💖

shikane(5), shikanectl(1)

---

okay that's the whole page bestie, go configure ur displays and slay 💅✨

— this edition of the manual was brought to you by shikane 1.1.1, dated 2026-06-23. take care of her, she's a 1.1.1 girlie 🎀🌷