Browse Source

[DOCS] Document MacOS keymap more prominently

It is very confusing to new Gertty users like me that it seems to
function fine except the search key is a noop on MacOS, and the
current documentation for fixing this is buried in a 250 line
configuration example.

This is just a minor documentation fix to make the possible need
for a custom key mapping on MacOS more prominent.

Change-Id: I8053de3a0a64ebeeec9d2d400766a8debe5c17fa
Logan V 1 year ago
parent
commit
1a277f8db6
2 changed files with 13 additions and 1 deletions
  1. 12
    0
      README.rst
  2. 1
    1
      examples/reference-gertty.yaml

+ 12
- 0
README.rst View File

@@ -176,6 +176,18 @@ screen.
176 176
 To select text (e.g., to copy to the clipboard), hold Shift while
177 177
 selecting the text.
178 178
 
179
+MacOS
180
+~~~~~
181
+
182
+The MacOS terminal blocks ctrl+o, which is the default search key combo in
183
+Gertty. To fix this, a custom keymap can be used on MacOS which modifies the
184
+search key combo. For example::
185
+
186
+  keymaps:
187
+    - name: default # MacOS blocks ctrl+o
188
+      change-search: 'ctrl s'
189
+      interactive-search: 'ctrl i'
190
+
179 191
 Terminal Integration
180 192
 --------------------
181 193
 

+ 1
- 1
examples/reference-gertty.yaml View File

@@ -107,7 +107,7 @@ keymaps:
107 107
     diff: 'd'
108 108
   - name: custom
109 109
     review: ['r', 'R']
110
-  - name: osx # OS X blocks ctrl+o
110
+  - name: osx # MacOS blocks ctrl+o
111 111
     change-search: 'ctrl s'
112 112
 # To specify a sequence of keys, they must be a list of keystrokes
113 113
 # within a list of key series.  For example:

Loading…
Cancel
Save