Move usage of iconh into the branch that assigns it
[dana/openbox.git] / doc / obxprop.1.sgml
index 06e7817..bf89442 100644 (file)
@@ -36,10 +36,12 @@ manpage.1: manpage.sgml
   <refsynopsisdiv>
     <cmdsynopsis>
       <command>&dhpackage;</command>
-      <arg><option>--help</option></arg>
-      <arg><option>--display</option></arg><arg>DISPLAY</arg>
-      <arg><option>--id</option></arg><arg>ID</arg>
-      <arg><option>--root</option></arg>
+      <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>
@@ -56,7 +58,8 @@ manpage.1: manpage.sgml
       clicking on it.</para>
 
     <para>Primarily, this tool exists for Openbox users to see the value of the
-      _OB_NAME, _OB_CLASS, and _OB_ROLE properties, which Openbox uses for
+      _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>
@@ -71,19 +74,24 @@ manpage.1: manpage.sgml
         </listitem>
       </varlistentry>
       <varlistentry>
-        <term><option>--display</option></term><term>DISPLAY</term>
+        <term><option>--display</option> DISPLAY</term>
         <listitem>
           <para>Specify the X display to use.</para>
         </listitem>
       </varlistentry>
       <varlistentry>
-        <term><option>--id</option></term><term>ID</term>
+        <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>