Add include of cairo.h when using librsvg
[dana/openbox.git] / doc / obxprop.1.sgml
1 <!doctype refentry PUBLIC "-//OASIS//DTD DocBook V4.1//EN" [
2
3 <!-- Process this file with docbook-to-man to generate an nroff manual
4      page: `docbook-to-man manpage.sgml > manpage.1'.  You may view
5      the manual page with: `docbook-to-man manpage.sgml | nroff -man |
6      less'.  A typical entry in a Makefile or Makefile.am is:
7
8 manpage.1: manpage.sgml
9         docbook-to-man $< > $@
10
11     
12         The docbook-to-man binary is found in the docbook-to-man package.
13         Please remember that if you create the nroff version in one of the
14         debian/rules file targets (such as build), you will need to include
15         docbook-to-man in your Build-Depends control field.
16
17   -->
18
19   <!ENTITY dhsection   "<manvolnum>1</manvolnum>">
20   <!ENTITY dhucpackage "<refentrytitle>OBXPROP</refentrytitle>">
21   <!ENTITY dhpackage   "openbox">
22 ]>
23
24 <refentry>
25   <refmeta>
26     &dhucpackage;
27
28     &dhsection;
29   </refmeta>
30   <refnamediv>
31     <refname>&dhpackage;</refname>
32
33     <refpurpose>A minimalistic, highly configurable, next generation window
34       manager with extensive standards support.</refpurpose>
35   </refnamediv>
36   <refsynopsisdiv>
37     <cmdsynopsis>
38       <command>&dhpackage;</command>
39       <arg choice="Opt">--help</arg>
40       <arg choice="Opt">--display DISPLAY</arg>
41       <arg choice="Opt">--id ID</arg>
42       <arg choice="Opt">--root</arg>
43       <arg choice="Opt">--</arg>
44       <arg choice="Opt" rep="Repeat">PROPERTY</arg>
45     </cmdsynopsis>
46   </refsynopsisdiv>
47   <refsect1>
48     <title>DESCRIPTION</title>
49
50     <para>obxprop is a tool for displaying the properties on an x
51       window.</para>
52
53     <para>This tool has a similar functionality to <command>xprop</command>,
54       but obxprop allows you to see UTF-8 strings as text.</para>
55
56     <para>You may use the <command>--id</command> option to specify a window
57       identifier, otherwise obxprop will allow you to select a window by
58       clicking on it.</para>
59
60     <para>Primarily, this tool exists for Openbox users to see the value of the
61       _OB_APP_NAME, _OB_APP_CLASS, _OB_APP_ROLE, and _OB_APP_TYPE properties,
62       which Openbox uses for
63       matching windows against user-defined application rules.</para>
64   </refsect1>
65   <refsect1>
66     <title>OPTIONS</title>
67
68     <para>These are the possible options that <command>&dhpackage;</command> accepts:</para>
69     <variablelist>
70       <varlistentry>
71         <term><option>--help</option></term>
72         <listitem>
73           <para>Show a summary of the options available.</para>
74         </listitem>
75       </varlistentry>
76       <varlistentry>
77         <term><option>--display</option> DISPLAY</term>
78         <listitem>
79           <para>Specify the X display to use.</para>
80         </listitem>
81       </varlistentry>
82       <varlistentry>
83         <term><option>--id</option> ID</term>
84         <listitem>
85           <para>Specify the window identifier for the window whose properties
86             will be displayed.</para>
87         </listitem>
88       </varlistentry>
89     </variablelist>
90
91     <para>Similar to <command>xprop</command>,
92       you may pass one or more property names to have
93       <command>&dhpackage;</command> limit its output to only the properties
94       requested.</para>
95   </refsect1>
96   <refsect1>
97     <title>SEE ALSO</title>
98
99     <para>openbox (1), openbox-session(1), openbox-gnome-session(1),
100       openbox-kde-session(1).</para>
101
102     <para>Please report bugs to: <literal>http://bugzilla.icculus.org/
103       </literal></para>
104   </refsect1>
105 </refentry>
106
107 <!-- Keep this comment at the end of the file
108 Local variables:
109 mode: sgml
110 sgml-omittag:t
111 sgml-shorttag:t
112 sgml-minimize-attributes:nil
113 sgml-always-quote-attributes:t
114 sgml-indent-step:2
115 sgml-indent-data:t
116 sgml-parent-document:nil
117 sgml-default-dtd-file:nil
118 sgml-exposed-tags:nil
119 sgml-local-catalogs:nil
120 sgml-local-ecat-files:nil
121 End:
122 -->
123
124