← Back to branch summary

~ubuntu-branches/ubuntu/precise/boinc/precise

« back to all changes in this revision

Viewing changes to packages/solaris/CSW/boincclient/boinc_client.1

Tags: 6.12.8+dfsg-1
* New upstream release.
* Simplified debian/rules

Show diffs side-by-side

added added

removed removed

Lines of Context:
packages/solaris/CSW/boincclient/boinc_client.1
 
1
.\"  Unix Manual page for boinc_client
 
2
.\"======================================================================
 
3
.\" This file is a part of BOINC.  Distribution and/or modifications
 
4
.\" are allowed under the terms of the Lesser GNU Public License.
 
5
.\" See the file COPYING for details.
 
6
.\"======================================================================
 
7
.\"  To view this file without the man command type: 
 
8
.\"         'nroff -man boinc.1 | more'
 
9
.\"  or, on some versions of man, just man -l boinc.1
 
10
.\"
 
11
.\" @(#) $Id: boinc_client.1,v 1.1 2007/12/29 16:50:09 myers Exp $
 
12
.TH boinc_cmd 1  "29 December 2007"  "BOINC 5.10"  "User Manuals"
 
13
 
 
14
.SH SYNOPSIS
 
15
.br
 
16
.sp
 
17
.in +2
 
18
.B boinc_client  
 
19
[options]
 
20
.in -2
 
21
.br
 
22
.sp
 
23
 
 
24
.SH DESCRIPTION
 
25
 
 
26
The BOINC "core client", 
 
27
.BR boinc_client ,
 
28
is the heart of BOINC.
 
29
It controls which project applications are run on your computer, 
 
30
downloading "Workunits" and uploading the "Result" files from
 
31
completed tasks.
 
32
.B boinc_client
 
33
is usually run in the background, ideally as a daemon.
 
34
It can then be controlled either by a graphical tool
 
35
called the BOINC Manager,
 
36
.BR boincmgr (1),
 
37
or a command line tool called
 
38
.BR boinc_cmd (1),
 
39
by means of Remote Proceedure Calls (RPCs) over port 31416.
 
40
 
 
41
.PP
 
42
 
 
43
The BOINC core client can be controlled by command-line options,
 
44
configuration files, and environment variables.
 
45
Standard usage is simply to start the client running in the
 
46
background.
 
47
 
 
48
 
 
49
.SH CONFIGURATION FILES
 
50
 
 
51
BOINC uses the following configuration files.
 
52
You can edit these files before launching
 
53
.B boinc_client
 
54
to control BOINC in various ways.
 
55
 
 
56
.TP 
 
57
.I account_<PROJECT-URL>.xml 
 
58
Accounting information for a given project.
 
59
There will be one for each attached project. 
 
60
 
 
61
.TP
 
62
.I global_prefs_override.xml
 
63
Override global preferences 
 
64
 
 
65
.TP
 
66
.I cc_config.xml
 
67
Turn log messages on/off by category, and other core client
 
68
configuration options. 
 
69
These settings can be very useful for troubleshooting problems or debugging.
 
70
 
 
71
.TP
 
72
.I remote_hosts.cfg
 
73
Hosts from which remote GUI RPCs are allowed.   
 
74
If this file does not exist then...?
 
75
 
 
76
.TP
 
77
.I gui_rpc_auth.cfg
 
78
GUI RPC password. 
 
79
 
 
80
.TP
 
81
.I project_init.xml
 
82
Startup project ...?
 
83
 
 
84
.TP
 
85
.I acct_mgr_url.xml
 
86
Account manager URL 
 
87
 
 
88
.TP
 
89
.I acct_mgr_login.xml
 
90
Account manager login
 
91
 
 
92
 
 
93
 
 
94
.SH COMMAND OPTIONS
 
95
 
 
96
These command-line options for 
 
97
.B boinc_client
 
98
can be used to control how BOINC is started.
 
99
Once the client has started, 
 
100
you should use a separate program, 
 
101
.RB ( boincmgr (1)
 
102
or
 
103
.BR boinc_cmd (1))
 
104
which communicates with it by means of Remote Proceedure Calls (RPCs).
 
105
 
 
106
 
 
107
.TP
 
108
.B    --help
 
109
Show these command line options.
 
110
 
 
111
.TP
 
112
.B    --version  
 
113
Show client software version.   
 
114
 
 
115
.TP
 
116
.B    --show_projects  
 
117
Show all attached projects.
 
118
 
 
119
.TP
 
120
.B    --detach_project <URL>    
 
121
Detach from the project associated with the given URL.
 
122
 
 
123
.TP
 
124
.B    --reset_project <URL>    
 
125
Reset (clear) the project associated with the given URL
 
126
 
 
127
.TP
 
128
.B    --attach_project <URL> <key>    
 
129
Attach to the project associated with the given URL.
 
130
The 
 
131
.B key 
 
132
is the authenthentication token (account key)
 
133
of an existing account on the project.
 
134
 
 
135
.TP
 
136
.B    --update_prefs <URL>   
 
137
Contact the project associated with the given URL
 
138
to update preferences.
 
139
 
 
140
.TP
 
141
.B    --run_cpu_benchmarks
 
142
Run the CPU benchmarks.
 
143
 
 
144
.TP
 
145
.B    --check_all_logins      
 
146
For idle detection, check remote logins too.
 
147
When BOINC is set to run when the computer is idle, it usually only
 
148
checks for user activity from locally logged-in user.
 
149
This causes it to also check for activity from remote logins.f
 
150
 
 
151
.TP
 
152
.B    --allow_remote_gui_rpc          
 
153
Allow remote GUI RPC connections.
 
154
 
 
155
.TP
 
156
.B    --gui_rpc_port <port>    
 
157
Set the port for GUI RPCs.
 
158
The default, if not otherwise set, is port 31416.
 
159
 
 
160
.TP
 
161
.B    --redirectio                
 
162
Redirect stdout and stderr to log files.
 
163
 
 
164
.TP
 
165
.B    --detach          
 
166
Detach from console (Windows only)
 
167
 
 
168
.TP
 
169
.B    --dir <path>         
 
170
Use the given directory as the BOINC home (working directory).
 
171
 
 
172
.TP
 
173
.B    --no_gui_rpc   
 
174
Do not allow GUI RPCs, don't make socket.
 
175
 
 
176
.TP
 
177
.B    --daemon                        
 
178
Run as daemon, in the background (Unix only).
 
179
 
 
180
.TP
 
181
.B    --insecure                      
 
182
Disable application sandboxing (Unix only).
 
183
 
 
184
.TP
 
185
.B    --launched_by_manager           
 
186
Indicates that the Core Client was launched by the BOINC Manager.
 
187
 
 
188
.TP
 
189
.B    --run_by_updater          
 
190
Indicates that the Core Client was launched by the updater.
 
191
 
 
192
.TP
 
193
.B --start_delay N
 
194
Specify a number of seconds to delay running apps after client startup 
 
195
[New in version 6.1.]
 
196
 
 
197
 
 
198
 
 
199
.SH ENVIRONMENT
 
200
The 
 
201
.B boinc_client
 
202
uses the following Unix environment variables to control
 
203
how it deals with web proxies.
 
204
 
 
205
.TP
 
206
.B HTTP_PROXY
 
207
URL of HTTP proxy 
 
208
 
 
209
.TP
 
210
.B HTTP_USER_NAME
 
211
User name for proxy authentication 
 
212
 
 
213
.TP
 
214
.B HTTP_USER_PASSWD
 
215
Password for proxy authentication 
 
216
.TP
 
217
.B SOCKS4_SERVER
 
218
URL of SOCKS 4 server 
 
219
 
 
220
.TP
 
221
.B SOCKS5_SERVER
 
222
URL of SOCKS 5 server 
 
223
 
 
224
.TP
 
225
.B SOCKS5_USER
 
226
User name for SOCKS authentication 
 
227
 
 
228
.TP
 
229
.B SOCKS5_PASSWD
 
230
Password for SOCKS authentication
 
231
 
 
232
 
 
233
.SH DEBUGGING OPTIONS
 
234
These command line options are usually only of use for
 
235
troubleshooting or debugging.
 
236
 
 
237
.TP
 
238
.B    --exit_when_idle    
 
239
Exit when there are no more results to process.
 
240
 
 
241
.TP
 
242
.B    --exit_before_start             
 
243
Exit right before starting a job (useful for debugging).
 
244
 
 
245
.TP
 
246
.B    --exit_after_finish       
 
247
Exit right after finishing a task (useful for debugging).
 
248
 
 
249
.TP
 
250
.B --no_time_test
 
251
Don't run performance benchmarks; use fixed numbers instead. 
 
252
 
 
253
.TP
 
254
.B --exit_after_app_start N
 
255
Exit about N seconds after first application starts 
 
256
 
 
257
.TP
 
258
.B --min
 
259
Put client in the background after starting up 
 
260
 
 
261
.TP
 
262
.B --skip_cpu_benchmarks
 
263
Don't run CPU benchmarks 
 
264
 
 
265
.TP
 
266
.B --file_xfer_giveup_period N
 
267
Specify giveup period for file transfers 
 
268
 
 
269
.TP
 
270
.B --started_by_screensaver
 
271
Passed by screensaver when it launches client
 
272
 
 
273
 
 
274
 
 
275
.SH SEE ALSO
 
276
.BR boinc (1),
 
277
.BR boincmgr (1),
 
278
.BR boinc_cmd (1).
 
279
 
 
280
.SH VERSION
 
281
.de VL
 
282
\\$2
 
283
..
 
284
Revision Number: 5.10.21-18 
 
285
.br
 
286
Release Date: 29 Dec 2007 
 
287
 
 
288
.end