DOCSEARCHbyAlgolia
Submit Docs

Termux:Float Documentation

repository·master·Indexed 21 days ago

https://github.com/termux/termux-float

A plugin for the Termux terminal emulator that enables a floating window mode, allowing the terminal to overlay other applications. Includes instructions for installation via F-Droid and GitHub, configuration via the ~/.termux/termux.float.properties file, and debugging using logcat.

Tokens
653
Snippets
2
Records
3
Agent score
24%

What's inside Termux:Float

  1. Install Termux:Float

    master

    Termux:Float is a plugin for the Termux app that allows you to display the terminal in a floating window.

    Prerequisite: You must ensure termux-app is installed correctly. Refer to the termux-app installation guide before proceeding.

    Installation Sources

    F-Droid

    Download the APK directly from F-Droid. You do not need the F-Droid app installed to download the APK. Note: F-Droid updates may lag behind GitHub releases. Ensure battery optimizations are disabled for the app to receive updates reliably.

    GitHub

    • Releases: Download stable APKs from the GitHub Releases page (version >= 0.15.0).
    • GitHub Actions: For the latest features or testing pull requests, download artifacts from GitHub Actions. You must be logged into a GitHub account to download artifacts.

    Google Play Store (Deprecated)

    Do not use the Google Play Store version. It is deprecated and no longer updated due to Android 10 compatibility issues.

  2. Configure Termux:Float settings

    master

    For version >= 0.15.0, you can customize the floating terminal behavior by creating or editing the ~/.termux/termux.float.properties file.

    Supported properties include:

    • enforce-char-based-input
    • ctrl-space-workaround
    • bell-character
    • terminal-cursor-style
    • terminal-transcript-rows
    • back-key
    • default-working-directory
    • volume-keys

    Note: ~/ refers to your Termux home directory (/data/data/com.termux/files/home/).

    mkdir -p ~/.termux
nano ~/.termux/termux.float.properties

  3. Debug Termux:Float using logcat

    master

    If you encounter issues, you can increase the logging verbosity to capture more information.

    1. Set Log Level

    In the Termux app, navigate to: Settings -> Termux:Float -> Debugging -> Log Level (Requires termux-app version >= 0.118.0).

    Available Log Levels:

    • Off: Log nothing.
    • Normal: Logs error, warn, info messages, and stacktraces (Default).
    • Debug: Logs debug messages.
    • Verbose: Logs additional verbose information.

    Warning: Revert to Normal after debugging to prevent private data from being passed to logcat and to avoid performance overhead.

    2. View Logs

    You can view logs in real-time within the terminal using logcat or dump them to a file:

    # View logs in real-time
logcat

# Dump logs to a file
logcat -d > logcat.txt
    logcat -d > logcat.txt