Skip to content
This repository has been archived by the owner on Apr 18, 2023. It is now read-only.

Commit

Permalink
add a manpage for i3-config-wizard
Browse files Browse the repository at this point in the history
  • Loading branch information
stapelberg committed Jul 31, 2011
1 parent 7419165 commit 052b69a
Show file tree
Hide file tree
Showing 2 changed files with 43 additions and 2 deletions.
4 changes: 2 additions & 2 deletions man/Makefile
@@ -1,6 +1,6 @@
A2M:=a2x -f manpage --asciidoc-opts="-f asciidoc.conf"

all: i3.1 i3-msg.1 i3-input.1 i3-nagbar.1 i3-wsbar.1
all: i3.1 i3-msg.1 i3-input.1 i3-nagbar.1 i3-wsbar.1 i3-config-wizard.1

%.1: %.man asciidoc.conf
${A2M} $<
Expand All @@ -9,7 +9,7 @@ i3-wsbar.1: ../i3-wsbar
pod2man $^ > $@

clean:
for file in $$(echo i3 i3-msg i3-input i3-nagbar i3-wsbar); \
for file in $$(echo i3 i3-msg i3-input i3-nagbar i3-wsbar i3-config-wizard); \
do \
rm -f $${file}.1 $${file}.html $${file}.xml; \
done
Expand Down
41 changes: 41 additions & 0 deletions man/i3-config-wizard.man
@@ -0,0 +1,41 @@
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

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

0 comments on commit 052b69a

Please sign in to comment.