From 2844cd54dab2893a0baa0464e8de0a01f1048b05 Mon Sep 17 00:00:00 2001
From: Anmol Sethi <hi@nhooyr.io>
Date: Wed, 1 Jul 2020 21:57:03 -0400
Subject: docs: Describe how to escape keycodes with nvim_feedkeys (#12484)

Closes #12297
---
 src/nvim/api/vim.c | 10 ++++++++++
 1 file changed, 10 insertions(+)

(limited to 'src')

diff --git a/src/nvim/api/vim.c b/src/nvim/api/vim.c
index 40cef87cf0..d6f95c7a5f 100644
--- a/src/nvim/api/vim.c
+++ b/src/nvim/api/vim.c
@@ -203,6 +203,16 @@ Integer nvim_get_hl_id_by_name(String name)
 /// flags. This is a blocking call, unlike |nvim_input()|.
 ///
 /// On execution error: does not fail, but updates v:errmsg.
+//
+//  If you need to input sequences like <C-o> use nvim_replace_termcodes
+//  to replace the termcodes and then pass the resulting string to
+//  nvim_feedkeys. You'll also want to enable escape_csi.
+///
+/// Example:
+/// <pre>
+///     :let key = nvim_replace_termcodes("<C-o>", v:true, v:false, v:true)
+///     :call nvim_feedkeys(key, 'n', v:true)
+/// </pre>
 ///
 /// @param keys         to be typed
 /// @param mode         behavior flags, see |feedkeys()|
-- 
cgit