terminology
1.0.0
Please report bugs/issues at git.enlightenment.org
This is an EFL terminal emulator with some extra bells and whistles such as the ability to display in-line images, video and even play music files, background images, videos, Z-Modem like sending (e.g. SSH into a server and use tysend to send a file back to the local terminal), GPU Accelerated rendering (optional - just set the EFL Elementary toolkit engine to use OpenGL) and much more.
Please see http://www.enlightenment.org for information on these.
Once you have met requirements, compiling and installing are simple:
meson build
ninja -C build
sudo ninja -C build installAt the end of this file is more complete information on cimpiling and installing.
NOTE: to make terminology work with input methods in general you need:
export ECORE_IMF_MODULE="xim"
export XMODIFIERS="@im=none"Apart from the ones shipped with Terminology, themes can be stored in
~/.config/terminology/themes/.
Documentation on themes is written in THEMES.md.
Terminology ships with some common color schemes.
To know how to modify or add some new color schemes, please read COLORSCHEMES.md.
Right mouse button = controls menuMiddle mouse button = paste highlight selectionLeft mouse button/drag = make highlightWheel = scroll up or down in historyCtrl+Wheel = zoom font size up/downCtrl+Left mouse button/drag = make block selection highlightShift+PgUp = Scroll 1 page upShift+PgDn = Scroll 1 page downShift+Up = Scroll 1 line upShift+Down = Scroll 1 line downShift+Home = Scroll to the top of the backlogShift+End = Reset scrollShift+Left = switch focus to previous terminal inside a windowShift+Right = switch focus to next terminal inside a windowShift+Insert = Paste Clipboard (ctrl+v/c) selectionShift+Ctrl+Insert = Paste Primary (highlight) selectionShift+Keypad-Plus = Font size up 1Shift+Keypad-Minus = Font size down 1Shift+Keypad-Multiply = Reset font sizeShift+Keypad-Divide = Copy highlight to Clipboard (same as Ctrl+c in gui apps)Ctrl+PgUp = switch focus to previous terminal inside a windowCtrl+PgDn = switch focus to next terminal inside a windowCtrl+Shift+t = create new terminal on top of current inside window (tabs)Ctrl+Shift+End = close the focused terminal.Ctrl+Shift+h = toggle displaying the miniview of the historyCtrl+Shift+Home = bring up "tab" switcherCtrl+Shift+PgUp = split terminal horizontally (1 term above the other)Ctrl+Shift+PgDn = split terminal vertically (1 term to the left of the other)Ctrl+Shift+c = copy current selection to clipboardCtrl+Shift+v = paste current clipboard selectionAlt+Home = Enter command mode (enter commands to control terminology itself)Alt+Return = Paste primary selectionAlt+g = Group input: send input to all visible terminals in the windowAlt+Shift+g = Group input: send input to all terminals in the windowAlt+w = Copy selection to primaryAlt+Up = Focus the terminal aboveAlt+Down = Focus the terminal belowAlt+Left = Focus the terminal on the leftAlt+Right = Focus the terminal on the rightCtrl+Alt+Equal = Font size up 1Ctrl+Alt+Minus = Font size down 1Ctrl+Alt+0 = Reset font sizeCtrl+Alt+9 = Big font sizeCtrl+Alt+t = Set terminal titleCtrl+1 = switch to terminal tab 1Ctrl+2 = switch to terminal tab 2Ctrl+3 = switch to terminal tab 3Ctrl+4 = switch to terminal tab 4Ctrl+5 = switch to terminal tab 5Ctrl+6 = switch to terminal tab 6Ctrl+7 = switch to terminal tab 7Ctrl+8 = switch to terminal tab 8Ctrl+9 = switch to terminal tab 9Ctrl+0 = switch to terminal tab 10Terminology ships with a set of tools to help you get the best out of Terminology.
tyls: list directory contents with bells and whistlestyalpha: set transparency level of the backgroundtybg: change the background imagetycat: display inline a media file or a URItypop: display in a popup a media file or a URItyq: queue media files or URI to be popped uptysend: send files to the terminal (useful through ssh)[ 33][}][COMMAND][ 00]
i.e.
ESC char ( 33 or 0x1b)} charnul ( 00 or 0x00). 00 char (nul byte or 0x00 to indicate end of sequence)e.g.
`echo -n ' 33}Hello world 00'`In the following, any values inside square brackets [] are to be replaced
by some content (numbers, strings, paths, url's etc.).
Examples:
aa[PATH-OF-FILE] should become something like: aa/tmp/file.png
aa[true/false] should become something like: aatrue or aafalse
pn[FULL-PATH-OR-URL]
popup the given media file/url now
pq[FULL-PATH-OR-URL]
queue a popup for the given media file/url
bt[FULL-PATH-OR-URL]
set the terminal background media file/url temporarily
bp[FULL-PATH-OR-URL]
set the terminal background media file/url permanently
at[on/true/yes/off/false/no]
set the terminal alpha state to be on, or off temporarily
ap[on/true/yes/off/false/no]
set the terminal alpha state to be on, or off permanently
qs
query grid and font size. stdin will have written to it:
W;H;FW;FHn
W is the width of the terminal grid in charactersH is the height of the terminal grid in charactersFW is the width of 1 character cell in pixelsFH is the height of 1 character cell in pixelsis[CW;H;FULL-PATH-OR-URL]
insert Stretched media (where image will stretch to fill the cell area)
and define expected cell area to be W cells wide and H cells high,
with the image/media/url.
C is the replace character to be identified in later textW is the width in character cells (up to 511).H is the height in character cells (up to 511).note that this escape alone has no effect. It indicates a future
intention of inserting media into the terminal. the terminal will
EXPECT a grid of WxH replace characters to follow, with each
sequence of such replace characters beginning with a ib escape command
and ending with an 'ie' escape command.
the FULL-PATH-OR-URL for all the i commands (is, ic, if, it)
may be of the form:
/full/path/to/file.png/full/path/to/linkn/full/path/to/file.png
where a newline character separates a URI for a link and a full
path to a file to display in the region. the link is the
destination URI when a user may click on the given media image.example:
printf(" 33}is#5;3;%s 00"
" 33}ib 00##### 33}ie 00n"
" 33}ib 00##### 33}ie 00n"
" 33}ib 00##### 33}ie 00n", "/tmp/icon.png");note that # is the replace character, and later # chars if inside
begin/end escapes, will be replaced by the given media indicated
in the insert media escape.
ic[CW;H;FULL-PATH-OR-URL]
insert Centered media (centered in cell area). Otherwise parameters are
identical to the is command, but retains aspect and is padded by
blank space.
if[CW;H;FULL-PATH-OR-URL]
insert Filled media (fill in cell area). Otherwise parameters are
identical to the is command but ensures the entire area is
filled like a background even if media goes beyond cell bounds and is
clipped.
it[CW;H;FULL-PATH-OR-URL]
insert Thumb media (thumbnail cell area). Otherwise parameters are
identical to the is command, but uses thumbnail generation to
make a fast to load but low resolution version (cached) of the media.
it[CW;H;LINKnFULL-PATH-OR-URL]
insert Thumb media with link (thumbnail cell area). Otherwise parameters
are identical to the is command, but uses thumbnail generation to
make a fast to load but low resolution version (cached) of the media.
LINK is a path (or url) to open when the thumb is clicked on by the
user.
ij[CW;H;FULL-PATHnGROUP][n][cmd1][rn][cmd2]...
insert Edje object with file path given, and the group name given.
The command list (and the n whitespace delimiter before the list)
is optional, but is executed/parsed before display of the actual
object to do things like initialize its initial state. See iC
command for more details on the command list.
Be aware that once you have an object with an assigned channel id,
it can send back signals and messages via escapes on stdin. These
escapes will follow terminology extended escape format
(ESC + } ... 00), and the content will be one of:
;CHIDndragnPART NAMEnVAL1nVAL2;CHIDndrag,startnPART NAMEnVAL1nVAL2;CHIDndrag,stopnPART NAMEnVAL1nVAL2;CHIDndrag,stepnPART NAMEnVAL1nVAL2;CHIDdrag,setnPART NAMEnVAL1nVAL2signal;CHIDnSIGNAL STRINGnSOURCE STRINGmessage;CHIDnOPCODE IDnstringnSTRING1message;CHIDnOPCODE IDnintnINT1message;CHIDnOPCODE IDnfloatnFLOAT1message;CHIDnOPCODE IDnstring_setnSTRING1nSTRING2nSTRING3...message;CHIDnOPCODE IDnint_setnINT1nINT2nINT3...message;CHIDnOPCODE IDnfloat_setnFLOAT1nFLOAT2nFLOAT3...message;CHIDnOPCODE IDnstring_intnSTRING1nINT1message;CHIDnOPCODE IDnstring_floatnSTRING1nFLOAT1message;CHIDnOPCODE IDnstring_int_setnSTRING1nINT1nINT2nINT3...message;CHIDnOPCODE IDnstring_float_setnSTRING1nFLOAT1nFLOAT2nFLOAT3...iC[CHID]n[cmd1][rn][cmd2][rn][cmd3]...
send a Command (cmd1, cmd2, cmd3 etc.) to an existing named
channel id CHID. this can be a list of 1 or more command strings,
with each string broken by a continuous sequence of 1 or more r
and/or n characters. e.g. n, r, rn, nr,
nrnnn, etc.
commands understood are:
textnPART NAMEnTEXT STRING
set the text of PART NAME to string TEXT STRING
emitnSIGNAL STRINGnSOURCE STRING
emit signal SIGNAL STRING SOURCE STRING
dragnPART NAMEn[value|size|step|page]nVAL1nVAL2
manipulate dragable of name PART NAME and either set value,
size, step or page properties to VAL1 and VAL2 for x
and y, where VAL1 and VAL2 are floating point valueschidnCHANNEL ID
set the channel id of a given edje object (only valid in setup
commands for the inline edje object) to CHANNEL ID so it can
be addressed later.messagenOPCODE IDn[string|int|float|string_set|int_set|...
float_set|string|int|string_float|string_int_set|...
string_float_set]n[message data]
send a message with opcode (integer) id OPCODE ID of one of
the given types supported (string, int, float, etc.) and
then with the given message data at the end.
message data format depends on message type:
string: STRING1
int: INT1
float: FLOAT1
string_set: STRING1nSTRING2nSTRING3...
int_set: INT1nINT2nINT3...
float_set: FLOAT1nFLOAT2nFLOAT3...
string_int: STRING1nINT1
string_float: STRING1nFLOAT1
string_int_set: STRING1nINT1nINT2nINT3...
string_float_set: STRING1nFLOAT1nFLOAT2nFLOAT3...
ib
begin media replace sequence run
ie
end media replace sequence run
fr[PATH/FILE]
begin file send for a file named PATH / FILE
fs[SIZE_BYTES]
set the size in bytes of a file send started with the above fr escape
fd[CHECKSUM DATA]
block of data for the current file transfer with checksum as a
string decimal which is the sum of every byte when taken as an
unsigned char per byte. the checksum is a signed 32bit integer.
the checksum is the sum of the data after escaping. 4 bits at a
time per data byte, encoded with high bits in one byte then low
bits, with the bits encoded as 4 bit value being 0x40 + 4 bit value
per byte. (@ == 0x0, A == 0x1, B == 0x2, ... N == 0xe, O == 0xf).
so to rebuild a byte will be (((bytes[0] - 0x40) & 0xf) << 4) | ((bytes[1] - 0x40) & 0xf) per byte pair in the data block.
fx
exit file send mode (normally at the end of the file or when it's
complete)
Meson is the build system used for this project. For more information please see mesonbuild.com
You will need normal build tooling installed such as a compiler (gcc or clang for example), pkg-config, ninja, any relevant package-dev or package-devel packages if your distribution splits out development headers (e.g. libc6-dev) etc.
Depending on where dependencies (like efl) are installed, you might have to
set your PKG_CONFIG_PATH environment variable like:
export PKG_CONFIG_PATH=/usr/local/lib/pkgconfig:/usr/lib/pkgconfigAlso note that some distributions like to add extra arch directories to your library locations so you might have to have more like:
export PKG_CONFIG_PATH=/usr/local/lib/pkgconfig:/usr/local/lib64/pkgconfig:/usr/local/lib/x86_64-linux-gnu/pkgconfig:/usr/lib/pkgconfig:/usr/lib64/pkgconfig:/usr/lib/x86_64-linux-gnu/pkgconfigYou will need to ensure that the destination library directory (e.g.
/usr/local/lib is in your /etc/ld.so.conf or /etc/ld.so.conf.d/
files and after installing anything that installs libraries you
re-run ldconfig. Please see relevant documentation on ldconfig and
ld.so.conf for your distribution.
You might also want to add the destination bin dir to your environment variable PATH (see documentation on your shell PATH variable) such as:
export PATH=/usr/local/bin:/usr/bin:/binNormal compilation in /usr/local:
meson . build
ninja -C build
sudo ninja -C build installFor meson build generic options:
meson --helpFor a list of project specific options supported:
cat meson_options.txtTo set 1 or more project specific options:
meson --prefix=/path/to -Doption=value [-Dother=value2] [...] . buildTo display current configuration:
meson configure buildThe above will only work after at least the following is done:
meson . buildHow to clean out the build and config and start fresh:
rm -rf buildHow to make a dist tarball and check its build: (must do it from git tree clone and commit all changes to git first)
ninja -C build distHow to change prefix:
meson --prefix=/path/to/prefix . buildHow to install in a specific destination directory for packaging:
DESTDIR=/path/to/destdir ninja -C build installHow to build with verbose output (full commands run):
ninja -C build -vTerminology can run on the framebuffer, if EFL is compiled with fb or
drm support.
Then the following environment need to be set:
ELM_DISPLAY=fbELM_ACCEL=noneEVAS_FB_DEV=/dev/fb0
