terminator/README.md

Terminator
==========

by Chris Jones <cmsj@tenshu.net> and others.

## Description

Terminator was originally developed by Chris Jones in 2007 as a simple, 300-ish line python script.  Since then, it has become The Robot Future of Terminals.  Originally inspired by projects like quadkonsole and gnome-multi-term and more recently by projects like Iterm2, and Tilix, It lets you combine and recombine terminals to suit the style you like.  If you live at the command-line, or are logged into 10 different remote machines at once, you should definitely try out Terminator.

When you run **`Terminator`**, you will get a terminal in a window, just like almost 
every other terminal emulator available. There is also a titlebar which will
update as shells/programs inside the terminal tell it to. Also on the titlebar
is a small button that opens the grouping menu. From here you can put terminals
into groups, which allows you to control multiple terminals simultaneously.

## New home on GitHub

In April of 2020 we started moving **`Terminator`** to GitHub. A new team wanted to continue the work of the original authors.

You can find the project on https://github.com/gnome-terminator/terminator

## Installing

Terminator is available for most (if not all) Linux distributions from the distribution's repository of binary packages.  It is also available on FreeBSD.   Please search your repository for `terminator`  If you want to find information on how to enable an updated package repository for your OS, build from source, or want to run the bleeding-edge master version, you can follow the instructions in [INSTALL.md](https://github.com/gnome-terminator/terminator/blob/master/INSTALL.md)


#### Quick Start:

Create more terminals by:  
 - horizontal split: `Ctrl-Shift-o`
 - vertical split: `Ctrl-Shift-e`

Shift focus to:  
 - next terminal: `Ctrl-Shift-n`
 - previous terminal: `Ctrl-Shift-p`

New tab: `Ctrl-Shift-t`

New window: `Ctrl-Shift-i`

Close terminal or tab:  
 - `Ctrl-Shift-w`
 - or right mouse click -> Close  

Close window with all it's terminals and tabs: `Ctrl-Shift-q`

Reset zoom: `Ctrl-0`

Terminator Preferences menu:  
 - right mouse click -> Preferences  

These and more modifiable shortcuts in:  
 - right mouse click -> Preferences -> Keybindings tab  

Web Documentation: 
 - press `F1` or at https://gnome-terminator.readthedocs.io/en/latest/

More info about shortcuts and cli config in man pages:  
 - `man terminator`
 - `man terminator_config`

## Contributing

Any help is welcome with the Terminator project.

* [Open issues for bugs or enhancements](https://github.com/gnome-terminator/terminator/issues/new)
* [Join our chat room on gitter.im for general questions](https://gitter.im/gnome-terminator/community)
* [Help translating Terminator](TRANSLATION.md)

You can find old bugs and questions in the launchpad project, but please don't post anything new there.

* https://answers.launchpad.net/terminator
* https://bugs.launchpad.net/terminator

## Origins

Terminator began by shamelessly copying code from the vte-demo.py in the vte 
widget package, and the gedit terminal plugin (which was fantastically 
useful at figuring out vte's API).

vte-demo.py was not my code and is copyright its original author. While it 
does not contain any specific licensing information in it, the VTE package 
appears to be licenced under LGPL v2.

## Licensing

The gedit terminal plugin is part of the gedit-plugins package, which is 
licenced under GPL v2 or later.

I am thus licensing Terminator as GPL v2 only.

Cristian Grada provided the old icon under the same licence.
Cory Kontros provided the new icon under the CC-by-SA licence.
For other authorship information, see debian/copyright
Bump version numbers for 0.96 2011-09-23 20:41:05 +00:00			`Terminator`
Update README 2020-04-01 21:31:54 +00:00			`==========`

Format shortcuts Format shortcuts a little in the README 2020-08-14 08:41:33 +00:00			`by Chris Jones <cmsj@tenshu.net> and others.`
Update README 2020-04-01 21:31:54 +00:00
			`## Description`
Initial import. Tiny amounts of documentation, some TODOage and boring licencing details 2006-11-17 04:16:58 +00:00
multiple small documentation fixes 2020-11-09 14:46:07 +00:00			`Terminator was originally developed by Chris Jones in 2007 as a simple, 300-ish line python script. Since then, it has become The Robot Future of Terminals. Originally inspired by projects like quadkonsole and gnome-multi-term and more recently by projects like Iterm2, and Tilix, It lets you combine and recombine terminals to suit the style you like. If you live at the command-line, or are logged into 10 different remote machines at once, you should definitely try out Terminator.`
Initial import. Tiny amounts of documentation, some TODOage and boring licencing details 2006-11-17 04:16:58 +00:00
Format shortcuts Format shortcuts a little in the README 2020-08-14 08:41:33 +00:00			When you run `Terminator`, you will get a terminal in a window, just like almost
Update some documentation for 0.90 2010-03-30 19:00:39 +00:00			`every other terminal emulator available. There is also a titlebar which will`
			`update as shells/programs inside the terminal tell it to. Also on the titlebar`
			`is a small button that opens the grouping menu. From here you can put terminals`
			`into groups, which allows you to control multiple terminals simultaneously.`
Update docs a bit 2007-07-29 04:05:26 +00:00
multiple small documentation fixes 2020-11-09 14:46:07 +00:00			`## New home on GitHub`

			In April of 2020 we started moving `Terminator` to GitHub. A new team wanted to continue the work of the original authors.

			`You can find the project on https://github.com/gnome-terminator/terminator`

			`## Installing`

Update README with install instructions Added a hint on where to look for information on enabling terminator package repository. 2020-12-01 14:51:58 +00:00			Terminator is available for most (if not all) Linux distributions from the distribution's repository of binary packages. It is also available on FreeBSD. Please search your repository for `terminator` If you want to find information on how to enable an updated package repository for your OS, build from source, or want to run the bleeding-edge master version, you can follow the instructions in [INSTALL.md](https://github.com/gnome-terminator/terminator/blob/master/INSTALL.md)
multiple small documentation fixes 2020-11-09 14:46:07 +00:00

			`#### Quick Start:`
Format shortcuts Format shortcuts a little in the README 2020-08-14 08:41:33 +00:00
fix up line breaks 2020-07-22 17:57:01 +00:00			`Create more terminals by:`
Format shortcuts Format shortcuts a little in the README 2020-08-14 08:41:33 +00:00			- horizontal split: `Ctrl-Shift-o`
			- vertical split: `Ctrl-Shift-e`
Update README.md TL;DR and quick help of what was (imo) excessively verbose. think of your user and how to quickly help them. have you seen a presenter faffing around in the middle of their presentation with their terminal/IDE, unable to adjust zoom level of their text/code, and audience shouting tips? i have. not once. 2020-07-20 12:26:42 +00:00
fix up line breaks 2020-07-22 17:57:01 +00:00			`Shift focus to:`
Format shortcuts Format shortcuts a little in the README 2020-08-14 08:41:33 +00:00			- next terminal: `Ctrl-Shift-n`
			- previous terminal: `Ctrl-Shift-p`
Update README.md TL;DR and quick help of what was (imo) excessively verbose. think of your user and how to quickly help them. have you seen a presenter faffing around in the middle of their presentation with their terminal/IDE, unable to adjust zoom level of their text/code, and audience shouting tips? i have. not once. 2020-07-20 12:26:42 +00:00
Format shortcuts Format shortcuts a little in the README 2020-08-14 08:41:33 +00:00			New tab: `Ctrl-Shift-t`
Update README.md TL;DR and quick help of what was (imo) excessively verbose. think of your user and how to quickly help them. have you seen a presenter faffing around in the middle of their presentation with their terminal/IDE, unable to adjust zoom level of their text/code, and audience shouting tips? i have. not once. 2020-07-20 12:26:42 +00:00
Format shortcuts Format shortcuts a little in the README 2020-08-14 08:41:33 +00:00			New window: `Ctrl-Shift-i`
Update README.md TL;DR and quick help of what was (imo) excessively verbose. think of your user and how to quickly help them. have you seen a presenter faffing around in the middle of their presentation with their terminal/IDE, unable to adjust zoom level of their text/code, and audience shouting tips? i have. not once. 2020-07-20 12:26:42 +00:00
fix up line breaks 2020-07-22 17:54:40 +00:00			`Close terminal or tab:`
Format shortcuts Format shortcuts a little in the README 2020-08-14 08:41:33 +00:00			- `Ctrl-Shift-w`
			`- or right mouse click -> Close`
Update README.md TL;DR and quick help of what was (imo) excessively verbose. think of your user and how to quickly help them. have you seen a presenter faffing around in the middle of their presentation with their terminal/IDE, unable to adjust zoom level of their text/code, and audience shouting tips? i have. not once. 2020-07-20 12:26:42 +00:00
Format shortcuts Format shortcuts a little in the README 2020-08-14 08:41:33 +00:00			Close window with all it's terminals and tabs: `Ctrl-Shift-q`
Update README.md TL;DR and quick help of what was (imo) excessively verbose. think of your user and how to quickly help them. have you seen a presenter faffing around in the middle of their presentation with their terminal/IDE, unable to adjust zoom level of their text/code, and audience shouting tips? i have. not once. 2020-07-20 12:26:42 +00:00
Format shortcuts Format shortcuts a little in the README 2020-08-14 08:41:33 +00:00			Reset zoom: `Ctrl-0`
Update README.md TL;DR and quick help of what was (imo) excessively verbose. think of your user and how to quickly help them. have you seen a presenter faffing around in the middle of their presentation with their terminal/IDE, unable to adjust zoom level of their text/code, and audience shouting tips? i have. not once. 2020-07-20 12:26:42 +00:00
fix up line breaks 2020-07-22 17:54:40 +00:00			`Terminator Preferences menu:`
Format shortcuts Format shortcuts a little in the README 2020-08-14 08:41:33 +00:00			`- right mouse click -> Preferences`
Update README.md TL;DR and quick help of what was (imo) excessively verbose. think of your user and how to quickly help them. have you seen a presenter faffing around in the middle of their presentation with their terminal/IDE, unable to adjust zoom level of their text/code, and audience shouting tips? i have. not once. 2020-07-20 12:26:42 +00:00
fix up line breaks 2020-07-22 17:54:40 +00:00			`These and more modifiable shortcuts in:`
Format shortcuts Format shortcuts a little in the README 2020-08-14 08:41:33 +00:00			`- right mouse click -> Preferences -> Keybindings tab`
Update README.md TL;DR and quick help of what was (imo) excessively verbose. think of your user and how to quickly help them. have you seen a presenter faffing around in the middle of their presentation with their terminal/IDE, unable to adjust zoom level of their text/code, and audience shouting tips? i have. not once. 2020-07-20 12:26:42 +00:00
multiple small documentation fixes 2020-11-09 14:46:07 +00:00			`Web Documentation:`
			- press `F1` or at https://gnome-terminator.readthedocs.io/en/latest/
Update README.md TL;DR and quick help of what was (imo) excessively verbose. think of your user and how to quickly help them. have you seen a presenter faffing around in the middle of their presentation with their terminal/IDE, unable to adjust zoom level of their text/code, and audience shouting tips? i have. not once. 2020-07-20 12:26:42 +00:00
fix up line breaks 2020-07-22 17:54:40 +00:00			`More info about shortcuts and cli config in man pages:`
Format shortcuts Format shortcuts a little in the README 2020-08-14 08:41:33 +00:00			- `man terminator`
			- `man terminator_config`
Initial import. Tiny amounts of documentation, some TODOage and boring licencing details 2006-11-17 04:16:58 +00:00
Update README 2020-04-01 21:31:54 +00:00			`## Contributing`

			`Any help is welcome with the Terminator project.`

			`* [Open issues for bugs or enhancements](https://github.com/gnome-terminator/terminator/issues/new)`
			`* [Join our chat room on gitter.im for general questions](https://gitter.im/gnome-terminator/community)`
Add documentation for translations 2021-01-03 18:51:31 +00:00			`* [Help translating Terminator](TRANSLATION.md)`

Update README 2020-04-01 21:31:54 +00:00			`You can find old bugs and questions in the launchpad project, but please don't post anything new there.`

			`* https://answers.launchpad.net/terminator`
			`* https://bugs.launchpad.net/terminator`

			`## Origins`
Add useful URLs 2007-07-28 01:29:32 +00:00
update docs in preparation for release 2008-07-03 22:48:37 +00:00			`Terminator began by shamelessly copying code from the vte-demo.py in the vte`
Update some documentation for 0.90 2010-03-30 19:00:39 +00:00			`widget package, and the gedit terminal plugin (which was fantastically`
update docs in preparation for release 2008-07-03 22:48:37 +00:00			`useful at figuring out vte's API).`
Initial import. Tiny amounts of documentation, some TODOage and boring licencing details 2006-11-17 04:16:58 +00:00
update docs in preparation for release 2008-07-03 22:48:37 +00:00			`vte-demo.py was not my code and is copyright its original author. While it`
			`does not contain any specific licensing information in it, the VTE package`
			`appears to be licenced under LGPL v2.`
Initial import. Tiny amounts of documentation, some TODOage and boring licencing details 2006-11-17 04:16:58 +00:00
Update README 2020-04-01 21:31:54 +00:00			`## Licensing`

update docs in preparation for release 2008-07-03 22:48:37 +00:00			`The gedit terminal plugin is part of the gedit-plugins package, which is`
			`licenced under GPL v2 or later.`
Initial import. Tiny amounts of documentation, some TODOage and boring licencing details 2006-11-17 04:16:58 +00:00
Add useful URLs 2007-07-28 01:29:32 +00:00			`I am thus licensing Terminator as GPL v2 only.`
Initial import. Tiny amounts of documentation, some TODOage and boring licencing details 2006-11-17 04:16:58 +00:00
Add Cory to README for the shiny new icon, and update the version number because it'll need doing eventually 2008-04-07 20:35:41 +00:00			`Cristian Grada provided the old icon under the same licence.`
			`Cory Kontros provided the new icon under the CC-by-SA licence.`
Update README 2009-01-20 22:52:59 +00:00			`For other authorship information, see debian/copyright`