Weird behavior of CTRL / in wezterm

[kprav33n]

I'm running nightly build of wezterm on Arch Linux.

~ 
➜ lsb_release -a
LSB Version:	1.4
Distributor ID:	Arch
Description:	Arch Linux
Release:	rolling
Codename:	n/a

~ 
➜ wezterm --version
wezterm 20210314-114017-04b7cedd-5-g2ea09317

Normally in other terminals, I use CTRL / for undo in Emacs and Bash, which is the default bindings. But, this doesn't seem to work under wezterm. CTRL / produces a newline character. I tried removing the default bindings by putting disable_default_key_bindings = true in the configuration file. It disabled all the default bindings, but still CTRL / produces a newline instead of undo. I'm not sure how to debug this. Any pointers? Thank you!

[wez]

When debugging key sequences there are two levels of thing to look at:

• You can run wezterm --config debug_key_events=true and it will log its interpretation of the keys that are being pressed. Under X11, we log: key_event KeyEvent { key: Char('/'), modifiers: CTRL, raw_key: None, raw_modifiers: CTRL, raw_code: Some(61), repeat_count: 1, key_is_down: true } which shows that it is being recognized correctly
• In your shell, you can run od -c and then type the key sequence to see how it is being encoded to send to the application:
  • wezterm produces: ^O
  • xterm and gnome terminal produce ^_

I'll look into resolving this, but for now you can workaround this by defining a key mapping:

local wezterm = require 'wezterm';

return {
  keys = {
    {key="/", mods="CTRL", action=wezterm.action{SendString="\x1f"}},
  }
}

[wez]

fixed by 7def5f0 which should show up in the nightly build in the next hour.

[kprav33n]

Thank you for taking a look and providing the workaround. I tried it in my config, and this fixes the issues for me. I also saw your commit that makes the CTRL key mappings conform to xterm behavior. Much appreciated!

I tried to install AUR wezterm-git and I'm seeing the error error: failed to parse lock file at: /home/praveen/.cache/yay/wezterm-git/src/wezterm/Cargo.lock, https://gist.github.com/kprav33n/17afc23b7410968cbc9b12e586975522 I'll debug this further after work today. I'm wondering if this is anyway related to c6922c0

I wish I have found out about wezterm much earlier. Such a wonderful piece of software and thank you for putting this out. Lua based configuration and OSC52 support are the most important features that I love. I'm still discovering all the cool things that wezterm has to offer. I'm so excited to be using it! Is your primary (personal) configuration file available on github to learn from?

[wez]

re: error parsing Cargo.lock; you may need to update the version of Rust on your system.

Here's my current config; there's some junk in there from testing things, but it should give a bit of a taste:

local wezterm = require 'wezterm';
local hostname = wezterm.hostname();

wezterm.on("my-thingy", function(window, pane)
  local dims = pane:get_dimensions();
  wezterm.log_error("did my thingy with wnidow " .. window:window_id() .. " pane " .. pane:pane_id() .. " " .. dims.cols .. "x" .. dims.viewport_rows);

  local scrollback = pane:get_lines_as_text(2000);
  local io = require 'io';
  local os = require 'os';
  local name = os.tmpname();
  local f = io.open(name, "w+");
  f:write(scrollback);
  f:flush();
  f:close();

  window:perform_action(wezterm.action{SpawnCommandInNewWindow={
    args={"vim", name}}
  }, pane)

  wezterm.sleep_ms(1000);
  os.remove(name);

  -- window:perform_action("IncreaseFontSize", pane);
end)

function pct_to_bar(val)
  local seventh = 1.0/7.0;
  local band = math.ceil(val / seventh)
  -- wezterm.log_info(string.format("%f -> band %d -> %x", val, band, 0x2580 + band))
  return utf8.char(0x2580 + band)
end

function pct_to_bar_fa(val)
  local fifth = 1.0/5.0;
  local band = math.ceil(val / fifth)
  -- Using font awesome battery glyphs
  return utf8.char(0xf245 - band)
end

function pct_to_bar_mdi(val, charging)
  local charge_map = {
    0xf089c, -- battery-charging-10
    0xf0086, -- 20
    0xf0087, -- 30
    0xf0088, -- 40
    0xf089d, -- 50
    0xf0089, -- 60
    0xf089e, -- 70
    0xf008a, -- 80
    0xf008b, -- 90
    0xf0085, -- 100
  };
  local discharge_map = {
    0xf007a, -- battery-10
    0xf007b, -- 20
    0xf007c, -- 30
    0xf007d, -- 40
    0xf007e, -- 50
    0xf007f, -- 60
    0xf0080, -- 70
    0xf0081, -- 80
    0xf0082, -- 90
    0xf0079, -- 100
  };
  local tenth = 1.0/10.0;
  local band = math.ceil(val / tenth)
  local map = discharge_map;
  if charging then
    map = charge_map
  end
  return utf8.char(map[band])
end

wezterm.on("update-right-status", function(window, pane)
  -- Each element holds the text for a cell in a "powerline" style << fade
  local cells = {""};

  -- Figure out the cwd and host of the current pane.
  -- This will pick up the hostname for the remote host if your
  -- shell is using OSC 7 on the remote host.
  local cwd_uri = pane:get_current_working_dir()
  if cwd_uri then
    cwd_uri = cwd_uri:sub(8);
    local slash = cwd_uri:find("/")
    local cwd = ""
    local hostname = ""
    if slash then
      hostname = cwd_uri:sub(1, slash-1)
      -- Remove the domain name portion of the hostname
      local dot = hostname:find("[.]")
      if dot then
        hostname = hostname:sub(1, dot-1)
      end
      -- and extract the cwd from the uri
      cwd = cwd_uri:sub(slash)

      table.insert(cells, cwd);
      table.insert(cells, hostname);
    end
  end

  -- I like my date/time in this style: "Wed Mar 3 08:14"
  local date = wezterm.strftime("%a %b %-d %H:%M");
  table.insert(cells, date);

  -- An entry for each battery (typically 0 or 1 battery)
  for _, b in ipairs(wezterm.battery_info()) do
    local charging = false;
    if b.state == "charging" or b.state == "Charging" then
      charging = true;
    end
    local level = pct_to_bar_mdi(b.state_of_charge, charging)
    table.insert(cells, string.format("%.0f%% %s", b.state_of_charge * 100, level))
  end

  -- The powerline < symbol
  local LEFT_ARROW = utf8.char(0xe0b3);
  -- The filled in variant of the < symbol
  local SOLID_LEFT_ARROW = utf8.char(0xe0b2)
  -- The little squares symbol
  local LITTLE_LEFT_SQUARES = utf8.char(0xe0c5)
  local LEFT_SQUARES = utf8.char(0xe0c7)
  local LEFT_FLAMES = utf8.char(0xe0c2)

  -- Color palette for the backgrounds of each cell
  local colors = {
    "#2b2042",
    "#382848",
    "#52307c",
    "#663a82",
    "#7c5295",
    "#b491c8",
  };

  -- Foreground color for the text across the fade
  local text_fg = "#c0c0c0";

  -- The elements to be formatted
  local elements = {};
  -- How many cells have been formatted
  local num_cells = 0;

  -- Translate a cell into elements
  function push(text, is_last)
    local cell_no = num_cells + 1
    table.insert(elements, {Foreground={Color=text_fg}})
    table.insert(elements, {Background={Color=colors[cell_no]}})
    table.insert(elements, {Text=" "..text.." "})
    if not is_last then
      table.insert(elements, {Foreground={Color=colors[cell_no+1]}})
      table.insert(elements, {Text=SOLID_LEFT_ARROW})
    end
    num_cells = num_cells + 1
  end

  while #cells > 0 do
    local cell = table.remove(cells, 1)
    push(cell, #cells == 0)
  end

  window:set_right_status(wezterm.format(elements));
end);

function font_with_fallback(name, params)
  local names = {name,
        -- "Font Awesome 5 Free Solid",
        "Material Design Icons Desktop",
        "Terminus"}
  return wezterm.font_with_fallback(names, params)
end

local keys = {
  -- {key="E", mods="CTRL", action=wezterm.action{CloseCurrentPane={confirm=false}}},
 --  {key="raw:26", mods="CTRL", action=wezterm.action{EmitEvent="my-thingy"}},
  {key="{", mods="SHIFT|ALT", action=wezterm.action{ActivateTabRelative=-1}},
  {key="}", mods="SHIFT|ALT", action=wezterm.action{ActivateTabRelative=1}},
  {key="{", mods="SHIFT|CTRL", action=wezterm.action{ActivateTabRelative=-1}},
  {key="}", mods="SHIFT|CTRL", action=wezterm.action{ActivateTabRelative=1}},
-- {key="Backspace", mods="CTRL", action=wezterm.action{SendString="\x1b[3~"}},
  {key="UpArrow", mods="LEADER", action=wezterm.action{ScrollToPrompt=-1}},
  {key="DownArrow", mods="LEADER", action=wezterm.action{ScrollToPrompt=1}},
--  {key="y", mods="CMD", action=wezterm.action{SpawnCommandInNewWindow={
--    args={"top"}
--  }}},
--  {key="m", mods="ALT", action="ShowTabNavigator"},
--  {key="l", mods="ALT", action="ShowLauncher"},
--    {key="t", mods="SHIFT|ALT", action=wezterm.action{SpawnTab="DefaultDomain"}},
  -- {key="m", mods="NONE", action=wezterm.action{SendString=""}},

  {key="H", mods="SHIFT|CTRL", action=wezterm.action{Search={Regex="[a-f0-9]{6,}"}}},

--  {key="UpArrow", mods="SHIFT|CTRL|ALT", action=wezterm.action{AdjustPaneSize={"Up", 5}}},

  --[[
      {key="LeftArrow", mods="OPT", action=wezterm.action{SendString="\x1bb"}},
    {key="RightArrow", mods="OPT", action=wezterm.action{SendString="\x1bf"}},
    ]]
    {key="q", mods="CMD", action="QuitApplication"},
};
for i = 1, 8 do
  table.insert(keys, {
    key=tostring(i),
    mods="CTRL|ALT",
    action=wezterm.action{ActivateTab=i-1},
  })
  table.insert(keys, {
    key="F" .. tostring(i),
    action=wezterm.action{ActivateTab=i-1},
  })
end

local window_decorations = "TITLE|RESIZE"

local font_size;
local enable_wayland = true
if wezterm.target_triple:find("apple") then
  window_decorations = "RESIZE"
  font_size = 13.3;
elseif hostname == "pixelbookgo-localdomain" then
  font_size = 12.0;
  enable_wayland = false;
else
  font_size = 10.0;
end

if wezterm.target_triple == "x86_64-unknown-linux-gnu" then
  window_decorations = "RESIZE"

  -- rebind CTRL+SHIFT+<number> to switch to a tab.
  if os.getenv("WAYLAND_DISPLAY") and enable_wayland then
    -- wayland hack
    local tab_no = 0
    for i = 2, 9 do
      table.insert(keys, {
        key="raw:"..tostring(i),
        mods="CTRL|SHIFT",
        action=wezterm.action{ActivateTab=tab_no},
      })
      tab_no = tab_no + 1
    end
  else
    local tab_no = 0
    for i = 10, 20 do
      table.insert(keys, {
        key="raw:"..tostring(i),
        mods="CTRL|SHIFT",
        action=wezterm.action{ActivateTab=tab_no},
      })
      tab_no = tab_no + 1
    end
  end
end

local font_locator
local font_dirs
if wezterm.target_triple == "x86_64-pc-windows-msvc" then
  font_dirs = {"wez-personal/dotfiles/fonts", "c:/open/wez-personal/dotfiles/fonts"}
  font_locator = "ConfigDirsOnly"
else
  font_dirs = {".dotfiles/fonts"}
end

local unix_domains
if wezterm.target_triple == "x86_64-pc-windows-msvc" then
  unix_domains = {
    {
      name = "wsl",
      serve_command = {"wsl", "wezterm", "start", "--daemonize", "--front-end", "MuxServer"}
    }
  }
else
  if os.getenv("WSL_DISTRO_NAME") then
    unix_domains = {
      {
        name = "wsl",
        socket_path = "/mnt/c/Users/wez/.local/share/wezterm/sock",
        -- skip_permissions_check = true,
        -- serve_command = {"wsl", "wezterm", "start", "--daemonize", "--front-end", "MuxServer"}
      }
    }
  else
    unix_domains = {{name = "unix"}}
  end
end

local USER = os.getenv("USER") or ""

local launch_menu = {}
local default_prog
local set_environment_variables = {}
if hostname == "glowy" and false then
  default_prog = {"c:/users/wez/wez-personal/wzsh/target/release/wzsh.exe"}
  -- default_prog = {"cmd.exe", "/s", "/k", "c:/users/wez/downloads/clink_0.4.9/clink_0.4.9/clink_x64.exe", "inject", "-q"}
end
if wezterm.target_triple == "x86_64-pc-windows-msvc" then
  set_environment_variables["prompt"] = "$E]7;file://localhost/$P$E\\$E[32m$T$E[0m $E[35m$P$E[36m$_$G$E[0m "

  -- use a more ls-like output format for dir
  set_environment_variables["DIRCMD"] = "/d"

  table.insert(launch_menu, {
    label = "Wzsh",
    args = {"c:/users/wez/wez-personal/wzsh/target/release/wzsh.exe"}
  })

  table.insert(launch_menu, {
    label = "CMD",
    args = {"cmd.exe"},
  })

  table.insert(launch_menu, {
    label = "PowerShell",
    args = {"powershell.exe", "-NoLogo"},
  })

  for _, vsvers in ipairs(wezterm.glob("Microsoft Visual Studio/20*", "C:/Program Files (x86)")) do
    local year = vsvers:gsub("Microsoft Visual Studio/", "")
    table.insert(launch_menu, {
      label = "x64 Native Tools VS " .. year,
      args = {"cmd.exe", "/k", "C:/Program Files (x86)/" .. vsvers .. "/BuildTools/VC/Auxiliary/Build/vcvars64.bat"},
    })
  end
end

return {
  -- color_scheme = "Gruvbox Dark",
  -- color_scheme = "Github",
   -- color_scheme = "Misterioso",
  -- color_scheme = "Piatto Light",
  colors = {
    scrollbar_thumb = "#555555",
    -- split = "#444444",
    -- foreground = "#b2b2b2",
    selection_bg = "#333333",
    selection_fg = "#9988aa",

    tab_bar = {
      -- macos inactive title bar background
      -- background = "#26262d",

      -- macos active title bar background
      -- background = "#35353c",

      background = "#2b2042",
      inactive_tab = {
        fg_color = "#a0a0a0",
        bg_color = "#1b1032",
        intensity = "Half",
      },
    },
  },
--  leader = { key="a", mods="CTRL" },
  enable_wayland = enable_wayland,
--  default_cursor_style = "BlinkingBlock",
--    cursor_blink_rate = 2000,
  use_local_build_for_proxy = false,
  enable_scroll_bar = false,
  enable_tab_bar = true,
  hide_tab_bar_if_only_one_tab = false,
  scrollback_lines = 35000,
  font_dirs = font_dirs,
  font_locator = font_locator,
  font_size = font_size,

  default_prog = default_prog,
  set_environment_variables = set_environment_variables,

  -- send_composed_key_when_alt_is_pressed = false,
  -- send_composed_key_when_left_alt_is_pressed = false,
  -- send_composed_key_when_right_alt_is_pressed = true,

  window_padding = {
    left = 2,
    bottom = 2,
  },

  font = font_with_fallback("Operator Mono SSm Lig Medium"),

  unix_domains = unix_domains,

  ssh_domains = {
    {
      name = "localhost",
      remote_address = "localhost",
      username = "wez",
    },
    {
      name = "cubessh",
      remote_address = "cube-localdomain",
      username = "wez",
    },
  },

  font_rules= {
    {
      italic = true,
      font = font_with_fallback("Operator Mono SSm Lig Medium Italic"),
    },

    {
      italic = true,
      intensity = "Bold",
      font = font_with_fallback("Operator Mono SSm Lig Book Italic"),
    },

    {
      intensity = "Bold",
      font = font_with_fallback("Operator Mono SSm Lig Bold", {foreground = "tomato"}),
    },

    {
      intensity = "Half",
      font = font_with_fallback("Operator Mono SSm Lig Light"),
    },
  },
  allow_square_glyphs_to_overflow_width = "WhenFollowedBySpace",

  mouse_bindings = {
    { event={Down={streak=3, button="Left"}},
      action={SelectTextAtMouseCursor="SemanticZone"},
      mods="NONE"
    },
  },
  allow_square_glyphs_to_overflow_width = "WhenFollowedBySpace",

  window_decorations = window_decorations,

  keys = keys,
  -- debug_key_events = true,
  use_ime = false,

  -- font_shaper = "Allsorts",

  launch_menu = (function()
    if #launch_menu == 0 then
      return nil
    else
      return launch_menu
    end
  end)(),
}

[bew]

For config example, check #548 (only 2 for now, maybe more later)
Also check on github with: https://github.com/search?l=&q=filename%3Awezterm.lua&type=code

[kprav33n]

I installed wezterm-git AUR after upgrading Rust (rustup update). The fix that you put in works fine. The behavior now is similar to xterm. Thank you for the pointer about upgrading Rust.

A huge shout out for sharing your config file! That is a lot to digest at once. I'll keep that as a reference and start using things that I see as fit.

Thanks @bew for the pointer about how to search for files with a specific name on github.

[bew]

To help with the debugging, what keyboard layout are you using?

[kprav33n]

Thank you for the help. I'm using Dvorak layout. But, this issue has nothing to do with the layout. I tried changing to QWERTY before I posted the question. It didn't matter. Wez has answered above with a workaround and he pushed a fix that addresses this issue.