man: replace hard coded man page section with substitution strings
[platform/upstream/xlsatoms.git] / xlsatoms.man
1 .\" Copyright 1989, 1994, 1998  The Open Group
2 .\"
3 .\" Permission to use, copy, modify, distribute, and sell this software and its
4 .\" documentation for any purpose is hereby granted without fee, provided that
5 .\" the above copyright notice appear in all copies and that both that
6 .\" copyright notice and this permission notice appear in supporting
7 .\" documentation.
8 .\"
9 .\" The above copyright notice and this permission notice shall be included
10 .\" in all copies or substantial portions of the Software.
11 .\"
12 .\" THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
13 .\" OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
14 .\" MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
15 .\" IN NO EVENT SHALL THE OPEN GROUP BE LIABLE FOR ANY CLAIM, DAMAGES OR
16 .\" OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
17 .\" ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
18 .\" OTHER DEALINGS IN THE SOFTWARE.
19 .\"
20 .\" Except as contained in this notice, the name of The Open Group shall
21 .\" not be used in advertising or otherwise to promote the sale, use or
22 .\" other dealings in this Software without prior written authorization
23 .\" from The Open Group.
24 .\"
25 .TH XLSATOMS 1 __xorgversion__
26 .SH NAME
27 xlsatoms - list interned atoms defined on server
28 .SH SYNOPSIS
29 .B xlsatoms
30 [-options ...]
31 .SH DESCRIPTION
32 .I Xlsatoms
33 lists the interned atoms.  By default, all atoms starting from 1 (the lowest
34 atom value defined by the protocol) are listed until unknown atom is found.
35 If an explicit range is given, \fIxlsatoms\fP will try all atoms in the range,
36 regardless of whether or not any are undefined.
37 .SH "OPTIONS"
38 .PP
39 .TP 8
40 .B \-display \fIdpy\fP
41 This option specifies the X server to which to connect.
42 .TP 8
43 .B \-format \fIstring\fP
44 This option specifies a \fIprintf\fP-style string used to list each atom
45 \fI<value,name>\fP pair, printed in that order (\fIvalue\fP is an \fIunsigned
46 long\fP and \fIname\fP is a \fIchar *\fP).  \fIXlsatoms\fP will supply a
47 newline at the end of each line.  The default is \fI%ld\\t%s\fP.
48 .TP 8
49 .B \-range \fI[low]-[high]\fP
50 This option specifies the range of atom values to check.  If \fIlow\fP is not
51 given, a value of 1 assumed.  If \fIhigh\fP is not given, \fIxlsatoms\fP will
52 stop at the first undefined atom at or above \fIlow\fP.
53 .TP 8
54 .B \-name \fIstring\fP
55 This option specifies the name of an atom to list.  If the atom does not
56 exist, a message will be printed on the standard error.
57 .PP
58 .SH "SEE ALSO"
59 X(__miscmansuffix__), Xserver(__appmansuffix__), xprop(__appmansuffix__)
60 .SH ENVIRONMENT
61 .TP 8
62 .B DISPLAY
63 to get the default host and display to use.
64 .SH AUTHOR
65 Jim Fulton, MIT X Consortium