git.hungrycats.org Git - xscreensaver/blob - hacks/memscroller.man

   1 .TH XScreenSaver 1 "14-Aug-2004" "X Version 11"
   2 .SH NAME
   3 memscroller - scrolls a dump of its own RAM across the screen
   4 .SH SYNOPSIS
   5 .B memscroller
   6 [\-display \fIhost:display.screen\fP]
   7 [\-window] [\-root] [\-mono] [\-install] [\-visual \fIvisual\fP]
   8 [\-font \fIfont\fP]
   9 [\-delay \fIint\fP]
  10 [\-mono | -color]
  11 [\-ram | -random | \-filename \fIfile\fP]
  12 [\-fps]
  13 .SH DESCRIPTION
  14 The \fImemscroller\fP program scrolls a dump of its own process memory
  15 across the screen in three windows at three different rates.
  16 .SH OPTIONS
  17 .I memscroller
  18 accepts the following options:
  19 .TP 8
  20 .B \-window
  21 Draw on a newly-created window.  This is the default.
  22 .TP 8
  23 .B \-root
  24 Draw on the root window.
  25 .TP 8
  26 .B \-install
  27 Install a private colormap for the window.
  28 .TP 8
  29 .B \-visual \fIvisual\fP
  30 Specify which visual to use.  Legal values are the name of a visual class,
  31 or the id number (decimal or hex) of a specific visual.
  32 .TP 8
  33 .B \-color
  34 Render each three bytes of memory as R, G, B.  This is the default.
  35 .TP 8
  36 .B \-mono
  37 Render each byte of memory in shades of green.
  38 .TP 8
  39 .B \-ram
  40 Read from the process's address space.  This is the default.
  41 .TP 8
  42 .B \-random
  43 Instead of reading from memory, generate random numbers.
  44 .TP 8
  45 .B \-filename \fIfile\fP
  46 Instead of reading from memory, read from the given file until EOF, then
  47 re-open it.  If you have permission, /dev/mem is an interesting choice here.
  48 (Note that /dev/null won't ever display anything, because it returns EOF
  49 without ever returning any data.)
  50 .TP 8
  51 .B \-delay \fImicroseconds\fP
  52 How much of a delay should be introduced between steps of the animation.
  53 Default 10000.
  54 .TP 8
  55 .B \-fps
  56 Display the current frame rate and CPU load.
  57 .SH ENVIRONMENT
  58 .PP
  59 .TP 8
  60 .B DISPLAY
  61 to get the default host and display number.
  62 .TP 8
  63 .B XENVIRONMENT
  64 to get the name of a resource file that overrides the global resources
  65 stored in the RESOURCE_MANAGER property.
  66 .SH SEE ALSO
  67 .BR X (1),
  68 .BR xscreensaver (1)
  69 .SH COPYRIGHT
  70 Copyright \(co 2004 by Jamie Zawinski.  Permission to use, copy, modify,
  71 distribute, and sell this software and its documentation for any purpose is
  72 hereby granted without fee, provided that the above copyright notice appear
  73 in all copies and that both that copyright notice and this permission notice
  74 appear in supporting documentation.  No representations are made about the
  75 suitability of this software for any purpose.  It is provided "as is" without
  76 express or implied warranty.
  77 .SH AUTHOR
  78 Jamie Zawinski <jwz@jwz.org>, 14-Aug-2004.