From 052b69a4bf29f543e4e6f144e1ef1c1f8c6340ae Mon Sep 17 00:00:00 2001 From: Michael Stapelberg Date: Sun, 31 Jul 2011 23:08:25 +0200 Subject: [PATCH] add a manpage for i3-config-wizard --- man/Makefile | 4 ++-- man/i3-config-wizard.man | 41 ++++++++++++++++++++++++++++++++++++++++ 2 files changed, 43 insertions(+), 2 deletions(-) create mode 100644 man/i3-config-wizard.man diff --git a/man/Makefile b/man/Makefile index ed72ebed..651e962a 100644 --- a/man/Makefile +++ b/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} $< @@ -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 diff --git a/man/i3-config-wizard.man b/man/i3-config-wizard.man new file mode 100644 index 00000000..5a9ca39e --- /dev/null +++ b/man/i3-config-wizard.man @@ -0,0 +1,41 @@ +i3-config-wizard(1) +=================== +Michael Stapelberg +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