/usr/share/doc/roxterm/en/guide.html is in roxterm-common 2.8.1-1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 | <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
<html xml:lang="en-US" lang="en-US" xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/html;charset=utf-8" />
<meta name="author" content="Adrian Sampson" />
<meta name="description" content="ROXTerm, a full-featured VTE terminal emulator" />
<title>ROXTerm</title>
<link rel="stylesheet" type="text/css" href="../lib/roxterm.css" />
<!--[if lte IE 7]>
<link rel="stylesheet" type="text/css" href="../lib/roxterm_ie.css" />
<![endif]-->
<link rel="shortcut icon" type="image/x-icon" href="../lib/favicon.ico" />
</head>
<body>
<div id="Container">
<a id='TopAnchor' name="Top"></a>
<div id="Header">
<div>
<a id="Logo" href="index.html">
<img src="../lib/logo_text.png" alt="ROXTerm" />
</a>
<ul>
<li><a id="MainNav_Home" href="index.html">Home</a></li>
<li><a id="MainNav_News" href="news.html">News</a></li>
<li><a id="MainNav_Installation" href="installation.html">Installation</a></li>
<li><a id="MainNav_UserGuide" class="active" href="#">User Guide</a></li>
<li><a id="MainNav_Forums" href="https://sourceforge.net/projects/roxterm/forums">Forums</a></li>
</ul>
</div>
<!-- PHP PLACEHOLDER -->
</div>
<div id="Middle" class="clear">
<ol id="SubNav">
<li><a href="#Tabs">Tabs</a></li>
<li><a href="#Menus">Menus</a></li>
<li><a href="#URIHighlighting">URI Highlighting</a></li>
<li><a href="#DragAndDrop">Drag & Drop</a></li>
<li><a href="#Configuration">Configuration</a></li>
<li><a href="#KeyboardShortcuts">Keyboard Shortcuts</a></li>
<li><a href="#ConfigurationManagement">Configuration Management</a></li>
<li><a href="#CommandlineOptions">Command-line Options</a></li>
<li><a href="#AdvancedDbusUsage">Advanced D-bus Usage</a></li>
</ol>
<div id="Content" class="partialWidth">
<h1>User Guide</h1>
<h2>Tabs <a class="pageAnchor" name="Tabs">:</a></h2>
<p>Each window can contain a number of tabs, each with its own terminal. Unlike gnome-terminal and earlier
versions of ROXTerm, the tab bar is always shown by default, even if there is only one tab, to avoid resizing
inconsistencies, but this is configurable.</p>
<h2>Menus <a class="pageAnchor" name="Menus">:</a></h2>
<p>When the menu bar is hidden the popup menu duplicates the same items as in the menu bar; this gives you full
access to all the functions with the menu bar hidden. The menu bar is effectively redundant but provided to make
ROXTerm appear more straightforward for first-time users. It can be turned on and off for a particular window or
more permanently by using the configuration manager.</p>
<p>The popup menu also allows email and web addresses to be opened in external applications if such an address is
highlighted by the pointer being over it.</p>
<h2>URI Highlighting <a class="pageAnchor" name="URIHighlighting">:</a></h2>
<p>When the pointer is over an address that ROXTerm recognises as a URI (typically a web URL or email address) it
is highlighted by underlining and a change of pointer shape. You can open the address either by right-clicking on
it and choosing Open... in the menu or by holding Ctrl and left-clicking. The applications used to handle these
addresses may be set with the configuration tool, otherwise it will try to find a suitable default. Also by holding
Ctrl you can drag a URI to pass it to another application which is willing to accept it as a URI or text; dragging
it into the same window it came from pastes the address back in.</p>
<p>Note that if the pointer is over the server address portion of a URL it only highlights the address, omitting
the filename; move the pointer over the filename to get the whole URL. Similarly you can highlight an email address
with or without a leading mailto:.</p>
<h2>Drag & Drop <a class="pageAnchor" name="DragAndDrop">:</a></h2>
<p>You can now drag items onto terminal windows. Text objects are fed to the terminal as if typed. Files and URIs
have their location (filename or URI) fed in rather than the object's contents. Graphical files can also be dragged
onto the appropriate area of the configuration manager to set terminal background images. Holding down Ctrl while
dragging a highlighted URI allows the address to be dragged to another application.</p>
<p>You can now drag tabs by their labels to reorder them within a window or to move them to another ROXTerm window
or, by dropping them outside a ROXTerm window, move tabs to new windows of their own. Use mouse button 3 (the right
button) to move an unselected tab without selecting it. Note that versions prior to 1.9 used button 2 (middle).
Button 2 is now a shortcut to paste the contents of the clipboard as the tab's name.</p>
<h2>Configuration <a class="pageAnchor" name="Configuration">:</a></h2>
<p>Configuration is based on named profiles so you can save different sets of options and switch between them
quickly. There are profiles for general options, colour schemes and keyboard shortcuts (sometimes also referred
to as accelerators). Colour Schemes and Profiles apply to one tab at a time, but Keyboard Shortcuts apply to all
tabs in the same window to avoid the potential for confusion from different tabs having different shortcuts for
switching tabs. New windows and tabs inherit settings from the window/tab they were opened from.</p>
<p>Prior to version 1.15.1 all tabs had to share the same Profile, but this has been changed. In consequence a
profile's font and other settings which affect a terminal's size may be overridden to keep geometry consistent
across a number of tabs in one window.</p>
<p>The Preferences menu allows you to select the current profile etc (this setting will not be remembered; use the
configuration manager to set the defaults), open the configuration manager to edit the current profile or colour
scheme or to manage all settings. In the configuration manager you can select one of the four types of option
groups and edit, copy, delete or rename it. Each item also has a radio button. The item with the selected radio
is the default for new terminals. Note that character encodings are handled slightly differently. </p>
<h2>Keyboard Shortcuts <a class="pageAnchor" name="KeyboardShortcuts">:</a></h2>
<p>There is no editor for keyboard shortcuts; instead they can be changed by pressing keys while the mouse is
hovering over a menu item in the terminal. This feature must be enabled with the "Enable editing" option under
the "Keyboard shortcuts" section of the <a href="#ConfigurationManagement">Configuration Manager</a>. There is
also a "hidden" global GNOME setting to determine whether GTK applications can have their shortcuts edited in this
way. The global option is managed by gconf, which roxterm is not linked with, so in some circumstances the global
and roxterm options may conflict with each other.</p>
<h2>Configuration Management <a class="pageAnchor" name="ConfigurationManagement">:</a></h2>
<p>You can also run the configuration manager by selecting "Configure..." in ROX's menu for the ROXTerm application
or by running roxterm-config if ROXTerm has been installed conventionally.</p>
<p>Configuration files can easily be swapped with other users. Each profile, colour scheme and keyboard shortcut
scheme has a single file associated with it; saving a valid file in the appropriate directory will create a profile
etc with the same name as the file.</p>
<p>The directory locations for these configuration files follow the XDG Base Directory specification. In descending
order of priority they are:</p>
<ol>
<li><span>${XDG_CONFIG_HOME}/roxterm.sourceforge.net defaulting to ~/.config/roxterm.sourceforge.net</span></li>
<li><span>${XDG_CONFIG_DIRS}/roxtem.sourceforge.net defaulting to /etc/xdg/roxtem.sourceforge.net</span></li>
<li><span>ROXTerm/Config for ROX users, or ${datadir}/roxterm/Config for others; ${datadir} is usually /usr/share for packages
or /usr/local/share when compiled from source</span></li>
</ol>
<p>Files will be loaded from any and all the above locations; files in high priority locations shadow ones with the same name in lower priority locations. Files are only saved in the first location.</p>
<p>Within any or each of those locations, profiles are saved in a "Profiles" subdirectory, colour schemes in
"Colours" and keyboard shortcut schemes in "Shortcuts". A file called "Globals" contains miscellaneous options
which don't fall into the above categories, including the default profile etc for new terminals.</p>
<h2>Command-line Options <a class="pageAnchor" name="CommandlineOptions">:</a></h2>
<p>ROXTerm accepts a number of command-line options. Run:</p>
<p class="snippet">roxterm --help</p>
<p>for a full list.</p>
<p>From version 1.1.0 ROXTerm defaults to using only one process for all terminals so that you can drag tabs
between windows. If you run the command again it sends a D-BUS message to the existing process to signal it to
open a new terminal, and the second process exits. To make a roxterm command run in its own separate process use
the --separate option.</p>
<p>Note that the --colour_scheme and --shortcut_scheme options have been replaced by --colour-scheme and
--shortcut-scheme respectively in 1.7.0 (underscores changed to hyphens) but the old versions remain usable for
backwards compatibility.</p>
<h2>Advanced D-Bus Usage <a class="pageAnchor" name="AdvancedDbusUsage">:</a></h2>
<p>From version 1.14.0 advanced users can use D-Bus to configure terminals from other applications and scripts.
There are three D-Bus methods especially for this purpose; they require an id code to target a specific terminal;
each terminal's id code can be read from the environment variable ROXTERM_ID in the shell/application running in it.
The D-Bus object path and interface for the methods are "net.sf.roxterm.Options" and "/net/sf/roxterm/Options"
respectively. The methods are:</p>
<p class="snippet">SetProfile("id", "profile_name")</p>
<p>Ask the terminal to use the named profile. Note that any other tabs in the same window will be updated to the
same new profile. All tabs in one window must have the same profile so that their font size and therefore terminal
size remain consistent.</p>
<p class="snippet">SetColourScheme("id", "scheme_name")</p>
<p>Ask the terminal to use the named colour scheme. Tabs sharing the same window may have different colour schemes
from each other.</p>
<p class="snippet">SetShortcutScheme("id", "scheme_name")</p>
<p>Ask the terminal to use the named keyboard shortcut scheme. Tabs sharing the same window must also share the
same shortcut scheme.</p>
<p>Example using dbus-send in a shell script:</p>
<p class="snippet">
<span>dbus-send --session /net/sf/roxterm/Options \</span>
<span>net.sf.roxterm.Options.SetColourScheme string:$ROXTERM_ID string:GTK</span>
</p>
<p>You may also send D-Bus signals to change individual options within a named profile or colour scheme using the
methods StringOption, IntOption (also used for boolean options) and FloatOption. All terminals using the named
profile or colour scheme are affected, but only temporarily. The options are not saved for new terminals. The
methods all take 3 arguments:</p>
<ul>
<li><span>Full profile name, including a prefix of "Profiles/" or "Colours/"</span></li>
<li><span>Option name</span></li>
<li><span>Value</span></li>
</ul>
<p>To see which option names you can use, check the config files, from which the types can be deduced.</p>
<p>Example using dbus-send in a shell script:</p>
<p class="snippet">
<span>dbus-send --session /net/sf/roxterm/Options \</span>
<span>net.sf.roxterm.Options.StringOption \</span>
<span>string:Colours/GTK string:background 'string:#ffffff'</span>
</p>
<p>A third possible use is to notify roxterm that a profile, colour scheme or shortcuts scheme has been changed by
an external program and all terminals using that profile etc need to reload it:</p>
<p class="snippet">OptionsChanged("family_name", "profile_name")</p>
<p>where family_name is one of "Profiles", "Colours" or "Shortcuts". For example:</p>
<p class="snippet">
<span>dbus-send --session /net/sf/roxterm/Options \</span>
<span>net.sf.roxterm.Options.OptionsChanged \</span>
<span>string:Profiles string:Default</span>
</p>
</div>
</div>
<div id="Footer">
<div id="FooterButtons">
<a id="SourceforgeLink" href="http://sourceforge.net/projects/roxterm" title="RoxTerm Sourceforge">
roxterm @ sourceforge
</a>
<br />
<a id="DonationLink" class="spriteLink" href="http://sourceforge.net/donate/index.php?group_id=124080">Donate</a>
<a id="ValidMarkupLink" class="spriteLink" href="http://validator.w3.org/check?uri=referer">Valid XHTML</a>
</div>
<p>ROXTerm is licensed under the <a href="http://www.gnu.org/licenses/gpl-3.0-standalone.html">GPL</a> | Site design by Adrian Sampson</p>
</div>
</div>
</body>
</html>
|