Update the manpage for obxprop
[mikachu/openbox.git] / doc / obxprop.1.in
1 .TH "OBXPROP" "1" 
2 .SH "NAME" 
3 openbox \(em A minimalistic, highly configurable, next generation window 
4 manager with extensive standards support. 
5 .SH "SYNOPSIS" 
6 .PP 
7 \fBopenbox\fR [\fB\-\-help\fP]  [\fB\-\-display\fP]  [DISPLAY]  [\fB\-\-id\fP]  [ID]  [\fB\-\-root\fP]  [\-\-]  [PROPERTY \&...]  
8 .SH "DESCRIPTION" 
9 .PP 
10 obxprop is a tool for displaying the properties on an x 
11 window. 
12 .PP 
13 This tool has a similar functionality to \fBxprop\fR, 
14 but obxprop allows you to see UTF-8 strings as text. 
15 .PP 
16 You may use the \fB\-\-id\fR option to specify a window 
17 identifier, otherwise obxprop will allow you to select a window by 
18 clicking on it. 
19 .PP 
20 Primarily, this tool exists for Openbox users to see the value of the 
21 _OB_NAME, _OB_CLASS, and _OB_ROLE properties, which Openbox uses for 
22 matching windows against user-defined application rules. 
23 .SH "OPTIONS" 
24 .PP 
25 These are the possible options that \fBopenbox\fR accepts: 
26 .IP "\fB\-\-help\fP" 10 
27 Show a summary of the options available. 
28 .IP "\fB\-\-display\fP" 10 
29 .IP "DISPLAY" 10 
30 Specify the X display to use. 
31 .IP "\fB\-\-id\fP" 10 
32 .IP "ID" 10 
33 Specify the window identifier for the window whose properties 
34 will be displayed. 
35 .PP 
36 Similar to \fBxprop\fR, 
37 you may pass one or more property names to have 
38 \fBopenbox\fR limit its output to only the properties 
39 requested. 
40 .SH "SEE ALSO" 
41 .PP 
42 openbox (1), openbox-session(1), openbox-gnome-session(1), 
43 openbox-kde-session(1). 
44 .PP 
45 Please report bugs to: \fBhttp://bugzilla.icculus.org/ 
46 \fP 
47 .\" created by instant / docbook-to-man, Mon 08 Feb 2010, 14:21