From 1a6fd441a5d8e949bc51f93c4c667450d0a3131c Mon Sep 17 00:00:00 2001 From: Chris Jones Date: Thu, 3 Jul 2008 23:48:37 +0100 Subject: [PATCH] update docs in preparation for release --- ChangeLog | 1 - INSTALL | 11 ++++++++-- README | 39 ++++++++++++++++++++++++++------- TODO | 2 -- debian/changelog | 6 ++++++ doc/terminator.1 | 48 +++++++++++++++++------------------------ doc/terminator_config.5 | 6 +++--- 7 files changed, 69 insertions(+), 44 deletions(-) diff --git a/ChangeLog b/ChangeLog index 2f9934f2..57859a6e 100644 --- a/ChangeLog +++ b/ChangeLog @@ -7,7 +7,6 @@ terminator 0.9: make the meaning clearer. * Added keybindings for terms size and scrollbar manipulation. Thanks Emmanuel Bretelle. - * Alpha transparency support when running in a composited window manager * Completely revamped config system which now transparently makes use of gconf settings if they are available, falls back to sensible defaults if not, and can be overridden entirely by ~/.config/terminator/config diff --git a/INSTALL b/INSTALL index b1531f5e..6d211533 100644 --- a/INSTALL +++ b/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 -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. diff --git a/README b/README index bc7cd21d..6a969273 100644 --- a/README +++ b/README @@ -1,24 +1,47 @@ Terminator 0.9 -by Chris Jones +by Chris Jones 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/ 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. Cristian Grada provided the old icon under the same licence. Cory Kontros provided the new icon under the CC-by-SA licence. + diff --git a/TODO b/TODO index 30ae8158..ae46d2fc 100644 --- a/TODO +++ b/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: * command ending * new text in window diff --git a/debian/changelog b/debian/changelog index 721e6de9..6d1509df 100644 --- a/debian/changelog +++ b/debian/changelog @@ -1,3 +1,9 @@ +terminator (0.9~rc1-0) hardy; urgency=low + + * First release candidate for 0.9 + + -- Chris Jones Thu, 03 Jul 2008 23:19:09 +0100 + terminator (0.9~beta4-0) hardy; urgency=low * Improve the previous fix diff --git a/doc/terminator.1 b/doc/terminator.1 index 3330fa47..dbf1845f 100644 --- a/doc/terminator.1 +++ b/doc/terminator.1 @@ -6,25 +6,22 @@ Terminator \- Multiple GNOME terminals in one window .RI [ options ] .br .SH "DESCRIPTION" -This manual page documents briefly the -.B Terminator -command. +This manual page documents \fBTerminator\fP, a terminal emulator application. .PP \fBTerminator\fP is a program that allows users to set up flexible 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 frame based window manager. .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 (`\-'). A summary of options is included below. -For a complete description, see the Info files. .TP .B \-h, \-\-help -Show summary of options. +Show summary of options .TP .B \-d, \-\-debug -Enable debugging output +Enable debugging output (please use this when reporting bugs) .TP .B \-m, \-\-maximise 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] Runs \fBthe rest of the command line\fR instead of your default shell or profile specified command. .SH "KEYBINDINGS" -\fBTerminator\fR allows you to manage windows using the keybindings described here: +The following keybindings can be used to control Terminator: .TP .B Ctrl+Shift+O Split terminals H\fBo\fRrizontally. @@ -54,16 +51,16 @@ Split terminals H\fBo\fRrizontally. Split terminals V\fBe\fRrtically. .TP .B Ctrl+Shift+Right -Move first parent HPaned handle \fBRight\fR. +Move parent handle \fBRight\fR. .TP .B Ctrl+Shift+Left -Move first parent HPaned handle \fBLeft\fR. +Move parent handle \fBLeft\fR. .TP .B Ctrl+Shift+Up -Move first VPaned handle \fBUp\fR. +Move parent handle \fBUp\fR. .TP .B Ctrl+Shift+Down -Move first VPaned handle \fBDown\fR. +Move parent handle \fBDown\fR. .TP .B Ctrl+Shift+S 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 Close the current terminal. .TP +.B Ctrl+Shift+Q +Quits Terminator +.TP .B Ctrl+Shift+X Toggle between showing all terminals and only showing the current one. .TP .B Ctrl+Shift+Z Toggle between showing all terminals and only showing a scaled version of the current one. .TP -.B Ctrl+Shift+Q -Close the current window. -.TP .B Ctrl+Shift+T Open new \fBt\fRab .TP @@ -104,30 +101,25 @@ Swap tab position with next Tab Swap tab position with previous Tab .TP .B Ctrl+Plus (+) -Increase font size +Increase font size. \fBNote:\fP this may require you to press shift, depending on your keyboard .TP .B Ctrl+Minus (-) -Decrease font size +Decrease font size. \fBNote:\fP this may require you to press shift, depending on your keyboard .TP .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 .B F11 Toggle fullscreen .SH "Drag and Drop" -Terminals layout can be modified by moving them using -.B Drag and Drop -To start dragging a terminal, press -.B Ctrl -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. +The layout can be modified by moving terminals with Drag and Drop. +To start dragging a terminal, hold down \fBCtrl\fP, click and hold the \fBright\fP mouse button. You can +now drag the terminal do the point in the layout you would like it to be. +The zone where the terminal would be inserted will be highlighted. .SH "SEE ALSO" .BR gnome\-terminal(1),terminator_config(5) .SH "AUTHOR" Terminator was written by Chris Jones and others. .PP This manual page was written by Chris Jones -for the Ubuntu project (but may be used by others). +and others. diff --git a/doc/terminator_config.5 b/doc/terminator_config.5 index 4990df8b..15188a5c 100644 --- a/doc/terminator_config.5 +++ b/doc/terminator_config.5 @@ -6,10 +6,10 @@ ${XDG_CONFIG_HOME}/terminator/config (usually ~/.config/terminator/config) This manual page documents briefly the .B Terminator config file. .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). -.SH "OPTIONS" -The options are defined one per line as \fB'OPTION = VALUE'\fR. The options are described below: +\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. +The options can be defined one per line in the form: \fBOPTION = VALUE\fR. +.SH "OPTIONS" .TP .B allow_bold\fR (boolean) If true, allow applications in the terminal to make text boldface.