I3\-CONFIG\-WIZARD

Section: i3 Manual (1)
Updated: 02/27/2021
Page Index

NAME

i3-config-wizard - creates a keysym based config based on your layout

SYNOPSIS

i3-config-wizard [-s socket] [-m modifier] [-v] [-h]

OPTIONS

-s, --socket socket

: Overwrites the path to the i3 IPC socket.

-m, --modifier modifier

: Generates the configuration file headlessly. Accepts win or alt.

-v, --version

: Display version number and exit.

-h, --help

: Display a short help message and exit.

FILES

/etc/i3/config.keycodes

This file contains the default configuration with keycodes. All the bindcode lines will be transformed to bindsym and the user-specified modifier will be used.

DESCRIPTION

i3-config-wizard is started by i3 in its default config, unless /.i3/config exists. i3-config-wizard creates a keysym based i3 config file (based on /etc/i3/config.keycodes) in /.i3/config.

The advantage of using keysyms is that the config file is easy to read, understand and modify. However, if we shipped with a keysym based default config file, the key positions would not be consistent across different keyboard layouts (take for example the homerow for movement). Therefore, we ship with a keycode based default config and let the wizard transform it according to your current keyboard layout.

AUTHOR

Michael Stapelberg and contributors