1boinccmd(1) boinccmd(1)
2
6 boinccmd - command line interface to the BOINC core client
7
9 boinccmd [--host hostname[:port]] [--passwd passwd] {command}
10 boinccmd [-hV]
11 Notice that the order of the options is important. The --host and
13 --passwd options must precede any command.
14
16 The BOINC command tool (boinccmd) provides a command line interface to
17 a running BOINC core client (boinc(1)).
18
20 --host hostname[:port]
21 Connect to the host hostname. The default host is localhost.
22 --passwd passwd
24 Use passwd as password for RPC authentication. If the current
25 working directory contains a file gui_rpc_auth.cfg, boinccmd
26 will read the password from this file.
27 -h, --help
29 Show a help message and all commands.
30 -V, --version
32 Show the version of the program.
33
35 ACCOUNT QUERY AND ATTACH
36 --lookup_account URL email passwd
37 Look up account and print account key.
38 --create_account URL email passwd name
40 Create account with the given email address, password, and user
41 name.
42 --project_attach URL account_key
44 Attach to an account.
45 --join_acct_mgr URL name passwd
47 Attach to an account manager (or do RPC if already attached).
48 --quit_acct_mgr
50 Detach from the current account manager.
51 STATE QUERIES
53 --get_state
54 Show complete client state.
55 --get_results
57 Show all results.
58 --get_simple_gui_info
60 Show status of projects and active results.
61 --get_file_transfers
63 Show all current file transfers.
64 --get_project_status
66 Show status of all projects.
67 --get_disk_usage
69 Show disk usage of all projects.
70 --get_proxy_settings
72 Get proxy settings.
73 --get_messages seqno
75 Show messages with sequence numbers beyond seqno.
76 --get_host_info
78 Show system information about the host where the BOINC client is
79 running.
80 CONTROL OPERATIONS
82 --result URL result_name {suspend | resume | abort | graphics_window |
83 graphics_fullscreen} [ --desktop dt | --window_station ws | --display
84 dp ]
85 Do operation on a result.
86 suspend
88 Temporarily stop work on result.
89 resume Allow work on result.
91 abort Permanently stop work on result.
93 graphics_window
95 Open graphics in a window. The optional desktop / win‐
96 dow_station (Windows) or display (X11) arguments specify
97 the display.
98 graphics_fullscreen
100 Open graphics fullscreen.
101 --project URL {reset | detach | update | suspend | resume | nomorework
103 | allowmorework | detach_when_done}
104 Do operation on a project, identified by its master URL.
105 reset Delete current work and get more.
107 detach Delete current work and don't get more.
109 update Contact scheduling server.
111 suspend
113 Stop work for project.
114 resume Resume work for project.
116 nomorework
118 Finish current work but don't get more.
119 allowmorework
121 Undo nomorework.
122 detach_when_done
124 Detach project.
125 --file_transfer URL filename {retry | abort}
127 Do operation on a file transfer.
128 --set_run_mode {always | auto | never} [duration]
130 Set run mode.
131 always Do CPU work always.
133 auto Do work only when allowed by preferences.
135 never Don't do work.
137 If duration is zero or absent, this mode is permanent. Otherwise, after
139 duration seconds elapse, revert to last permanent mode.
140 --set_network_mode {always | auto | never} [duration]
142 Set network mode. Like --set_run_mode but applies to network
143 transfers only.
144 --set_proxy_settings http_server_name http_server_port http_user_name
146 http_user_passwd socks_server_name socks_server_port socks_version
147 socks5_user_name socks5_user_passwd
148 Set proxy settings. All fields are mandantory.
149 --run_benchmarks
151 Run CPU benchmarks.
152 --set_screensaver_mode {on | off} blank_time [ --desktop dt | --win‐
154 dow_station ws | --display dp ]
155 Tell the core client to start or stop doing fullscreen graphics,
156 and going to black after blank_time seconds. The optional argu‐
157 ments specify which desktop / windows_station (Windows) or dis‐
158 play (X11) to use.
159 --read_global_prefs_override
161 Tell the core client to read the global_prefs_override.xml file
162 and incorporate any global preferences indicated there.
163 --quit Tell the core client to quit.
165 --read_cc_config
167 Reread the configuration file (cc_config.xml).
168 --set_debts URL1 STD1 LTD1 [URL2 STD2 LTD2 ...]
170 Set the short- and long-term debts of one or more projects.
171 Note, if you adjust the debts of a single project, the debts of
172 other projects are changed. So if you want to set the debts of
173 multiple projects, do it in a single command.
174 --get_project_config URL
176 Fetch configuration at project located at URL.
177 --get_project_config_poll
179 --network_available
181 --get_cc_status
183
185 boinc(1), boincmgr(1)
186 ⟨http://boinc.berkeley.edu/wiki/Boinccmd_tool⟩
188
190 Copyright © 2007-2008 University of California.
191 Permission is granted to copy, distribute and/or modify this document
193 under the terms of the GNU Free Documentation License, Version 1.2 or
194 any later version published by the Free Software Foundation; with no
195 Invariant Sections, no Front-Cover Texts, and no Back-Cover Texts.
196 11 January 2008 boinccmd(1)