← Back to branch summary

~ubuntu-branches/ubuntu/lucid/boinc/lucid

« back to all changes in this revision

Viewing changes to doc/manpages/boinccmd.xml

  • Committer: Bazaar Package Importer
  • Author(s): Frank S. Thomas, Frank S. Thomas
  • Date: 2008-05-31 08:02:47 UTC
  • mfrom: (1.1.8 upstream)
  • Revision ID: james.westby@ubuntu.com-20080531080247-4ce890lp2rc768cr
Tags: 6.2.7-1
http://bugs.debian.org/463823
[ Frank S. Thomas ]
* New upstream release.
  - BOINC Manager: Redraw disk usage charts immediately after connecting to
    a (different) client. (closes: 463823)
* debian/copyright:
  - Added the instructions from debian/README.Debian-source about how
    repackaged BOINC tarballs can be reproduced because DevRef now
    recommends to put this here instead of in the afore-mentioned file.
  - Updated for the new release.
* Removed the obsolete debian/README.Debian-source.
* For consistency upstream renamed the core client and the command tool
  ("boinc_client" to "boinc" and "boinc_cmd" to "boinccmd"). Done the same
  in all packages and created symlinks with the old names for the binaries
  and man pages. Also added an entry in debian/boinc-client.NEWS explaining
  this change.
* debian/rules: Do not list Makefile.ins in the clean target individually,
  just remove all that can be found.

Show diffs side-by-side

added added

removed removed

Lines of Context:
doc/manpages/boinccmd.xml
 
1
<?xml version="1.0" encoding="UTF-8"?>
 
2
 
 
3
<!--
 
4
 This is the manual page for boinccmd, a command tool that provides an
 
5
 interactive command-line interface for the core client.
 
6
 
 
7
 Copyright © 2007-2008 University of California
 
8
 
 
9
 Permission is granted to copy, distribute and/or modify this document
 
10
 under the terms of the GNU Free Documentation License, Version 1.2 or
 
11
 any later version published by the Free Software Foundation; with no
 
12
 Invariant Sections, no Front-Cover Texts, and no Back-Cover Texts.
 
13
-->
 
14
 
 
15
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.4//EN"
 
16
"file:///usr/share/xml/docbook/schema/dtd/4.4/docbookx.dtd" [
 
17
 
 
18
  <!ENTITY % COMMON SYSTEM "common.ent">
 
19
  %COMMON;
 
20
 
 
21
  <!ENTITY date "<date>11 January 2008</date>">
 
22
]>
 
23
 
 
24
<refentry>
 
25
  <refentryinfo>
 
26
    <authorgroup>
 
27
      <author>
 
28
        <firstname>Frank</firstname>
 
29
        <lastname>Thomas</lastname>
 
30
        <email>frank@thomas-alfeld.de</email>
 
31
      </author>
 
32
 
 
33
      <author>
 
34
        <firstname>Peter</firstname>
 
35
        <lastname>Bailis</lastname>
 
36
        <email>pbailis@gmail.com</email>
 
37
      </author>
 
38
    </authorgroup>
 
39
    <copyright>
 
40
      <year>2007</year>
 
41
      <year>2008</year>
 
42
      <holder>University of California</holder>
 
43
    </copyright>
 
44
    &date;
 
45
  </refentryinfo>
 
46
 
 
47
  <refmeta>
 
48
    <refentrytitle>&boinccmd;</refentrytitle>
 
49
    <manvolnum>1</manvolnum>
 
50
  </refmeta>
 
51
 
 
52
  <refnamediv>
 
53
    <refname>&boinccmd;</refname> 
 
54
    <refpurpose>command line interface to the BOINC core client</refpurpose>
 
55
  </refnamediv>
 
56
 
 
57
  <refsynopsisdiv>
 
58
    <para>
 
59
      <cmdsynopsis>
 
60
        &cmd_boinccmd;
 
61
        <arg><option>--host</option> <replaceable>hostname</replaceable><arg
 
62
          >:<replaceable>port</replaceable></arg></arg>
 
63
        <arg><option>--passwd</option> <replaceable>passwd</replaceable></arg>
 
64
        <arg choice="req"><replaceable>command</replaceable></arg>
 
65
      </cmdsynopsis>
 
66
      <cmdsynopsis>
 
67
        &cmd_boinccmd;
 
68
        <arg><option>-hV</option></arg>
 
69
      </cmdsynopsis>
 
70
    </para>
 
71
    <para>Notice that the order of the options is important. The <option
 
72
      >--host</option> and <option>--passwd</option> options must precede any
 
73
      command.</para>
 
74
  </refsynopsisdiv>
 
75
 
 
76
  <refsect1>
 
77
    <title>DESCRIPTION</title>
 
78
    <para>The BOINC command tool (&cmd_boinccmd;) provides a command line
 
79
      interface to a running BOINC core client (&man_boinc;).</para>
 
80
  </refsect1>
 
81
 
 
82
  <refsect1>
 
83
    <title>OPTIONS</title>
 
84
    <para></para>
 
85
 
 
86
    <variablelist>
 
87
      <varlistentry>
 
88
        <term>
 
89
          <option>--host</option> <replaceable>hostname</replaceable><optional
 
90
            >:<replaceable>port</replaceable></optional>
 
91
        </term>
 
92
        <listitem>
 
93
          <para>Connect to the host <replaceable>hostname</replaceable>.
 
94
            The default host is localhost.</para>
 
95
        </listitem>
 
96
      </varlistentry>
 
97
 
 
98
      <varlistentry>
 
99
        <term>
 
100
          <option>--passwd</option> <replaceable>passwd</replaceable>
 
101
        </term>
 
102
        <listitem>
 
103
          <para>Use <replaceable>passwd</replaceable> as password for RPC
 
104
            authentication. If the current working directory contains a file
 
105
            <filename>gui_rpc_auth.cfg</filename>, &cmd_boinccmd; will read
 
106
            the password from this file.</para>
 
107
        </listitem>
 
108
      </varlistentry>
 
109
 
 
110
      <varlistentry>
 
111
        <term><option>-h</option>, <option>--help</option></term>
 
112
        <listitem>
 
113
          <para>Show a help message and all commands.</para>
 
114
        </listitem>
 
115
      </varlistentry>
 
116
 
 
117
      <varlistentry>
 
118
        <term><option>-V</option>, <option>--version</option></term>
 
119
        <listitem>
 
120
          <para>Show the version of the program.</para>
 
121
        </listitem>
 
122
      </varlistentry>
 
123
    </variablelist>
 
124
  </refsect1>
 
125
 
 
126
  <refsect1>
 
127
    <title>COMMANDS</title>
 
128
 
 
129
    <refsect2>
 
130
      <title>Account query and attach</title>
 
131
 
 
132
      <variablelist>
 
133
        <varlistentry>
 
134
          <term>
 
135
            <option>--lookup_account</option>
 
136
            <replaceable>URL</replaceable>
 
137
            <replaceable>email</replaceable>
 
138
            <replaceable>passwd</replaceable>
 
139
          </term>
 
140
          <listitem>
 
141
            <para>Look up account and print account key.</para>
 
142
          </listitem>
 
143
        </varlistentry>
 
144
 
 
145
        <varlistentry>
 
146
          <term>
 
147
            <option>--create_account</option>
 
148
            <replaceable>URL</replaceable>
 
149
            <replaceable>email</replaceable>
 
150
            <replaceable>passwd</replaceable>
 
151
            <replaceable>name</replaceable>
 
152
          </term>
 
153
          <listitem>
 
154
            <para>Create account with the given email address, password, and
 
155
              user name.</para>
 
156
          </listitem>
 
157
        </varlistentry>
 
158
 
 
159
        <varlistentry>
 
160
          <term>
 
161
            <option>--project_attach</option>
 
162
            <replaceable>URL</replaceable>
 
163
            <replaceable>account_key</replaceable>
 
164
          </term>
 
165
          <listitem>
 
166
            <para>Attach to an account.</para>
 
167
          </listitem>
 
168
        </varlistentry>
 
169
 
 
170
        <varlistentry>
 
171
          <term>
 
172
            <option>--join_acct_mgr</option>
 
173
            <replaceable>URL</replaceable>
 
174
            <replaceable>name</replaceable>
 
175
            <replaceable>passwd</replaceable>
 
176
          </term>
 
177
          <listitem>
 
178
            <para>Attach to an account manager (or do RPC if already
 
179
              attached).</para>
 
180
          </listitem>
 
181
        </varlistentry>
 
182
 
 
183
        <varlistentry>
 
184
          <term><option>--quit_acct_mgr</option></term>
 
185
          <listitem>
 
186
            <para>Detach from the current account manager.</para>
 
187
          </listitem>
 
188
        </varlistentry>
 
189
      </variablelist>
 
190
    </refsect2>
 
191
 
 
192
    <refsect2>
 
193
      <title>State queries</title>
 
194
 
 
195
      <variablelist>
 
196
        <varlistentry>
 
197
          <term><option>--get_state</option></term>
 
198
          <listitem>
 
199
            <para>Show complete client state.</para>
 
200
          </listitem>
 
201
        </varlistentry>
 
202
 
 
203
        <varlistentry>
 
204
          <term><option>--get_results</option></term>
 
205
          <listitem>
 
206
            <para>Show all results.</para>
 
207
          </listitem>
 
208
        </varlistentry>
 
209
 
 
210
        <varlistentry>
 
211
          <term><option>--get_simple_gui_info</option></term>
 
212
          <listitem>
 
213
            <para>Show status of projects and active results.</para>
 
214
          </listitem>
 
215
        </varlistentry>
 
216
 
 
217
        <varlistentry>
 
218
          <term><option>--get_file_transfers</option></term>
 
219
          <listitem>
 
220
            <para>Show all current file transfers.</para>
 
221
          </listitem>
 
222
        </varlistentry>
 
223
 
 
224
        <varlistentry>
 
225
          <term><option>--get_project_status</option></term>
 
226
          <listitem>
 
227
            <para>Show status of all projects.</para>
 
228
          </listitem>
 
229
        </varlistentry>
 
230
 
 
231
        <varlistentry>
 
232
          <term><option>--get_disk_usage</option></term>
 
233
          <listitem>
 
234
            <para>Show disk usage of all projects.</para>
 
235
          </listitem>
 
236
        </varlistentry>
 
237
 
 
238
        <varlistentry>
 
239
          <term><option>--get_proxy_settings</option></term>
 
240
          <listitem>
 
241
            <para>Get proxy settings.</para>
 
242
          </listitem>
 
243
        </varlistentry>
 
244
 
 
245
        <varlistentry>
 
246
          <term>
 
247
            <option>--get_messages</option> <replaceable>seqno</replaceable>
 
248
          </term>
 
249
          <listitem>
 
250
            <para>Show messages with sequence numbers beyond
 
251
              <replaceable>seqno</replaceable>.</para>
 
252
          </listitem>
 
253
        </varlistentry>
 
254
 
 
255
        <varlistentry>
 
256
          <term><option>--get_host_info</option></term>
 
257
          <listitem>
 
258
            <para>Show system information about the host where the BOINC
 
259
              client is running.</para>
 
260
          </listitem>
 
261
        </varlistentry>
 
262
      </variablelist>
 
263
    </refsect2>
 
264
 
 
265
    <refsect2>
 
266
      <title>Control operations</title>
 
267
 
 
268
      <variablelist>
 
269
        <varlistentry>
 
270
          <term>
 
271
            <option>--result</option>
 
272
            <replaceable>URL</replaceable>
 
273
            <replaceable>result_name</replaceable>
 
274
            {suspend | resume | abort | graphics_window | graphics_fullscreen}
 
275
            <optional>--desktop <replaceable>dt</replaceable> |
 
276
              --window_station <replaceable>ws</replaceable> |
 
277
              --display <replaceable>dp</replaceable></optional>
 
278
          </term>
 
279
          <listitem>
 
280
            <para>Do operation on a result.</para>
 
281
 
 
282
            <variablelist>
 
283
              <varlistentry>
 
284
                <term><option>suspend</option></term>
 
285
                <listitem>
 
286
                  <para>Temporarily stop work on result.</para>
 
287
                </listitem>
 
288
              </varlistentry>
 
289
 
 
290
              <varlistentry>
 
291
                <term><option>resume</option></term>
 
292
                <listitem>
 
293
                  <para>Allow work on result.</para>
 
294
                </listitem>
 
295
              </varlistentry>
 
296
 
 
297
              <varlistentry>
 
298
                <term><option>abort</option></term>
 
299
                <listitem>
 
300
                  <para>Permanently stop work on result.</para>
 
301
                </listitem>
 
302
              </varlistentry>
 
303
 
 
304
              <varlistentry>
 
305
                <term><option>graphics_window</option></term>
 
306
                <listitem>
 
307
                  <para>Open graphics in a window. The optional desktop /
 
308
                    window_station (Windows) or display (X11) arguments
 
309
                    specify the display.</para>
 
310
                </listitem>
 
311
              </varlistentry>
 
312
 
 
313
              <varlistentry>
 
314
                <term><option>graphics_fullscreen</option></term>
 
315
                <listitem>
 
316
                  <para>Open graphics fullscreen.</para>
 
317
                </listitem>
 
318
              </varlistentry>
 
319
            </variablelist>
 
320
          </listitem>
 
321
        </varlistentry>
 
322
 
 
323
        <varlistentry>
 
324
          <term>
 
325
            <option>--project</option>
 
326
            <replaceable>URL</replaceable>
 
327
            {reset | detach | update | suspend | resume | nomorework 
 
328
            | allowmorework | detach_when_done}
 
329
          </term>
 
330
          <listitem>
 
331
            <para>Do operation on a project, identified by its master
 
332
              URL.</para>
 
333
 
 
334
            <variablelist>
 
335
              <varlistentry>
 
336
                <term><option>reset</option></term>
 
337
                <listitem>
 
338
                  <para>Delete current work and get more.</para>
 
339
                </listitem>
 
340
              </varlistentry>
 
341
 
 
342
              <varlistentry>
 
343
                <term><option>detach</option></term>
 
344
                <listitem>
 
345
                  <para>Delete current work and don't get more.</para>
 
346
                </listitem>
 
347
              </varlistentry>
 
348
 
 
349
              <varlistentry>
 
350
                <term><option>update</option></term>
 
351
                <listitem>
 
352
                  <para>Contact scheduling server.</para>
 
353
                </listitem>
 
354
              </varlistentry>
 
355
 
 
356
              <varlistentry>
 
357
                <term><option>suspend</option></term>
 
358
                <listitem>
 
359
                  <para>Stop work for project.</para>
 
360
                </listitem>
 
361
              </varlistentry>
 
362
 
 
363
              <varlistentry>
 
364
                <term><option>resume</option></term>
 
365
                <listitem>
 
366
                  <para>Resume work for project.</para>
 
367
                </listitem>
 
368
              </varlistentry>
 
369
 
 
370
              <varlistentry>
 
371
                <term><option>nomorework</option></term>
 
372
                <listitem>
 
373
                  <para>Finish current work but don't get more.</para>
 
374
                </listitem>
 
375
              </varlistentry>
 
376
 
 
377
              <varlistentry>
 
378
                <term><option>allowmorework</option></term>
 
379
                <listitem>
 
380
                  <para>Undo <option>nomorework</option>.</para>
 
381
                </listitem>
 
382
              </varlistentry>
 
383
 
 
384
              <varlistentry>
 
385
                <term><option>detach_when_done</option></term>
 
386
                <listitem>
 
387
                  <para>Detach project.</para>
 
388
                </listitem>
 
389
              </varlistentry>
 
390
            </variablelist>
 
391
          </listitem>
 
392
        </varlistentry>
 
393
 
 
394
        <varlistentry>
 
395
          <term>
 
396
            <option>--file_transfer</option>
 
397
            <replaceable>URL</replaceable>
 
398
            <replaceable>filename</replaceable>
 
399
            {retry | abort}
 
400
          </term>
 
401
          <listitem>
 
402
            <para>Do operation on a file transfer.</para>
 
403
          </listitem>
 
404
        </varlistentry>
 
405
 
 
406
        <varlistentry>
 
407
          <term>
 
408
            <option>--set_run_mode</option>
 
409
            {always | auto | never}
 
410
            <optional><replaceable>duration</replaceable></optional>
 
411
          </term>
 
412
          <listitem>
 
413
            <para>Set run mode.</para>
 
414
 
 
415
            <variablelist>
 
416
              <varlistentry>
 
417
                <term><option>always</option></term>
 
418
                <listitem>
 
419
                  <para>Do CPU work always.</para>
 
420
                </listitem>
 
421
              </varlistentry>
 
422
 
 
423
              <varlistentry>
 
424
                <term><option>auto</option></term>
 
425
                <listitem>
 
426
                  <para>Do work only when allowed by preferences.</para>
 
427
                </listitem>
 
428
              </varlistentry>
 
429
 
 
430
              <varlistentry>
 
431
                <term><option>never</option></term>
 
432
                <listitem>
 
433
                  <para>Don't do work.</para>
 
434
                </listitem>
 
435
              </varlistentry>
 
436
            </variablelist>
 
437
            <para>If <replaceable>duration</replaceable> is zero or absent,
 
438
              this mode is permanent. Otherwise, after <replaceable
 
439
              >duration</replaceable> seconds elapse, revert to last
 
440
              permanent mode.</para>
 
441
          </listitem>
 
442
        </varlistentry>
 
443
 
 
444
        <varlistentry>
 
445
          <term>
 
446
            <option>--set_network_mode</option>
 
447
            {always | auto | never}
 
448
            <optional><replaceable>duration</replaceable></optional>
 
449
          </term>
 
450
          <listitem>
 
451
            <para>Set network mode. Like <option>--set_run_mode</option> but
 
452
              applies to network transfers only.</para>
 
453
          </listitem>
 
454
        </varlistentry>
 
455
 
 
456
        <varlistentry>
 
457
          <term>
 
458
            <option>--set_proxy_settings</option>
 
459
            <replaceable>http_server_name</replaceable>
 
460
            <replaceable>http_server_port</replaceable>
 
461
            <replaceable>http_user_name</replaceable>
 
462
            <replaceable>http_user_passwd</replaceable>
 
463
            <replaceable>socks_server_name</replaceable>
 
464
            <replaceable>socks_server_port</replaceable>
 
465
            <replaceable>socks_version</replaceable>
 
466
            <replaceable>socks5_user_name</replaceable>
 
467
            <replaceable>socks5_user_passwd</replaceable>
 
468
          </term>
 
469
          <listitem>
 
470
            <para>Set proxy settings. All fields are mandantory.</para>
 
471
          </listitem>
 
472
        </varlistentry>
 
473
 
 
474
        <varlistentry>
 
475
          <term><option>--run_benchmarks</option></term>
 
476
          <listitem>
 
477
            <para>Run CPU benchmarks.</para>
 
478
          </listitem>
 
479
        </varlistentry>
 
480
 
 
481
        <varlistentry>
 
482
          <term>
 
483
            <option>--set_screensaver_mode</option> {on | off}
 
484
            <replaceable>blank_time</replaceable>
 
485
            <optional>--desktop dt | --window_station ws |
 
486
              --display dp</optional>
 
487
          </term>
 
488
          <listitem>
 
489
            <para>Tell the core client to start or stop doing fullscreen
 
490
              graphics, and going to black after
 
491
              <replaceable>blank_time</replaceable> seconds. The optional
 
492
              arguments specify which desktop / windows_station (Windows)
 
493
              or display (X11) to use.</para>
 
494
          </listitem>
 
495
        </varlistentry>
 
496
 
 
497
        <varlistentry>
 
498
          <term><option>--read_global_prefs_override</option></term>
 
499
          <listitem>
 
500
            <para>Tell the core client to read the <filename
 
501
              >global_prefs_override.xml</filename> file and
 
502
              incorporate any global preferences indicated there.</para>
 
503
          </listitem>
 
504
        </varlistentry>
 
505
 
 
506
        <varlistentry>
 
507
          <term><option>--quit</option></term>
 
508
          <listitem>
 
509
            <para>Tell the core client to quit.</para>
 
510
          </listitem>
 
511
        </varlistentry>
 
512
 
 
513
        <varlistentry>
 
514
          <term><option>--read_cc_config</option></term>
 
515
          <listitem>
 
516
            <para>Reread the configuration file
 
517
              (<filename>cc_config.xml</filename>).</para>
 
518
          </listitem>
 
519
        </varlistentry>
 
520
 
 
521
        <varlistentry>
 
522
          <term>
 
523
            <option>--set_debts</option>
 
524
            <replaceable>URL1</replaceable>
 
525
            <replaceable>STD1</replaceable>
 
526
            <replaceable>LTD1</replaceable>
 
527
            <optional><replaceable>URL2</replaceable>
 
528
              <replaceable>STD2</replaceable>
 
529
              <replaceable>LTD2</replaceable>
 
530
              ...</optional>
 
531
          </term>
 
532
          <listitem>
 
533
            <para>Set the short- and long-term debts of one or more projects.
 
534
              Note, if you adjust the debts of a single project, the debts of
 
535
              other projects are changed. So if you want to set the debts of
 
536
              multiple projects, do it in a single command.</para>
 
537
          </listitem>
 
538
        </varlistentry>
 
539
 
 
540
        <varlistentry>
 
541
          <term>
 
542
            <option>--get_project_config</option>
 
543
            <replaceable>URL</replaceable>
 
544
          </term>
 
545
          <listitem>
 
546
            <para>Fetch configuration at project located at
 
547
              <replaceable>URL</replaceable>.</para>
 
548
          </listitem>
 
549
        </varlistentry>
 
550
 
 
551
        <varlistentry>
 
552
          <term><option>--get_project_config_poll</option></term>
 
553
        </varlistentry>
 
554
 
 
555
        <varlistentry>
 
556
          <term><option>--network_available</option></term>
 
557
        </varlistentry>
 
558
 
 
559
        <varlistentry>
 
560
          <term><option>--get_cc_status</option></term>
 
561
        </varlistentry>
 
562
      </variablelist>
 
563
    </refsect2>
 
564
  </refsect1>
 
565
 
 
566
  <refsect1>
 
567
    <title>SEE ALSO</title>
 
568
    <para>&man_boinc;, &man_boincmgr;</para>
 
569
    <para><ulink url="http://boinc.berkeley.edu/trac/wiki/BoincCmd"/></para>
 
570
  </refsect1>
 
571
 
 
572
  <refsect1>
 
573
    <title>COPYRIGHT</title>
 
574
    <para>Copyright © 2007-2008 University of California.</para>
 
575
    <para>Permission is granted to copy, distribute and/or modify this
 
576
      document under the terms of the &gnu; Free Documentation License,
 
577
      Version 1.2 or any later version published by the Free Software
 
578
      Foundation; with no Invariant Sections, no Front-Cover Texts, and no
 
579
      Back-Cover Texts.</para>
 
580
  </refsect1>
 
581
</refentry>