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