boinc_cmd(1)

1boinc_cmd(1)                     User Manuals                     boinc_cmd(1)
2
3
4

SYNOPSIS

6         boinc_cmd boinc_cmd [--host hostname] [--passwd passwd] --command
7
8
9

DESCRIPTION

11       boinc_cmd  issues  a  command  to  the running BOINC client core, which
12       should already be running as a background daemon.   See boinc_client(1)
13       for more information about the core client.
14
15
16

COMMAND OPTIONS

18       These  command-line  commands  for boinc_cmd can be used to control the
19       running core client.
20
21
22   Core Client Connection
23       Controlling the connection to the core client:
24
25
26       --host hostname[:port]
27              The host to connect to (default: localhost) .
28
29
30       --passwd
31              The password for RPC  authentication  (default:  boinc_cmd  will
32              look  for a file named gui_rpc_auth.cfg in the current directory
33              and use the password it contains).
34
35
36
37   Account Query and Attach
38       Query or control account information for the core client:
39
40
41       --lookup_account URL email password
42              Look up account and print account key.  [New in 5.8.16]
43
44
45       --create_account URL email password name
46              Create account with the given email address, password, and  user
47              name.
48
49
50       --project_attach URL auth
51              Attach  the  core client to the project associated with the URL,
52              using the authentication token (account key)
53
54
55       --join_acct_mgr URL name password
56              Attach to an account manager (or do RPC if already attached).  [
57              New in 5.10]
58
59
60       --quit_acct_mgr
61              Detach from the current account manager.  [New in 5.10]
62
63
64
65   State Queries
66       Querying  the  core  client  for  information about its current running
67       state:
68
69
70       --get_state
71              Show complete client state
72
73
74       --get_results
75              Show results
76
77
78       --get_simple_gui_info
79              Show projects and active results
80
81
82       --get_file_transfers
83              Show file transfers
84
85
86       --get_project_status
87              Show status of all projects
88
89
90       --get_disk_usage
91              Show disk usage by project
92
93
94       --get_proxy_settings
95              Get proxy settings
96
97
98       --get_messages seqno
99              Show messages with sequence numbers beyond the given seqno
100
101
102       --get_host_info
103              Show host info
104
105
106       --get_screensaver_mode
107              Return the current screensaver mode (is it active or not?)
108
109
110       --version, -V
111              Show core client software version.
112
113
114
115
116   Control Operations
117       Controlling the core client:
118
119
120
121       --result URL result_name operation
122               Perform an operation on  a  Result,  identified  by  the
123               project master URL and the Result name.  Operations:
124
125               suspend - temporarily stop work on the Result
126
127               resume - allow work on result
128
129               abort: permanently stop work on result
130
131               graphics_window   -  open  graphics  in  a  window.  The
132               optional  desktop/window_station  (Windows)  or  display
133               (X11) arguments specify the display.
134
135               graphics_fullscreen - open graphics fullscreen
136
137
138       --project URL operation
139                Do  operation  on  a  project, identified by its master
140               URL. Operations:
141
142
143               reset - delete current work and get more;
144
145               detach - delete current work and don't get more;
146
147               update - contact scheduling server;
148
149               suspend - stop work for project;
150
151               result - resume work for project;
152
153               nomorework - finish current work but don't get more;
154
155               allowmorework - undo nomorework
156
157               detach_when_done - detach project
158
159
160
161       --set_proxy_settings      http_server_name      http_server_port
162       http_user_name         http_user_passwd        socks_server_name
163       socks_server_port         socks_version         socks5_user_name
164       socks5_user_passwd
165               Set proxy settings (all fields are mandatory)
166
167
168       --run_benchmarks
169               Run CPU benchmarks
170
171
172       --set_screensaver_mode on|off blank_time [ --display display ]
173               Tell  the  core client to start or stop doing fullscreen
174               graphics, and going to black after  blank_time  seconds.
175               The   optional   arguments  specify  which  desktop/win‐
176               dows_station (Windows) or display (X11) to use.
177
178
179       --read_global_prefs_override
180               Tell the core  client  to  read  the  global_prefs_over‐
181               ride.xml  file,  and  incorporate any global preferences
182               indicated there.
183
184
185       --quit  Tell the core client to quit
186
187
188       --read_cc_config
189               Reread the configuration file (cc_config.xml)
190
191
192       --set_debts URL1 STD1 LTD1 [ URL2 STD2 LTD2 ... ]
193               Set the short-  and  long-term  debts  of  one  or  more
194               projects.  Note:  if  you  adjust  the debts of a single
195               project, the debts of other projects are changed. So  if
196               you want to set the debts of multiple projects, do it in
197               a single command.  [New in 5.10.11]
198
199
200   Miscellaneous
201       --help, -h
202              Show options and commands
203
204
205

VERSION

211       Revision Number: 5.10.21-18
212       Release Date: 29 Dec 2007
213
214
215
216
217BOINC 5.10                     29 December 2007                   boinc_cmd(1)

SYNOPSIS

DESCRIPTION

COMMAND OPTIONS

SEE ALSO

VERSION