---
name: "ekg2-remote"
section: "1"
platform: "linux"
package: "ekg2-remote"
version: "1:0.3.1-3"
release: "Debian 7 (Wheezy)"
platforms: ["linux"]
url: "https://new.carta.tech/ekg2-remote"
---

# ekg2-remote(1)

remote User Interface for EKG2

## NAME

ekg2-remote - remote User Interface for EKG2

## SYNOPSIS

**ekg2-remote** \[*OPTIONS*\] REMOTE-ENDPOINT

## DESCRIPTION

**ekg2-remote** is a program which provides a remote user interface to an EKG2 instance that uses the "remote" plugin. It connects to EKG2 via a socket, and lets you use the program as if it was running locally.

The motivation behind this program was to be able to use EKG2 on a low performance machine with limited memory and CPU resources.

## OPTIONS

- **-c***,* **--charset***=CHARSET*

  forces the charset name to use,

- **-p***,* **--password***=PASSWORD*

  sets the password,

- **-T***,* **--test***=FRONTEND*

  runs in test mode (for debugging), using *FRONTEND* user interface (default is ncurses),

- **-F***,* **--frontend***=FRONTEND*

  uses *FRONTEND* user interface (default is ncurses),

- **-m**, **--no-mouse**

  does not load mouse support,

- **-U**, **--unicode**

  forces unicode support,

- **-h**, **--help**

  displays a help message,

- **-v**, **--version**

  displays program version and exits

*ENDPOINT* specifies the EKG2 instance to connect to. The following are accepted:

- **tcp:***address***:***port*

  cleartext TCP/IP connection to given *address* and *port*

- **tcps:***address***:***port*

  SSL-encrypted TCP/IP connection to given *address* and *port*

- **udp:***address***:***port*

  UDP/IP connection to given *address* and *port*

- **unix:***socket-path*

  local (UNIX) connection to given *socket-path*

- **pipe:***fifo-path*

  local (pipe) connection to given *fifo-path*. Currently unsupported.

## SEE ALSO

[**ekg2**(1)](/ekg2/1.md). The full documentation for **ekg2** is maintained as a Docbook manual.  See **http://ekg2.org/ekg2book/** for an online version.