Solaris/manpages/man1/gnome-terminal.1
branch217update
changeset 19096 d542fc2c823e
equal deleted inserted replaced
19095:e8e7aa8c74b9 19096:d542fc2c823e
       
     1 <!DOCTYPE REFENTRY PUBLIC "-//Sun Microsystems//DTD DocBook V3.0-Based SolBook Subset V2.0//EN" [
       
     2 <!--ArborText, Inc., 1988-1999, v.4002-->
       
     3 <!ENTITY cmd "gnome-terminal">
       
     4 <!ENTITY % commonents SYSTEM "smancommon.ent">
       
     5 %commonents;
       
     6 <!ENTITY % booktitles SYSTEM "booktitles.ent">
       
     7 %booktitles;
       
     8 <!ENTITY suncopy "Copyright (c) 2003,2004,2006 Sun Microsystems, Inc. All Rights Reserved.">
       
     9 ]>
       
    10 <?Pub UDT _bookmark _target>
       
    11 <?Pub Inc>
       
    12 <refentry id="gnome-terminal-1">
       
    13 <!-- %Z%%M% %I% %E% SMI; -->
       
    14 <refmeta><refentrytitle>gnome-terminal</refentrytitle><manvolnum>1</manvolnum>
       
    15 <refmiscinfo class="date">31 Aug 2004</refmiscinfo>
       
    16 <refmiscinfo class="sectdesc">&man1;</refmiscinfo>
       
    17 <refmiscinfo class="software">&release;</refmiscinfo>
       
    18 <refmiscinfo class="arch">generic</refmiscinfo>
       
    19 <refmiscinfo class="copyright">&suncopy;</refmiscinfo>
       
    20 </refmeta>
       
    21 <indexterm><primary>gnome-terminal</primary></indexterm><indexterm><primary>
       
    22 terminal emulator for GNOME</primary></indexterm>
       
    23 <refnamediv id="gnome-terminal-1-name"><refname>gnome-terminal</refname><refpurpose>
       
    24 terminal emulator for GNOME</refpurpose></refnamediv>
       
    25 <refsynopsisdiv id="gnome-terminal-1-synp"><title>&synp-tt;</title>
       
    26 <cmdsynopsis><command>&cmd;</command>
       
    27 <arg choice="opt"><option>-tab</option></arg>
       
    28 <arg choice="opt"><option>-tab-with-profile=<replaceable>profilename</replaceable></option></arg>
       
    29 <arg choice="opt"><option>-window</option></arg>
       
    30 <arg choice="opt"><option>-window-with-profile=<replaceable>profilename</replaceable></option></arg>
       
    31 <arg choice="opt"><option>-command=<replaceable>command</replaceable></option></arg>
       
    32 <arg choice="opt"><option>-execute=<replaceable>command</replaceable></option></arg>
       
    33 <arg choice="opt"><option>-full-screen</option></arg>
       
    34 <arg choice="opt"><option>-role=<replaceable>role</replaceable></option></arg>
       
    35 
       
    36 <group><arg choice="plain"><option>-show-menubar </option></arg>
       
    37 <arg choice="plain"><option>-hide-menubar</option></arg></group>
       
    38 
       
    39 <arg choice="opt"><option>-startup-id=<replaceable>id</replaceable></option></arg>
       
    40 <arg choice="opt"><option>-title=<replaceable>title</replaceable></option></arg>
       
    41 
       
    42 <group><arg choice="plain"><option>-use-factory</option></arg>
       
    43 <arg choice="plain"><option>-disable-factory</option></arg></group>
       
    44 
       
    45 <arg choice="opt"><option>-zoom</option></arg>
       
    46 <arg choice="opt"><option role="nodash"><replaceable>gnome-std-options</replaceable></option></arg>
       
    47 </cmdsynopsis></refsynopsisdiv>
       
    48 <refsect1 id="gnome-terminal-1-desc"><title>&desc-tt;</title>
       
    49 <para><command>&cmd;</command> is the GNOME terminal emulation program. It
       
    50 provides access to the UNIX shell on the GNOME environment. <command>&cmd;</command>
       
    51 supports multiple profiles to allow easy switching between preferences, and
       
    52 supports tabbing so that multiple terminals can be managed from a single window.
       
    53 By default, all GNOME terminals share a single process, reducing memory usage.
       
    54 This can be disabled by starting <command>&cmd;</command> with the <option>
       
    55 -disable-factory</option> option.</para>
       
    56 </refsect1>
       
    57 <refsect1 id="gnome-terminal-1-opts"><title>&opts-tt;</title>
       
    58 <para>The following options are supported:</para>
       
    59 <variablelist termlength="wholeline">
       
    60 <varlistentry><term><option>e</option>, <option>-command <replaceable>command</replaceable></option></term>
       
    61 <listitem><para>Executes the command <filename><replaceable>command</replaceable></filename>
       
    62 instead of the shell. This saves some memory if you just plan to run a dedicated
       
    63 application on that window.</para>
       
    64 </listitem></varlistentry>
       
    65 
       
    66 <varlistentry><term><option>-disable-factory</option></term><listitem><para>
       
    67 Do not register with the activation name server, and do not reuse an already
       
    68 running GNOME terminal process.</para>
       
    69 </listitem></varlistentry>
       
    70 
       
    71 <varlistentry><term><option>x</option>, <option>-execute <replaceable>command</replaceable></option></term>
       
    72 <listitem><para>This option is provided for compatibility reasons. It is the
       
    73 same as the <option>-command</option> option.</para>
       
    74 </listitem></varlistentry>
       
    75 
       
    76 <varlistentry><term><option>-full-screen</option></term>
       
    77 <listitem><para>Set the last-specified window into fullscreen mode.  Applies to
       
    78 only one window.  Can be specified one for each wwindow you create from the
       
    79 command line.</para>
       
    80 </listitem></varlistentry>
       
    81 
       
    82 <varlistentry><term><option>-hide-menubar</option></term><listitem><para>
       
    83 Hide the menubar. This applies only to one window. When used with multiple <option>
       
    84 -window-with-profile</option> options, it applies to the <option>-window-with-profile
       
    85 </option> option immediately to the left. Can be specified multiple times,
       
    86 once for each <option>-window-with-profile</option> option.</para>
       
    87 </listitem></varlistentry>
       
    88 
       
    89 <varlistentry><term><option>-role=<replaceable>role</replaceable></option></term>
       
    90 <listitem><para>The GNOME session manager follows the ICCCM convention of
       
    91 using the window title and the window role to identify specific windows. The
       
    92 session manager uses this information to put windows back in the same place
       
    93 when the user restarts their session. If all windows have a unique title,
       
    94 there is no need to set the role. However, as it is common for multiple GNOME
       
    95 terminals to have the same title, the user can also specify the role on the
       
    96 command line with the <option>-role</option> option. This helps the session
       
    97 manager to properly identify and restart each GNOME terminal (in the same
       
    98 location, and so on).	When used with multiple <option>-window-with-profile
       
    99 </option> options, it applies to the <option>-window-with-profile</option>
       
   100 option immediately to the left. Can be specified multiple times, once for
       
   101 each <option>-window-with-profile</option> option.</para>
       
   102 </listitem></varlistentry>
       
   103 
       
   104 <varlistentry><term><option>-show-menubar</option></term><listitem><para>
       
   105 Show the menubar. This applies only to one window. When used with multiple <option>
       
   106 -window-with-profile</option> options, it applies to the <option>-window-with-profile
       
   107 </option> option immediately to the left. Can be specified multiple times,
       
   108 once for each <option>-window-with-profile</option> option.</para>
       
   109 </listitem></varlistentry>
       
   110 
       
   111 <varlistentry><term><option>-startup-id=<replaceable>id</replaceable></option></term>
       
   112 <listitem><para>Set the <replaceable>id</replaceable> for startup notification
       
   113 protocol.</para>
       
   114 </listitem></varlistentry>
       
   115 
       
   116 <varlistentry><term><option>-tab</option></term><listitem><para>
       
   117 Open a new tab in the last-opened window with the default profile.  More than
       
   118 one of these options can be provided.</para>
       
   119 </listitem></varlistentry>
       
   120 
       
   121 <varlistentry><term><option>-tab-with-profile=<replaceable>profilename</replaceable></option></term>
       
   122 <listitem><para>Creates a tab that uses the specified profile. This argument
       
   123 may be specified multiple times to create multiple tabs in a terminal. If
       
   124 this is used with multiple <option>-window-with-profile</option> options,
       
   125 the tab is created for the window that corresponds to the <option>-window-with-profile
       
   126 </option> option immediately to the 		left.</para>
       
   127 </listitem></varlistentry>
       
   128 
       
   129 <varlistentry><term><option>t</option>, <option>-title=<replaceable>title</replaceable></option></term>
       
   130 <listitem><para>Set the title for the GNOME terminal to be <replaceable>title
       
   131 </replaceable>.</para>
       
   132 </listitem></varlistentry>
       
   133 
       
   134 <varlistentry><term><option>-use-factory</option></term><listitem><para>Register
       
   135 with the activation name server, and reuse an already running GNOME terminal
       
   136 process.</para>
       
   137 </listitem></varlistentry>
       
   138 
       
   139 <varlistentry><term><option>-window</option></term><listitem><para>
       
   140 Open a new window contianing a tab with the defeault profile.  More than one of
       
   141 these options can be provided.</para>
       
   142 </listitem></varlistentry>
       
   143 
       
   144 <varlistentry><term><option>-window-with-profile=<replaceable>profilename
       
   145 </replaceable></option></term><listitem><para>Creates a GNOME terminal and
       
   146 a tab that uses the specified profile. This may be used with the <option>
       
   147 -tab-with-profile</option> option to create additional tabs. Multiple <option>
       
   148 -window-with-profile</option> options can be specified to create multiple
       
   149 GNOME terminal windows. All options specified after an <option>-window-with-profile
       
   150 </option> option apply to that <option>-window-with-profile</option> option
       
   151 only.</para>
       
   152 </listitem></varlistentry>
       
   153 
       
   154 <varlistentry><term><option>-working-directory=<replaceable>dirname</replaceable></option></term>
       
   155 <listitem><para>Set the working directory for the GNOME terminal to be <replaceable>
       
   156 dirname</replaceable>.</para>
       
   157 </listitem></varlistentry>
       
   158 
       
   159 <varlistentry><term><option>-zoom</option></term>
       
   160 <listitem><para>Set the terminal's zoom factor (1.0 = normal size).</para>
       
   161 </listitem></varlistentry>
       
   162 
       
   163 <varlistentry><term><option role="nodash"><replaceable>gnome-std-options</replaceable></option></term>
       
   164 <listitem><para>Standard options available for use with most GNOME applications.
       
   165 See <citerefentry><refentrytitle>gnome-std-options</refentrytitle><manvolnum>
       
   166 5</manvolnum></citerefentry> for more information.</para>
       
   167 </listitem></varlistentry>
       
   168 </variablelist></refsect1>
       
   169 <refsect1 id="gnome-terminal-1-exde"><title>&exde-tt;</title>
       
   170 <para><command>&cmd;</command> is designed to emulate the <filename>xterm
       
   171 </filename> program provided by the X  Consortium.  The <citerefentry><refentrytitle>
       
   172 xterm</refentrytitle><manvolnum>1</manvolnum></citerefentry> program in turn
       
   173 is an almost-complete emulation of the DEC VT102 terminal. <command>&cmd;</command>
       
   174 supports the same extensions to the VT102 as those provided by the <filename>
       
   175 xterm</filename> program, through special escape sequences. The <filename>
       
   176 xterm</filename> program is an evolving program. Recent changes to <filename>
       
   177 xterm</filename> have been been incorporated into <command>&cmd;</command>.
       
   178 This includes emulation of the newer DEC VT220 escape sequences.</para>
       
   179 </refsect1>
       
   180 <refsect1 id="gnome-terminal-1-exam"><title>&exam-tt;</title>
       
   181 <example role="example">
       
   182 <title>Running the `minicom' terminal emulator on the window</title>
       
   183 <para><screen>example% <userinput>&cmd; --command minicom</userinput></screen></para>
       
   184 </example>
       
   185 <example role="example">
       
   186 <title>Monitoring the system</title>
       
   187 <para><screen>example% <userinput>&cmd; --command top</userinput></screen></para>
       
   188 </example>
       
   189 <example role="example">
       
   190 <title>Starting two windows with different profiles</title>
       
   191 <para><screen>example% <userinput>&cmd; --window-with-profile=FirstProfile
       
   192 	 --tab-with-profile=SecondProfile --window-with-profile=SecondProfile</userinput></screen></para>
       
   193 <para>In this example, the first window will have two tabs (<literal>FirstProfile
       
   194 </literal> and <literal>SecondProfile</literal>) and the second window will
       
   195 have one tab (<literal>SecondProfile</literal>).</para>
       
   196 </example>
       
   197 </refsect1>
       
   198 <refsect1 id="gnome-terminal-1-envr"><title>&envr-tt;</title>
       
   199 <para>See <citerefentry><refentrytitle>environ</refentrytitle><manvolnum>
       
   200 5</manvolnum></citerefentry> for descriptions of the following environment
       
   201 variables, set by <command>&cmd;</command>:</para>
       
   202 <variablelist>
       
   203 <varlistentry><term>TERM</term><listitem><para>This variable is set to <literal>
       
   204 xterm</literal> by default. Some implementations of curses, and applications
       
   205 based on curses, may prefer the value to be <literal>xterm-color</literal>, <literal>
       
   206 color-xterm</literal>, or <literal>xterm-debian</literal> to support color.
       
   207 Users might need to change this setting to one of these values to enable color
       
   208 for such applications.</para>
       
   209 </listitem></varlistentry>
       
   210 <varlistentry><term>COLORTERM</term><listitem><para>This variable is set to <literal>
       
   211 xterm</literal>. Various applications (especially the Slang-based applications)
       
   212 use this setting to determine whether the terminal supports color.</para>
       
   213 </listitem></varlistentry>
       
   214 <varlistentry><term>WINDOWID</term><listitem><para>This variable contains
       
   215 the X11 Window identifier. This is sometimes used by applications to modify
       
   216 the contents of this window or provide special effects.</para>
       
   217 </listitem></varlistentry>
       
   218 </variablelist></refsect1>
       
   219 <refsect1 id="gnome-terminal-1-exit"><title>&exit-tt;</title>
       
   220 <para>The following exit values are returned:</para>
       
   221 <variablelist termlength="xtranarrow">
       
   222 <varlistentry><term><returnvalue>0</returnvalue></term><listitem><para>Application
       
   223 exited successfully</para>
       
   224 </listitem></varlistentry>
       
   225 <varlistentry><term><returnvalue>>0</returnvalue></term><listitem><para>Application
       
   226 exited with failure</para>
       
   227 </listitem></varlistentry>
       
   228 </variablelist></refsect1>
       
   229 <refsect1 id="gnome-terminal-1-file"><title>&file-tt;</title>
       
   230 <para>The following files are used by this application:</para>
       
   231 <variablelist termlength="wide">
       
   232 <varlistentry><term><filename>/usr/bin/&cmd;</filename> </term><listitem>
       
   233 <para>Executable for GNOME terminal emulator</para>
       
   234 </listitem></varlistentry>
       
   235 </variablelist></refsect1>
       
   236 <refsect1 id="gnome-terminal-1-attr"><title>&attr-tt;</title>
       
   237 <para>See <olink targetdocent="REFMAN5" localinfo="attributes-5"><citerefentry>
       
   238 <refentrytitle>attributes</refentrytitle><manvolnum>5</manvolnum></citerefentry></olink>
       
   239 for descriptions of the following attributes:</para>
       
   240 <informaltable frame="all">
       
   241 <tgroup cols="2" colsep="1" rowsep="1"><colspec colname="COLSPEC0" colwidth="1*">
       
   242 <colspec colname="COLSPEC1" colwidth="1*">
       
   243 <thead>
       
   244 <row><entry align="center" valign="middle">ATTRIBUTE TYPE</entry><entry align="center"
       
   245 valign="middle">ATTRIBUTE VALUE</entry></row>
       
   246 </thead>
       
   247 <tbody>
       
   248 <row><entry><para>Availability</para></entry><entry><para>SUNWgnome-terminal
       
   249 </para></entry></row>
       
   250 <row><entry colname="COLSPEC0"><para>Interface stability</para></entry><entry
       
   251 colname="COLSPEC1"><para>Volatile</para></entry></row>
       
   252 </tbody>
       
   253 </tgroup>
       
   254 </informaltable>
       
   255 </refsect1>
       
   256 <refsect1 id="gnome-terminal-1-also"><title>&also-tt;</title>
       
   257 <!--Reference to another man page-->
       
   258 <!--Reference to a Help manual-->
       
   259 <!--Reference to a book.-->
       
   260 <para><citerefentry><refentrytitle>gnome-session</refentrytitle><manvolnum>
       
   261 1</manvolnum></citerefentry>, <citerefentry><refentrytitle>xterm</refentrytitle>
       
   262 <manvolnum>1</manvolnum></citerefentry>, <citerefentry><refentrytitle>vte
       
   263 </refentrytitle><manvolnum>1</manvolnum></citerefentry>, <citerefentry><refentrytitle>
       
   264 libvte</refentrytitle><manvolnum>3</manvolnum></citerefentry>, <citerefentry>
       
   265 <refentrytitle>gnome-std-options</refentrytitle><manvolnum>5</manvolnum></citerefentry></para>
       
   266 <para>Latest version of the <citetitle>GNOME Desktop User Guide</citetitle>
       
   267 for your platform.</para>
       
   268 </refsect1>
       
   269 <refsect1 id="gnome-terminal-1-note"><title>&note-tt;</title>
       
   270 <para>Written by Michael Zucchi, Miguel de Icaza, Erik Troan.</para>
       
   271 <para>Updated by Brian Cameron, Sun Microsystems Inc., 2003, 2004, 2006.</para>
       
   272 </refsect1>
       
   273 </refentry><?Pub Caret>
       
   274 <?Pub *0000013418>