e0234797618d4555ecaa6269b72896393fd294da
[xscreensaver] / local / man / cat.1 / webcollage.1
1
2
3
4 XScreenSaver(1)                                   XScreenSaver(1)
5
6
7 N\bNA\bAM\bME\bE
8        webcollage  -  decorate the screen with random images from
9        the web
10
11 S\bSY\bYN\bNO\bOP\bPS\bSI\bIS\bS
12        w\bwe\beb\bbc\bco\bol\bll\bla\bag\bge\be [-display _\bh_\bo_\bs_\bt_\b:_\bd_\bi_\bs_\bp_\bl_\ba_\by_\b._\bs_\bc_\br_\be_\be_\bn]  [-root]  [-ver-
13        bose]  [-delay  _\bs_\be_\bc_\bs]  [-timeout  _\bs_\be_\bc_\bs]  [-background  _\bb_\bg]
14        [-filter _\bc_\bo_\bm_\bm_\ba_\bn_\bd] [-filter2 _\bc_\bo_\bm_\bm_\ba_\bn_\bd]
15
16 D\bDE\bES\bSC\bCR\bRI\bIP\bPT\bTI\bIO\bON\bN
17        The _\bw_\be_\bb_\bc_\bo_\bl_\bl_\ba_\bg_\be program pulls random image off of the World
18        Wide  Web  and scatters them on the root window.  It finds
19        these images by doing random web searches, and  extracting
20        images  from  the returned pages.  It places the images on
21        the root window  by  using  the  x\bxv\bv(1),  g\bgi\bif\bft\bto\bop\bpn\bnm\bm(1),  and
22        d\bdj\bjp\bpe\beg\bg(1) tools.
23
24        _\bw_\be_\bb_\bc_\bo_\bl_\bl_\ba_\bg_\be also works as a CGI program: simply make a sym-
25        bolic link to the _\bw_\be_\bb_\bc_\bo_\bl_\bl_\ba_\bg_\be executable called _\bn_\bp_\bh_\b-_\bw_\be_\bb_\bc_\bo_\bl_\b-
26        _\bl_\ba_\bg_\be_\b._\bc_\bg_\bi.   If this program sees that it is being run as a
27        CGI, then it will behave  appropriately.   (The  generated
28        web  page  will  list the images one after another, rather
29        than tiling them together.)
30
31        _\bw_\be_\bb_\bc_\bo_\bl_\bl_\ba_\bg_\be is written in p\bpe\ber\brl\bl(1) and requires Perl 5.
32
33 O\bOP\bPT\bTI\bIO\bON\bNS\bS
34        _\bw_\be_\bb_\bc_\bo_\bl_\bl_\ba_\bg_\be accepts the following options:
35
36        -\b-r\bro\boo\bot\bt   Draw on the root window.  This  option  is  mandi-
37                tory: drawing to a window other than the root win-
38                dow is not yet supported.
39
40        -\b-v\bve\ber\brb\bbo\bos\bse\be or -\b-v\bv
41                Print diagnostics to stderr.  Multiple _\b-_\bv switches
42                increase  the amount of output.  _\b-_\bv will print out
43                only the URLs of the images; _\b-_\bv_\bv  will  print  all
44                the  commands  being run; and _\b-_\bv_\bv_\bv will print more
45                than you care about.
46
47        -\b-d\bde\bel\bla\bay\by _\bs_\be_\bc_\bo_\bn_\bd_\bs
48                How long to sleep between images.  Default 1  sec-
49                ond.   (Remember that this program probably spends
50                a lot of time waiting for the network.)
51
52        -\b-b\bba\bac\bck\bkg\bgr\bro\bou\bun\bnd\bd _\bc_\bo_\bl_\bo_\br_\b-_\bo_\br_\b-_\bp_\bp_\bm
53                What to use for the background onto  which  images
54                are pasted.  This may be a color name, a hexadeci-
55                mal RGB specification in the  form  '#rrggbb',  or
56                the name of a PPM file.
57
58        -\b-t\bti\bim\bme\beo\bou\but\bt _\bs_\be_\bc_\bo_\bn_\bd_\bs
59                How long to wait for a URL to complete before giv-
60                ing up on it  and  moving  on  to  the  next  one.
61
62
63
64 X Version 11                17-Jun-99                           1
65
66
67
68
69
70 XScreenSaver(1)                                   XScreenSaver(1)
71
72
73                Default 30 seconds.
74
75        -\b-f\bfi\bil\blt\bte\ber\br _\bc_\bo_\bm_\bm_\ba_\bn_\bd
76                Filter  all  source  images  through this command.
77                The command must take a PPM  file  on  stdin,  and
78                write  a  new PPM file to stdout.  One good choice
79                for a filter would be:
80
81                     webcollage -root -filter 'vidwhacker -stdin -stdout'
82
83
84        -\b-f\bfi\bil\blt\bte\ber\br2\b2 _\bc_\bo_\bm_\bm_\ba_\bn_\bd
85                Filter the _\bc_\bo_\bm_\bp_\bo_\bs_\bi_\bt_\be image through  this  command.
86                The  _\b-_\bf_\bi_\bl_\bt_\be_\br option applies to the sub-images; the
87                _\b-_\bf_\bi_\bl_\bt_\be_\br_\b2 applies to the final, full-screen  image.
88
89 E\bEN\bNV\bVI\bIR\bRO\bON\bNM\bME\bEN\bNT\bT
90        D\bDI\bIS\bSP\bPL\bLA\bAY\bY to get the default host and display number.
91
92        X\bXE\bEN\bNV\bVI\bIR\bRO\bON\bNM\bME\bEN\bNT\bT
93                to  get the name of a resource file that overrides
94                the global resources stored in  the  RESOURCE_MAN-
95                AGER property.
96
97 F\bFI\bIL\bLE\bES\bS A\bAN\bND\bD U\bUR\bRL\bLS\bS
98        _\b/_\bu_\bs_\br_\b/_\bd_\bi_\bc_\bt_\b/_\bw_\bo_\br_\bd_\bs or _\b/_\bu_\bs_\br_\b/_\bs_\bh_\ba_\br_\be_\b/_\bl_\bi_\bb_\b/_\bd_\bi_\bc_\bt_\b/_\bw_\bo_\br_\bd_\bs
99               To find the random words to feed to search engines.
100
101        _\bh_\bt_\bt_\bp_\b:_\b/_\b/_\br_\ba_\bn_\bd_\bo_\bm_\b._\by_\ba_\bh_\bo_\bo_\b._\bc_\bo_\bm_\b/_\bb_\bi_\bn_\b/_\br_\by_\bl_\b,
102        _\bh_\bt_\bt_\bp_\b:_\b/_\b/_\bi_\bm_\ba_\bg_\be_\b._\ba_\bl_\bt_\ba_\bv_\bi_\bs_\bt_\ba_\b._\bc_\bo_\bm_\b/ To find random web pages.
103
104 B\bBU\bUG\bGS\bS
105        When  drawing  on  the  root  window,  it  always uses the
106        default colormap.  This is actually a  limitation  of  xv.
107        But regardless, when using this program with xscreensaver,
108        it must be given the d\bde\bef\bfa\bau\bul\blt\bt-\b-n\bn visual  specification  (see
109        the x\bxs\bsc\bcr\bre\bee\ben\bns\bsa\bav\bve\ber\br(1) manual for more details.)
110
111        Only the GIF and JPEG image formats are supported.
112
113        Transparent and animating GIFs are not supported.
114
115        It's slow.
116
117 S\bSE\bEE\bE A\bAL\bLS\bSO\bO
118        X\bX(1),  x\bxs\bsc\bcr\bre\bee\ben\bns\bsa\bav\bve\ber\br(1), x\bxv\bv(1), g\bgi\bif\bft\bto\bop\bpn\bnm\bm(1), d\bdj\bjp\bpe\beg\bg(1), v\bvi\bid\bd-\b-
119        w\bwh\bha\bac\bck\bke\ber\br(1), p\bpe\ber\brl\bl(1)
120
121 C\bCO\bOP\bPY\bYR\bRI\bIG\bGH\bHT\bT
122        Copyright (C) 1998, 1999 by Jamie Zawinski.  Permission to
123        use,  copy, modify, distribute, and sell this software and
124        its documentation for any purpose is hereby granted  with-
125        out  fee,  provided that the above copyright notice appear
126        in all copies and that both that copyright notice and this
127
128
129
130 X Version 11                17-Jun-99                           2
131
132
133
134
135
136 XScreenSaver(1)                                   XScreenSaver(1)
137
138
139        permission  notice appear in supporting documentation.  No
140        representations are made about  the  suitability  of  this
141        software  for any purpose.  It is provided "as is" without
142        express or implied warranty.
143
144 A\bAU\bUT\bTH\bHO\bOR\bR
145        Jamie Zawinski <jwz@jwz.org>, 24-May-98.
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196 X Version 11                17-Jun-99                           3
197
198