aboutsummaryrefslogtreecommitdiff
path: root/README.md
blob: c9449007f075e88b6e111dc4190715c8133cecb0 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
This project was mostly an exercise on how to make the leanest possible terminal
emulator using GTK+2 and VTE. It is not actively developed.

# T #
T is a lean **T**erminal emulator. The project aims to keep it as simple as
possible, while still being usable. Configuration is done by modifying the file
`config.h` and recompiling. In order to use T, you must first run it as a daemon
(-d option) and then send commands by running the same executable using other
options. This was done so that the resource usage is (somewhat) minimized by
keeping all terminals under the same process while new windows are opened
(somewhat) faster.

## Compilation ##
T has the following compilation dependencies. The versions are the ones used to
develop T, but it will *probably* work with any API-compatible version.

* VTE 0.28
* GTK+ 2.24

To compile T, run

    make

## Installation ##
To install T, run (needs superuser privileges)

    make install

## Usage ##
T is invoked as

    T [ARG]

where `ARG` is one of the arguments in the following table.

Argument | Description
---------|-------------------------------------------------------------------------
`-n`     | Requests a new window; default if omitted
`-x`     | Request daemon termination; only successful if there are no open windows
`-d`     | Run in daemon mode