update docs in preparation for release
This commit is contained in:
parent
88eb16ce1e
commit
1a6fd441a5
|
@ -7,7 +7,6 @@ terminator 0.9:
|
||||||
make the meaning clearer.
|
make the meaning clearer.
|
||||||
* Added keybindings for terms size and scrollbar manipulation. Thanks
|
* Added keybindings for terms size and scrollbar manipulation. Thanks
|
||||||
Emmanuel Bretelle.
|
Emmanuel Bretelle.
|
||||||
* Alpha transparency support when running in a composited window manager
|
|
||||||
* Completely revamped config system which now transparently makes use
|
* Completely revamped config system which now transparently makes use
|
||||||
of gconf settings if they are available, falls back to sensible
|
of gconf settings if they are available, falls back to sensible
|
||||||
defaults if not, and can be overridden entirely by ~/.config/terminator/config
|
defaults if not, and can be overridden entirely by ~/.config/terminator/config
|
||||||
|
|
11
INSTALL
11
INSTALL
|
@ -1,5 +1,12 @@
|
||||||
install python vte bindings ("python-vte" on Debian/ubuntu) and run:
|
If at all possible I would encourage you to use a distribution
|
||||||
|
package of Terminator rather than the source tarball (ie I hope
|
||||||
|
that most users never read this file).
|
||||||
|
|
||||||
|
If you must install from source, install python vte bindings
|
||||||
|
("python-vte" on Debian/ubuntu) and run:
|
||||||
|
|
||||||
./setup.py install
|
./setup.py install
|
||||||
|
|
||||||
Note that this is not as complete as a package install at the moment - e.g. GNOME menu integration will not happen and there is no uninstall option.
|
Note that this is not as complete as a package install at the moment
|
||||||
|
e.g. GNOME menu integration will not happen and there is no
|
||||||
|
uninstall option.
|
||||||
|
|
39
README
39
README
|
@ -1,24 +1,47 @@
|
||||||
Terminator 0.9
|
Terminator 0.9
|
||||||
by Chris Jones <cmsj@tenshu.net>
|
by Chris Jones <cmsj@tenshu.net> and several others.
|
||||||
|
|
||||||
This is a little python script to give me lots of terminals in a single window, saving me valuable laptop screen space otherwise wasted on window decorations and not quite being able to fill the screen with terminals.
|
The goal of this project is to produce a useful tool for arranging terminals.
|
||||||
|
It is inspired by programs such as gnome-multi-term, quadkonsole, etc. in that
|
||||||
|
the main focus is arranging terminals in grids (tabs is the most common default
|
||||||
|
method).
|
||||||
|
|
||||||
Right now it will open a single window with one terminal and it will (to some degree) mirror the settings of your default gnome-terminal profile in gconf. Eventually this will be extended and improved to offer profile selection per-terminal, configuration thereof and the ability to alter the number of terminals and save meta-profiles.
|
When you run Terminator, you will get a terminal in a window, just like almost
|
||||||
|
every other terminal emulator available. There is no other GUI apart from the
|
||||||
|
context menu on each terminal, but there is a configuration file which can be
|
||||||
|
used to control the behaviours and settings of Terminator (see the manpage
|
||||||
|
"terminator_config"). If you use GNOME then the settings for your default
|
||||||
|
gnome-terminal profile will be used (you can specify an alternate profile on
|
||||||
|
the command line).
|
||||||
|
|
||||||
You can create more terminals by right clicking on one and choosing to split it vertically or horizontally. You can get rid of a terminal by right clicking on it and choosing Close. ctrl-shift-o and ctrl-shift-e will also effect the splitting.
|
You can create more terminals by right clicking on one and choosing to split
|
||||||
|
it vertically or horizontally. You can get rid of a terminal by right
|
||||||
|
clicking on it and choosing Close. Ctrl-Shift-o and Ctrl-Shift-e will also
|
||||||
|
effect the splitting.
|
||||||
|
|
||||||
ctrl-shift-n and ctrl-shift-p will shift focus to the next/previous terminal respectively, and ctrl-shift-w will close the current terminal and ctrl-shift-q the current window
|
Ctrl-Shift-n and Ctrl-Shift-p will Shift focus to the next/previous terminal
|
||||||
|
respectively, and Ctrl-Shift-w will close the current terminal and
|
||||||
|
Ctrl-Shift-q the current window
|
||||||
|
|
||||||
|
For more keyboard shortcuts and also the command line options, please see the
|
||||||
|
manpage "terminator"
|
||||||
|
|
||||||
Ask questions at: https://answers.launchpad.net/terminator/
|
Ask questions at: https://answers.launchpad.net/terminator/
|
||||||
Please report all bugs to https://bugs.launchpad.net/terminator/+filebug
|
Please report all bugs to https://bugs.launchpad.net/terminator/+filebug
|
||||||
|
|
||||||
It's quite shamelessly based on code in the vte-demo.py from the vte widget package, and on the gedit terminal plugin (which was fantastically useful).
|
Terminator began by shamelessly copying code from the vte-demo.py in the vte
|
||||||
|
widget package, and on the gedit terminal plugin (which was fantastically
|
||||||
|
useful at figuring out vte's API).
|
||||||
|
|
||||||
vte-demo.py is 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.
|
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.
|
||||||
|
|
||||||
the gedit terminal plugin is part of the gedit-plugins package, which is licenced under GPL v2 or later.
|
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.
|
I am thus licensing Terminator as GPL v2 only.
|
||||||
|
|
||||||
Cristian Grada provided the old icon under the same licence.
|
Cristian Grada provided the old icon under the same licence.
|
||||||
Cory Kontros provided the new icon under the CC-by-SA licence.
|
Cory Kontros provided the new icon under the CC-by-SA licence.
|
||||||
|
|
||||||
|
|
2
TODO
2
TODO
|
@ -1,5 +1,3 @@
|
||||||
* Edit doc/terminator_config.5 manpage to contain the information about the options
|
|
||||||
|
|
||||||
* menu entry/keybinding to hightlight a term upon:
|
* menu entry/keybinding to hightlight a term upon:
|
||||||
* command ending
|
* command ending
|
||||||
* new text in window
|
* new text in window
|
||||||
|
|
|
@ -1,3 +1,9 @@
|
||||||
|
terminator (0.9~rc1-0) hardy; urgency=low
|
||||||
|
|
||||||
|
* First release candidate for 0.9
|
||||||
|
|
||||||
|
-- Chris Jones <cmsj@tenshu.net> Thu, 03 Jul 2008 23:19:09 +0100
|
||||||
|
|
||||||
terminator (0.9~beta4-0) hardy; urgency=low
|
terminator (0.9~beta4-0) hardy; urgency=low
|
||||||
|
|
||||||
* Improve the previous fix
|
* Improve the previous fix
|
||||||
|
|
|
@ -6,25 +6,22 @@ Terminator \- Multiple GNOME terminals in one window
|
||||||
.RI [ options ]
|
.RI [ options ]
|
||||||
.br
|
.br
|
||||||
.SH "DESCRIPTION"
|
.SH "DESCRIPTION"
|
||||||
This manual page documents briefly the
|
This manual page documents \fBTerminator\fP, a terminal emulator application.
|
||||||
.B Terminator
|
|
||||||
command.
|
|
||||||
.PP
|
.PP
|
||||||
\fBTerminator\fP is a program that allows users to set up flexible
|
\fBTerminator\fP is a program that allows users to set up flexible
|
||||||
arrangements of GNOME terminals. It is aimed at those who normally
|
arrangements of GNOME terminals. It is aimed at those who normally
|
||||||
arrange lots of terminals near each other, but don't want to use a
|
arrange lots of terminals near each other, but don't want to use a
|
||||||
frame based window manager.
|
frame based window manager.
|
||||||
.SH "OPTIONS"
|
.SH "OPTIONS"
|
||||||
These programs follow the usual GNU command line syntax, with long
|
This program follow the usual GNU command line syntax, with long
|
||||||
options starting with two dashes (`\-').
|
options starting with two dashes (`\-').
|
||||||
A summary of options is included below.
|
A summary of options is included below.
|
||||||
For a complete description, see the Info files.
|
|
||||||
.TP
|
.TP
|
||||||
.B \-h, \-\-help
|
.B \-h, \-\-help
|
||||||
Show summary of options.
|
Show summary of options
|
||||||
.TP
|
.TP
|
||||||
.B \-d, \-\-debug
|
.B \-d, \-\-debug
|
||||||
Enable debugging output
|
Enable debugging output (please use this when reporting bugs)
|
||||||
.TP
|
.TP
|
||||||
.B \-m, \-\-maximise
|
.B \-m, \-\-maximise
|
||||||
Maximise the Terminator window when it starts
|
Maximise the Terminator window when it starts
|
||||||
|
@ -45,7 +42,7 @@ Runs the specified command instead of your default shell or profile specified co
|
||||||
.B \-x, \-\-execute=COMMAND [ARGS]
|
.B \-x, \-\-execute=COMMAND [ARGS]
|
||||||
Runs \fBthe rest of the command line\fR instead of your default shell or profile specified command.
|
Runs \fBthe rest of the command line\fR instead of your default shell or profile specified command.
|
||||||
.SH "KEYBINDINGS"
|
.SH "KEYBINDINGS"
|
||||||
\fBTerminator\fR allows you to manage windows using the keybindings described here:
|
The following keybindings can be used to control Terminator:
|
||||||
.TP
|
.TP
|
||||||
.B Ctrl+Shift+O
|
.B Ctrl+Shift+O
|
||||||
Split terminals H\fBo\fRrizontally.
|
Split terminals H\fBo\fRrizontally.
|
||||||
|
@ -54,16 +51,16 @@ Split terminals H\fBo\fRrizontally.
|
||||||
Split terminals V\fBe\fRrtically.
|
Split terminals V\fBe\fRrtically.
|
||||||
.TP
|
.TP
|
||||||
.B Ctrl+Shift+Right
|
.B Ctrl+Shift+Right
|
||||||
Move first parent HPaned handle \fBRight\fR.
|
Move parent handle \fBRight\fR.
|
||||||
.TP
|
.TP
|
||||||
.B Ctrl+Shift+Left
|
.B Ctrl+Shift+Left
|
||||||
Move first parent HPaned handle \fBLeft\fR.
|
Move parent handle \fBLeft\fR.
|
||||||
.TP
|
.TP
|
||||||
.B Ctrl+Shift+Up
|
.B Ctrl+Shift+Up
|
||||||
Move first VPaned handle \fBUp\fR.
|
Move parent handle \fBUp\fR.
|
||||||
.TP
|
.TP
|
||||||
.B Ctrl+Shift+Down
|
.B Ctrl+Shift+Down
|
||||||
Move first VPaned handle \fBDown\fR.
|
Move parent handle \fBDown\fR.
|
||||||
.TP
|
.TP
|
||||||
.B Ctrl+Shift+S
|
.B Ctrl+Shift+S
|
||||||
Hide/Show \fBS\fRcrollbar.
|
Hide/Show \fBS\fRcrollbar.
|
||||||
|
@ -79,15 +76,15 @@ If \fBcycle_term_tab\fR is \fBFalse\fR, cycle within the same tab will be disabl
|
||||||
.B Ctrl+Shift+W
|
.B Ctrl+Shift+W
|
||||||
Close the current terminal.
|
Close the current terminal.
|
||||||
.TP
|
.TP
|
||||||
|
.B Ctrl+Shift+Q
|
||||||
|
Quits Terminator
|
||||||
|
.TP
|
||||||
.B Ctrl+Shift+X
|
.B Ctrl+Shift+X
|
||||||
Toggle between showing all terminals and only showing the current one.
|
Toggle between showing all terminals and only showing the current one.
|
||||||
.TP
|
.TP
|
||||||
.B Ctrl+Shift+Z
|
.B Ctrl+Shift+Z
|
||||||
Toggle between showing all terminals and only showing a scaled version of the current one.
|
Toggle between showing all terminals and only showing a scaled version of the current one.
|
||||||
.TP
|
.TP
|
||||||
.B Ctrl+Shift+Q
|
|
||||||
Close the current window.
|
|
||||||
.TP
|
|
||||||
.B Ctrl+Shift+T
|
.B Ctrl+Shift+T
|
||||||
Open new \fBt\fRab
|
Open new \fBt\fRab
|
||||||
.TP
|
.TP
|
||||||
|
@ -104,30 +101,25 @@ Swap tab position with next Tab
|
||||||
Swap tab position with previous Tab
|
Swap tab position with previous Tab
|
||||||
.TP
|
.TP
|
||||||
.B Ctrl+Plus (+)
|
.B Ctrl+Plus (+)
|
||||||
Increase font size
|
Increase font size. \fBNote:\fP this may require you to press shift, depending on your keyboard
|
||||||
.TP
|
.TP
|
||||||
.B Ctrl+Minus (-)
|
.B Ctrl+Minus (-)
|
||||||
Decrease font size
|
Decrease font size. \fBNote:\fP this may require you to press shift, depending on your keyboard
|
||||||
.TP
|
.TP
|
||||||
.B Ctrl+Equals (=)
|
.B Ctrl+Equals (=)
|
||||||
Restore font size to original setting
|
Restore font size to original setting. \fBNote:\fP this may require you to press shift, depending on your keyboard
|
||||||
.TP
|
.TP
|
||||||
.B F11
|
.B F11
|
||||||
Toggle fullscreen
|
Toggle fullscreen
|
||||||
.SH "Drag and Drop"
|
.SH "Drag and Drop"
|
||||||
Terminals layout can be modified by moving them using
|
The layout can be modified by moving terminals with Drag and Drop.
|
||||||
.B Drag and Drop
|
To start dragging a terminal, hold down \fBCtrl\fP, click and hold the \fBright\fP mouse button. You can
|
||||||
To start dragging a terminal, press
|
now drag the terminal do the point in the layout you would like it to be.
|
||||||
.B Ctrl
|
The zone where the terminal would be inserted will be highlighted.
|
||||||
and
|
|
||||||
.B right click
|
|
||||||
on the terminal
|
|
||||||
Move the terminal over the landing terminal.
|
|
||||||
The zone where the terminal will be inserted will be highlighted.
|
|
||||||
.SH "SEE ALSO"
|
.SH "SEE ALSO"
|
||||||
.BR gnome\-terminal(1),terminator_config(5)
|
.BR gnome\-terminal(1),terminator_config(5)
|
||||||
.SH "AUTHOR"
|
.SH "AUTHOR"
|
||||||
Terminator was written by Chris Jones <cmsj@tenshu.net> and others.
|
Terminator was written by Chris Jones <cmsj@tenshu.net> and others.
|
||||||
.PP
|
.PP
|
||||||
This manual page was written by Chris Jones <cmsj@tenshu.net>
|
This manual page was written by Chris Jones <cmsj@tenshu.net>
|
||||||
for the Ubuntu project (but may be used by others).
|
and others.
|
||||||
|
|
|
@ -6,10 +6,10 @@ ${XDG_CONFIG_HOME}/terminator/config (usually ~/.config/terminator/config)
|
||||||
This manual page documents briefly the
|
This manual page documents briefly the
|
||||||
.B Terminator config file.
|
.B Terminator config file.
|
||||||
.PP
|
.PP
|
||||||
\fBterminator/config\fP is an optional file to configure the terminator terminal emulator. It is used if there is no gconf PROFILE on the system for configuring the options of the terminal(s).
|
\fBterminator/config\fP is an optional file to configure the terminator terminal emulator. It is used to control options not in gnome-terminal gconf profiles, or override gconf settings.
|
||||||
.SH "OPTIONS"
|
|
||||||
The options are defined one per line as \fB'OPTION = VALUE'\fR. The options are described below:
|
|
||||||
|
|
||||||
|
The options can be defined one per line in the form: \fBOPTION = VALUE\fR.
|
||||||
|
.SH "OPTIONS"
|
||||||
.TP
|
.TP
|
||||||
.B allow_bold\fR (boolean)
|
.B allow_bold\fR (boolean)
|
||||||
If true, allow applications in the terminal to make text boldface.
|
If true, allow applications in the terminal to make text boldface.
|
||||||
|
|
Loading…
Reference in New Issue