debian/xtoys-gtk.install: Actually distribute the manpages.
[xtoys] / xscsize.1
... / ...
CommitLineData
1.\" -*-nroff-*-
2.TH xscsize 1 "15 November 1998" "Straylight/Edgeware" "xtoys"
3.SH NAME
4xscsize \- return size of an X display to a shell script
5.SH SYNOPSIS
6.B xscsize
7.RB [ \-bcx ]
8.RB [ \-d
9.IR display ]
10.SH DESCRIPTION
11The
12.B xscsize
13program interrogates an X display and writes the size of the root
14window to standard output in the form of a shell variable assignment
15statement. The dimensions are returned in the
16.B XWIDTH
17and
18.B XHEIGHT
19variables.
20.PP
21Command line options can be used to force output in either Bourne or C
22shell syntax. In the absence of any explicit instructions,
23.B xscsize
24looks at the
25.B SHELL
26environment variable to help make its mind up.
27.PP
28Typical use would be something like
29.RS 5
30.ft B
31.nf
32eval `xscsize`
33.ft R
34.fi
35.SS Options
36.TP 5
37.BI "\-d, \-\-display " display
38Choose which display to connect to.
39.TP 5
40.B \-b, --bourne-shell
41Output the assignments in Bourne shell syntax (usable by Bourne,
42POSIX, Korn, Z and Bourne Again shells).
43.TP 5
44.B \-c, --c-shell
45Output the assignments in C shell syntax (usable by C and Terminal C
46shells).
47.TP 5
48.B \-x, --export
49Output a variable export command, so that the screen size is inherited
50by child processes. The default is to just set local shell variables.
51.SH ENVIRONMENT
52.TP
53.B XWIDTH
54Set to the width of the display in pixels.
55.B XHEIGHT
56Set to the height of the display in pixels.
57.B SHELL
58Used to decide the nature of the calling shell. If absent, a Bourne
59shell is assumed.
60.SH BUGS
61Hopefully none.
62.SH AUTHOR
63Mark Wooding (mdw@distorted.org.uk).