git.hungrycats.org Git - xscreensaver/blob - driver/xscreensaver-getimage-desktop.man

   1 .TH XScreenSaver 1 "07-Sep-2003 (4.13)" "X Version 11"
   2 .SH NAME
   3 xscreensaver-getimage-desktop - put a desktop image on the root window
   4 .SH SYNOPSIS
   5 .B xscreensaver-getimage-desktop
   6 [\-display \fIhost:display.screen\fP] [\--verbose] [\--stdout]
   7 .SH DESCRIPTION
   8 The \fIxscreensaver\-getimage\-desktop\fP program is a helper program
   9 for the xscreensaver hacks that manipulate images.  Specifically, it
  10 is invoked by
  11 .BR xscreensaver\-getimage (1)
  12 as needed.  This is not a user-level command.
  13
  14 This program is only used on MacOS X / XDarwin systems, because
  15 on those systems, it's necessary to use the
  16 .BR screencapture (1)
  17 program to get an image of the desktop -- the usual X11
  18 mechanism for grabbing the screen doesn't work on OSX.
  19
  20 This script works by running
  21 .BR screencapture (1)
  22 to get a PDF, then converting it to a JPEG with
  23 .BR pdf2jpeg (1),
  24 then loading it onto the window with
  25 .BR xscreensaver\-getimage\-file (1).
  26 .SH OPTIONS
  27 .I xscreensaver-getimage-desktop
  28 accepts the following options:
  29 .TP 4
  30 .B --verbose
  31 Print diagnostics.
  32 .TP 4
  33 .B --stdout
  34 Instead of loading the image onto the root window, write it to stdout
  35 as a PBM file.
  36 .SH SEE ALSO
  37 .BR screencapture (1),
  38 .BR pdf2jpeg (1),
  39 .BR X (1),
  40 .BR xscreensaver (1),
  41 .BR xscreensaver\-demo (1),
  42 .BR xscreensaver\-getimage (1),
  43 .BR xscreensaver\-getimage\-file (1),
  44 .BR xscreensaver\-getimage\-video (1),
  45 .SH COPYRIGHT
  46 Copyright \(co 2003 by Jamie Zawinski.  Permission to use, copy,
  47 modify, distribute, and sell this software and its documentation for
  48 any purpose is hereby granted without fee, provided that the above
  49 copyright notice appear in all copies and that both that copyright
  50 notice and this permission notice appear in supporting documentation.
  51 No representations are made about the suitability of this software for
  52 any purpose.  It is provided "as is" without express or implied
  53 warranty.
  54 .SH AUTHOR
  55 Jamie Zawinski <jwz@jwz.org>, 20-Oct-03.