Merge pull request #3251 from cdr/jsjoeio/document-android-issue

docs(termux): add workaround for Android backspace issue

ci/dev/fmt.sh

@@ -30,6 +30,7 @@ main() {
   doctoc --title '# Maintaining' docs/MAINTAINING.md >/dev/null
   doctoc --title '# Contributor Covenant Code of Conduct' docs/CODE_OF_CONDUCT.md >/dev/null
   doctoc --title '# iPad' docs/ipad.md >/dev/null
+  doctoc --title '# Termux' docs/termux.md >/dev/null
 
   if [[ ${CI-} && $(git ls-files --other --modified --exclude-standard) ]]; then
     echo "Files need generation or are formatted incorrectly:"

docs/install.md

@@ -10,7 +10,6 @@
 - [Fedora, CentOS, RHEL, SUSE](#fedora-centos-rhel-suse)
 - [Arch Linux](#arch-linux)
 - [Termux](#termux)
-  - [Known Search Issue](#known-search-issue)
 - [yarn, npm](#yarn-npm)
 - [macOS](#macos)
 - [Standalone Releases](#standalone-releases)
@@ -131,32 +130,7 @@ sudo systemctl enable --now code-server@$USER
 
 ## Termux
 
-Termux is an Android terminal application and Linux environment, which can also run code-server from your phone.
+Please see "Installation" in the [Termux docs](./termux.md#installation)
-
-1. Install Termux from the [Google Play Store](https://play.google.com/store/apps/details?id=com.termux&hl=en_US&gl=US)
-2. Make sure it's up-to-date by running `apt update && apt upgrade`
-3. Install required packages: `apt install build-essential python git nodejs yarn`
-4. Install code-server: `yarn global add code-server`
-5. Run code-server: `code-server` and navigate to localhost:8080 in your browser
-
-To upgrade run: `yarn global upgrade code-server --latest`
-
-### Known Search Issue
-
-There is a known issue with search not working on Android because it's missing `bin/rg`. To fix:
-
-1. Install `ripgrep` with `pkg`
-   ```sh
-   pkg install ripgrep
-   ```
-2. Make a soft link using `ln -s`
-
-```sh
-# run this command inside the code-server directory
-ln -s $PREFIX/bin/rg ./lib/vscode/node_modules/vscode-ripgrep/bin/rg
-```
-
-For more context, see [comment](https://github.com/cdr/code-server/issues/1730#issuecomment-721515979).
 
 ## yarn, npm
 

docs/termux.md

@@ -0,0 +1,61 @@
+<!-- START doctoc generated TOC please keep comment here to allow auto update -->
+<!-- DON'T EDIT THIS SECTION, INSTEAD RE-RUN doctoc TO UPDATE -->
+# Termux
+
+- [Termux](#termux)
+  - [Installation](#installation)
+  - [Upgrading](#upgrading)
+  - [Known Issues](#known-issues)
+    - [Search issue](#search-issue)
+    - [Backspace not working](#backspace-not-working)
+
+<!-- END doctoc generated TOC please keep comment here to allow auto update -->
+
+# Termux
+
+Termux is an Android terminal application and Linux environment, which can also run code-server from your phone.
+
+## Installation
+
+1. Install Termux from the [Google Play Store](https://play.google.com/store/apps/details?id=com.termux)
+2. Make sure it's up-to-date by running `apt update && apt upgrade`
+3. Install required packages: `apt install build-essential python git nodejs yarn`
+4. Install code-server: `yarn global add code-server`
+5. Run code-server: `code-server` and navigate to localhost:8080 in your browser
+
+## Upgrading
+
+To upgrade run: `yarn global upgrade code-server --latest`
+
+## Known Issues
+
+### Search issue
+
+There is a known issue with search not working on Android because it's missing `bin/rg`. To fix:
+
+1. Install `ripgrep` with `pkg`
+   ```sh
+   pkg install ripgrep
+   ```
+2. Make a soft link using `ln -s`
+
+```sh
+# run this command inside the code-server directory
+ln -s $PREFIX/bin/rg ./lib/vscode/node_modules/vscode-ripgrep/bin/rg
+```
+
+For more context, see [comment](https://github.com/cdr/code-server/issues/1730#issuecomment-721515979).
+
+### Backspace not working
+
+There is a known issue with the backspace key not working correctly when using the on-screen keyboard on Android. This is due to an upstream issue. Read more:
+
+- [Issues with Backspace in Codespaces on Android (Surface Duo)](https://github.com/microsoft/vscode/issues/107602)
+- [Support mobile platforms](https://github.com/xtermjs/xterm.js/issues/1101)
+
+Workaround: use a Bluetooth keyboard.
+
+For more context, see issues:
+
+- [500 error: 3.9.2 not working on Android + Termux](https://github.com/cdr/code-server/issues/3036)
+- [Document Android backspace issue](https://github.com/cdr/code-server/issues/3079)