1boinccmd(1)                                                        boinccmd(1)
2
3
4

NAME

6       boinccmd - The command line interface to the BOINC client.
7

SYNOPSIS

9       boinccmd [--host hostname[:port]] [--passwd passwd] {command}
10       boinccmd [-hV]
11
12       Notice  that  the  order  of  the  options is important. The --host and
13       --passwd options must precede any command.
14

DESCRIPTION

16       The BOINC command tool (boinccmd) provides a command line interface  to
17       control  a running BOINC client (boinc(1)). It communicates with a run‐
18       ning client using port 31416 over TCP/IP. It can only  connect  to  one
19       client at a time.
20

OPTIONS

22       --host hostname[:port]
23              Connect to the host hostname.  The default host is localhost.
24
25       --passwd passwd
26              Use  passwd  as  password for RPC authentication. If the current
27              working directory contains  a  file  gui_rpc_auth.cfg,  boinccmd
28              will read the password from this file.
29
30       -h, --help
31              Show a help message and all commands.
32
33       -V, --version
34              Show the version of the program.
35

COMMANDS

37   ACCOUNT QUERY AND ATTACH
38       --lookup_account URL email passwd
39              Look up account and print account key.
40
41       --create_account URL email passwd name
42              Create  account with the given email address, password, and user
43              name.
44
45       --project_attach URL account_key
46              Attach to an account using the  project  URL  and  authenticator
47              (send via email after --create_account was successful).
48
49       --join_acct_mgr URL name passwd
50              Attach  to  an  account manager (or do RPC if already attached).
51              The account has to be created via the account manager website.
52
53       --quit_acct_mgr
54              Detach from the current account manager.
55
56   STATE QUERIES
57       --get_state
58              Show complete client state.
59
60       --get_cc_status
61              Show only current CPU, GPU and network modes.
62
63       --get_tasks
64              Show all tasks of the client (in progress, waiting and completed
65              only).  Tasks  that where reported to the project server are not
66              shown here.
67
68       --get_simple_gui_info
69              Show status of projects and active tasks.
70
71       --get_file_transfers
72              Show all current file transfers.
73
74       --get_project_status
75              Show status of all projects.
76
77       --get_disk_usage
78              Show disk usage of all projects.
79
80       --get_proxy_settings
81              Get proxy settings.
82
83       --get_messages seqno
84              Show messages with sequence numbers beyond seqno.
85
86       --get_message_count
87              Show largest message sequence number.
88
89       --get_notices seqno
90              Show project notices with sequence numbers beyond seqno.
91
92       --get_host_info
93              Show system information about the host where the BOINC client is
94              running.
95
96       --get_daily_xfer_history
97              Show network traffic history of the BOINC client.
98
99   CONTROL OPERATIONS
100       --task URL task_name {suspend | resume | abort}
101              Do operation on a task.
102
103              suspend
104                     Temporarily stop work on task.
105
106              resume Allow work on task.
107
108              abort  Permanently stop work on task.
109
110       --project  URL {reset | detach | update | suspend | resume | nomorework
111       | allowmorework | detach_when_done | dont_detach_when_done}
112              Do operation on a project, identified by its master URL.
113
114              reset  Delete current tasks, applications and other  files  from
115                     this project, request new tasks.
116
117              detach Delete  current  tasks  applications and other files from
118                     this project, don't request any new tasks.
119
120              update Contact project scheduling server.
121
122              suspend
123                     Stop all tasks for project.
124
125              resume Resume tasks for project.
126
127              nomorework
128                     Finish all downloaded tasks but don't get more.
129
130              allowmorework
131                     Undo nomorework.
132
133              detach_when_done
134                     Detach project after all tasks are finished.
135
136              dont_detach_when_done
137                     Undo detach_when_done.
138
139       --file_transfer URL filename {retry | abort}
140              Do operation on a file transfer.
141
142              retry  Retry file transfer.
143
144              abort  Permanently abort file transfer.
145
146       --set_run_mode {always | auto | never} [duration]
147              Set run mode (applies to CPU and GPU).
148
149              always Do work always.
150
151              auto   Do work only when allowed by preferences.
152
153              never  Don't do work.
154
155       If duration is zero or absent, this mode is permanent. Otherwise, after
156       duration seconds elapse, revert to last permanent mode.
157
158       --set_network_mode {always | auto | never} [duration]
159              Set  network  mode.  Like  --set_run_mode but applies to network
160              transfers only.
161
162       --set_gpu_mode {always | auto | never} [duration]
163              Set GPU mode. Like --set_run_mode but applies to GPU  processing
164              only.
165
166       --set_proxy_settings  http_server_name  http_server_port http_user_name
167       http_user_passwd socks_server_name  socks_server_port  socks5_user_name
168       socks5_user_passwd noproxy_hosts
169              Set proxy settings. All fields are mandatory.
170
171       --run_benchmarks
172              Run CPU benchmarks.
173
174       --read_global_prefs_override
175              Tell  the  client to read the global_prefs_override.xml file and
176              incorporate any global preferences indicated there.
177
178       --quit Tell the client to quit.
179
180       --read_cc_config
181              Tell the  client  to  reread  the  configuration  file  (cc_con‐
182              fig.xml).
183
184       --get_project_config URL
185              Fetch configuration of project located at URL.
186
187       --network_available
188              Tell the client to retry deferred network communication.
189

SEE ALSO

191       boinc(1), boincmgr(1)
192
193https://boinc.berkeley.edu/wiki/Boinccmd_tool
194
196       Copyright © 2007-2019 University of California.
197
198       Permission  is  granted to copy, distribute and/or modify this document
199       under the terms of the GNU Free Documentation License, Version  1.2  or
200       any  later  version  published by the Free Software Foundation; with no
201       Invariant Sections, no Front-Cover Texts, and no Back-Cover Texts.
202
203
204
205                                 08 April 2019                     boinccmd(1)
Impressum