mdw@git.distorted.org.uk Git - xtoys/blob - xscsize.1

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