itdominator/terminator
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity
527d892ebd
terminator/doc/manual/_build/html/preferences.html
Stephen Boddy 1d977cc6aa A manual has been added to Terminator 
* Added source and generated html of manual, and API doc
* setup.py can install the manual (and by extension do can debuild)
* setup.py has (inactive) code for generating the html from the source
  but this will break if rtd theme is not available
* A few changes to doc strings to make the autodoc prettier
* Added help shortcut, by default F1 to open the local manual
* Added button to About tab to launch manual
* A couple of additional string to translate related to manual/help
2015-08-08 04:11:30 +02:00

924 lines
44 KiB
HTML
Raw Blame History

<!DOCTYPE html>
<!--[if IE 8]><html class="no-js lt-ie9" lang="en" > <![endif]-->
<!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]-->
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>Preferences Window &mdash; Terminator 1.0 alpha documentation</title>
<link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
<link rel="top" title="Terminator 1.0 alpha documentation" href="index.html"/>
<link rel="next" title="Layouts and the Layout Launcher" href="layouts.html"/>
<link rel="prev" title="Getting Started" href="gettingstarted.html"/>
<script src="_static/js/modernizr.min.js"></script>
</head>
<body class="wy-body-for-nav" role="document">
<div class="wy-grid-for-nav">
<nav data-toggle="wy-nav-shift" class="wy-nav-side">
<div class="wy-side-nav-search">
<a href="index.html" class="icon icon-home"> Terminator
</a>
<div role="search">
<form id="rtd-search-form" class="wy-form" action="search.html" method="get">
<input type="text" name="q" placeholder="Search docs" />
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
</div>
</div>
<div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">
<p class="caption"><span class="caption-text">Contents:</span></p>
<ul class="current">
<li class="toctree-l1"><a class="reference internal" href="licensing.html">Licensing</a></li>
<li class="toctree-l1"><a class="reference internal" href="history.html">Document history</a></li>
<li class="toctree-l1"><a class="reference internal" href="gettingstarted.html">Getting Started</a><ul>
<li class="toctree-l2"><a class="reference internal" href="gettingstarted.html#the-context-menu">The Context Menu</a></li>
<li class="toctree-l2"><a class="reference internal" href="gettingstarted.html#navigating-around">Navigating around</a><ul>
<li class="toctree-l3"><a class="reference internal" href="gettingstarted.html#click-able-items">Click-able items</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="gettingstarted.html#changing-the-current-layout">Changing the current layout</a><ul>
<li class="toctree-l3"><a class="reference internal" href="gettingstarted.html#using-the-splitters">Using the splitters</a></li>
<li class="toctree-l3"><a class="reference internal" href="gettingstarted.html#dragging-and-dropping-a-terminal">Dragging and dropping a terminal</a></li>
<li class="toctree-l3"><a class="reference internal" href="gettingstarted.html#using-the-keyboard">Using the keyboard</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="gettingstarted.html#resetting-the-terminal">Resetting the terminal</a></li>
<li class="toctree-l2"><a class="reference internal" href="gettingstarted.html#the-scrollbar-and-scrollback-buffer">The scrollbar and scrollback buffer</a></li>
<li class="toctree-l2"><a class="reference internal" href="gettingstarted.html#search-the-buffer">Search the buffer</a></li>
<li class="toctree-l2"><a class="reference internal" href="gettingstarted.html#zooming-the-terminal">Zooming the terminal</a></li>
<li class="toctree-l2"><a class="reference internal" href="gettingstarted.html#setting-titles">Setting Titles</a></li>
<li class="toctree-l2"><a class="reference internal" href="gettingstarted.html#insert-terminal-number">Insert terminal number</a></li>
<li class="toctree-l2"><a class="reference internal" href="gettingstarted.html#next-prev-profile">Next/Prev profile</a></li>
</ul>
</li>
<li class="toctree-l1 current"><a class="current reference internal" href="">Preferences Window</a><ul>
<li class="toctree-l2"><a class="reference internal" href="#global">Global</a><ul>
<li class="toctree-l3"><a class="reference internal" href="#behaviour">Behaviour</a></li>
<li class="toctree-l3"><a class="reference internal" href="#appearance">Appearance</a></li>
<li class="toctree-l3"><a class="reference internal" href="#terminal-titlebar">Terminal Titlebar</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="#profiles">Profiles</a><ul>
<li class="toctree-l3"><a class="reference internal" href="#general">General</a><ul>
<li class="toctree-l4"><a class="reference internal" href="#cursor">Cursor</a></li>
<li class="toctree-l4"><a class="reference internal" href="#terminal-bell">Terminal bell</a></li>
<li class="toctree-l4"><a class="reference internal" href="#not-in-terminator">Not in Terminator</a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="#command">Command</a><ul>
<li class="toctree-l4"><a class="reference internal" href="#id1">Not in Terminator</a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="#colours">Colours</a><ul>
<li class="toctree-l4"><a class="reference internal" href="#foreground-and-background">Foreground and Background</a></li>
<li class="toctree-l4"><a class="reference internal" href="#palette">Palette</a></li>
<li class="toctree-l4"><a class="reference internal" href="#id2">Not in Terminator</a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="#background">Background</a></li>
<li class="toctree-l3"><a class="reference internal" href="#scrolling">Scrolling</a></li>
<li class="toctree-l3"><a class="reference internal" href="#compatibility">Compatibility</a><ul>
<li class="toctree-l4"><a class="reference internal" href="#encoding">Encoding</a></li>
</ul>
</li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="#layouts">Layouts</a></li>
<li class="toctree-l2"><a class="reference internal" href="#keybindings">Keybindings</a></li>
<li class="toctree-l2"><a class="reference internal" href="#plugins">Plugins</a></li>
<li class="toctree-l2"><a class="reference internal" href="#about">About</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="layouts.html">Layouts and the Layout Launcher</a><ul>
<li class="toctree-l2"><a class="reference internal" href="layouts.html#the-layout-launcher">The Layout Launcher</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="grouping.html">The Grouping Menu</a><ul>
<li class="toctree-l2"><a class="reference internal" href="grouping.html#manipulating-terminal-groups">Manipulating terminal groups</a></li>
<li class="toctree-l2"><a class="reference internal" href="grouping.html#broadcasting-input-to-multiple-terminals">Broadcasting input to multiple terminals</a></li>
<li class="toctree-l2"><a class="reference internal" href="grouping.html#insert-terminal-number">Insert terminal number</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="plugins.html">Plugins</a><ul>
<li class="toctree-l2"><a class="reference internal" href="plugins.html#included-plugins">Included plugins</a><ul>
<li class="toctree-l3"><a class="reference internal" href="plugins.html#activity-watch">Activity Watch</a></li>
<li class="toctree-l3"><a class="reference internal" href="plugins.html#apt-url-handler">APT URL Handler</a></li>
<li class="toctree-l3"><a class="reference internal" href="plugins.html#custom-commands-menu">Custom Commands Menu</a></li>
<li class="toctree-l3"><a class="reference internal" href="plugins.html#inactivity-watch">Inactivity Watch</a></li>
<li class="toctree-l3"><a class="reference internal" href="plugins.html#launchpad-bug-url-handler">Launchpad Bug URL Handler</a></li>
<li class="toctree-l3"><a class="reference internal" href="plugins.html#launchpad-code-url-handler">Launchpad Code URL Handler</a></li>
<li class="toctree-l3"><a class="reference internal" href="plugins.html#logger">Logger</a></li>
<li class="toctree-l3"><a class="reference internal" href="plugins.html#maven-plugin-url-handler">Maven Plugin URL Handler</a></li>
<li class="toctree-l3"><a class="reference internal" href="plugins.html#terminal-shot">Terminal Shot</a></li>
<li class="toctree-l3"><a class="reference internal" href="plugins.html#test-plugin">Test Plugin</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="plugins.html#third-party-plugins">Third party plugins</a></li>
<li class="toctree-l2"><a class="reference internal" href="plugins.html#installing-a-plugin">Installing a plugin</a></li>
<li class="toctree-l2"><a class="reference internal" href="plugins.html#creating-your-own-plugins">Creating your own plugins</a><ul>
<li class="toctree-l3"><a class="reference internal" href="plugins.html#the-basics-of-a-plugin">The basics of a plugin</a></li>
<li class="toctree-l3"><a class="reference internal" href="plugins.html#url-handlers">URL Handlers</a></li>
<li class="toctree-l3"><a class="reference internal" href="plugins.html#context-menu-items">Context menu items</a></li>
<li class="toctree-l3"><a class="reference internal" href="plugins.html#wrap-up">Wrap up</a></li>
</ul>
</li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="advancedusage.html">Advanced Usage</a><ul>
<li class="toctree-l2"><a class="reference internal" href="advancedusage.html#command-line-options">Command line options</a><ul>
<li class="toctree-l3"><a class="reference internal" href="advancedusage.html#general-options">General options</a></li>
<li class="toctree-l3"><a class="reference internal" href="advancedusage.html#window-options">Window options</a></li>
<li class="toctree-l3"><a class="reference internal" href="advancedusage.html#shell-options">Shell options</a></li>
<li class="toctree-l3"><a class="reference internal" href="advancedusage.html#layout-options">Layout options</a></li>
<li class="toctree-l3"><a class="reference internal" href="advancedusage.html#custom-window-manager-options">Custom Window Manager options</a></li>
<li class="toctree-l3"><a class="reference internal" href="advancedusage.html#debugging-options">Debugging options</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="advancedusage.html#the-config-file">The Config file</a></li>
<li class="toctree-l2"><a class="reference internal" href="advancedusage.html#debugging">Debugging</a></li>
<li class="toctree-l2"><a class="reference internal" href="advancedusage.html#dbus">DBus</a></li>
<li class="toctree-l2"><a class="reference internal" href="advancedusage.html#remotinator">Remotinator</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="faq.html">Frequently Asked Questions</a><ul>
<li class="toctree-l2"><a class="reference internal" href="faq.html#why">Why...</a><ul>
<li class="toctree-l3"><a class="reference internal" href="faq.html#write-in-python-it-s-slow-bloated-bad">...write in Python? It&#8217;s slow/bloated/bad?</a><ul>
<li class="toctree-l4"><a class="reference internal" href="faq.html#performance">Performance</a></li>
<li class="toctree-l4"><a class="reference internal" href="faq.html#memory-use-the-dumb-way">Memory use - The dumb way</a></li>
<li class="toctree-l4"><a class="reference internal" href="faq.html#memory-use-the-sensible-way">Memory use - The sensible way</a></li>
<li class="toctree-l4"><a class="reference internal" href="faq.html#python-sucks">&#8220;Python sucks!&#8221;</a></li>
<li class="toctree-l4"><a class="reference internal" href="faq.html#in-summary">In summary</a></li>
</ul>
</li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="faq.html#how-do-i">How do I...</a><ul>
<li class="toctree-l3"><a class="reference internal" href="faq.html#make-terminator-work-like-quake-style-terminals">...make Terminator work like Quake style terminals?</a></li>
</ul>
</li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="gettinginvolved.html">Getting involved</a><ul>
<li class="toctree-l2"><a class="reference internal" href="gettinginvolved.html#translations">Translations</a></li>
<li class="toctree-l2"><a class="reference internal" href="gettinginvolved.html#improve-icons-artwork">Improve icons/artwork</a></li>
<li class="toctree-l2"><a class="reference internal" href="gettinginvolved.html#terminator-action-shots">Terminator action shots</a></li>
<li class="toctree-l2"><a class="reference internal" href="gettinginvolved.html#manual-updates">Manual updates</a></li>
<li class="toctree-l2"><a class="reference internal" href="gettinginvolved.html#testing">Testing</a></li>
<li class="toctree-l2"><a class="reference internal" href="gettinginvolved.html#bugs">Bugs</a></li>
<li class="toctree-l2"><a class="reference internal" href="gettinginvolved.html#plugins">Plugins</a></li>
<li class="toctree-l2"><a class="reference internal" href="gettinginvolved.html#main-application-development">Main Application Development</a></li>
<li class="toctree-l2"><a class="reference internal" href="gettinginvolved.html#gtk3-port">GTK3 Port</a></li>
<li class="toctree-l2"><a class="reference internal" href="gettinginvolved.html#api-docs">API Docs</a></li>
</ul>
</li>
</ul>
</div>
&nbsp;
</nav>
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
<nav class="wy-nav-top" role="navigation" aria-label="top navigation">
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
<a href="index.html">Terminator</a>
</nav>
<div class="wy-nav-content">
<div class="rst-content">
<div role="navigation" aria-label="breadcrumbs navigation">
<ul class="wy-breadcrumbs">
<li><a href="index.html">Docs</a> &raquo;</li>
<li>Preferences Window</li>
<li class="wy-breadcrumbs-aside">
<a href="_sources/preferences.txt" rel="nofollow"> View page source</a>
</li>
</ul>
<hr/>
</div>
<div role="main" class="document">
<img alt="Because spanners mean settings?!?!?" class="align-right" src="_images/icon_prefs.png" />
<div class="section" id="preferences-window">
<span id="preferences"></span><h1>Preferences Window<a class="headerlink" href="#preferences-window" title="Permalink to this headline"></a></h1>
<p>Terminator is <em>highly</em> configurable, and automate-able, so the Preferences
dialog is naturally quite extensive. It currently consists of six tabs.
Let&#8217;s work through them one by one.</p>
<div class="section" id="global">
<span id="prefs-global"></span><h2>Global<a class="headerlink" href="#global" title="Permalink to this headline"></a></h2>
<img alt="_images/prefs_global.png" src="_images/prefs_global.png" />
<p>These settings are defaults, but some of them can be overridden by a
options on the command-line, or within a layout. A number will also
require a restart to take effect.</p>
<div class="section" id="behaviour">
<h3>Behaviour<a class="headerlink" href="#behaviour" title="Permalink to this headline"></a></h3>
<blockquote>
<div><p><strong>Window state</strong> (default: Normal)</p>
<blockquote>
<div><p>This will determine what happens on startup normally.</p>
<ul class="simple">
<li><em>Normal</em> - Window opens as normal.</li>
<li><em>Hidden</em> - Window does not open. Useful at login, so it is already
available with a shortcut.</li>
<li><em>Maximised</em> - Window opens maximised in the standard window manager
frame.</li>
<li><em>Fullscreen</em> - Window opens fullscreen with no window manager frame.</li>
</ul>
</div></blockquote>
<p><strong>Always on top</strong> (default: off)</p>
<blockquote>
<div>Window attempts to remain on top.</div></blockquote>
<p><strong>Show on all workspaces</strong> (default: off)</p>
<blockquote>
<div>The focused window will follow if you switch to a different virtual
desktop.</div></blockquote>
<p><strong>Hide on lose focus</strong> (default: off)</p>
<blockquote>
<div><p>This is a quake console like feature, where the user want the window to
vanish when clicking elsewhere.</p>
<p>This is rather buggy at the moment as it is very easy for the main
window to lose focus and disappear.</p>
</div></blockquote>
<p><strong>Hide from taskbar</strong> (default: off)</p>
<blockquote>
<div>The first window opened will not be displayed in the taskbar.
Subsequent windows will show in the taskbar (bug?).</div></blockquote>
<p><strong>Window geometry hints</strong> (default: on)</p>
<blockquote>
<div><p>If this is checked, then when resizing Terminator will attempt to
step the sizing by the current font, and display a small box with the
dimension of the window in characters.</p>
<div class="admonition warning">
<p class="first admonition-title">Warning</p>
<p class="last">If you have problems with Terminator windows shrinking
in an uncontrollable way, then turning this option
<strong>off</strong> will usually fix the issue. It is not clear
why, but it seems Terminator and the window manager
get into an argument over what size the window should
be.</p>
</div>
</div></blockquote>
<p><strong>Mouse focus</strong> (default: Click to focus)</p>
<blockquote>
<div><p>By what method the mouse pointer sets the focus on a terminal.</p>
<ul class="simple">
<li><em>GNOME Default</em> - Act as per the system settings.</li>
<li><em>Click to focus</em> - You must click with in a terminal to make it the
focus.</li>
<li><em>Follow mouse pointer</em> - Moving the pointer over a terminal makes
it the focus.</li>
</ul>
</div></blockquote>
<p><strong>Broadcast default</strong> (default: Group)</p>
<blockquote>
<div><p>Which broadcast mode should be selected at startup:</p>
<ul class="simple">
<li><em>All</em> - All terminals receive keystrokes.</li>
<li><em>Group</em> - Only terminals in the same group as the current terminal
receive keystrokes.</li>
<li><em>None</em> - Only the current terminal receives keystrokes.</li>
</ul>
</div></blockquote>
<p><strong>Re-use profiles for new terminals</strong> (default: off)</p>
<blockquote>
<div>When creating a new terminal with splitting or new tabs, if this is
enabled, then the profile from the previously focussed terminal will
also be used for the new one.</div></blockquote>
<p><strong>Use custom URL handler</strong> (default: off)</p>
<blockquote>
<div>If this is enabled then Ctrl+left-mouse-click on a URL will try to use
the command defined in <em>Custom URL handler</em> to open the link. If not
enabled, Terminator will attempt to open the link with its internal
logic.</div></blockquote>
<p><strong>Custom URL handler</strong> (default: inactive, empty)</p>
<blockquote>
<div>If active and set, then URL&#8217;s will be passed as a command-line parameter
to the given command.</div></blockquote>
<p><strong>DBus server</strong> (default: on)</p>
<blockquote>
<div>If a Terminator <a class="reference internal" href="advancedusage.html#dbus"><span>DBus</span></a> server is not already on the session
bus, try to start one.</div></blockquote>
</div></blockquote>
</div>
<div class="section" id="appearance">
<h3>Appearance<a class="headerlink" href="#appearance" title="Permalink to this headline"></a></h3>
<blockquote>
<div><p><strong>Terminator seperator size</strong> (default: -1)</p>
<blockquote>
<div>This is the width in pixels, and can range from -1 to 5. The value
of -1 will take the default size from the system theme.</div></blockquote>
<p><strong>Unfocused terminal font brightness</strong> (default: 0.8)</p>
<blockquote>
<div>Terminals that do not currently have the focus will can be dimmed
to aid focus. The value can range from 0 (invisible) to 1 (full
brightness)</div></blockquote>
<p><strong>Window borders</strong> (default: on)</p>
<blockquote>
<div>The window manager frame can be removed from your windows.</div></blockquote>
<p><strong>Tab position</strong> (default: Top)</p>
<blockquote>
<div><p>Where the tabs will be located within the window</p>
<ul class="simple">
<li><em>Top</em></li>
<li><em>Bottom</em></li>
<li><em>Left</em></li>
<li><em>Right</em></li>
<li><em>Hidden</em> - Tabs still work, you just can&#8217;t see them.</li>
</ul>
</div></blockquote>
<p><strong>Tabs homogeneous</strong> (default: on)</p>
<blockquote>
<div>Tabs will have equal widths</div></blockquote>
<p><strong>Tabs scroll buttons</strong> (default: off)</p>
<blockquote>
<div>When there are more tabs than can fit within the window buttons will
be drawn for moving left and right.</div></blockquote>
</div></blockquote>
</div>
<div class="section" id="terminal-titlebar">
<h3>Terminal Titlebar<a class="headerlink" href="#terminal-titlebar" title="Permalink to this headline"></a></h3>
<blockquote>
<div><p>There is a table of the colours for the titlebars on the left. These
are modelled on those used in a utility I used to use called ClusTerm.
The three sets (Focused, Inactive and Receiving) will make more sense
after reading the section about <a class="reference internal" href="grouping.html#grouping-menu"><span>The Grouping Menu</span></a>.</p>
<table border="1" class="docutils">
<colgroup>
<col width="30%" />
<col width="21%" />
<col width="23%" />
<col width="26%" />
</colgroup>
<thead valign="bottom">
<tr class="row-odd"><th class="head">&nbsp;</th>
<th class="head">Focused</th>
<th class="head">Inactive</th>
<th class="head">Receiving</th>
</tr>
</thead>
<tbody valign="top">
<tr class="row-even"><td>Font colour</td>
<td>#FFFFFF</td>
<td>#000000</td>
<td>#FFFFFF</td>
</tr>
<tr class="row-odd"><td>Background</td>
<td>#C80003</td>
<td>#C0BEBF</td>
<td>#0076C9</td>
</tr>
</tbody>
</table>
<p><strong>Hide size from title</strong> (default: off)</p>
<blockquote>
<div>At the end of the label in the titlebar the size of the terminal is
given in characters, i.e. (80x24). Enabling this item will disable
the size text.</div></blockquote>
<p><strong>Use the system font</strong> (default: on)</p>
<blockquote>
<div>By default the system defined proportional font will be used for the
text in the titlebar. Turning this off allows you to use a custom font.</div></blockquote>
<p><strong>Font</strong> (default: inactive, system proportional font)</p>
<blockquote>
<div>If active and set, then the custom font to be used in the titlebar.</div></blockquote>
<div class="admonition warning">
<p class="first admonition-title">Warning</p>
<p class="last">With newer versions of some of the underlying libraries,
using a bitmap font can cause the Preference window to
crash. If you find this happening, you will need to
either remove the configuration from the Terminator
<a class="reference internal" href="advancedusage.html#config-file"><span>configuration file</span></a> or you will
need to change your system settings. Please see
<a class="reference external" href="https://bugs.launchpad.net/bugs/1294699">LP#1294699</a> for more information.</p>
</div>
</div></blockquote>
</div>
</div>
<div class="section" id="profiles">
<span id="prefs-profiles"></span><h2>Profiles<a class="headerlink" href="#profiles" title="Permalink to this headline"></a></h2>
<p>You should already be familiar with the sub-tabs from GNOME Terminal,
and Terminator&#8217;s are modelled on those available in GNOME Terminal where
it makes sense, and give much of the same functionality. Bear in mind that
some of these differences are due to changes in the underlying VTE
widget between GTK2 and GTK3.</p>
<p>Below we will go through each pane, and highlight and explain differences
between Terminator with GTK2 and GNOME Terminal with GTK3.</p>
<div class="section" id="general">
<h3>General<a class="headerlink" href="#general" title="Permalink to this headline"></a></h3>
<img alt="_images/prefs_profiles_general.png" src="_images/prefs_profiles_general.png" />
<p>One key difference is that we have a sidebar to the left listing the
available Profiles, as opposed to GNOME Terminator, where the list is
a separate window launched from the menu bar.</p>
<p><strong>Use the system fixed width font</strong> (default: on)</p>
<blockquote>
<div>By default the system defined proportional font will be used for the
text in the terminal. Turning this off allows you to use a custom font.</div></blockquote>
<p><strong>Font</strong> (inactive, system fixed width font)</p>
<blockquote>
<div>If active and set, then the custom font to be used in the terminal.</div></blockquote>
<div class="admonition warning">
<p class="first admonition-title">Warning</p>
<p class="last">With newer versions of some of the underlying libraries,
using a bitmap font can cause the Preference window to
crash. If you find this happening, you will need to
either remove the configuration from the Terminator
<a class="reference internal" href="advancedusage.html#config-file"><span>configuration file</span></a> or you will
need to change your system settings. Please see
<a class="reference external" href="https://bugs.launchpad.net/bugs/1294699">LP#1294699</a> for more information.</p>
</div>
<p><strong>Allow bold text</strong> (default: on)</p>
<blockquote>
<div>Allows you to disable the use of bold fonts in the terminal.</div></blockquote>
<p><strong>Anti-alias text</strong> (default: on) †<em>Not in GNOME Terminal</em></p>
<blockquote>
<div>In Terminator you can turn the font smoothing off. This is no
longer possible in GNOME Terminator.</div></blockquote>
<p><strong>Show titlebar</strong> (default: on)</p>
<blockquote>
<div>The titlebar strip across the top of each terminal can be turned off.</div></blockquote>
<p><strong>Copy on selection</strong> (default: off)</p>
<blockquote>
<div>This puts the selection into the copy/paste buffer, as well as being
available on middle-click.</div></blockquote>
<p><strong>Select-by-word characters</strong> (default: <code class="docutils literal"><span class="pre">-A-Za-z0-9,./?%&amp;#:_</span></code>)</p>
<blockquote>
<div>Using double-click to select text will use this pattern to define
what characters are considered part of the word.</div></blockquote>
<div class="section" id="cursor">
<h4>Cursor<a class="headerlink" href="#cursor" title="Permalink to this headline"></a></h4>
<blockquote>
<div><p><strong>Shape</strong> (default: Block)</p>
<blockquote>
<div><p>Set the cursor shape</p>
<ul class="simple">
<li><em>Block</em> - Solid rectangle.</li>
<li><em>Underline</em> - Single pixel tall horizontal line.</li>
<li><em>I-Beam</em> - Single pixel wide vertical line.</li>
</ul>
</div></blockquote>
<p><strong>Colour</strong> (default: #AAAAAA)</p>
<blockquote>
<div>The colour of the cursor.</div></blockquote>
<p><strong>Blink</strong> (default: on)</p>
<blockquote>
<div>Whether the cursor blinks on and off.</div></blockquote>
</div></blockquote>
</div>
<div class="section" id="terminal-bell">
<h4>Terminal bell<a class="headerlink" href="#terminal-bell" title="Permalink to this headline"></a></h4>
<blockquote>
<div><p><strong>Titlebar icon</strong> (default: on)</p>
<blockquote>
<div>On the right side of the titlebar a small light-bulb icon will
be displayed for a few seconds.</div></blockquote>
<p><strong>Visual flash</strong> (default: off)</p>
<blockquote>
<div>The terminal area will briefly flash.</div></blockquote>
<p><strong>Audible beep</strong> (default: off)</p>
<blockquote>
<div>The normal system beep noise as defined in system settings.</div></blockquote>
<p><strong>Window list flash</strong> (default: off)</p>
<blockquote>
<div>This will set the urgent flag on the window in the taskbar. The
actual effect will be taskbar dependant.</div></blockquote>
</div></blockquote>
</div>
<div class="section" id="not-in-terminator">
<h4>Not in Terminator<a class="headerlink" href="#not-in-terminator" title="Permalink to this headline"></a></h4>
<blockquote>
<div><p><strong>Profile name</strong></p>
<blockquote>
<div>Our profiles names are in the sidebar to the left.</div></blockquote>
<p><strong>Show menubar by default in new terminals</strong></p>
<blockquote>
<div>Terminator doesn&#8217;t use a traditional menu bar.</div></blockquote>
<p><strong>Terminal bell</strong></p>
<blockquote>
<div>Terminator has more options, so has four separate options in their
own grouping. This item in GNOME Terminal is the same as <em>Audible
beep</em> defined above.</div></blockquote>
<p><strong>Use custom default terminal size</strong></p>
<blockquote>
<div>Terminator handles window sizes within <a class="reference internal" href="layouts.html#layouts"><span>Layouts</span></a>,
or with <a class="reference internal" href="advancedusage.html#command-line-options"><span>Command line options</span></a>.</div></blockquote>
</div></blockquote>
</div>
</div>
<div class="section" id="command">
<h3>Command<a class="headerlink" href="#command" title="Permalink to this headline"></a></h3>
<img alt="_images/prefs_profiles_command.png" src="_images/prefs_profiles_command.png" />
<p><strong>Run commands as a login shell</strong> (default: off)</p>
<blockquote>
<div>Force the command to run as a login shell.</div></blockquote>
<p><strong>Update login records when command is launched</strong> (default: on)</p>
<blockquote>
<div>Updates login records when a new shell is opened.</div></blockquote>
<p><strong>Run a custom command instead of my shell</strong> (default: off)</p>
<blockquote>
<div>Enable the use of a custom command instead of the users default
shell.</div></blockquote>
<p><strong>Custom command</strong> (default: inactive, empty)</p>
<blockquote>
<div>If enabled and set, the users default shell will be replaced with
the command specified here.</div></blockquote>
<p><strong>When command exits</strong> (default: Exit the terminal)</p>
<blockquote>
<div><p>When the running command exits (default or custom) what action
should be taken.</p>
<ul class="simple">
<li><em>Exit the terminal</em> - Terminal closes, causing layout to adjust.</li>
<li><em>Restart the command</em> - Original command restarts immediately.</li>
<li><em>Hold the terminal open</em> - The terminal and scrollback will remain
visible and accessible until the user explicitly closes the
terminal, or closes the window.</li>
</ul>
<div class="admonition warning">
<p class="first admonition-title">Warning</p>
<p class="last">If you are using <em>Restart the command</em> and your command
is broken and exits immediately, then you can end up
in a resource hungry loop.</p>
</div>
</div></blockquote>
<div class="section" id="id1">
<h4>Not in Terminator<a class="headerlink" href="#id1" title="Permalink to this headline"></a></h4>
<blockquote>
<div><p><strong>Initial title</strong></p>
<blockquote>
<div>Terminator handles window title within <a class="reference internal" href="layouts.html#layouts"><span>Layouts</span></a>,
or with <a class="reference internal" href="advancedusage.html#command-line-options"><span>Command line options</span></a>.</div></blockquote>
<p><strong>When terminal commands set their own titles</strong></p>
<blockquote>
<div>Terminator doesn&#8217;t have this setting.</div></blockquote>
</div></blockquote>
</div>
</div>
<div class="section" id="colours">
<h3>Colours<a class="headerlink" href="#colours" title="Permalink to this headline"></a></h3>
<img alt="_images/prefs_profiles_colors.png" src="_images/prefs_profiles_colors.png" />
<p>There seems to be some mild quirks and differences (palettes available
or selected from the system theme) between Terminator and GNOME
Terminal.</p>
<div class="section" id="foreground-and-background">
<h4>Foreground and Background<a class="headerlink" href="#foreground-and-background" title="Permalink to this headline"></a></h4>
<blockquote>
<div><p><strong>Use colours from system theme</strong> (default: off)</p>
<blockquote>
<div>Use colours as defined in the system theme. Not clear at this time
where exactly these come from. Differences in the GTK2, GTK3 and
GNOME Terminal.</div></blockquote>
<p><strong>Built-in schemes</strong> (default: Grey on black)</p>
<blockquote>
<div><p>Pick a primary colour combination for foreground and background.
Again there are unexplained differences between Terminator and
GNOME Terminal.</p>
<p>The list seems to be dynamic and vary depending on the system,
with the addition of <em>Custom</em> which allows setting the colours
as desired.</p>
</div></blockquote>
<p><strong>Text colour</strong> (default: inactive, #AAAAAA)</p>
<blockquote>
<div>If the <em>Built-in schemes</em> is set to <em>Custom</em> the text colour can
be set here.</div></blockquote>
<p><strong>Background colour</strong> (default: inactive, #000000)</p>
<blockquote>
<div>If the <em>Built-in schemes</em> is set to <em>Custom</em> the background colour
can be set here.</div></blockquote>
</div></blockquote>
</div>
<div class="section" id="palette">
<h4>Palette<a class="headerlink" href="#palette" title="Permalink to this headline"></a></h4>
<blockquote>
<div><p><strong>Built-in schemes</strong> (default: Ambience)</p>
<blockquote>
<div><p>A predefined colour palette can be selected. Again there are
unexplained differences between Terminator and GNOME Terminal.</p>
<p>The default here may be system dependant, with Ambience being
an Ubuntu colour scheme.</p>
</div></blockquote>
<p><strong>Colour palette</strong> (default: inactive)</p>
<blockquote>
<div>If the Palette&#8217;s <em>Built-in schemes</em> is set to custom, a set of
colour swatches are used to configure the 16 primary colours
of the shell palette.</div></blockquote>
</div></blockquote>
</div>
<div class="section" id="id2">
<h4>Not in Terminator<a class="headerlink" href="#id2" title="Permalink to this headline"></a></h4>
<blockquote>
<div><p><strong>Bold colour</strong></p>
<blockquote>
<div>In theory nothing is stopping us implementing this, it just doesn&#8217;t
appear to have ever been added.</div></blockquote>
<p><strong>Same as text colour</strong></p>
<blockquote>
<div>In truth, I&#8217;m not exactly sure what this does, but at a guess, the
user can force bold to be drawn in the same colour as the
foreground text.</div></blockquote>
</div></blockquote>
</div>
</div>
<div class="section" id="background">
<h3>Background<a class="headerlink" href="#background" title="Permalink to this headline"></a></h3>
<img alt="_images/prefs_profiles_background.png" src="_images/prefs_profiles_background.png" />
<p><strong>Solid colour</strong> (default: active)</p>
<blockquote>
<div>Background of terminal is set to the solid colour set in previous
<em>Colours</em> tab.</div></blockquote>
<p><strong>Background image</strong> (default: inactive)</p>
<blockquote>
<div>Background will be an image. There is no scaling done.</div></blockquote>
<p><strong>Image file</strong> (default: inactive, None)</p>
<blockquote>
<div>If <em>Background image</em> is set, then the image to use can be selected
here.</div></blockquote>
<p><strong>Background image scrolls</strong> (default: inactive, on)</p>
<blockquote>
<div>If the <em>Background image</em> is set, then setting this to on will cause
the background image to change as the window moves. This is a for of
fake transparency.</div></blockquote>
<p><strong>Transparent background</strong> (default: inactive)</p>
<blockquote>
<div><p>This will attempt true transparency where the windows below are
partially visible through the terminal.</p>
<div class="admonition note">
<p class="first admonition-title">Note</p>
<p class="last">This option requires a compositing desktop.</p>
</div>
</div></blockquote>
<p><strong>Shade transparent or image background</strong> (default: 0.5)</p>
<blockquote>
<div>For <em>Background image</em> and <em>Transparent background</em> this is how
much the solid colour should be blended in, giving a tinting effect.</div></blockquote>
</div>
<div class="section" id="scrolling">
<h3>Scrolling<a class="headerlink" href="#scrolling" title="Permalink to this headline"></a></h3>
<img alt="_images/prefs_profiles_scrolling.png" src="_images/prefs_profiles_scrolling.png" />
<p><strong>Scrollbar is</strong> (default: On the right side)</p>
<blockquote>
<div><p>If and where the scrollbar should appear.</p>
<ul class="simple">
<li><em>On the left side</em></li>
<li><em>On the right side</em></li>
<li><em>Disabled</em></li>
</ul>
</div></blockquote>
<p><strong>Scrollback</strong> (default: 500 lines)</p>
<blockquote>
<div>How many lines to keep before discarding.</div></blockquote>
<p><strong>Infinite Scrollback</strong> (default: off)</p>
<blockquote>
<div><p>Lines are never discarded, and all lines since the session began
are available.</p>
<div class="admonition note">
<p class="first admonition-title">Note</p>
<p class="last">Data is placed onto the disk by the underlying VTE
component, so even after a long time, the memory footprint
and performance of Terminator should be OK.</p>
</div>
</div></blockquote>
<p><strong>Scroll on output</strong> (default: on)</p>
<blockquote>
<div>Moves terminal to end of scrollback buffer when any output occurs.</div></blockquote>
<p><strong>Scroll on keystroke</strong> (default: on)</p>
<blockquote>
<div>Moves terminal to end of scrollback buffer when any keypress occurs.</div></blockquote>
<p><strong>Use keystrokes to scroll on alternate screen</strong> (default: on)</p>
<blockquote>
<div>Ummmm... I don&#8217;t know. Alternate screens are a bit of a mystery to me.</div></blockquote>
</div>
<div class="section" id="compatibility">
<h3>Compatibility<a class="headerlink" href="#compatibility" title="Permalink to this headline"></a></h3>
<img alt="_images/prefs_profiles_compatability.png" src="_images/prefs_profiles_compatability.png" />
<p><strong>Backspace key generates</strong> (default: ASCII DEL)</p>
<blockquote>
<div><p>Change behaviour of the Backspace key.</p>
<ul class="simple">
<li><em>Automatic</em></li>
<li><em>Control-H</em></li>
<li><em>ASCII DEL</em></li>
<li><em>Escape sequence</em></li>
</ul>
</div></blockquote>
<p><strong>Delete key generates</strong> (default: Escape sequence)</p>
<blockquote>
<div><p>Change behaviour of the Delete key.</p>
<ul class="simple">
<li><em>Automatic</em></li>
<li><em>Control-H</em></li>
<li><em>ASCII DEL</em></li>
<li><em>Escape sequence</em></li>
</ul>
</div></blockquote>
<p><strong>Reset Compatibility Options to Defaults</strong></p>
<blockquote>
<div>Sets the two previous items back to their defaults.</div></blockquote>
<div class="section" id="encoding">
<h4>Encoding<a class="headerlink" href="#encoding" title="Permalink to this headline"></a></h4>
<p><strong>Default</strong> (default: Unicode UTF-8)</p>
<blockquote>
<div>Choose the default encoding method used from a long list of
available encodings.</div></blockquote>
</div>
</div>
</div>
<div class="section" id="layouts">
<span id="prefs-layouts"></span><h2>Layouts<a class="headerlink" href="#layouts" title="Permalink to this headline"></a></h2>
<img alt="_images/prefs_layouts.png" src="_images/prefs_layouts.png" />
<p>Layouts are the primary means for saving collections of windows,
tabs, and terminals. The use and flexibility of layouts is covered in
<a class="reference internal" href="layouts.html#layouts"><span>Layouts and the Layout Launcher</span></a>. Here we will cover the bare minimum to understand the
configuration options.</p>
<p>In the left list is the saved layouts, with three buttons below:</p>
<ul class="simple">
<li><em>Add</em> - Creates a new layout from the current windows, tabs and
terminals, and saves them with a new name.</li>
<li><em>Remove</em> - Delete the selected layout</li>
<li><em>Save</em> - Update the selected layout with the current windows, tabs,
and terminals.</li>
</ul>
<p>Once a layout is highlighted, it&#8217;s name can be changed by clicking it
again.</p>
<p>In the central list is a tree showing the structure of the selected
layout. When highlighting an entry of type Terminal, the controls on
the right become enabled, and can be changed.</p>
<div class="admonition warning">
<p class="first admonition-title">Warning</p>
<p>You do not need to use the save button when changing the
options in the controls on the right.</p>
<p class="last">If you do, you <em>will</em> lose the <em>Custom command</em> and
<em>Working directory</em> settings for all terminals in this
layout.</p>
</div>
<p><strong>Profile</strong></p>
<blockquote>
<div>The profile used by the select terminal as listed in the
<a class="reference internal" href="#prefs-profiles"><span>Profiles</span></a> tab.</div></blockquote>
<p><strong>Custom command</strong></p>
<blockquote>
<div>Override the command run in the terminal, same as in a profile,
but this one has a higher priority. If empty, it will run the command
in the profile, or the default user shell.</div></blockquote>
<p><strong>Working directory</strong></p>
<blockquote>
<div>Whatever command is run (from layout, profile, or user default) it
will be executed with this entry as the working path. If empty the
default working directory is used, which is either where Terminator
was launched from, or the users home directory.</div></blockquote>
</div>
<div class="section" id="keybindings">
<h2>Keybindings<a class="headerlink" href="#keybindings" title="Permalink to this headline"></a></h2>
<img alt="_images/prefs_keybindings.png" src="_images/prefs_keybindings.png" />
<p>This is a list of all available keyboard shortcuts in the application.</p>
<p>To change a keybinding, first highlight the entry you wish to change.
Next click on the <em>Keybinding</em> column again. The entry should change
to <strong>New accelerator...</strong>. Simply perform the shortcut you wish to
set. If you change your mind use <code class="docutils literal"><span class="pre">Esc</span></code> (Escape) key to revert back
to the existing shortcut. If you wish to delete a shortcut, use the
<code class="docutils literal"><span class="pre">BkSp</span></code> key (Backspace, ←, or ⌫ depending on your keyboard).</p>
</div>
<div class="section" id="plugins">
<span id="prefs-plugins"></span><h2>Plugins<a class="headerlink" href="#plugins" title="Permalink to this headline"></a></h2>
<img alt="_images/prefs_plugins.png" src="_images/prefs_plugins.png" />
<p>Here you will find a list of available plugins, and whether they are
enabled or not. Plugins are covered in more detail in <a class="reference internal" href="plugins.html#plugins"><span>Plugins</span></a>.</p>
<div class="admonition warning">
<p class="first admonition-title">Warning</p>
<p class="last">For some reason clicking on the text label of a plugin
does not just select the item, but actually toggles the
active/inactive status. This does not happen in the
experimental GTK3 version of Terminator, and is a bit of
a mystery.</p>
</div>
</div>
<div class="section" id="about">
<h2>About<a class="headerlink" href="#about" title="Permalink to this headline"></a></h2>
<img alt="_images/prefs_about.png" src="_images/prefs_about.png" />
<p>A simple panel describing a bit about the application, and a set of
links that will guide users to some helpful Terminator project
resources. There&#8217;s also a mysterious button... I wonder what happens
when I press it?</p>
</div>
</div>
</div>
<footer>
<div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
<a href="layouts.html" class="btn btn-neutral float-right" title="Layouts and the Layout Launcher" accesskey="n">Next <span class="fa fa-arrow-circle-right"></span></a>
<a href="gettingstarted.html" class="btn btn-neutral" title="Getting Started" accesskey="p"><span class="fa fa-arrow-circle-left"></span> Previous</a>
</div>
<hr/>
<div role="contentinfo">
<p>
&copy; Copyright 2015, Stephen Boddy, licensed under the CC-BY-SA..
</p>
</div>
Built with <a href="http://sphinx-doc.org/">Sphinx</a> using a <a href="https://github.com/snide/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>.
</footer>
</div>
</div>
</section>
</div>
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT:'./',
VERSION:'1.0 alpha',
COLLAPSE_INDEX:false,
FILE_SUFFIX:'.html',
HAS_SOURCE: true
};
</script>
<script type="text/javascript" src="_static/jquery.js"></script>
<script type="text/javascript" src="_static/underscore.js"></script>
<script type="text/javascript" src="_static/doctools.js"></script>
<script type="text/javascript" src="_static/js/theme.js"></script>
<script type="text/javascript">
jQuery(function () {
SphinxRtdTheme.StickyNav.enable();
});
</script>
</body>
</html>
Reference in New Issue View Git Blame Copy Permalink