gnome-terminal.1 revision 18745
<!DOCTYPE REFENTRY PUBLIC "-//Sun Microsystems//DTD DocBook V3.0-Based SolBook Subset V2.0//EN" [
<!--ArborText, Inc., 1988-1999, v.4002-->
<!ENTITY cmd "gnome-terminal">
%commonents;
%booktitles;
<!ENTITY suncopy "Copyright (c) 2003,2004,2006 Sun Microsystems, Inc. All Rights Reserved.">
]>
<?Pub UDT _bookmark _target>
<?Pub Inc>
<refentry id="gnome-terminal-1">
<!-- %Z%%M% %I% %E% SMI; -->
<refmeta><refentrytitle>gnome-terminal</refentrytitle><manvolnum>1</manvolnum>
<refmiscinfo class="date">31 Aug 2004</refmiscinfo>
<refmiscinfo class="sectdesc">&man1;</refmiscinfo>
<refmiscinfo class="software">&release;</refmiscinfo>
<refmiscinfo class="arch">generic</refmiscinfo>
<refmiscinfo class="copyright">&suncopy;</refmiscinfo>
</refmeta>
<indexterm><primary>gnome-terminal</primary></indexterm><indexterm><primary>
terminal emulator for GNOME</primary></indexterm>
<refnamediv id="gnome-terminal-1-name"><refname>gnome-terminal</refname><refpurpose>
terminal emulator for GNOME</refpurpose></refnamediv>
<refsynopsisdiv id="gnome-terminal-1-synp"><title>&synp-tt;</title>
<cmdsynopsis><command>&cmd;</command>
<arg choice="opt"><option>-tab</option></arg>
<arg choice="opt"><option>-window</option></arg>
<arg choice="opt"><option>-tab-with-profile=<replaceable>profilename</replaceable></option></arg>
<arg choice="opt"><option>-window-with-profile=<replaceable>profilename</replaceable></option></arg>
<arg choice="opt"><option>-active</option></arg>
<arg choice="opt"><option>-command=<replaceable>command</replaceable></option></arg>
<arg choice="opt"><option>-execute=<replaceable>command</replaceable></option></arg>
<arg choice="opt"><option>-full-screen</option></arg>
<arg choice="opt"><option>-maximize</option></arg>
<arg choice="opt"><option>-role=<replaceable>role</replaceable></option></arg>
<group><arg choice="plain"><option>-show-menubar </option></arg>
<arg choice="plain"><option>-hide-menubar</option></arg></group>
<arg choice="opt"><option>-startup-id=<replaceable>id</replaceable></option></arg>
<arg choice="opt"><option>-title=<replaceable>title</replaceable></option></arg>
<group><arg choice="plain"><option>-use-factory</option></arg>
<arg choice="plain"><option>-disable-factory</option></arg></group>
<arg choice="opt"><option>-working-directory=<replaceable>dirname</replaceable></option></arg>
<arg choice="opt"><option>-zoom=<replaceable>zoomfactor</replaceable></option></arg>
<arg choice="opt"><option role="nodash"><replaceable>gnome-std-options</replaceable></option></arg>
</cmdsynopsis></refsynopsisdiv>
<refsect1 id="gnome-terminal-1-desc"><title>&desc-tt;</title>
<para><command>&cmd;</command> is the GNOME terminal emulation program. It
provides access to the UNIX shell on the GNOME environment. <command>&cmd;</command>
supports multiple profiles to allow easy switching between preferences, and
supports tabbing so that multiple terminals can be managed from a single window.
By default, all GNOME terminals share a single process, reducing memory usage.
This can be disabled by starting <command>&cmd;</command> with the <option>
-disable-factory</option> option.</para>
</refsect1>
<refsect1 id="gnome-terminal-1-opts"><title>&opts-tt;</title>
<para>The following options are supported:</para>
<variablelist termlength="wholeline">
<varlistentry><term><option>-active</option></term><listitem><para>
Set the last specified tab as the active one in its window.
</para>
</listitem></varlistentry>
<varlistentry><term><option>e</option>, <option>-command <replaceable>command</replaceable></option></term>
<listitem><para>Executes the command <filename><replaceable>command</replaceable></filename>
instead of the shell. This saves some memory if you just plan to run a dedicated
application on that window.</para>
</listitem></varlistentry>
<varlistentry><term><option>-disable-factory</option></term><listitem><para>
Do not register with the activation name server, and do not reuse an already
running GNOME terminal process.</para>
</listitem></varlistentry>
<varlistentry><term><option>x</option>, <option>-execute <replaceable>command</replaceable></option></term>
<listitem><para>This option is provided for compatibility reasons. It is the
same as the <option>-command</option> option.</para>
</listitem></varlistentry>
<varlistentry><term><option>-full-screen</option></term>
<listitem><para>Set the last-specified window into fullscreen mode. Applies to
only one window. Can be specified one for each wwindow you create from the
command line.</para>
</listitem></varlistentry>
<varlistentry><term><option>-maximize</option></term>
<listitem><para>
Set the last-specified window into maximized mode; a pplies to only one window;
can be specified once for each window you create from the command line.
</para>
</listitem></varlistentry>
<varlistentry><term><option>-hide-menubar</option></term><listitem><para>
Hide the menubar. This applies only to one window. When used with multiple <option>
-window-with-profile</option> options, it applies to the <option>-window-with-profile
</option> option immediately to the left. Can be specified multiple times,
once for each <option>-window-with-profile</option> option.</para>
</listitem></varlistentry>
<varlistentry><term><option>-role=<replaceable>role</replaceable></option></term>
<listitem><para>The GNOME session manager follows the ICCCM convention of
using the window title and the window role to identify specific windows. The
session manager uses this information to put windows back in the same place
when the user restarts their session. If all windows have a unique title,
there is no need to set the role. However, as it is common for multiple GNOME
terminals to have the same title, the user can also specify the role on the
command line with the <option>-role</option> option. This helps the session
manager to properly identify and restart each GNOME terminal (in the same
location, and so on). When used with multiple <option>-window-with-profile
</option> options, it applies to the <option>-window-with-profile</option>
option immediately to the left. Can be specified multiple times, once for
each <option>-window-with-profile</option> option.</para>
</listitem></varlistentry>
<varlistentry><term><option>-show-menubar</option></term><listitem><para>
Show the menubar. This applies only to one window. When used with multiple <option>
-window-with-profile</option> options, it applies to the <option>-window-with-profile
</option> option immediately to the left. Can be specified multiple times,
once for each <option>-window-with-profile</option> option.</para>
</listitem></varlistentry>
<varlistentry><term><option>-startup-id=<replaceable>id</replaceable></option></term>
<listitem><para>Set the <replaceable>id</replaceable> for startup notification
protocol.</para>
</listitem></varlistentry>
<varlistentry><term><option>-tab</option></term><listitem><para>
Open a new tab in the last-opened window with the default profile. More than
one of these options can be provided.</para>
</listitem></varlistentry>
<varlistentry><term><option>-tab-with-profile=<replaceable>profilename</replaceable></option></term>
<listitem><para>Creates a tab that uses the specified profile. This argument
may be specified multiple times to create multiple tabs in a terminal. If
this is used with multiple <option>-window-with-profile</option> options,
the tab is created for the window that corresponds to the <option>-window-with-profile
</option> option immediately to the left.</para>
</listitem></varlistentry>
<varlistentry><term><option>t</option>, <option>-title=<replaceable>title</replaceable></option></term>
<listitem><para>Set the title for the GNOME terminal to be <replaceable>title
</replaceable>.</para>
</listitem></varlistentry>
<varlistentry><term><option>-use-factory</option></term><listitem><para>Register
with the activation name server, and reuse an already running GNOME terminal
process.</para>
</listitem></varlistentry>
<varlistentry><term><option>-window</option></term><listitem><para>
Open a new window contianing a tab with the default profile. More than one of
these options can be provided.</para>
</listitem></varlistentry>
<varlistentry><term><option>-window-with-profile=<replaceable>profilename
</replaceable></option></term><listitem><para>Creates a GNOME terminal and
a tab that uses the specified profile. This may be used with the <option>
-tab-with-profile</option> option to create additional tabs. Multiple <option>
-window-with-profile</option> options can be specified to create multiple
GNOME terminal windows. All options specified after an <option>-window-with-profile
</option> option apply to that <option>-window-with-profile</option> option
only.</para>
</listitem></varlistentry>
<varlistentry><term><option>-working-directory=<replaceable>dirname</replaceable></option></term>
<listitem><para>Set the working directory for the GNOME terminal to be <replaceable>
dirname</replaceable>.</para>
</listitem></varlistentry>
<varlistentry><term><option>-zoom=<replaceable>zoomfactor</replaceable></option></term>
<listitem><para>Set the terminal's zoom factor (1.0 = normal size).</para>
</listitem></varlistentry>
<varlistentry><term><option role="nodash"><replaceable>gnome-std-options</replaceable></option></term>
<listitem><para>Standard options available for use with most GNOME applications.
See <citerefentry><refentrytitle>gnome-std-options</refentrytitle><manvolnum>
5</manvolnum></citerefentry> for more information.</para>
</listitem></varlistentry>
</variablelist></refsect1>
<refsect1 id="gnome-terminal-1-exde"><title>&exde-tt;</title>
<para><command>&cmd;</command> is designed to emulate the <filename>xterm
</filename> program provided by the X Consortium. The <citerefentry><refentrytitle>
xterm</refentrytitle><manvolnum>1</manvolnum></citerefentry> program in turn
is an almost-complete emulation of the DEC VT102 terminal. <command>&cmd;</command>
supports the same extensions to the VT102 as those provided by the <filename>
xterm</filename> program, through special escape sequences. The <filename>
xterm</filename> program is an evolving program. Recent changes to <filename>
xterm</filename> have been been incorporated into <command>&cmd;</command>.
This includes emulation of the newer DEC VT220 escape sequences.</para>
</refsect1>
<refsect1 id="gnome-terminal-1-exam"><title>&exam-tt;</title>
<example role="example">
<title>Running the `minicom' terminal emulator on the window</title>
<para><screen>example% <userinput>&cmd; --command minicom</userinput></screen></para>
</example>
<example role="example">
<title>Monitoring the system</title>
<para><screen>example% <userinput>&cmd; --command top</userinput></screen></para>
</example>
<example role="example">
<title>Starting two windows with different profiles</title>
<para><screen>example% <userinput>&cmd; --window-with-profile=FirstProfile
--tab-with-profile=SecondProfile --window-with-profile=SecondProfile</userinput></screen></para>
<para>In this example, the first window will have two tabs (<literal>FirstProfile
</literal> and <literal>SecondProfile</literal>) and the second window will
have one tab (<literal>SecondProfile</literal>).</para>
</example>
</refsect1>
<refsect1 id="gnome-terminal-1-envr"><title>&envr-tt;</title>
<para>See <citerefentry><refentrytitle>environ</refentrytitle><manvolnum>
5</manvolnum></citerefentry> for descriptions of the following environment
variables, set by <command>&cmd;</command>:</para>
<variablelist>
<varlistentry><term>TERM</term><listitem><para>This variable is set to <literal>
xterm</literal> by default. Some implementations of curses, and applications
based on curses, may prefer the value to be <literal>xterm-color</literal>, <literal>
color-xterm</literal>, or <literal>xterm-debian</literal> to support color.
Users might need to change this setting to one of these values to enable color
for such applications.</para>
</listitem></varlistentry>
<varlistentry><term>COLORTERM</term><listitem><para>This variable is set to <literal>
xterm</literal>. Various applications (especially the Slang-based applications)
use this setting to determine whether the terminal supports color.</para>
</listitem></varlistentry>
<varlistentry><term>WINDOWID</term><listitem><para>This variable contains
the X11 Window identifier. This is sometimes used by applications to modify
the contents of this window or provide special effects.</para>
</listitem></varlistentry>
</variablelist></refsect1>
<refsect1 id="gnome-terminal-1-exit"><title>&exit-tt;</title>
<para>The following exit values are returned:</para>
<variablelist termlength="xtranarrow">
<varlistentry><term><returnvalue>0</returnvalue></term><listitem><para>Application
exited successfully</para>
</listitem></varlistentry>
<varlistentry><term><returnvalue>>0</returnvalue></term><listitem><para>Application
exited with failure</para>
</listitem></varlistentry>
</variablelist></refsect1>
<refsect1 id="gnome-terminal-1-file"><title>&file-tt;</title>
<para>The following files are used by this application:</para>
<variablelist termlength="wide">
<para>Executable for GNOME terminal emulator</para>
</listitem></varlistentry>
</variablelist></refsect1>
<refsect1 id="gnome-terminal-1-attr"><title>&attr-tt;</title>
<para>See <olink targetdocent="REFMAN5" localinfo="attributes-5"><citerefentry>
<refentrytitle>attributes</refentrytitle><manvolnum>5</manvolnum></citerefentry></olink>
for descriptions of the following attributes:</para>
<informaltable frame="all">
<tgroup cols="2" colsep="1" rowsep="1"><colspec colname="COLSPEC0" colwidth="1*">
<colspec colname="COLSPEC1" colwidth="1*">
<thead>
<row><entry align="center" valign="middle">ATTRIBUTE TYPE</entry><entry align="center"
valign="middle">ATTRIBUTE VALUE</entry></row>
</thead>
<tbody>
</para></entry></row>
<row><entry colname="COLSPEC0"><para>Interface stability</para></entry><entry
colname="COLSPEC1"><para>Volatile</para></entry></row>
</tbody>
</tgroup>
</informaltable>
</refsect1>
<refsect1 id="gnome-terminal-1-also"><title>&also-tt;</title>
<!--Reference to another man page-->
<!--Reference to a Help manual-->
<!--Reference to a book.-->
<para>
<citerefentry><refentrytitle>gnome-session</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
<citerefentry><refentrytitle>xterm</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
<citerefentry><refentrytitle>vte</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
<citerefentry><refentrytitle>libvte</refentrytitle><manvolnum>3</manvolnum></citerefentry>,
<citerefentry><refentrytitle>attributes</refentrytitle><manvolnum>5</manvolnum></citerefentry>,
<citerefentry><refentrytitle>environ</refentrytitle><manvolnum>5</manvolnum></citerefentry>
<citerefentry><refentrytitle>gnome-std-options</refentrytitle><manvolnum>5</manvolnum></citerefentry>
</para>
<para>Latest version of the <citetitle>GNOME Desktop User Guide</citetitle>
for your platform.</para>
</refsect1>
<refsect1 id="gnome-terminal-1-note"><title>¬e-tt;</title>
<para>Written by Michael Zucchi, Miguel de Icaza, Erik Troan.</para>
<para>Updated by Brian Cameron, Sun Microsystems Inc., 2003, 2004, 2006.</para>
</refsect1>
</refentry>