nbargnesi/xy — Issue #4: Document configuration options
Author: nbargnesi
Created: 2012-02-04 03:08:33+00:00
State: open

When xy writes its default configuration out, the options are not documented in any way. E.g.,
{{{
# xy configuration file
skip_window_manager_check = false
window_manager_name = xy
master_clients = 2
master_percentage = 0.50
warp = true
broadcast_group = 224.0.0.3
broadcast_port = 47002
key_shortcut_quit = Mod4 q
key_shortcut_terminal = Mod4 Return
key_shortcut_menu = Mod4 p
key_shortcut_restart = Mod4 r
terminal_command = urxvt
menu_command = dmenu_run
}}}

Inlining some documentation would be an improvement to the default configuration. E.g.,

# xy configuration file

# When true, xy will not check for a running
# window manager at startup
#
skip_window_manager_check = false
# See http://bb.den-4.com/xy/wiki/...

# Changes the window manager name to
# allow for bug work-arounds (e.g., LG3D)
#
window_manager_name = xy
# See http://bb.den-4.com/xy/wiki/...

[...]