http://packetstormsecurity.org/UNIX/admin/xscreensaver-4.14.tar.gz
[xscreensaver] / hacks / apple2.man
1 .de EX          \"Begin example
2 .ne 5
3 .if n .sp 1
4 .if t .sp .5
5 .nf
6 .in +.5i
7 ..
8 .de EE
9 .fi
10 .in -.5i
11 .if n .sp 1
12 .if t .sp .5
13 ..
14 .TH XScreenSaver 1 "30-Oct-99" "X Version 11"
15 .SH NAME
16 apple2 - Apple ][ display emulator
17 .SH SYNOPSIS
18 .B apple2
19 [\-display \fIhost:display.screen\fP] [\-foreground \fIcolor\fP]
20 [\-background \fIcolor\fP] [\-window] [\-root] [\-mono] [\-install]
21 [\-visual \fIvisual\fP] [\-delay \fIseconds\fP]
22 [\-program \fIcommand to run\fP]
23 [\-text] [\-slideshow] [\-basic]
24 .SH DESCRIPTION
25 The
26 .I apple2 
27 program simulates an original Apple ][ Plus computer in all its 1979
28 glory. It also reproduces the appearance of display on a color
29 television set of the period.
30 .PP
31 There are 3 modes: text, slideshow, and basic. Normally it chooses a
32 mode randomly, but you can override with the \fI\-text\fP,
33 \fI\-slideshow\fP, or \fI\-basic\fP options.
34 .PP
35 In text mode it displays the output of a command (by default your
36 system's fortune program, but can be overridden with -program).
37 .PP
38 In slideshow mode it chooses a number of images from the image source
39 you configured into XScreenSaver and displays them within the
40 limitations of the Apple ][ display hardware. With only 6 available
41 colors, you can only make out the general shape of the pictures.
42 .PP
43 In basic mode a simulated user types in a Basic program and runs it.
44
45 .SH OPTIONS
46 .I apple2
47 accepts the following options:
48 .TP 8
49 .B \-window
50 Draw on a newly-created window.  This is the default.
51 .TP 8
52 .B \-root
53 Draw on the root window.
54 .TP 8
55 .B \-mono 
56 If on a color display, pretend we're on a monochrome display.
57 .TP 8
58 .B \-install
59 Install a private colormap for the window.
60 .TP 8
61 .B \-visual \fIvisual\fP
62 Specify which visual to use.  Legal values are the name of a visual class,
63 or the id number (decimal or hex) of a specific visual.
64 .TP 8
65 .B \-delay \fIdelay\fP
66 The delay between displaying one crash and another.
67 .TP 8
68 .B \-text
69 Choose text mode
70 .TP 8
71 .B \-slideshow
72 Choose slideshow mode
73 .TP 8
74 .B \-basic
75 Choose basic mode
76 .TP 8
77 .B \-program \fIsh-command\fP
78 In text mode, the command to run to generate the text to display. This
79 option may be any string acceptable to /bin/sh. The program will be
80 run at the end of a pipe, and any characters that it prints to
81 \fIstdout\fP will be printed on the Apple ][ display. If the program
82 exits, it will be launched again after 3 seconds.  Default:
83 .BR fortune (1).
84
85 Note that apple2 is \fInot\fP a terminal emulator: programs that try
86 to directly address the screen will not do what you might expect. It
87 merely draws the characters on the screen left to right, top to
88 bottom. Lines wrap when they reach the right edge, and the screen
89 scrolls when characters reach the bottom.
90
91 In other words, programs like
92 .BR fortune (1)
93 will work, but programs like
94 .BR top (1)
95 won't.
96
97 For example:
98 .EX
99 apple2 -text -program 'cat /usr/src/linux*/README | fold -sw40'
100 apple2 -text -program 'ping apple.com'
101 apple2 -text -program 'ps -e'
102 apple2 -text -program 'od -txCz -w7 /dev/random'
103 .EE
104 .SH ENVIRONMENT
105 .PP
106 .TP 8
107 .B DISPLAY
108 to get the default host and display number.
109 .TP 8
110 .B XENVIRONMENT
111 to get the name of a resource file that overrides the global resources
112 stored in the RESOURCE_MANAGER property.
113 .SH X RESOURCES
114 Notable X resources supported include the following which correspond
115 to standard TV controls:
116 .BR analogTVTint ,
117 .BR analogTVColor ,
118 .BR analogTVBrightness , 
119 and
120 .BR analogTVContrast
121 which correspond to standard TV controls. They range from 0 to
122 100,except for tint which is an angle between -180 and +180.
123 .SH TRADEMARKS
124 Apple ][ and Applesoft are trademarks of Apple Computer.
125
126 .SH SEE ALSO
127 .BR xscreensaver (1),
128 .BR bsod (1),
129 .BR fortune (1),
130 .BR phosphor (1),
131 .BR starwars (1),
132 .BR ljlatest (1),
133 .BR dadadodo (1),
134 .BR webcollage (1),
135 .BR driftnet (1)
136 .BR EtherPEG ,
137 .BR EtherPeek
138 .SH COPYRIGHT
139 Copyright \(co 2002-2003 by Trevor Blackwell.  Permission to use, copy,
140 modify, distribute, and sell this software and its documentation for
141 any purpose is hereby granted without fee, provided that the above
142 copyright notice appear in all copies and that both that copyright
143 notice and this permission notice appear in supporting documentation.
144 No representations are made about the suitability of this software for
145 any purpose.  It is provided "as is" without express or implied
146 warranty.
147 .SH AUTHOR
148 Television and Apple ][ emulation by Trevor Blackwell <tlb@tlb.org>.
149 Slideshow and text mode by Jamie Zawinski <jwz@jwz.org>.