← Back to branch summary

~ubuntu-branches/ubuntu/precise/boinc/precise

« back to all changes in this revision

Viewing changes to packages/solaris/CSW/boincclient/boinc_cmd.1

Tags: 6.12.8+dfsg-1
* New upstream release.
* Simplified debian/rules

Show diffs side-by-side

added added

removed removed

Lines of Context:
packages/solaris/CSW/boincclient/boinc_cmd.1
 
1
.\"  Unix Manual Pages for boinc_cmd
 
2
.\"======================================================================
 
3
.\" This file is a part of BOINC.  Distribution and/or modifications
 
4
.\" are allowed under the terms of the Lesser GNU Public License
 
5
.\" See the file COPYING for details.
 
6
.\"======================================================================
 
7
.\"  To view this file without the man command type: 
 
8
.\"         'nroff -man boinc.1 | more'
 
9
.\"  or, on some versions of man, just man -l boinc.1
 
10
.\"
 
11
.\" @(#) $Id: boinc_cmd.1,v 1.1 2007/12/29 16:50:10 myers Exp $
 
12
.TH boinc_cmd 1  "29 December 2007"  "BOINC 5.10"  "User Manuals"
 
13
 
 
14
.SH SYNOPSIS
 
15
.br
 
16
.sp
 
17
.in +2
 
18
.B boinc_cmd  
 
19
boinc_cmd [--host hostname] [--passwd passwd] --command
 
20
.in -2
 
21
.br
 
22
.sp
 
23
 
 
24
.SH DESCRIPTION
 
25
.B boinc_cmd
 
26
issues a command to the running BOINC client core, which should already be running as
 
27
a background daemon.   See
 
28
.BR boinc_client (1)
 
29
for more information about the core client.
 
30
 
 
31
 
 
32
.SH COMMAND OPTIONS
 
33
 
 
34
These command-line commands for 
 
35
.B boinc_cmd
 
36
can be used to control the running core client.
 
37
 
 
38
.SS  Core Client Connection 
 
39
Controlling the connection to the core client:
 
40
 
 
41
.TP
 
42
.B  --host hostname[:port]
 
43
The host to connect to (default: localhost) .
 
44
 
 
45
.TP
 
46
.B  --passwd
 
47
The password for RPC authentication (default: 
 
48
.B boinc_cmd 
 
49
will look
 
50
for a file named
 
51
.I gui_rpc_auth.cfg 
 
52
in the current directory and use the password it contains).
 
53
 
 
54
 
 
55
.SS  Account Query and Attach 
 
56
Query or control account information for the core client:
 
57
 
 
58
.TP
 
59
.B --lookup_account URL email password
 
60
Look up account and print account key. 
 
61
[New in 5.8.16]
 
62
 
 
63
.TP
 
64
.B --create_account URL email password name
 
65
Create account with the given email address, password, and user name.
 
66
 
 
67
.TP
 
68
.B --project_attach URL auth
 
69
Attach the core client to the project associated with the URL,
 
70
using the authentication token (account key)
 
71
 
 
72
.TP
 
73
.B  --join_acct_mgr URL name password
 
74
Attach to an account manager (or do RPC if already attached). 
 
75
[ New in 5.10]
 
76
 
 
77
.TP
 
78
.B --quit_acct_mgr
 
79
Detach from the current account manager. 
 
80
[New in 5.10] 
 
81
 
 
82
 
 
83
.SS State Queries
 
84
Querying the core client for information about its current running state:
 
85
 
 
86
.TP
 
87
.B --get_state
 
88
Show complete client state 
 
89
 
 
90
.TP
 
91
.B --get_results
 
92
Show results 
 
93
 
 
94
.TP
 
95
.B --get_simple_gui_info
 
96
Show projects and active results 
 
97
 
 
98
.TP 
 
99
.B --get_file_transfers
 
100
Show file transfers 
 
101
 
 
102
.TP
 
103
.B --get_project_status
 
104
Show status of all projects 
 
105
 
 
106
.TP
 
107
.B --get_disk_usage
 
108
Show disk usage by project 
 
109
 
 
110
.TP 
 
111
.B --get_proxy_settings
 
112
Get proxy settings 
 
113
 
 
114
.TP
 
115
.B --get_messages seqno
 
116
Show messages with sequence numbers beyond the given seqno 
 
117
 
 
118
.TP
 
119
.B --get_host_info
 
120
Show host info 
 
121
 
 
122
.TP
 
123
.B --get_screensaver_mode
 
124
Return the current screensaver mode (is it active or not?)
 
125
 
 
126
.TP
 
127
.B --version, -V
 
128
Show core client software version.
 
129
 
 
130
 
 
131
 
 
132
.SS Control Operations
 
133
Controlling the core client:
 
134
 
 
135
.TP 8
 
136
.TP 
 
137
.B --result URL result_name operation 
 
138
Perform an operation on a Result, identified by the project master URL and
 
139
the Result name.  
 
140
Operations:
 
141
.IP
 
142
.I suspend 
 
143
- temporarily stop work on the Result
 
144
.IP
 
145
.I resume
 
146
- allow work on result
 
147
.IP
 
148
.I abort: permanently stop work on result
 
149
.IP
 
150
.I graphics_window
 
151
- open graphics in a window. The optional
 
152
desktop/window_station (Windows) or display (X11) arguments specify
 
153
the display.
 
154
.IP 
 
155
.I graphics_fullscreen
 
156
- open graphics fullscreen 
 
157
 
 
158
.TP
 
159
.B --project URL operation
 
160
 Do operation on a project, identified by its master
 
161
URL. Operations:
 
162
 
 
163
.IP 
 
164
.I  reset
 
165
- delete current work and get more;
 
166
.IP
 
167
.I  detach
 
168
- delete current work and don't get more;
 
169
.IP
 
170
.I  update
 
171
- contact scheduling server;
 
172
.IP
 
173
.I  suspend
 
174
- stop work for project;
 
175
.IP
 
176
.I  result
 
177
- resume work for project;
 
178
.IP
 
179
.I  nomorework
 
180
- finish current work but don't get more;
 
181
.IP
 
182
.I  allowmorework
 
183
- undo nomorework
 
184
.IP
 
185
.I  detach_when_done
 
186
- detach project 
 
187
 
 
188
 
 
189
.TP
 
190
.B  --set_proxy_settings http_server_name http_server_port \
 
191
http_user_name http_user_passwd socks_server_name socks_server_port \
 
192
socks_version socks5_user_name socks5_user_passwd
 
193
Set proxy settings (all fields are mandatory) 
 
194
 
 
195
.TP
 
196
.B --run_benchmarks
 
197
Run CPU benchmarks 
 
198
 
 
199
.TP
 
200
.B --set_screensaver_mode on|off blank_time [ --display display ]
 
201
Tell the core client to start or stop doing fullscreen graphics,
 
202
and going to black after blank_time seconds. The optional arguments
 
203
specify which desktop/windows_station (Windows) or display (X11) to
 
204
use. 
 
205
 
 
206
.TP
 
207
.B --read_global_prefs_override
 
208
Tell the core client to read the global_prefs_override.xml file,
 
209
and incorporate any global preferences indicated there. 
 
210
 
 
211
.TP
 
212
.B --quit
 
213
Tell the core client to quit 
 
214
 
 
215
.TP
 
216
.B --read_cc_config
 
217
Reread the configuration file (cc_config.xml) 
 
218
 
 
219
.TP
 
220
.B   --set_debts URL1 STD1 LTD1 [ URL2 STD2 LTD2 ... ]
 
221
Set the short- and long-term debts of one or more projects. Note:
 
222
if you adjust the debts of a single project, the debts of other
 
223
projects are changed. So if you want to set the debts of multiple
 
224
projects, do it in a single command. 
 
225
[New in 5.10.11]
 
226
 
 
227
.SS Miscellaneous 
 
228
.TP
 
229
.B --help, -h
 
230
Show options and commands
 
231
 
 
232
 
 
233
.SH SEE ALSO
 
234
.BR boinc (1),
 
235
.BR boinc_client (1),
 
236
.BR boincmgr (1).
 
237
 
 
238
.SH VERSION
 
239
.de VL
 
240
 
 
241
B\\$2
 
242
..
 
243
Revision Number: 5.10.21-18 
 
244
.br
 
245
Release Date: 29 Dec 2007 
 
246
 
 
247
.end