From 7067f19c8adfc404f0617a3e2d61b136d196f4cb Mon Sep 17 00:00:00 2001 From: Samuel Fadel Date: Wed, 1 Apr 2015 23:05:35 -0300 Subject: Updated README file. --- README.md | 17 +++++++++++++++-- 1 file changed, 15 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 4f5b8e2..ef975ee 100644 --- a/README.md +++ b/README.md @@ -1,8 +1,11 @@ # 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. +`config.h` and recompiling. It is actually two applications: one acts as a +daemon (`Td`) while the other (`Tc`) is invoked to request new windows or kill +the daemon. 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 @@ -19,3 +22,13 @@ To compile T, run: To install T, run (needs superuser privileges): make install + +## Usage ## +`Td` has no invocation arguments. You just keep it running and it will listen on +a local socket file (see `config.h`) for connections from `Tc`. `Tc` has the +following invocation arguments: + +`-n` + Requests a new window; default if omitted +`-x` + Request daemon termination; only successful if there are no open windows -- cgit v1.2.3