1boinc_cmd(1) User Manuals boinc_cmd(1)
2
6 boinc_client [options]
7
11 The BOINC "core client", boinc_client, is the heart of BOINC. It con‐
12 trols which project applications are run on your computer, downloading
13 "Workunits" and uploading the "Result" files from completed tasks.
14 boinc_client is usually run in the background, ideally as a daemon. It
15 can then be controlled either by a graphical tool called the BOINC Man‐
16 ager, boincmgr(1), or a command line tool called boinc_cmd(1), by means
17 of Remote Proceedure Calls (RPCs) over port 31416.
18 The BOINC core client can be controlled by command-line options, con‐
21 figuration files, and environment variables. Standard usage is simply
22 to start the client running in the background.
23
27 BOINC uses the following configuration files. You can edit these files
28 before launching boinc_client to control BOINC in various ways.
29 account_<PROJECT-URL>.xml
32 Accounting information for a given project. There will be one
33 for each attached project.
34 global_prefs_override.xml
37 Override global preferences
38 cc_config.xml
41 Turn log messages on/off by category, and other core client con‐
42 figuration options. These settings can be very useful for trou‐
43 bleshooting problems or debugging.
44 remote_hosts.cfg
47 Hosts from which remote GUI RPCs are allowed. If this file does
48 not exist then...?
49 gui_rpc_auth.cfg
52 GUI RPC password.
53 project_init.xml
56 Startup project ...?
57 acct_mgr_url.xml
60 Account manager URL
61 acct_mgr_login.xml
64 Account manager login
65
70 These command-line options for boinc_client can be used to control how
71 BOINC is started. Once the client has started, you should use a sepa‐
72 rate program, (boincmgr(1) or boinc_cmd(1)) which communicates with it
73 by means of Remote Proceedure Calls (RPCs).
74 --help Show these command line options.
78 --version
81 Show client software version.
82 --show_projects
85 Show all attached projects.
86 --detach_project <URL>
89 Detach from the project associated with the given URL.
90 --reset_project <URL>
93 Reset (clear) the project associated with the given URL
94 --attach_project <URL> <key>
97 Attach to the project associated with the given URL. The key is
98 the authenthentication token (account key) of an existing
99 account on the project.
100 --update_prefs <URL>
103 Contact the project associated with the given URL to update
104 preferences.
105 --run_cpu_benchmarks
108 Run the CPU benchmarks.
109 --check_all_logins
112 For idle detection, check remote logins too. When BOINC is set
113 to run when the computer is idle, it usually only checks for
114 user activity from locally logged-in user. This causes it to
115 also check for activity from remote logins.f
116 --allow_remote_gui_rpc
119 Allow remote GUI RPC connections.
120 --gui_rpc_port <port>
123 Set the port for GUI RPCs. The default, if not otherwise set,
124 is port 31416.
125 --redirectio
128 Redirect stdout and stderr to log files.
129 --detach
132 Detach from console (Windows only)
133 --dir <path>
136 Use the given directory as the BOINC home (working directory).
137 --no_gui_rpc
140 Do not allow GUI RPCs, don't make socket.
141 --daemon
144 Run as daemon, in the background (Unix only).
145 --insecure
148 Disable application sandboxing (Unix only).
149 --launched_by_manager
152 Indicates that the Core Client was launched by the BOINC Man‐
153 ager.
154 --run_by_updater
157 Indicates that the Core Client was launched by the updater.
158 --start_delay N
161 Specify a number of seconds to delay running apps after client
162 startup [New in version 6.1.]
163
168 The boinc_client uses the following Unix environment variables to con‐
169 trol how it deals with web proxies.
170 HTTP_PROXY
173 URL of HTTP proxy
174 HTTP_USER_NAME
177 User name for proxy authentication
178 HTTP_USER_PASSWD
181 Password for proxy authentication
182 SOCKS4_SERVER
184 URL of SOCKS 4 server
185 SOCKS5_SERVER
188 URL of SOCKS 5 server
189 SOCKS5_USER
192 User name for SOCKS authentication
193 SOCKS5_PASSWD
196 Password for SOCKS authentication
197
201 These command line options are usually only of use for troubleshooting
202 or debugging.
203 --exit_when_idle
206 Exit when there are no more results to process.
207 --exit_before_start
210 Exit right before starting a job (useful for debugging).
211 --exit_after_finish
214 Exit right after finishing a task (useful for debugging).
215 --no_time_test
218 Don't run performance benchmarks; use fixed numbers instead.
219 --exit_after_app_start N
222 Exit about N seconds after first application starts
223 --min Put client in the background after starting up
226 --skip_cpu_benchmarks
229 Don't run CPU benchmarks
230 --file_xfer_giveup_period N
233 Specify giveup period for file transfers
234 --started_by_screensaver
237 Passed by screensaver when it launches client
238
243 boinc(1), boincmgr(1), boinc_cmd(1).
244
247 Revision Number: 5.10.21-18
248 Release Date: 29 Dec 2007
249BOINC 5.10 29 December 2007 boinc_cmd(1)