<!DOCTYPE REFENTRY PUBLIC "-//Sun Microsystems//DTD DocBook V3.0-Based SolBook Subset V2.0//EN" [

<!--ArborText, Inc., 1988-1999, v.4002-->

<!ENTITY cmd "vte">

<!ENTITY % commonents SYSTEM "smancommon.ent">

%commonents;

<!ENTITY % booktitles SYSTEM "booktitles.ent">

%booktitles;

<!ENTITY suncopy "Copyright (c) 2004,2007 Sun Microsystems, Inc. All Rights Reserved.">

]>

<?Pub UDT _bookmark _target>

<?Pub Inc>

<refentry id="vte-1">

<refmeta><refentrytitle>vte</refentrytitle><manvolnum>1</manvolnum>

<refmiscinfo class="date">08 Nov 2007</refmiscinfo>

<refmiscinfo class="sectdesc">&man1;</refmiscinfo>

<refmiscinfo class="software">&release;</refmiscinfo>

<refmiscinfo class="arch">generic</refmiscinfo>

<refmiscinfo class="copyright">&suncopy;</refmiscinfo>

</refmeta>

<indexterm><primary>vte</primary></indexterm><indexterm><primary>virtual terminal

emulator</primary></indexterm>

<refnamediv id="vte-1-name"><refname>vte</refname><refpurpose>virtual terminal

emulator</refpurpose></refnamediv>

<refsynopsisdiv id="vte-1-synp"><title>&synp-tt;</title>

<cmdsynopsis><command>&cmd;</command>

<arg choice="opt"><option>-antialias</option></arg>

<arg choice="opt"><option>-audbile</option></arg>

<arg choice="opt"><option>-background=<replaceable>image</replaceable></option></arg>

<arg choice="opt"><option>-blink</option></arg>

<arg choice="opt"><option>-color-cursor</option></arg>

<arg choice="opt"><option>-command=<replaceable>command</replaceable></option></arg>

<arg choice="opt"><option>-console</option></arg>

<arg choice="opt"><option>-debug</option></arg>

<arg choice="opt"><option>-dingus</option></arg>

<arg choice="opt"><option>-display=<replaceable>display</replaceable></option></arg>

<arg choice="opt"><option>-double-buffer</option></arg>

<arg choice="opt"><option>-font=<replaceable>font</replaceable></option></arg>

<arg choice="opt"><option>-geometry=<replaceable>geometry</replaceable></option></arg>

<arg choice="opt"><option>-highlight</option></arg>

<arg choice="opt"><option>-icon-title</option></arg>

<arg choice="opt"><option>-keep</option></arg>

<arg choice="opt"><option>-no-geometry-hints</option></arg>

<arg choice="opt"><option>-reverse</option></arg>

<arg choice="opt"><option>-scroll-background</option></arg>

<arg choice="opt"><option>-scrollback-lines</option></arg>

<arg choice="opt"><option>-shell</option></arg>

<arg choice="opt"><option>-termcap=<replaceable>terminal-type</replaceable></option></arg>

<arg choice="opt"><option>-transparent</option></arg>

<arg choice="opt"><option>-working-directory=<replaceable>directory</replaceable></option></arg>

</cmdsynopsis></refsynopsisdiv>

<refsect1 id="vte-1-desc"><title>&desc-tt;</title>

<para><command>&cmd;</command> is simply a window wrapped around the vte embeddable

terminal emulation control, which does most of the work for <command>gnome-terminal

</command>. <command>&cmd;</command> is used mainly to test the control. Most

users do not need to use vte directly, but use <command>gnome-terminal</command>

instead.</para>

</refsect1>

<refsect1 id="vte-1-opts"><title>&opts-tt;</title>

<para>The following options are supported:</para>

<variablelist termlength="fullscreen">

<varlistentry><term><option>2</option>, <option>-double-buffer</option></term>

<listitem><para>Toggle double buffering. Enabled by default.</para>

</listitem></varlistentry>

<varlistentry><term><option>A</option>, <option>-antialias</option></term>

<listitem><para>Toggle antialiasing. The default is that of the current GTK+

default.</para>

</listitem></varlistentry>

<varlistentry><term><option>a</option>, <option>-audible</option></term>

<listitem><para>Toggle audible bell on/off. If audible bell is enabled,

visible bell is disabled. If audible bell is disabled, visible bell is

enabled. Audible bell enabled by default.</para>

</listitem></varlistentry>

<varlistentry><term><option>B</option>, <option>-background=<replaceable>image</replaceable></option></term>

<listitem><para>Use <replaceable>image</replaceable> as background.</para>

</listitem></varlistentry>

<varlistentry><term><option>b</option>, <option>-blink</option></term>

<listitem><para>Toggle cursor blinking. Enabled by default.</para>

</listitem></varlistentry>

<varlistentry><term><option>C</option>, <option>-console</option></term>

<listitem><para>Open a "console" connection.</para>

</listitem></varlistentry>

<varlistentry><term><option>c</option>, <option>-command=<replaceable>command</replaceable></option></term>

<listitem><para>Fork the specified <replaceable>command</replaceable>.</para>

</listitem></varlistentry>

<varlistentry><term><option>D</option>, <option>-dingus</option></term>

<listitem><para>Use dingus clicking: as the cursor moves over text matching

a certain pattern, the matched text is highlighted and the cursor changes shape.

Disabled by default.</para>

</listitem></varlistentry>

<varlistentry><term><option>d</option>, <option>-debug</option></term>

<listitem><para>Toggle update debugging. Disabled by default.</para>

</listitem></varlistentry>

<varlistentry><term><option>-display=<replaceable>display</replaceable></option></term>

<listitem><para>Specify the X <replaceable>display</replaceable> to use.</para>

</listitem></varlistentry>

<varlistentry><term><option>f</option>, <option>-font=<replaceable>font</replaceable></option></term>

<listitem><para>Specify the <replaceable>font</replaceable> to use. Default

font is "Sans 12".</para>

</listitem></varlistentry>

<varlistentry><term><option>G</option>, <option>-no-geometry-hints</option></term>

<listitem><para>Allow the terminal to be resized to any dimension, not constrained

to fit to an integer multiple of characters.</para>

</listitem></varlistentry>

<varlistentry><term><option>g</option>, <option>-geometry=<replaceable>geometry</replaceable></option></term>

<listitem><para>Set the size (in characters) and position.</para>

</listitem></varlistentry>

<varlistentry><term><option>h</option>, <option>-highlight</option></term>

<listitem><para>Toggle highlighting. Disabled by default.</para>

</listitem></varlistentry>

<varlistentry><term><option>i</option>, <option>-icon-title</option></term>

<listitem><para>Toggle whether to obey attempts to set the icon name, if

applications running in the terminal request this.</para>

</listitem></varlistentry>

<varlistentry><term><option>k</option>, <option>-keep</option></term>

<listitem><para>Toggle whether to keep program running after GTK main loop.

Disabled by default.</para>

</listitem></varlistentry>

<varlistentry><term><option>n</option>, <option>-scrollback-lines</option></term>

<listitem><para>Specify the number of scrollback lines. Minumum number of

scrollback lines is 100. Default number of scrollback lines is 100.</para>

</listitem></varlistentry>

<varlistentry><term><option>r</option>, <option>-color-cursor</option></term>

<listitem><para>Toggle whether to set cursor color to pale red. Disabled by

default.</para>

</listitem></varlistentry>

<varlistentry><term><option>-reverse</option></term>

<listitem><para>Reverse foreground and background colors.</para>

</listitem></varlistentry>

<varlistentry><term><option>S</option>, <option>-shell</option></term>

<listitem><para>Toggle launching a shell. Enabled by default.</para>

</listitem></varlistentry>

<varlistentry><term><option>s</option>, <option>-scroll-background</option></term>

<listitem><para>Toggle whether to scroll background image along with text. This

option is only useful when combined with the <option>B</option> option.

Disabled by default.</para>

</listitem></varlistentry>

<varlistentry><term><option>T</option>, <option>-transparent</option></term>

<listitem><para>Use transparent background. Overrides the <option>B</option>

option.</para>

</listitem></varlistentry>

<varlistentry><term><option>t</option>, <option>-termcap=<replaceable>terminal-type</replaceable></option></term>

<listitem><para>Specify the terminal type to emulate.</para>

</listitem></varlistentry>

<varlistentry><term><option>w</option>, <option>-working-directory=<replaceable>directory</replaceable></option></term>

<listitem><para>Specify the initial working directory of the terminal.</para>

</listitem></varlistentry>

</variablelist></refsect1>

<refsect1 id="vte-1-exde"><title>&exde-tt;</title>

<para><command>&cmd;</command> is designed to emulate the <command>xterm</command>

program provided by the X Consortium. In turn, <command>xterm</command> is

an almost complete emulation of the DEC VT102 terminal. <command>&cmd;</command>

supports the same extensions to VT102 as those provided by <command>xterm

</command>, through special escape sequences.</para>

<para><command>xterm</command> is an evolving program. Recent changes to <command>

xterm</command> have been been incorporated into <command>&cmd;</command>.

This includes emulation of the newer DEC VT220 escape sequences.</para>

</refsect1>

<refsect1 id="vte-1-exam"><title>&exam-tt;</title>

<example role="example">

<title>Launching the Virtual Terminal Emulator</title>

<para><screen>example% <userinput>&cmd;</userinput></screen></para>

</example>

</refsect1>

<refsect1 id="vte-1-envr"><title>&envr-tt;</title>

<para>See <citerefentry><refentrytitle>environ</refentrytitle><manvolnum>

5</manvolnum></citerefentry> for descriptions of the following environment

variables:</para>

<variablelist>

<varlistentry><term>VTE_PROFILE_MEMORY</term><listitem><para>Virtualize memory

allocation for debugging purposes.</para>

</listitem></varlistentry>

</variablelist></refsect1>

<refsect1 id="vte-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="vte-1-file"><title>&file-tt;</title>

<para>The following files are used by this application:</para>

<variablelist termlength="wide">

<varlistentry>

<term><filename>/usr/bin/&cmd;</filename></term>

<listitem><para>

Executable for virtual terminal emulator</para>

</listitem></varlistentry>

<varlistentry>

<term><filename>/usr/share/gtk-doc/html/vte</filename></term>

<listitem><para>

Location of developer documentation

</para>

</listitem></varlistentry>

</variablelist></refsect1>

<refsect1 id="vte-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>

<row><entry><para>Availability</para></entry><entry><para>SUNWvte</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="vte-1-also"><title>&also-tt;</title>

<para>

<citerefentry><refentrytitle>gnome-terminal</refentrytitle><manvolnum>1</manvolnum></citerefentry>,

<citerefentry><refentrytitle>xterm</refentrytitle><manvolnum>1</manvolnum></citerefentry>,

<citerefentry><refentrytitle>libvte</refentrytitle><manvolnum>3</manvolnum></citerefentry></para>,

<citerefentry><refentrytitle>attributes</refentrytitle><manvolnum>5</manvolnum></citerefentry>,

<citerefentry><refentrytitle>environ</refentrytitle><manvolnum>5</manvolnum></citerefentry>

</refsect1>

<refsect1 id="vte-1-note"><title>&note-tt;</title>

<para>Written by Johan Steyn, updated by Brian Cameron, Sun Microsystems Inc., 2004, 2007.</para>

</refsect1>

</refentry>