Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/whisperity/monomux

Monophone Terminal Multiplexer - Less intrusive than tmux, smarter than screen
https://github.com/whisperity/monomux

console detach linux posix screen ssh terminal terminal-application tmux unix

Last synced: about 1 month ago
JSON representation

Monophone Terminal Multiplexer - Less intrusive than tmux, smarter than screen

Awesome Lists containing this project

README 

        
MonoMux

=======



MonoMux (for _Monophone Terminal Multiplexer_ — pun intended) is a system tool that allows executing terminal sessions in the background with on-demand attaching to them.



> **đŸ“ĸ Important!** MonoMux is in active incremental development!

> You are welcome using it as your daily driver, but for long-term production systems, use the proven alternatives instead!



MonoMux is a tool similar to [`screen`](http://gnu.org/software/screen/) and [`tmux`](https://github.com/tmux/tmux/wiki).

It allows most of the core features of _screen_ or _tmux_, with being less intrusive about its behaviour when it comes to using these tools with modern _terminal emulators_.



> **⚠ī¸ Warning!** Currently, _MonoMux_ is designed with only supporting Linux operating systems in mind.

> Most of the project is written with POSIX system calls in mind, but there are *some* GNU extensions used.



> **ℹī¸ Note:** _MonoMux_ is **NOT** a terminal emulator by itself!

> To use it, you may use any of your favourite terminal emulators.



Dependencies

------------



MonoMux uses modern C++ features, and as such, a C++17-capable compiler and associated standard library is needed to compile and execute the tool.

There are no other dependencies.



Installation

------------



### Ubuntu (18.04, 20.04, 22.04)



Download the `.deb` (and optionally the `.ddeb`) file for the release, and install the standard way:



~~~{.bash}

sudo dpkg --install monomux-*.*deb

~~~



Alternatively, a `.tar.gz` archive might be used.

The application consists of a single self-contained binary.



Usage

-----



The easiest use of MonoMux is simply starting it: `monomux`.

By default, a server starts in the background, and a default session is created with the default shell of the current user, and the client automatically attaches to this session.

Executing the client with a server already running will attach to the only session on the server, or if multiple sessions exist, an interactive menu will start with which a session can be selected.

(The interactive menu can be explicitly requested, even if only at most one session exists, with the `-i` or `--interactive` parameter.)



> **ℹī¸ Note:** Please always refer to the output of `monomux -h` for up-to-date information about what flags the installed tool supports.



To run multiple independent servers, specify the `-s`/`--socket` option with a path on the file system.

Communication between the server and the client takes place on this socket.



### Fine-tuning Client options



The client can be fine-tuned during its start-up with several flags:



 * `monomux /bin/myshell` will start the specified program without passing any arguments to it.

 * `monomux -- /bin/myshell -a -b --arg-to-shell` will start the specified program with command-line arguments, if a new session is created.

   (If the started program takes `-` or `--` arguments, an _explicit_ separator `--` must be given **BEFORE** the program's name!)

 * `monomux -n SESSION_NAME` will attach or start the session `SESSION_NAME`, bypassing the interactive menu.

 * Environment variables can be specified or removed via `-e VARIABLE=Value -u UNSET_VARIABLE`.



A server can be started explicitly via `monomux --server`, in which case no client creation and attachment will be done.



Why?

----



One of the most important contexts where _screen_ or _tmux_ comes to mind is over remote sessions.

If a remote connection breaks — or the local graphical terminal closes or crashes —, the terminal session behind the connection is sent a **`SIGHUP`** signal, for which most programs exit.

This results in the loss of shell history, and the interrupt of running programs.



The most crucial problem from an interactive work's point-of-view with existing tools is that both _screen_ and _tmux_ **act as terminal emulators** themselves.

Their behaviour is to _parse_ the [VT sequences](http://vt100.net/docs/vt100-ug/chapter3.html) of the output received from the "remote" terminal and emit them to the attached client(s).

Programs using extensive modern, or terminal specific features will have to fall back to the older and more restrictive set of what _screen_ or _tmux_ understands.



A fork of _screen_, [`dtach`](http://github.com/crigler/dtach) was created which emulates **only** the attach/detach features of _screen_.

However, _dtach_ has a straightforward and non-trivial interface, e.g. the user must specify the connection socket file manually.



(Moreover, all of the aforementioned tools are written in C.)



MonoMux aims to combine the good aspects of all of these tools but remove almost all of the possible hurdles in the way of tools running in the background session.



 * Attach/detach features are supported without the need of parsing control sequences.

 * Every I/O operation to and from the client to the attached session is passed **verbatim**, without understanding the contents.

   * This allows using all the features of a modern _terminal emulator_ as-is.

   * However, this also means that features found in _tmux_ such as splits or keybinds _can not_ and **will not** be implemented in this tool.

 * Better defaults than _dtach_: no need to specify an exit escape sequence or modern resize events.

 * Like _tmux_, there is meaningful session management by default, giving an interactive attach menu if multiple sessions exist.



Written in C++17, with object-oriented design in mind.

This might result in a larger binary than for other tools, however, _MonoMux_ is intended for user systems, not embedded contexts.