1boinc(1) boinc(1)
2
6 boinc - The BOINC client program.
7
9 boinc [options]
10
12 The BOINC "client", boinc, is the heart of BOINC. It controls which
13 project applications are run on your computer, downloading "Tasks" and
14 uploading the resulting files from completed tasks. boinc is usually
15 run in the background, ideally as a daemon. It can then be controlled
16 either by a graphical tool called the BOINC Manager, boincmgr(1), or a
17 command-line tool called boinccmd(1), by means of Remote Procedure
18 Calls (RPCs) over port 31416.
19 The BOINC client can be controlled by command-line options, configura‐
21 tion files, and environment variables. Standard usage is simply to
22 start the client running in the background.
23
25 These command-line options for boinc can be used to control how BOINC
26 is started. Once the client has started, you should use a separate pro‐
27 gram, (boincmgr(1) or boinccmd(1)) which communicates with it by means
28 of Remote Procedure Calls (RPCs).
29 GENERAL OPTIONS
31 --help Show options.
32 --version
34 Show version info.
35 --run_cpu_benchmarks
37 Run the CPU benchmarks.
38 --check_all_logins
40 For idle detection, check remote logins too.
41 --daemon
43 Run as daemon. Will redirect stderr and stdout to syslog.
44 --dir path
46 Use given dir as the client working directory.
47 --no_gpus
49 Don't check for GPUs.
50 --no_info_fetch
52 Don't fetch project list or client version info from
53 boinc.berkeley.edu.
54 --skip_cpu_benchmarks
56 Don't run CPU benchmarks.
57 --start_delay X
59 Delay starting apps for X secs.
60 PROJECT OPTIONS
62 --attach_project URL key
63 Attach to a project using URL and authenticator.
64 --show_projects
66 Show attached projects.
67 --detach_project URL
69 Detach from project specified by URL.
70 --reset_project URL
72 Reset (clear) the projectspecified by URL.
73 --update_prefs URL
75 Contact the project specified by URL to update preferences
76 COMMUNICATION OPTIONS
78 --allow_remote_gui_rpc
79 Allow RPC connections from remote hosts.
80 --gui_rpc_port port
82 Port for RPCs.
83 --no_gui_rpc
85 Omits creation of a socket as required for the remote control of
86 the client. Consequently the client cannot be controlled by ex‐
87 ternal tools like GUIs (boincmgr etc.) or the console command
88 tool (boinccmd).
89 DEBUGGING OPTIONS
91 --abort_jobs_on_exit
92 When client exits, abort and report tasks.
93 --allow_multiple_clients
95 Allow more than one client instance per host.
96 --exit_after_app_start N
98 Exit N seconds after an app starts. Useful to look at the files
99 in the slot directory.
100 --exit_after_finish
102 Exit right after finishing a task. Useful to look at the files
103 in the slot directory.
104 --exit_before_start
106 Exit right before starting a task. Useful to look at the files
107 in the slot directory.
108 --exit_before_upload
110 Exit right before starting an upload.
111 --exit_when_idle
113 Exit when there are no more tasks to work on.
114 --fetch_minimal_work
116 Fetch only 1 task per device.
117 --file_xfer_giveup_period N
119 Give up on file transfers after N sec.
120 --master_fetch_interval N
122 Limiting the period of project master file dowload retries.
123 --master_fetch_period N
125 Reload a project's master file after N RPC failures.
126 --master_fetch_retry_cap N
128 Exponential backoff limit for downloading project master files.
129 --no_priority_change
131 Run applications at same priority as client.
132 --pers_giveup N
134 Giveup time for persistent file transfer errors.
135 --pers_retry_delay_max N
137 Maximum time (sec) for file transfer exponential backoff.
138 --pers_retry_delay_min N
140 Minimum time (sec) for file transfer exponential backoff.
141 --redirectio
143 Redirect stdout and stderr to log files (stdoutdae.txt and
144 stderrdae.txt).
145 --retry_cap N
147 Limit the maximum exponential backoff time.
148 --sched_retry_delay_max N
150 Maximum time (sec) for project RPC exponential backoff.
151 --sched_retry_delay_min N
153 Minimum time (sec) for project RPC exponential backoff.
154 --unsigned_apps_ok
156 Allow unsigned apps (for testing).
157
159 By default the client accepts GUI RPC connections only from programs on
160 the same host, which means that any user on this host can control the
161 client.
162
164 boinccmd(1), boincmgr(1)
165 ⟨https://boinc.berkeley.edu/wiki/
167 Client_configuration#Command-line_options⟩
168
170 Copyright © 2007-2020 University of California.
171 Permission is granted to copy, distribute and/or modify this document
173 under the terms of the GNU Free Documentation License, Version 1.2 or
174 any later version published by the Free Software Foundation; with no
175 Invariant Sections, no Front-Cover Texts, and no Back-Cover Texts.
176 03 February 2020 boinc(1)