openbox/doc/obxprop.1.sgml
2010-02-08 15:04:35 -05:00

124 lines
3.7 KiB
Text

<!doctype refentry PUBLIC "-//OASIS//DTD DocBook V4.1//EN" [
<!-- Process this file with docbook-to-man to generate an nroff manual
page: `docbook-to-man manpage.sgml > manpage.1'. You may view
the manual page with: `docbook-to-man manpage.sgml | nroff -man |
less'. A typical entry in a Makefile or Makefile.am is:
manpage.1: manpage.sgml
docbook-to-man $< > $@
The docbook-to-man binary is found in the docbook-to-man package.
Please remember that if you create the nroff version in one of the
debian/rules file targets (such as build), you will need to include
docbook-to-man in your Build-Depends control field.
-->
<!ENTITY dhsection "<manvolnum>1</manvolnum>">
<!ENTITY dhucpackage "<refentrytitle>OBXPROP</refentrytitle>">
<!ENTITY dhpackage "openbox">
]>
<refentry>
<refmeta>
&dhucpackage;
&dhsection;
</refmeta>
<refnamediv>
<refname>&dhpackage;</refname>
<refpurpose>A minimalistic, highly configurable, next generation window
manager with extensive standards support.</refpurpose>
</refnamediv>
<refsynopsisdiv>
<cmdsynopsis>
<command>&dhpackage;</command>
<arg choice="Opt">--help</arg>
<arg choice="Opt">--display DISPLAY</arg>
<arg choice="Opt">--id ID</arg>
<arg choice="Opt">--root</arg>
<arg choice="Opt">--</arg>
<arg choice="Opt" rep="Repeat">PROPERTY</arg>
</cmdsynopsis>
</refsynopsisdiv>
<refsect1>
<title>DESCRIPTION</title>
<para>obxprop is a tool for displaying the properties on an x
window.</para>
<para>This tool has a similar functionality to <command>xprop</command>,
but obxprop allows you to see UTF-8 strings as text.</para>
<para>You may use the <command>--id</command> option to specify a window
identifier, otherwise obxprop will allow you to select a window by
clicking on it.</para>
<para>Primarily, this tool exists for Openbox users to see the value of the
_OB_APP_NAME, _OB_APP_CLASS, _OB_APP_ROLE, and _OB_APP_TYPE properties,
which Openbox uses for
matching windows against user-defined application rules.</para>
</refsect1>
<refsect1>
<title>OPTIONS</title>
<para>These are the possible options that <command>&dhpackage;</command> accepts:</para>
<variablelist>
<varlistentry>
<term><option>--help</option></term>
<listitem>
<para>Show a summary of the options available.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><option>--display</option> DISPLAY</term>
<listitem>
<para>Specify the X display to use.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><option>--id</option> ID</term>
<listitem>
<para>Specify the window identifier for the window whose properties
will be displayed.</para>
</listitem>
</varlistentry>
</variablelist>
<para>Similar to <command>xprop</command>,
you may pass one or more property names to have
<command>&dhpackage;</command> limit its output to only the properties
requested.</para>
</refsect1>
<refsect1>
<title>SEE ALSO</title>
<para>openbox (1), openbox-session(1), openbox-gnome-session(1),
openbox-kde-session(1).</para>
<para>Please report bugs to: <literal>http://bugzilla.icculus.org/
</literal></para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
sgml-omittag:t
sgml-shorttag:t
sgml-minimize-attributes:nil
sgml-always-quote-attributes:t
sgml-indent-step:2
sgml-indent-data:t
sgml-parent-document:nil
sgml-default-dtd-file:nil
sgml-exposed-tags:nil
sgml-local-catalogs:nil
sgml-local-ecat-files:nil
End:
-->