Penguin
Recent Changes
Blame: setiathome(1)
EditPageHistoryDiffInfoLikePages
Annotated edit history of setiathome(1) version 1, including all changes. View license author blame.
Rev Author # Line
1 perry 1 SETIATHOME
2 !!!SETIATHOME
3 NAME
4 SYNOPSIS
5 DESCRIPTION
6 FILES
7 RUNNING SETIATHOME
8 ENVIRONMENT VARIABLES
9 OPTIONS
10 KNOWN BUGS:
11 SEE ALSO:
12 AUTHOR
13 ----
14 !!NAME
15
16
17 setiathome - the SETI@home client program
18 !!SYNOPSIS
19
20
21 __setiathome__ [[__options__]
22 !!DESCRIPTION
23
24
25 __setiathome__ is the UNIX version of the SETI@home
26 client. It downloads radio telescope data from a network
27 server, analyzes the data looking for signals of
28 extraterrestrial origin, and uploads results to the server,
29 repeating this cycle indefinitely. See
30 http://setiathome.ssl.berkeley.edu for more
31 information.
32 !!FILES
33
34
35 The program generates several files with .sah extension in
36 the directory from which it is run. These should not be
37 modified.
38
39
40 If you want to run multiple instances of setiathome (on a
41 multiprocessor machine, or on multiple machines that share a
42 filesystem) each one must be run in a different directory.
43 You can use symlinks for each directory to avoid duplication
44 of the binary image. e.g.:
45
46
47 ln -s cpu0/setiathome cpu1/setiathome
48 __setiathome__ uses a lock file (lock.txt) to prevent multiple instances from running in the same directory.
49
50
51 To finish up your current work unit, return your result, and
52 not download a new work unit, while the client is running,
53 touch a file named
54 ***__ Note this one
55 file extension is .txt, while all other files used by the
56 client have extensions .sah __***__
57
58
59 The file
60 !!RUNNING SETIATHOME
61
62
63 It is suggested that the user create a new directory, say,
64 ''/root/setiathome'' (henceforth referred to as SETIDIR)
65 and then cd into SETIDIR, before running __setiathome__
66 for the first time. The first time you run __setiathome__
67 it will interactively ask you for email address, name,
68 country etc. This info is stored in a file and no
69 interaction is needed when you run the program
70 subsequently.
71
72
73 After this you can run __setiathome__ in the background,
74 and direct its output to /dev/null if you like.
75
76
77 __setiathome__ can be freely aborted and restarted. It
78 saves its state in files, and will pick up where it left
79 off.
80
81
82 If you want __setiathome__ to be started automatically,
83 you may wish to setup a cron job. If you add the following
84 line to your crontab:
85
86
87 0 * * * * cd SETIDIR; setiathome -nice 19
88 (where SETIDIR is the directory chosen above - where you normally run the client program from), this cron job will attempt to start the client at the top of every hour. If it is already running, the next invocation will do nothing. If the client is not running, it will be started. For more information on cron jobs see the __crontab(1)__ manual page.
89
90
91 The following script will stop all instances
92 __SETI@home:__ (assuming the binary execution name is:
93 setiathome)
94
95
96 #! /bin/sh
97 kill `ps aux | grep setia | grep -v grep | awk '{print }'`
98 The following will stop the instance in the current directory:
99
100
101 #! /bin/sh
102 kill `cat pid.sah`
103 Please do not operate the client on machines for which you do not have permission.
104 !!ENVIRONMENT VARIABLES
105
106
107 If the environment variable HTTP_PROXY is defined,
108 setiathome will connect through a proxy server, specified as
109 hostname or hostname:port.
110
111
112 If the environment variable SOCKS_SERVER is defined,
113 setiathome will connect through a SOCKS server, specified as
114 hostname or hostname:port. If the environment variables
115 SOCKS_USER and SOCKS_PASSWD are defined, these will be used
116 as the login name and password for the SOCKS server.
117 Otherwise setiathome will query you.
118 !!OPTIONS
119
120
121 __-login__
122
123
124 Login or create new account.
125
126
127 __-countries__
128
129
130 Show list of country codes.
131
132
133 __-version__
134
135
136 show software version
137
138
139 __-nice N__
140
141
142 set
143
144
145 __-email__
146
147
148 Send email (to login email address) on errors. Useful if you
149 run in background directed to /dev/null.
150
151
152 __-graphics__
153
154
155 Generate a data stream for the xsetiathome graphical
156 interface (available from version 2). This option is not
157 available for all clients. The debian version of the
158 setiathome package currently does not install xsetiathome
159 currently, due to a X-library incompatibility of the
160 precompiled binary.
161
162
163 __-proxy hostname:port__
164
165
166 Connect to SETI@home server via specified proxy server and
167 port.
168
169
170 __-socks_server hostname:port__
171
172
173 Connect to SETI@home server via specified SOCKS server and
174 port. Overrides SOCKS_SERVER. SOCKS versions 4 and 5 are
175 supported.
176
177
178 __-socks_user name__
179
180
181 SOCKS user name.
182
183
184 __-socks_password password__
185
186
187 SOCKS password.
188
189
190 __-stop_after_process__
191
192
193 If a work_unit.sah file is present, process this work unit
194 and stop after processing is complete, do not return result.
195 If the client is started with this option, and there is a
196 completed result.sah file present, the client will first
197 return the results, then pick up a new work unit, process to
198 completion, then exit.
199
200
201 __-stop_after_xfer__
202
203
204 Return results and pick up a new work unit. This option only
205 functions if the result.sah file is present and complete
206 indicating that processing is finished for this work unit.
207 If a work_unit.sah is present, indicating processing is not
208 complete, no transfer or processing will be performed, and
209 the client will exit.
210
211
212 __-verbose__
213
214
215 print a running summary of the work being done. Starting
216 with the version 2.4 clients, the client is silent to stdout
217 during processing. There are messages at the start and
218 finish of processing a work unit, but there are no progress
219 messages printed during processing unless this option is
220 used.
221
222
223 __-nolock__
224
225
226 omit the multiple-instance check, which uses file locking
227 (not available on some NFS systems)
228 !!KNOWN BUGS:
229
230
231 Outstanding shared memory segments and semaphores may be
232 left active in case of an abnormal exit of the 'setiathome
233 -graphics' process. These can prevent any future invocation
234 of and 'ipcrm' to remove shared memory segments and
235 semaphores that are not associated with a process. This
236 behavior may vary depending upon how your UNIX system
237 handles this situation. See also __ipcs(1)__ and
238 __ipcrm(1)__
239
240
241 For version 3.0 clients, the estimated progress as indicated
242 by the prog= line in the state.sah file in not exactly
243 linear in relationship to completion time. Using this value
244 to predict completion time may not be completely accurate.
245 The linear relationship will vary depending upon the
246 characteristics of the work unit parameters.
247 !!SEE ALSO:
248
249
250 There is much more information to be found about the
251 operation of the client at the following WEB
252 sites:
253
254
255 http://setiathome.berkeley.edu/
256 http://setiathome.berkeley.edu/faq.html
257 http://setiathome.berkeley.edu/links.html
258 with discussions of add-on programs and scripts to control the client in various situations.
259 !!AUTHOR
260
261
262 This manual page was written by Gopal Narayanan
263 setiathome__ client program.
264 ----
This page is a man page (or other imported legacy content). We are unable to automatically determine the license status of this page.