« back to all changes in this revision
Viewing changes to source/preferences.rst
- browse files at revision 1
- compare with another revision
- download diff
- download tarball
- view history from revision 1
- Committer: Stephen Boddy
- Date: 2016-10-26 23:04:09 UTC
- Revision ID: stephen.j.boddy@gmail.com-20161026230409-zp8af5cdt3ar1903
Initial creation of GTK3 documentation tree for using with readthedocs.org
- files added:
- source
- source/imgs
added
removed
source/preferences.rst
1
.. image:: imgs/icon_prefs.png
2
:align: right
3
:alt: Because spanners mean settings?!?!?
4
5
.. _preferences:
6
7
==================
8
Preferences Window
9
==================
10
11
Terminator is *highly* configurable, and automate-able, so the Preferences
12
dialog is naturally quite extensive. It currently consists of six tabs.
13
Let's work through them one by one.
14
15
.. _prefs-global:
16
17
------
18
Global
19
------
20
21
.. image:: imgs/prefs_global.png
22
23
These settings are defaults, but some of them can be overridden by a
24
options on the command-line, or within a layout. A number will also
25
require a restart to take effect.
26
27
^^^^^^^^^
28
Behaviour
29
^^^^^^^^^
30
31
**Window state** (default: Normal)
32
33
This will determine what happens on startup normally.
34
35
- *Normal* - Window opens as normal.
36
- *Hidden* - Window does not open. Useful at login, so it is already
37
available with a shortcut.
38
- *Maximised* - Window opens maximised in the standard window manager
39
frame.
40
- *Fullscreen* - Window opens fullscreen with no window manager frame.
41
42
**Always on top** (default: off)
43
44
Window attempts to remain on top.
45
46
**Show on all workspaces** (default: off)
47
48
The focused window will follow if you switch to a different virtual
49
desktop.
50
51
**Hide on lose focus** (default: off)
52
53
This is a quake console like feature, where the user want the window to
54
vanish when clicking elsewhere.
55
56
This is rather buggy at the moment as it is very easy for the main
57
window to lose focus and disappear.
58
59
**Hide from taskbar** (default: off)
60
61
The first window opened will not be displayed in the taskbar.
62
Subsequent windows will show in the taskbar (bug?).
63
64
**Window geometry hints** (default: off)
65
66
If this is checked, then when resizing Terminator will attempt to
67
step the sizing by the current font, and display a small box with the
68
dimension of the window in characters.
69
70
.. warning:: If you have problems with Terminator windows shrinking
71
in an uncontrollable way, then turning this option
72
**off** will usually fix the issue. It is not clear
73
why, but it seems Terminator and the window manager
74
get into an argument over what size the window should
75
be.
76
77
**DBus server** (default: on)
78
79
If a Terminator :ref:`dbus` server is not already on the session
80
bus, try to start one.
81
82
**Mouse focus** (default: Click to focus)
83
84
By what method the mouse pointer sets the focus on a terminal.
85
86
- *GNOME Default* - Act as per the system settings.
87
- *Click to focus* - You must click with in a terminal to make it the
88
focus.
89
- *Follow mouse pointer* - Moving the pointer over a terminal makes
90
it the focus.
91
92
**Broadcast default** (default: Group)
93
94
Which broadcast mode should be selected at startup:
95
96
- *All* - All terminals receive keystrokes.
97
- *Group* - Only terminals in the same group as the current terminal
98
receive keystrokes.
99
- *None* - Only the current terminal receives keystrokes.
100
101
**PuTTY style paste** (default: off)
102
103
Make the right mouse button operate like in PuTTY, so ``right-click``
104
will paste the Primary selection, and ``middle-click`` will open
105
the :ref:`Context Menu <context-menu>`. (For ex-PuTTY users).
106
107
**Smart copy** (default: on)
108
109
If enabled and there is no selection, the shortcut is allowed to
110
pass through. This is useful for overloading ``Ctrl``\ +\ ``C``
111
to copy a selection, or send the SIGINT to the current process if
112
there is no selection. If not enabled the shortcut does not pass
113
through at all, and the SIGINT does not get sent.
114
115
**Re-use profiles for new terminals** (default: off)
116
117
When creating a new terminal with splitting or new tabs, if this is
118
enabled, then the profile from the previously focussed terminal will
119
also be used for the new one.
120
121
**Use custom URL handler** (default: off)
122
123
If this is enabled then ``Ctrl``\ +\ ``click`` on a URL will try to use
124
the command defined in *Custom URL handler* to open the link. If not
125
enabled, Terminator will attempt to open the link with its internal
126
logic.
127
128
**Custom URL handler** (default: inactive, empty)
129
130
If active and set, then URL's will be passed as a command-line parameter
131
to the given command.
132
133
134
^^^^^^^^^^
135
Appearance
136
^^^^^^^^^^
137
138
**Terminator seperator size** (default: -1)
139
140
This is the width in pixels, and can range from -1 to 5. The value
141
of -1 will take the default size from the system theme.
142
143
**Unfocused terminal font brightness** (default: 0.8)
144
145
Terminals that do not currently have the focus will can be dimmed
146
to aid focus. The value can range from 0 (invisible) to 1 (full
147
brightness)
148
149
**Window borders** (default: on)
150
151
The window manager frame can be removed from your windows.
152
153
**Tab position** (default: Top)
154
155
Where the tabs will be located within the window
156
157
- *Top*
158
- *Bottom*
159
- *Left*
160
- *Right*
161
- *Hidden* - Tabs still work, you just can't see them.
162
163
**Tabs homogeneous** (default: on)
164
165
Tabs will have equal widths
166
167
**Tabs scroll buttons** (default: off)
168
169
When there are more tabs than can fit within the window buttons will
170
be drawn for moving left and right.
171
172
^^^^^^^^^^^^^^^^^
173
Terminal Titlebar
174
^^^^^^^^^^^^^^^^^
175
176
There is a table of the colours for the titlebars on the left. These
177
are modelled on those used in a utility I used to use called ClusTerm.
178
The three sets (Focused, Inactive and Receiving) will make more sense
179
after reading the section about :ref:`grouping-menu`.
180
181
+-------------+---------+----------+-----------+
182
| | Focused | Inactive | Receiving |
183
+=============+=========+==========+===========+
184
| Font colour | #FFFFFF | #000000 | #FFFFFF |
185
+-------------+---------+----------+-----------+
186
| Background | #C80003 | #C0BEBF | #0076C9 |
187
+-------------+---------+----------+-----------+
188
189
**Hide size from title** (default: off)
190
191
At the end of the label in the titlebar the size of the terminal is
192
given in characters, i.e. (80x24). Enabling this item will disable
193
the size text.
194
195
**Use the system font** (default: on)
196
197
By default the system defined proportional font will be used for the
198
text in the titlebar. Turning this off allows you to use a custom font.
199
200
**Font** (default: inactive, system proportional font)
201
202
If active and set, then the custom font to be used in the titlebar.
203
204
.. warning:: With newer versions of some of the underlying libraries,
205
using a bitmap font can cause the Preference window to
206
crash. If you find this happening, you will need to
207
either remove the configuration from the Terminator
208
:ref:`configuration file <config-file>` or you will
209
need to change your system settings. Please see
210
`LP#1294699`_ for more information.
211
212
.. _LP#1294699: https://bugs.launchpad.net/bugs/1294699
213
214
.. _prefs-profiles:
215
216
--------
217
Profiles
218
--------
219
220
You should already be familiar with the sub-tabs from GNOME Terminal,
221
and Terminator's are modelled on those available in GNOME Terminal where
222
it makes sense, and give much of the same functionality. Bear in mind that
223
some of these differences are due to changes in the underlying VTE
224
widget between GTK2 and GTK3.
225
226
Below we will go through each pane, and highlight and explain differences
227
between Terminator with GTK2 and GNOME Terminal with GTK3.
228
229
^^^^^^^
230
General
231
^^^^^^^
232
233
.. image:: imgs/prefs_profiles_general.png
234
235
One key difference is that we have a sidebar to the left listing the
236
available Profiles, as opposed to GNOME Terminator, where the list is
237
a separate window launched from the menu bar.
238
239
**Use the system fixed width font** (default: on)
240
241
By default the system defined proportional font will be used for the
242
text in the terminal. Turning this off allows you to use a custom font.
243
244
**Font** (inactive, system fixed width font)
245
246
If active and set, then the custom font to be used in the terminal.
247
248
.. warning:: With newer versions of some of the underlying libraries,
249
using a bitmap font can cause the Preference window to
250
crash. If you find this happening, you will need to
251
either remove the configuration from the Terminator
252
:ref:`configuration file <config-file>` or you will
253
need to change your system settings. Please see
254
`LP#1294699`_ for more information.
255
256
**Allow bold text** (default: on)
257
258
Allows you to disable the use of bold fonts in the terminal.
259
260
**Anti-alias text** (default: on) †*Not in GNOME Terminal*
261
262
In Terminator you can turn the font smoothing off. This is no
263
longer possible in GNOME Terminator.
264
265
**Show titlebar** (default: on)
266
267
The titlebar strip across the top of each terminal can be turned off.
268
269
**Copy on selection** (default: off)
270
271
This puts the selection into the copy/paste buffer, as well as being
272
available on middle-click.
273
274
**Select-by-word characters** (default: ``-A-Za-z0-9,./?%&#:_``)
275
276
Using ``double-click`` to select text will use this pattern to define
277
what characters are considered part of the word.
278
279
""""""
280
Cursor
281
""""""
282
283
**Shape** (default: Block)
284
285
Set the cursor shape
286
287
- *Block* - Solid rectangle.
288
- *Underline* - Single pixel tall horizontal line.
289
- *I-Beam* - Single pixel wide vertical line.
290
291
**Colour** (default: #AAAAAA)
292
293
The colour of the cursor.
294
295
**Blink** (default: on)
296
297
Whether the cursor blinks on and off.
298
299
"""""""""""""
300
Terminal bell
301
"""""""""""""
302
303
**Titlebar icon** (default: on)
304
305
On the right side of the titlebar a small light-bulb icon will
306
be displayed for a few seconds.
307
308
**Visual flash** (default: off)
309
310
The terminal area will briefly flash.
311
312
**Audible beep** (default: off)
313
314
The normal system beep noise as defined in system settings.
315
316
**Window list flash** (default: off)
317
318
This will set the urgent flag on the window in the taskbar. The
319
actual effect will be taskbar dependant.
320
321
"""""""""""""""""
322
Not in Terminator
323
"""""""""""""""""
324
325
**Profile name**
326
327
Our profiles names are in the sidebar to the left.
328
329
**Show menubar by default in new terminals**
330
331
Terminator doesn't use a traditional menu bar.
332
333
**Terminal bell**
334
335
Terminator has more options, so has four separate options in their
336
own grouping. This item in GNOME Terminal is the same as *Audible
337
beep* defined above.
338
339
**Use custom default terminal size**
340
341
Terminator handles window sizes within :ref:`Layouts <layouts>`,
342
or with :ref:`command-line-options`.
343
344
^^^^^^^
345
Command
346
^^^^^^^
347
348
.. image:: imgs/prefs_profiles_command.png
349
350
**Run commands as a login shell** (default: off)
351
352
Force the command to run as a login shell.
353
354
**Update login records when command is launched** (default: on)
355
356
Updates login records when a new shell is opened.
357
358
**Run a custom command instead of my shell** (default: off)
359
360
Enable the use of a custom command instead of the users default
361
shell.
362
363
**Custom command** (default: inactive, empty)
364
365
If enabled and set, the users default shell will be replaced with
366
the command specified here.
367
368
.. note:: If you place an entry here note that there is no ``bash`` or
369
other shell underneath it. When the command ends, there
370
is no chance to drop to a shell or other program. This can
371
be worked around by using the shell line seperator ``;``
372
and a following ``bash`` command.
373
374
**When command exits** (default: Exit the terminal)
375
376
When the running command exits (default or custom) what action
377
should be taken.
378
379
- *Exit the terminal* - Terminal closes, causing layout to adjust.
380
- *Restart the command* - Original command restarts immediately.
381
- *Hold the terminal open* - The terminal and scrollback will remain
382
visible and accessible until the user explicitly closes the
383
terminal, or closes the window.
384
385
.. warning:: If you are using *Restart the command* and your command
386
is broken and exits immediately, then you can end up
387
in a resource hungry loop.
388
389
"""""""""""""""""
390
Not in Terminator
391
"""""""""""""""""
392
393
**Initial title**
394
395
Terminator handles window title within :ref:`Layouts <layouts>`,
396
or with :ref:`command-line-options`.
397
398
**When terminal commands set their own titles**
399
400
Terminator doesn't have this setting.
401
402
^^^^^^^
403
Colours
404
^^^^^^^
405
406
.. image:: imgs/prefs_profiles_colors.png
407
408
There seems to be some mild quirks and differences (palettes available
409
or selected from the system theme) between Terminator and GNOME
410
Terminal.
411
412
"""""""""""""""""""""""""""""""""""""""
413
Foreground and Background
414
"""""""""""""""""""""""""""""""""""""""
415
416
**Use colours from system theme** (default: off)
417
418
Use colours as defined in the system theme. Not clear at this time
419
where exactly these come from. Differences in the GTK2, GTK3 and
420
GNOME Terminal.
421
422
**Built-in schemes** (default: Grey on black)
423
424
Pick a primary colour combination for foreground and background.
425
Again there are unexplained differences between Terminator and
426
GNOME Terminal.
427
428
The list seems to be dynamic and vary depending on the system,
429
with the addition of *Custom* which allows setting the colours
430
as desired.
431
432
**Text colour** (default: inactive, #AAAAAA)
433
434
If the *Built-in schemes* is set to *Custom* the text colour can
435
be set here.
436
437
**Background colour** (default: inactive, #000000)
438
439
If the *Built-in schemes* is set to *Custom* the background colour
440
can be set here.
441
442
"""""""""""""""""""""""""""""""""""""""
443
Palette
444
"""""""""""""""""""""""""""""""""""""""
445
446
**Built-in schemes** (default: Ambience)
447
448
A predefined colour palette can be selected. Again there are
449
unexplained differences between Terminator and GNOME Terminal.
450
451
The default here may be system dependant, with Ambience being
452
an Ubuntu colour scheme.
453
454
**Colour palette** (default: inactive)
455
456
If the Palette's *Built-in schemes* is set to custom, a set of
457
colour swatches are used to configure the 16 primary colours
458
of the shell palette.
459
460
"""""""""""""""""""""""""""""""""""""""
461
Not in Terminator
462
"""""""""""""""""""""""""""""""""""""""
463
464
**Bold colour**
465
466
In theory nothing is stopping us implementing this, it just doesn't
467
appear to have ever been added.
468
469
**Same as text colour**
470
471
In truth, I'm not exactly sure what this does, but at a guess, the
472
user can force bold to be drawn in the same colour as the
473
foreground text.
474
475
^^^^^^^^^^
476
Background
477
^^^^^^^^^^
478
479
.. image:: imgs/prefs_profiles_background.png
480
481
**Solid colour** (default: active)
482
483
Background of terminal is set to the solid colour set in previous
484
*Colours* tab.
485
486
**Background image** (default: inactive)
487
488
Background will be an image. There is no scaling done.
489
490
**Image file** (default: inactive, None)
491
492
If *Background image* is set, then the image to use can be selected
493
here.
494
495
**Background image scrolls** (default: inactive, on)
496
497
If the *Background image* is set, then setting this to on will cause
498
the background image to change as the window moves. This is a for of
499
fake transparency.
500
501
**Transparent background** (default: inactive)
502
503
This will attempt true transparency where the windows below are
504
partially visible through the terminal.
505
506
.. note:: This option requires a compositing desktop.
507
508
**Shade transparent or image background** (default: 0.5)
509
510
For *Background image* and *Transparent background* this is how
511
much the solid colour should be blended in, giving a tinting effect.
512
513
^^^^^^^^^
514
Scrolling
515
^^^^^^^^^
516
517
.. image:: imgs/prefs_profiles_scrolling.png
518
519
**Scrollbar is** (default: On the right side)
520
521
If and where the scrollbar should appear.
522
523
- *On the left side*
524
- *On the right side*
525
- *Disabled*
526
527
**Scrollback** (default: 500 lines)
528
529
How many lines to keep before discarding.
530
531
**Infinite Scrollback** (default: off)
532
533
Lines are never discarded, and all lines since the session began
534
are available.
535
536
.. note:: Data is placed onto the disk by the underlying VTE
537
component, so even after a long time, the memory footprint
538
and performance of Terminator should be OK.
539
540
**Scroll on output** (default: on)
541
542
Moves terminal to end of scrollback buffer when any output occurs.
543
544
**Scroll on keystroke** (default: on)
545
546
Moves terminal to end of scrollback buffer when any keypress occurs.
547
548
**Use keystrokes to scroll on alternate screen** (default: on)
549
550
Ummmm... I don't know. Alternate screens are a bit of a mystery to me.
551
552
^^^^^^^^^^^^^
553
Compatibility
554
^^^^^^^^^^^^^
555
556
.. image:: imgs/prefs_profiles_compatability.png
557
558
**Backspace key generates** (default: ASCII DEL)
559
560
Change behaviour of the Backspace key.
561
562
- *Automatic*
563
- *Control-H*
564
- *ASCII DEL*
565
- *Escape sequence*
566
567
**Delete key generates** (default: Escape sequence)
568
569
Change behaviour of the Delete key.
570
571
- *Automatic*
572
- *Control-H*
573
- *ASCII DEL*
574
- *Escape sequence*
575
576
**Reset Compatibility Options to Defaults**
577
578
Sets the two previous items back to their defaults.
579
580
"""""""""""""""""""""""
581
Encoding
582
"""""""""""""""""""""""
583
584
**Default** (default: Unicode UTF-8)
585
586
Choose the default encoding method used from a long list of
587
available encodings.
588
589
.. _prefs-layouts:
590
591
-------
592
Layouts
593
-------
594
595
.. image:: imgs/prefs_layouts.png
596
597
Layouts are the primary means for saving collections of windows,
598
tabs, and terminals. The use and flexibility of layouts is covered in
599
:ref:`layouts`. Here we will cover the bare minimum to understand the
600
configuration options.
601
602
In the left list is the saved layouts, with three buttons below:
603
604
- *Add* - Creates a new layout from the current windows, tabs and
605
terminals, and saves them with a new name.
606
- *Remove* - Delete the selected layout
607
- *Save* - Update the selected layout with the current windows, tabs,
608
and terminals.
609
610
Once a layout is highlighted, it's name can be changed by clicking it
611
again.
612
613
In the central list is a tree showing the structure of the selected
614
layout. When highlighting an entry of type Terminal, the controls on
615
the right become enabled, and can be changed.
616
617
.. warning:: You do not need to use the save button when changing the
618
options in the controls on the right.
619
620
If you do, you *will* lose the *Custom command* and
621
*Working directory* settings for all terminals in this
622
layout.
623
624
**Profile**
625
626
The profile used by the select terminal as listed in the
627
:ref:`prefs-profiles` tab.
628
629
**Custom command**
630
631
Override the command run in the terminal, same as in a profile,
632
but this one has a higher priority. If empty, it will run the command
633
in the profile, or the default user shell.
634
635
.. note:: If you place an entry here note that there is no ``bash`` or
636
other shell underneath it. When the command ends, there
637
is no chance to drop to a shell or other program. This can
638
be worked around by using the shell line seperator ``;``
639
and a following ``bash`` command.
640
641
**Working directory**
642
643
Whatever command is run (from layout, profile, or user default) it
644
will be executed with this entry as the working path. If empty the
645
default working directory is used, which is either where Terminator
646
was launched from, or the users home directory.
647
648
-----------
649
Keybindings
650
-----------
651
652
.. image:: imgs/prefs_keybindings.png
653
654
This is a list of all available keyboard shortcuts in the application.
655
656
To change a keybinding, first highlight the entry you wish to change.
657
Next ``click`` on the *Keybinding* column again. The entry should change
658
to **New accelerator...**. Simply perform the shortcut you wish to
659
set. If you change your mind use ``Esc`` (Escape) key to revert back
660
to the existing shortcut. If you wish to delete a shortcut, use the
661
``BkSp`` key (Backspace, ←, or ⌫ depending on your keyboard).
662
663
.. _prefs-plugins:
664
665
-------
666
Plugins
667
-------
668
669
.. image:: imgs/prefs_plugins.png
670
671
Here you will find a list of available plugins, and whether they are
672
enabled or not. Plugins are covered in more detail in :ref:`plugins`.
673
674
.. warning:: For some reason clicking on the text label of a plugin
675
does not just select the item, but actually toggles the
676
active/inactive status. This does not happen in the
677
experimental GTK3 version of Terminator, and is a bit of
678
a mystery.
679
680
-----
681
About
682
-----
683
684
.. image:: imgs/prefs_about.png
685
686
A simple panel describing a bit about the application, and a set of
687
links that will guide users to some helpful Terminator project
688
resources. There's also a mysterious button... I wonder what happens
689
when I press it?
690
Loggerhead is a web-based interface for Breezy
Version: 2.0.1