summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
Diffstat (limited to 'doc')
-rw-r--r--doc/obxprop.1.in42
-rw-r--r--doc/obxprop.1.sgml116
-rw-r--r--doc/openbox-gnome-session.1.in4
-rw-r--r--doc/openbox-gnome-session.1.sgml2
-rw-r--r--doc/openbox-kde-session.1.in4
-rw-r--r--doc/openbox-kde-session.1.sgml2
-rw-r--r--doc/openbox-session.1.in4
-rw-r--r--doc/openbox-session.1.sgml2
-rw-r--r--doc/openbox.1.in4
-rw-r--r--doc/openbox.1.sgml2
10 files changed, 170 insertions, 12 deletions
diff --git a/doc/obxprop.1.in b/doc/obxprop.1.in
new file mode 100644
index 00000000..f3ac096c
--- /dev/null
+++ b/doc/obxprop.1.in
@@ -0,0 +1,42 @@
+.TH "OBXPROP" "1"
+.SH "NAME"
+openbox \(em A minimalistic, highly configurable, next generation window
+manager with extensive standards support.
+.SH "SYNOPSIS"
+.PP
+\fBopenbox\fR [\fB\-\-help\fP] [\fB\-\-display\fP] [DISPLAY] [\fB\-\-id\fP] [ID] [\fB\-\-root\fP]
+.SH "DESCRIPTION"
+.PP
+obxprop is a tool for displaying the properties on an x
+window.
+.PP
+This tool has a similar functionality to \fBxprop\fR,
+but obxprop allows you to see UTF-8 strings as text.
+.PP
+You may use the \fB\-\-id\fR option to specify a window
+identifier, otherwise obxprop will allow you to select a window by
+clicking on it.
+.PP
+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
+matching windows against user-defined application rules.
+.SH "OPTIONS"
+.PP
+These are the possible options that \fBopenbox\fR accepts:
+.IP "\fB\-\-help\fP" 10
+Show a summary of the options available.
+.IP "\fB\-\-display\fP" 10
+.IP "DISPLAY" 10
+Specify the X display to use.
+.IP "\fB\-\-id\fP" 10
+.IP "ID" 10
+Specify the window identifier for the window whose properties
+will be displayed.
+.SH "SEE ALSO"
+.PP
+openbox (1), openbox-session(1), openbox-gnome-session(1),
+openbox-kde-session(1).
+.PP
+Please report bugs to: \fBhttp://bugzilla.icculus.org/
+\fP
+.\" created by instant / docbook-to-man, Wed 06 Jan 2010, 13:40
diff --git a/doc/obxprop.1.sgml b/doc/obxprop.1.sgml
new file mode 100644
index 00000000..06e78175
--- /dev/null
+++ b/doc/obxprop.1.sgml
@@ -0,0 +1,116 @@
+<!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><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>
+ </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_NAME, _OB_CLASS, and _OB_ROLE 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></term><term>DISPLAY</term>
+ <listitem>
+ <para>Specify the X display to use.</para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><option>--id</option></term><term>ID</term>
+ <listitem>
+ <para>Specify the window identifier for the window whose properties
+ will be displayed.</para>
+ </listitem>
+ </varlistentry>
+ </variablelist>
+ </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:
+-->
+
+
diff --git a/doc/openbox-gnome-session.1.in b/doc/openbox-gnome-session.1.in
index f38c9bf6..7256874b 100644
--- a/doc/openbox-gnome-session.1.in
+++ b/doc/openbox-gnome-session.1.in
@@ -15,8 +15,8 @@ openbox(1), openbox-kde-session(1), openbox-session(1).
.PP
The program's full documentation is available on the website:
-\fBhttp://icculus.org/openbox/\fP
+\fBhttp://openbox.org/\fP
.PP
Please report bugs to: \fBhttp://bugzilla.icculus.org/
\fP
-.\" created by instant / docbook-to-man, Wed 23 May 2007, 14:03
+.\" created by instant / docbook-to-man, Wed 06 Jan 2010, 13:40
diff --git a/doc/openbox-gnome-session.1.sgml b/doc/openbox-gnome-session.1.sgml
index c72865a7..66add1b3 100644
--- a/doc/openbox-gnome-session.1.sgml
+++ b/doc/openbox-gnome-session.1.sgml
@@ -49,7 +49,7 @@ manpage.1: manpage.sgml
</para>
<para>The program's full documentation is available on the website:
- <literal>http://icculus.org/openbox/</literal></para>
+ <literal>http://openbox.org/</literal></para>
<para>Please report bugs to: <literal>http://bugzilla.icculus.org/
</literal></para>
diff --git a/doc/openbox-kde-session.1.in b/doc/openbox-kde-session.1.in
index d46d14b4..9a96275d 100644
--- a/doc/openbox-kde-session.1.in
+++ b/doc/openbox-kde-session.1.in
@@ -15,8 +15,8 @@ openbox(1), openbox-gnome-session(1), openbox-session(1).
.PP
The program's full documentation is available on the website:
-\fBhttp://icculus.org/openbox/\fP
+\fBhttp://openbox.org/\fP
.PP
Please report bugs to: \fBhttp://bugzilla.icculus.org/
\fP
-.\" created by instant / docbook-to-man, Wed 23 May 2007, 14:03
+.\" created by instant / docbook-to-man, Wed 06 Jan 2010, 13:40
diff --git a/doc/openbox-kde-session.1.sgml b/doc/openbox-kde-session.1.sgml
index e4f049db..70c5117e 100644
--- a/doc/openbox-kde-session.1.sgml
+++ b/doc/openbox-kde-session.1.sgml
@@ -49,7 +49,7 @@ manpage.1: manpage.sgml
</para>
<para>The program's full documentation is available on the website:
- <literal>http://icculus.org/openbox/</literal></para>
+ <literal>http://openbox.org/</literal></para>
<para>Please report bugs to: <literal>http://bugzilla.icculus.org/
</literal></para>
diff --git a/doc/openbox-session.1.in b/doc/openbox-session.1.in
index 26232474..483cdfda 100644
--- a/doc/openbox-session.1.in
+++ b/doc/openbox-session.1.in
@@ -35,8 +35,8 @@ openbox(1), openbox-session(1), openbox-gnome-session(1).
.PP
The program's full documentation is available on the website:
-\fBhttp://icculus.org/openbox/\fP
+\fBhttp://openbox.org/\fP
.PP
Please report bugs to: \fBhttp://bugzilla.icculus.org/
\fP
-.\" created by instant / docbook-to-man, Wed 23 May 2007, 14:03
+.\" created by instant / docbook-to-man, Wed 06 Jan 2010, 13:40
diff --git a/doc/openbox-session.1.sgml b/doc/openbox-session.1.sgml
index 3c31755e..ccece7a2 100644
--- a/doc/openbox-session.1.sgml
+++ b/doc/openbox-session.1.sgml
@@ -66,7 +66,7 @@ manpage.1: manpage.sgml
</para>
<para>The program's full documentation is available on the website:
- <literal>http://icculus.org/openbox/</literal></para>
+ <literal>http://openbox.org/</literal></para>
<para>Please report bugs to: <literal>http://bugzilla.icculus.org/
</literal></para>
diff --git a/doc/openbox.1.in b/doc/openbox.1.in
index 2a5446f3..d508e8c6 100644
--- a/doc/openbox.1.in
+++ b/doc/openbox.1.in
@@ -88,8 +88,8 @@ obconf (1), openbox-session(1), openbox-gnome-session(1),
openbox-kde-session(1).
.PP
The program's full documentation is available on the website:
-\fBhttp://icculus.org/openbox/\fP
+\fBhttp://openbox.org/\fP
.PP
Please report bugs to: \fBhttp://bugzilla.icculus.org/
\fP
-.\" created by instant / docbook-to-man, Tue 22 May 2007, 00:06
+.\" created by instant / docbook-to-man, Wed 06 Jan 2010, 13:40
diff --git a/doc/openbox.1.sgml b/doc/openbox.1.sgml
index 6921a666..275c3246 100644
--- a/doc/openbox.1.sgml
+++ b/doc/openbox.1.sgml
@@ -177,7 +177,7 @@ manpage.1: manpage.sgml
openbox-kde-session(1).</para>
<para>The program's full documentation is available on the website:
- <literal>http://icculus.org/openbox/</literal></para>
+ <literal>http://openbox.org/</literal></para>
<para>Please report bugs to: <literal>http://bugzilla.icculus.org/
</literal></para>