Dogcows Code - chaz/openbox/blob - 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><option>--help</option></arg>
  40       <arg><option>--display</option></arg><arg>DISPLAY</arg>
  41       <arg><option>--id</option></arg><arg>ID</arg>
  42       <arg><option>--root</option></arg>
  43     </cmdsynopsis>
  44   </refsynopsisdiv>
  45   <refsect1>
  46     <title>DESCRIPTION</title>
  47
  48     <para>obxprop is a tool for displaying the properties on an x
  49       window.</para>
  50
  51     <para>This tool has a similar functionality to <command>xprop</command>,
  52       but obxprop allows you to see UTF-8 strings as text.</para>
  53
  54     <para>You may use the <command>--id</command> option to specify a window
  55       identifier, otherwise obxprop will allow you to select a window by
  56       clicking on it.</para>
  57
  58     <para>Primarily, this tool exists for Openbox users to see the value of the
  59       _OB_NAME, _OB_CLASS, and _OB_ROLE properties, which Openbox uses for
  60       matching windows against user-defined application rules.</para>
  61   </refsect1>
  62   <refsect1>
  63     <title>OPTIONS</title>
  64
  65     <para>These are the possible options that <command>&dhpackage;</command> accepts:</para>
  66     <variablelist>
  67       <varlistentry>
  68         <term><option>--help</option></term>
  69         <listitem>
  70           <para>Show a summary of the options available.</para>
  71         </listitem>
  72       </varlistentry>
  73       <varlistentry>
  74         <term><option>--display</option></term><term>DISPLAY</term>
  75         <listitem>
  76           <para>Specify the X display to use.</para>
  77         </listitem>
  78       </varlistentry>
  79       <varlistentry>
  80         <term><option>--id</option></term><term>ID</term>
  81         <listitem>
  82           <para>Specify the window identifier for the window whose properties
  83             will be displayed.</para>
  84         </listitem>
  85       </varlistentry>
  86     </variablelist>
  87   </refsect1>
  88   <refsect1>
  89     <title>SEE ALSO</title>
  90
  91     <para>openbox (1), openbox-session(1), openbox-gnome-session(1),
  92       openbox-kde-session(1).</para>
  93
  94     <para>Please report bugs to: <literal>http://bugzilla.icculus.org/
  95       </literal></para>
  96   </refsect1>
  97 </refentry>
  98
  99 <!-- Keep this comment at the end of the file
 100 Local variables:
 101 mode: sgml
 102 sgml-omittag:t
 103 sgml-shorttag:t
 104 sgml-minimize-attributes:nil
 105 sgml-always-quote-attributes:t
 106 sgml-indent-step:2
 107 sgml-indent-data:t
 108 sgml-parent-document:nil
 109 sgml-default-dtd-file:nil
 110 sgml-exposed-tags:nil
 111 sgml-local-catalogs:nil
 112 sgml-local-ecat-files:nil
 113 End:
 114 -->
 115
 116