add a manpage for obxprop

[chaz/openbox] / doc / obxprop.1.in

diff --git a/doc/obxprop.1.in b/doc/obxprop.1.in
new file mode 100644 (file)
index 0000000..f3ac096
--- /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