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

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

<!ENTITY cmd "gnome-wm">

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

%commonents;

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

%booktitles;

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

]>

<refentry id="gnome-wm-1">

<refmeta><refentrytitle>gnome-wm</refentrytitle><manvolnum>1</manvolnum>

<refmiscinfo class="date">22 Oct 2009</refmiscinfo>

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

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

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

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

</refmeta>

<indexterm><primary>&cmd;</primary></indexterm>

<indexterm><primary>launch the GNOME window manager</primary></indexterm>

<refnamediv id="gnome-wm-1-name">

<refname>&cmd;</refname>

<refpurpose>launch the GNOME window manager</refpurpose>

</refnamediv>

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

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

<arg choice="opt"><option>-default-wm <replaceable>wm</replaceable></option></arg>

<arg choice="opt"><option>-sm-client-id <replaceable>id</replaceable></option></arg>

</cmdsynopsis></refsynopsisdiv>

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

<para>

<command>&cmd;</command> is a shell script which launches the GNOME window

manager, <command>metacity</command>. The user may specify that another window

manager should be launched, either by using the <option>-default-wm</option>

option or by setting the WINDOW_MANAGER environment variable.

</para>

</refsect1>

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

<para>

The following options are supported:

</para>

<variablelist termlength="medium">

<varlistentry>

<term><option>-default-wm <replaceable>wm</replaceable></option></term>

<listitem><para>

Launch the window manager <replaceable>wm</replaceable>.

</para></listitem></varlistentry>

<varlistentry>

<term><option>-sm-client-id <replaceable>id</replaceable></option></term>

<listitem><para>

Specify the session management ID with which the window manager should be

launched.

</para>

</listitem></varlistentry>

</variablelist></refsect1>

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

<example role="example">

<title>Launching the foowm window manager using --default -wm</title>

<para><screen>

example% <userinput>&cmd; --default-wm foowm</userinput></screen></para>

</example>

<example role="example">

<title>Launching the foowm window manager using WINDOW_MANAGER</title>

<para><screen>

example% <userinput>WINDOW_MANAGER=foowm &cmd;</userinput>

</screen></para>

</example>

</refsect1>

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

<para>See

<citerefentry><refentrytitle>environ</refentrytitle>

<manvolnum>5</manvolnum></citerefentry>

for descriptions of the following environment variables that affect the

execution of <command>&cmd;</command>: NLSPATH.

</para>

<variablelist>

<varlistentry><term><envar>WINDOW_MANAGER</envar></term>

<listitem><para>

Used to override the configured window manager to use.

</para></listitem></varlistentry>

</variablelist>

</refsect1>

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

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

<variablelist termlength="medium"><varlistentry>

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

<listitem><para>

Executable for GNOME window manager

</para>

</listitem></varlistentry>

</variablelist></refsect1>

<refsect1 id="gnome-wm-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>gnome/gnome-session</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-wm-1-also"><title>&also-tt;</title>

<para>

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

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

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

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

</para>

</refsect1>

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

<para>

Written by Mark McLoughlin, Sun Microsystems Inc., 2003, 2009.

</para>

</refsect1>

</refentry>