vte.1 revision 10139
2b449ca06646ebb6603e35918a40bca8e0f43c8eSatyen Desai<!DOCTYPE REFENTRY PUBLIC "-//Sun Microsystems//DTD DocBook V3.0-Based SolBook Subset V2.0//EN" [
64953b0596d07dbee9a9b521ed61c434ce4709b5Satyen Desai<!--ArborText, Inc., 1988-1999, v.4002-->
e0008d92cea7515616980ad13e1075346a3bca2eSatyen Desai<!ENTITY suncopy "Copyright (c) 2004, Sun Microsystems, Inc. All Rights Reserved.">
2b449ca06646ebb6603e35918a40bca8e0f43c8eSatyen Desai<!-- %Z%%M% %I% %E% SMI; -->
1201815cf554ddd27ca4898d9623926cfe3c2ac9Satyen Desai<refmeta><refentrytitle>vte</refentrytitle><manvolnum>1</manvolnum>
1201815cf554ddd27ca4898d9623926cfe3c2ac9Satyen Desai<refmiscinfo class="date">6 Sep 2004</refmiscinfo>
64953b0596d07dbee9a9b521ed61c434ce4709b5Satyen Desai<refmiscinfo class="sectdesc">&man1;</refmiscinfo>
64953b0596d07dbee9a9b521ed61c434ce4709b5Satyen Desai<refmiscinfo class="software">&release;</refmiscinfo>
793e508bd277c48d6a09b91bb99064b4046eda7aSatyen Desai<refmiscinfo class="copyright">&suncopy;</refmiscinfo>
793e508bd277c48d6a09b91bb99064b4046eda7aSatyen Desai<indexterm><primary>vte</primary></indexterm><indexterm><primary>virtual terminal
1201815cf554ddd27ca4898d9623926cfe3c2ac9Satyen Desai<refnamediv id="vte-1-name"><refname>vte</refname><refpurpose>virtual terminal
1201815cf554ddd27ca4898d9623926cfe3c2ac9Satyen Desai<refsynopsisdiv id="vte-1-synp"><title>&synp-tt;</title>
1201815cf554ddd27ca4898d9623926cfe3c2ac9Satyen Desai<cmdsynopsis><command>&cmd;</command><arg choice="opt"><option>2</option></arg>
2b449ca06646ebb6603e35918a40bca8e0f43c8eSatyen Desai<arg choice="opt"><option>A</option></arg><arg choice="opt"><option>a</option></arg>
b4e59b5d4777b2fc949d0b8da063b6ea1f2d43a1Satyen Desai<arg choice="opt"><option>B <replaceable>image</replaceable></option></arg>
1201815cf554ddd27ca4898d9623926cfe3c2ac9Satyen Desai<arg choice="opt"><option>b</option></arg><arg choice="opt"><option>C</option></arg>
1201815cf554ddd27ca4898d9623926cfe3c2ac9Satyen Desai<arg choice="opt"><option>c <replaceable>command</replaceable></option></arg>
1201815cf554ddd27ca4898d9623926cfe3c2ac9Satyen Desai<arg choice="opt"><option>D</option></arg><arg choice="opt"><option>d</option></arg>
1201815cf554ddd27ca4898d9623926cfe3c2ac9Satyen Desai<arg choice="opt"><option>f <replaceable>font</replaceable></option></arg>
64953b0596d07dbee9a9b521ed61c434ce4709b5Satyen Desai<arg choice="opt"><option>g</option></arg><arg choice="opt"><option>h</option></arg>
1201815cf554ddd27ca4898d9623926cfe3c2ac9Satyen Desai<arg choice="opt"><option>i</option></arg><arg choice="opt"><option>k</option></arg>
64953b0596d07dbee9a9b521ed61c434ce4709b5Satyen Desai<arg choice="opt"><option>n</option></arg><arg choice="opt"><option>r</option></arg>
64953b0596d07dbee9a9b521ed61c434ce4709b5Satyen Desai<arg choice="opt"><option>S</option></arg><arg choice="opt"><option>s</option></arg>
1201815cf554ddd27ca4898d9623926cfe3c2ac9Satyen Desai<arg choice="opt"><option>T</option></arg><arg choice="opt"><option>t <replaceable>
1201815cf554ddd27ca4898d9623926cfe3c2ac9Satyen Desai<refsect1 id="vte-1-desc"><title>&desc-tt;</title>
1201815cf554ddd27ca4898d9623926cfe3c2ac9Satyen Desai<para><command>&cmd;</command> is simply a window wrapped around the vte embeddable
1201815cf554ddd27ca4898d9623926cfe3c2ac9Satyen Desaiterminal emulation control, which does most of the work for <command>gnome-terminal
1201815cf554ddd27ca4898d9623926cfe3c2ac9Satyen Desai</command>. <command>&cmd;</command> is used mainly to test the control. Most
1201815cf554ddd27ca4898d9623926cfe3c2ac9Satyen Desaiusers do not need to use vte directly, but use <command>gnome-terminal</command>
1201815cf554ddd27ca4898d9623926cfe3c2ac9Satyen Desaiinstead.</para>
1201815cf554ddd27ca4898d9623926cfe3c2ac9Satyen Desai<refsect1 id="vte-1-opts"><title>&opts-tt;</title>
64953b0596d07dbee9a9b521ed61c434ce4709b5Satyen Desai<para>The following options are supported:</para>
1201815cf554ddd27ca4898d9623926cfe3c2ac9Satyen Desai<varlistentry><term><option>2</option></term><listitem><para>Toggle double
1201815cf554ddd27ca4898d9623926cfe3c2ac9Satyen Desaibuffering. Enabled by default.</para>
793e508bd277c48d6a09b91bb99064b4046eda7aSatyen Desai<varlistentry><term><option>A</option></term><listitem><para>Toggle antialiasing.
1201815cf554ddd27ca4898d9623926cfe3c2ac9Satyen DesaiThe default is that of the current GTK+ default.</para>
1201815cf554ddd27ca4898d9623926cfe3c2ac9Satyen Desai<varlistentry><term><option>a</option></term><listitem><para>Toggle audible
1201815cf554ddd27ca4898d9623926cfe3c2ac9Satyen Desaibell on/off. If audible bell is enabled, visible bell is disabled. If audible
793e508bd277c48d6a09b91bb99064b4046eda7aSatyen Desaibell is disabled, visible bell is enabled. Audible bell enabled by default.
1201815cf554ddd27ca4898d9623926cfe3c2ac9Satyen Desai<varlistentry><term><option>B <replaceable>image</replaceable></option></term>
1201815cf554ddd27ca4898d9623926cfe3c2ac9Satyen Desai<listitem><para>Use <replaceable>image</replaceable> as background.</para>
64953b0596d07dbee9a9b521ed61c434ce4709b5Satyen Desai<varlistentry><term><option>b</option></term><listitem><para>Toggle cursor
1201815cf554ddd27ca4898d9623926cfe3c2ac9Satyen Desaiblinking. Enabled by default.</para>
2b449ca06646ebb6603e35918a40bca8e0f43c8eSatyen Desai<varlistentry><term><option>C</option></term><listitem><para>Open a "console"
1201815cf554ddd27ca4898d9623926cfe3c2ac9Satyen Desaiconnection.</para>
1201815cf554ddd27ca4898d9623926cfe3c2ac9Satyen Desai<varlistentry><term><option>c <replaceable>command</replaceable></option></term>
1201815cf554ddd27ca4898d9623926cfe3c2ac9Satyen Desai<listitem><para>Fork the specified command.</para>
1201815cf554ddd27ca4898d9623926cfe3c2ac9Satyen Desai<varlistentry><term><option>D</option></term><listitem><para>Use dingus clicking:
1201815cf554ddd27ca4898d9623926cfe3c2ac9Satyen Desaias the cursor moves over text matching a certain pattern, the matched text
1201815cf554ddd27ca4898d9623926cfe3c2ac9Satyen Desaiis highlighted and the cursor changes shape. Disabled by default.</para>
1201815cf554ddd27ca4898d9623926cfe3c2ac9Satyen Desai<varlistentry><term><option>d</option></term><listitem><para>Toggle update
1201815cf554ddd27ca4898d9623926cfe3c2ac9Satyen Desaidebugging. Disabled by default.</para>
1201815cf554ddd27ca4898d9623926cfe3c2ac9Satyen Desai<varlistentry><term><option>f <replaceable>font</replaceable></option></term>
1201815cf554ddd27ca4898d9623926cfe3c2ac9Satyen Desai<listitem><para>Specify the font to use. Default font is "Sans 12".</para>
1201815cf554ddd27ca4898d9623926cfe3c2ac9Satyen Desai<varlistentry><term><option>g</option></term><listitem><para>Toggle whether
1201815cf554ddd27ca4898d9623926cfe3c2ac9Satyen Desaito set <?Pub Caret>geometry hints if font is changed. Enabled by default.
1201815cf554ddd27ca4898d9623926cfe3c2ac9Satyen Desai<varlistentry><term><option>h</option></term><listitem><para>Toggle highlighting.
1201815cf554ddd27ca4898d9623926cfe3c2ac9Satyen DesaiDisabled by default.</para>
1201815cf554ddd27ca4898d9623926cfe3c2ac9Satyen Desai<varlistentry><term><option>i</option></term><listitem><para>Toggle whether
1201815cf554ddd27ca4898d9623926cfe3c2ac9Satyen Desaito obey attempts to set the icon name, if applications running in the terminal
1201815cf554ddd27ca4898d9623926cfe3c2ac9Satyen Desairequest this.</para>
1201815cf554ddd27ca4898d9623926cfe3c2ac9Satyen Desai<varlistentry><term><option>k</option></term><listitem><para>Toggle whether
1201815cf554ddd27ca4898d9623926cfe3c2ac9Satyen Desaito keep program running after GTK main loop. Disabled by default.</para>
1201815cf554ddd27ca4898d9623926cfe3c2ac9Satyen Desai<varlistentry><term><option>n</option></term><listitem><para>Specify the number
1201815cf554ddd27ca4898d9623926cfe3c2ac9Satyen Desaiof scrollback lines. Minumum number of scrollback lines is 100. Default number
1201815cf554ddd27ca4898d9623926cfe3c2ac9Satyen Desaiof scrollback lines is 100.</para>
1201815cf554ddd27ca4898d9623926cfe3c2ac9Satyen Desai<varlistentry><term><option>r</option></term><listitem><para>Toggle whether
1201815cf554ddd27ca4898d9623926cfe3c2ac9Satyen Desaito set cursor color to pale red. Disabled by default.</para>
1201815cf554ddd27ca4898d9623926cfe3c2ac9Satyen Desai<varlistentry><term><option>S</option></term><listitem><para>Toggle launching
1201815cf554ddd27ca4898d9623926cfe3c2ac9Satyen Desaia shell. Enabled by default.</para>
1201815cf554ddd27ca4898d9623926cfe3c2ac9Satyen Desai<varlistentry><term><option>s</option></term><listitem><para>Toggle whether
1201815cf554ddd27ca4898d9623926cfe3c2ac9Satyen Desaito scroll background image along with text. This option is only useful when
1201815cf554ddd27ca4898d9623926cfe3c2ac9Satyen Desaicombined with the <option>B</option> option. Disabled by default.</para>
1201815cf554ddd27ca4898d9623926cfe3c2ac9Satyen Desai<varlistentry><term><option>T</option></term><listitem><para>Use transparent
2b449ca06646ebb6603e35918a40bca8e0f43c8eSatyen Desaibackground. Overrides the <option>B</option> option.</para>
1201815cf554ddd27ca4898d9623926cfe3c2ac9Satyen Desai<varlistentry><term><option>t <replaceable>terminal-type</replaceable></option></term>
1201815cf554ddd27ca4898d9623926cfe3c2ac9Satyen Desai<listitem><para>Specify the terminal type to emulate.</para>
1201815cf554ddd27ca4898d9623926cfe3c2ac9Satyen Desai<refsect1 id="vte-1-exde"><title>&exde-tt;</title>
1201815cf554ddd27ca4898d9623926cfe3c2ac9Satyen Desai<para><command>&cmd;</command> is designed to emulate the <command>xterm</command>
1201815cf554ddd27ca4898d9623926cfe3c2ac9Satyen Desaiprogram provided by the X Consortium. In turn, <command>xterm</command> is
1201815cf554ddd27ca4898d9623926cfe3c2ac9Satyen Desaian almost complete emulation of the DEC VT102 terminal. <command>&cmd;</command>
1201815cf554ddd27ca4898d9623926cfe3c2ac9Satyen Desaisupports the same extensions to VT102 as those provided by <command>xterm
1201815cf554ddd27ca4898d9623926cfe3c2ac9Satyen Desai</command>, through special escape sequences.</para>
1201815cf554ddd27ca4898d9623926cfe3c2ac9Satyen Desai<para><command>xterm</command> is an evolving program. Recent changes to <command>
1201815cf554ddd27ca4898d9623926cfe3c2ac9Satyen Desaixterm</command> have been been incorporated into <command>&cmd;</command>.
1201815cf554ddd27ca4898d9623926cfe3c2ac9Satyen DesaiThis includes emulation of the newer DEC VT220 escape sequences.</para>
1201815cf554ddd27ca4898d9623926cfe3c2ac9Satyen Desai<refsect1 id="vte-1-exam"><title>&exam-tt;</title>
1201815cf554ddd27ca4898d9623926cfe3c2ac9Satyen Desai<title>Launching the Virtual Terminal Emulator</title>
1201815cf554ddd27ca4898d9623926cfe3c2ac9Satyen Desai<para><screen>example% <userinput>&cmd;</userinput></screen></para>
1201815cf554ddd27ca4898d9623926cfe3c2ac9Satyen Desai<refsect1 id="vte-1-envr"><title>&envr-tt;</title>
1201815cf554ddd27ca4898d9623926cfe3c2ac9Satyen Desai<para>See <citerefentry><refentrytitle>environ</refentrytitle><manvolnum>
1201815cf554ddd27ca4898d9623926cfe3c2ac9Satyen Desai5</manvolnum></citerefentry> for descriptions of the following environment
1201815cf554ddd27ca4898d9623926cfe3c2ac9Satyen Desaivariables:</para>
1201815cf554ddd27ca4898d9623926cfe3c2ac9Satyen Desai<variablelist>
1201815cf554ddd27ca4898d9623926cfe3c2ac9Satyen Desai<varlistentry><term>VTE_PROFILE_MEMORY</term><listitem><para>Virtualize memory
1201815cf554ddd27ca4898d9623926cfe3c2ac9Satyen Desaiallocation for debugging purposes.</para>
1201815cf554ddd27ca4898d9623926cfe3c2ac9Satyen Desai<refsect1 id="vte-1-exit"><title>&exit-tt;</title>
1201815cf554ddd27ca4898d9623926cfe3c2ac9Satyen Desai<para>The following exit values are returned:</para>
1201815cf554ddd27ca4898d9623926cfe3c2ac9Satyen Desai<varlistentry><term><returnvalue>0</returnvalue></term><listitem><para>Application
1201815cf554ddd27ca4898d9623926cfe3c2ac9Satyen Desaiexited successfully</para>
1201815cf554ddd27ca4898d9623926cfe3c2ac9Satyen Desai<varlistentry><term><returnvalue>>0</returnvalue></term><listitem><para>Application
1201815cf554ddd27ca4898d9623926cfe3c2ac9Satyen Desaiexited with failure</para>
2b449ca06646ebb6603e35918a40bca8e0f43c8eSatyen Desai<refsect1 id="vte-1-file"><title>&file-tt;</title>
1201815cf554ddd27ca4898d9623926cfe3c2ac9Satyen Desai<para>The following files are used by this application:</para>
1201815cf554ddd27ca4898d9623926cfe3c2ac9Satyen Desai<varlistentry><term><filename>/usr/bin/&cmd;</filename></term><listitem><para>
1201815cf554ddd27ca4898d9623926cfe3c2ac9Satyen DesaiExecutable for virtual terminal emulator</para>
1201815cf554ddd27ca4898d9623926cfe3c2ac9Satyen Desai<refsect1 id="vte-1-attr"><title>&attr-tt;</title>
1201815cf554ddd27ca4898d9623926cfe3c2ac9Satyen Desai<para>See <olink targetdocent="REFMAN5" localinfo="attributes-5"><citerefentry>
1201815cf554ddd27ca4898d9623926cfe3c2ac9Satyen Desai<refentrytitle>attributes</refentrytitle><manvolnum>5</manvolnum></citerefentry></olink>
1201815cf554ddd27ca4898d9623926cfe3c2ac9Satyen Desaifor descriptions of the following attributes:</para>
1201815cf554ddd27ca4898d9623926cfe3c2ac9Satyen Desai<tgroup cols="2" colsep="1" rowsep="1"><colspec colname="COLSPEC0" colwidth="1*">
1201815cf554ddd27ca4898d9623926cfe3c2ac9Satyen Desai<row><entry align="center" valign="middle">ATTRIBUTE TYPE</entry><entry align="center"
1201815cf554ddd27ca4898d9623926cfe3c2ac9Satyen Desai<row><entry><para>Availability</para></entry><entry><para>SUNWvte</para></entry>
1201815cf554ddd27ca4898d9623926cfe3c2ac9Satyen Desai<row><entry colname="COLSPEC0"><para>Interface stability</para></entry><entry
1201815cf554ddd27ca4898d9623926cfe3c2ac9Satyen Desaicolname="COLSPEC1"><para>Volatile</para></entry></row>
1201815cf554ddd27ca4898d9623926cfe3c2ac9Satyen Desai</informaltable>
1201815cf554ddd27ca4898d9623926cfe3c2ac9Satyen Desai<refsect1 id="vte-1-also"><title>&also-tt;</title>
1201815cf554ddd27ca4898d9623926cfe3c2ac9Satyen Desai<!--Reference to another man page-->
1201815cf554ddd27ca4898d9623926cfe3c2ac9Satyen Desai<!--Reference to a Help manual-->
1201815cf554ddd27ca4898d9623926cfe3c2ac9Satyen Desai<!--Reference to a book.-->
1201815cf554ddd27ca4898d9623926cfe3c2ac9Satyen Desai<para><citerefentry><refentrytitle>gnome-terminal</refentrytitle><manvolnum>