mobile-shell / mobile-shell/mosh

MOSH_ESCAPE_KEY requires literal control characters

Open
#619 1 comment 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

feature
Dominant language
C++
Stars
14.5k
Forks
865
PR merge metrics
No merged PRs in 30d

Description

Currently, the implementation of MOSH_ESCAPE_KEY simply uses the first character of the environment variable as the escape key. This means that control characters must be encoded as literals in this variable. This makes it somewhat harder to set the variable in the first place, is confusing to users when non-printing control characters make the variable look empty when they do "echo $MOSH_ESCAPE_KEY", and poses a mostly-unlikely issue that users could cause themselves more pain if they set the variable to a control character that's interpreted by their terminal on output (ESC, TAB, CR, LF, ...)
I think it might be worthwhile to improve this before release, by having a little bit of syntax, maybe just "^B". That has a few issues of its own, though. This is tied in with the i18n issue of ASCII control characters often being hard to use or understand for anybody whose language varies much from English. @rinne, do you have any comments on this?

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by locating the MOSH_ESCAPE_KEY implementation and reviewing how it currently takes the first environment-variable character. Evaluate the proposed control-character syntax such as "^B", including the stated terminal-output and internationalization concerns. The issue does not define a settled syntax or acceptance criteria, so completion would require agreement on the design.

Written by the indexing model from the issue text.

Assessment

Tech stack
cpp
Domain
cli
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.