add a manpage for i3-config-wizard

This commit is contained in:
Michael Stapelberg 2011-07-31 23:08:25 +02:00
parent 74191652d4
commit 052b69a4bf
2 changed files with 43 additions and 2 deletions

View File

@ -1,6 +1,6 @@
A2M:=a2x -f manpage --asciidoc-opts="-f asciidoc.conf" 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 %.1: %.man asciidoc.conf
${A2M} $< ${A2M} $<
@ -9,7 +9,7 @@ i3-wsbar.1: ../i3-wsbar
pod2man $^ > $@ pod2man $^ > $@
clean: 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 \ do \
rm -f $${file}.1 $${file}.html $${file}.xml; \ rm -f $${file}.1 $${file}.html $${file}.xml; \
done done

41
man/i3-config-wizard.man Normal file
View File

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