From: Dana Jansens Date: Wed, 6 Jan 2010 18:39:02 +0000 (-0500) Subject: add a manpage for obxprop X-Git-Url: https://git.dogcows.com/gitweb?a=commitdiff_plain;h=e65411aa0de52f8d2af1c22646e7a8397f7357b8;p=chaz%2Fopenbox add a manpage for obxprop --- diff --git a/Makefile.am b/Makefile.am index 60c22321..14786f57 100644 --- a/Makefile.am +++ b/Makefile.am @@ -493,6 +493,8 @@ dist_noinst_DATA = \ doc/openbox-gnome-session.1.in \ doc/openbox-kde-session.1.sgml \ doc/openbox-kde-session.1.in \ + doc/obxprop.1.sgml \ + doc/obxprop.1.in \ render/obrender-3.0.pc.in \ parser/obparser-3.0.pc.in \ tools/themeupdate/themeupdate.py \ 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 @@ + 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. + + --> + + 1"> + OBXPROP"> + +]> + + + + &dhucpackage; + + &dhsection; + + + &dhpackage; + + A minimalistic, highly configurable, next generation window + manager with extensive standards support. + + + + &dhpackage; + + DISPLAY + ID + + + + + DESCRIPTION + + obxprop is a tool for displaying the properties on an x + window. + + This tool has a similar functionality to xprop, + but obxprop allows you to see UTF-8 strings as text. + + You may use the --id option to specify a window + identifier, otherwise obxprop will allow you to select a window by + clicking on it. + + 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. + + + OPTIONS + + These are the possible options that &dhpackage; accepts: + + + + + Show a summary of the options available. + + + + DISPLAY + + Specify the X display to use. + + + + ID + + Specify the window identifier for the window whose properties + will be displayed. + + + + + + SEE ALSO + + openbox (1), openbox-session(1), openbox-gnome-session(1), + openbox-kde-session(1). + + Please report bugs to: http://bugzilla.icculus.org/ + + + + + + +