From dadbaf9ab1e1f655e8a26a20d304a42ce445e3c4 Mon Sep 17 00:00:00 2001
From: Kovid Goyal <kovid@kovidgoyal.net>
Date: Mon, 4 Jun 2018 08:28:53 +0530
Subject: [PATCH] More conf docs

---
 kitty/config.py      |  1 -
 kitty/config_data.py | 40 +++++++++++++++++++++++++++++++---------
 2 files changed, 31 insertions(+), 10 deletions(-)

diff --git a/kitty/config.py b/kitty/config.py
index 5a0147186..daec034b7 100644
--- a/kitty/config.py
+++ b/kitty/config.py
@@ -308,7 +308,6 @@ def window_size(val):
 type_map = {
     'allow_remote_control': to_bool,
     'focus_follows_mouse': to_bool,
-    'repaint_delay': positive_int,
     'input_delay': positive_int,
     'sync_to_monitor': to_bool,
     'close_on_child_death': to_bool,
diff --git a/kitty/config_data.py b/kitty/config_data.py
index bcb838339..f2c5515f7 100644
--- a/kitty/config_data.py
+++ b/kitty/config_data.py
@@ -92,17 +92,13 @@ o, g, all_groups = option_func(all_options, {
           'font faces and even specify special fonts for particular characters.')
     ],
 
-    'cursor': [
-        _('Cursor customization'),
-    ],
+    'cursor': [_('Cursor customization'), ],
 
-    'scrollback': [
-        _('Scrollback'),
-    ],
+    'scrollback': [_('Scrollback'), ],
 
-    'mouse': [
-        _('Mouse'),
-    ],
+    'mouse': [_('Mouse'), ],
+
+    'performance': [_('Performance tuning')],
 })
 type_map = {o.name: o.option_type for o in all_options.values()}
 # }}}
@@ -245,3 +241,29 @@ Set the active window to the window under the mouse when
 moving the mouse around'''))
 
 # }}}
+
+
+g('performance')  # {{{
+
+o('repaint_delay', 10, option_type=positive_int, long_text=_('''
+Delay (in milliseconds) between screen updates. Decreasing it, increases
+frames-per-second (FPS) at the cost of more CPU usage. The default value
+yields ~100 FPS which is more than sufficient for most uses. Note that to
+actually achieve 100 FPS you have to either set :conf:`sync_to_monitor` to no
+or use a monitor with a high refresh rate.'''))
+
+o('input_delay', 3, option_type=positive_int, long_text=_('''
+Delay (in milliseconds) before input from the program running in the terminal
+is processed. Note that decreasing it will increase responsiveness, but also
+increase CPU usage and might cause flicker in full screen programs that
+redraw the entire screen on each loop, because kitty is so fast that partial
+screen updates will be drawn.'''))
+
+o('sync_to_monitor', True, long_text=_('''
+Sync screen updates to the refresh rate of the monitor. This prevents
+tearing (https://en.wikipedia.org/wiki/Screen_tearing) when scrolling. However,
+it limits the rendering speed to the refresh rate of your monitor. With a
+very high speed mouse/high keyboard repeat rate, you may notice some slight input latency.
+If so, set this to no.'''))
+
+# }}}