aboutsummaryrefslogtreecommitdiff
path: root/man/i3-config-wizard.man
blob: 8e8486dc2862f3b3b5b0e8d6a8eec4327bf54b2f (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
i3-config-wizard(1)
===================
Michael Stapelberg <michael+i3@stapelberg.de>
v4.0, July 2011

== 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.

== SEE ALSO

i3(1)

== AUTHOR

Michael Stapelberg and contributors