← Back to branch summary

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

« back to all changes in this revision

Viewing changes to doc/manager.php

  • 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/manager.php
1
 
<?php
2
 
require_once("docutil.php");
3
 
page_head("The BOINC manager");
4
 
echo "
5
 
<p>
6
 
This page describes the <b>BOINC manager</b>,
7
 
the 'control panel' for BOINC.
8
 
<a href=help.php>Go here</a> for general help with BOINC.
9
 
<h2>The BOINC Manager icon and menu</h2>
10
 
On Windows, the Manager is represented by an icon in the system tray.
11
 
    <ul>
12
 
    <li>Double-click on the icon to open the BOINC manager window.
13
 
    <li>Right-click on the icon to access its menu (shown below).
14
 
    </ul>
15
 
<br>
16
 
<a name=icon/></a>
17
 
<img src=mgrsystraymenu.png>
18
 
<br>
19
 
On Mac OS X, the Manager is represented by icons in both the menubar and the Dock.
20
 
    <ul>
21
 
    <li>Click on the icon in the menubar or Dock and hold the
22
 
    button down until the menu appears.
23
 
    </ul>
24
 
<p>
25
 
The icon menu choices are:
26
 
<ul>
27
 
<li> <b>Open BOINC Manager</b>: opens the current BOINC Manager.
28
 
<li> <b>Snooze</b>: stop work (computation and file transfer) for
29
 
one hour or until you cancel it.
30
 
See also <a href=#activity>Activity menu</a>.
31
 
<li> <b>About BOINC Manager</b>:  displays useful information about the
32
 
BOINC Manager.
33
 
<li> <b>Exit</b>:  exit the BOINC manager and all running BOINC applications.
34
 
No further work will take place until you run the BOINC manager again.
35
 
<br>(On Mac OS X, this menu item is called <b>Quit</b>.)
36
 
</ul>
37
 
<br>
38
 
<img src=mgrsystrayballoon.png>
39
 
<p>
40
 
Hovering over the BOINC icon will display a status balloon which contains
41
 
the project it is currently working on, how far along it is, and which
42
 
computer it is connected to (Windows only).
43
 
 
44
 
<h2>The Projects tab</h2>
45
 
<p>
46
 
Shows the projects in which this computer is participating.
47
 
<br><br>
48
 
<img src=mgrprojects.png>
49
 
<p>
50
 
 
51
 
<h3>Status messages</h3>
52
 
<ul>
53
 
<li>Suspended by user:
54
 
    The project is currently suspended.
55
 
<li> Communication deferred ...:
56
 
    The client will wait the specified amount of time before attempting
57
 
    to contact the project server again.
58
 
    If no communication is required at that point, none will be attempted.
59
 
<li>Won't get new tasks:
60
 
    The project will not fill the cache for this project
61
 
    when it runs out of tasks.
62
 
</ul>
63
 
 
64
 
<h3>Commands</h3>
65
 
<p>
66
 
Click on a project name to enable the following additional buttons:
67
 
 
68
 
<ul>
69
 
<li> <b>Allow new tasks</b>:
70
 
    Allow the project to download additional work, if needed.
71
 
<li> <b>Detach</b>:
72
 
    Your computer will stop working for the project.
73
 
<li> <b>No new tasks</b>:
74
 
    Do not download any additional work for this project.
75
 
<li> <b>Reset project</b>:
76
 
    Stop the project's current work, if any,
77
 
    and start from scratch.
78
 
    Use this if BOINC has become stuck for some reason.
79
 
    Any unreported results and tasks in progress will be discarded.
80
 
<li> <b>Resume</b>:
81
 
    Resumes processing of a previously suspended project.
82
 
<li> <b>Suspend</b>:
83
 
    Suspends any further processing of this project.
84
 
<li> <b>Update</b>:
85
 
    Connect to the project;
86
 
    report all completed results,
87
 
    get more work if necessary,
88
 
    and get your latest <a href=prefs.php>preferences</a>.
89
 
</ul>
90
 
<h3>Web sites</h3>
91
 
 
92
 
<p>Project administrators can add <a href=gui_urls.php>buttons</a>
93
 
   to the manager to quickly navigate the project website.
94
 
 
95
 
<h2>The Tasks tab</h2>
96
 
<p>Shows the tasks currently on your computer.
97
 
<br><br>
98
 
<img src=mgrwork.png>
99
 
<br>
100
 
 
101
 
<p>
102
 
Each task is either:
103
 
<ul>
104
 
<li>Aborted by user:
105
 
    Result has been aborted.
106
 
<li>Downloading:
107
 
    Input files are being downloaded.
108
 
<li>Preempted:
109
 
    Result has been suspended by the client-side scheduler and will be
110
 
    resumed the next time the project comes up in the processing rotation.
111
 
<li>Ready to report:
112
 
    Waiting to notify the scheduling server.
113
 
<li>Ready to run:
114
 
    An estimate of the total CPU time is shown.
115
 
<li>Running:
116
 
    Elapsed CPU time and estimated percent done is shown.
117
 
<li>Suspended by user:
118
 
    Task has been suspended by the user.
119
 
    Use the 'Resume' button on this tab to resume the task.
120
 
<li>Uploading:
121
 
    Output files are being uploaded.
122
 
<li>Activities Suspended:
123
 
    BOINC is suspended, either by the Activity->Suspend menu item or 
124
 
    benchmarks are running
125
 
<li>Project suspended by user:
126
 
    Project has been suspended by user.  Use the 'Resume' button on the
127
 
    Projects tab to resume the project.
128
 
</ul>
129
 
 
130
 
</ul>
131
 
 
132
 
<p>
133
 
Click on a result name to enable the following additional buttons:
134
 
<ul>
135
 
<li> <b>Abort</b>:
136
 
    Abort processing for a result. NOTE: This will prevent you from receiving
137
 
    credit for any work already completed.
138
 
<li> <b>Resume</b>:
139
 
    Resumes processing of a previously suspended task.  
140
 
    Note, this applies to tasks with status 'Suspended by user'.
141
 
<li> <b>Show graphics</b>:
142
 
    Open a window showing application graphics.
143
 
<li> <b>Suspend</b>:
144
 
    Suspends any further processing of this task.
145
 
</ul>
146
 
 
147
 
<h2>The Transfers tab</h2>
148
 
<p>
149
 
Shows file transfers (uploads and downloads).
150
 
    These may be ready to start, in progress, and completed.
151
 
<br><br>
152
 
<img src=mgrtransfers.png>
153
 
 
154
 
<ul>
155
 
<li>Aborted by user:
156
 
    Result has been aborted and will be reported to the project server
157
 
    as a computational error.
158
 
<li>Downloading:
159
 
    Your computer is receiving data from the project server.
160
 
<li>Retry in ...:
161
 
    The client will wait the specified amount of time before attempting
162
 
    to contact the project server again.
163
 
<li>Uploading:
164
 
    Your computer is sending data to the project server.
165
 
</ul>
166
 
 
167
 
<p>Click on a file name to enable the following additional buttons:
168
 
<ul>
169
 
<li> <b>Retry Now</b>:
170
 
    Retry the file transfer now.
171
 
<li> <b>Abort Transfer</b>:
172
 
    Abort the file transfer. NOTE: This will prevent you from receiving credit
173
 
    for any work already completed.
174
 
</ul>
175
 
 
176
 
<h2>The Messages tab</h2>
177
 
<p>
178
 
Shows status and error messages.
179
 
    You can <a href=client_msgs.php>control what messages are shown</a>.
180
 
    Messages are also written to a file 'stdoutdae.txt'.
181
 
<br>
182
 
<img src=mgrmessages.png>
183
 
 
184
 
<p>
185
 
Click on one or more messages to enable the following additional buttons:
186
 
<ul>
187
 
<li> <b>Copy all messages</b>:
188
 
    Copies all the messages to the clipboard.
189
 
<li> <b>Copy selected messages</b>:
190
 
    Copies the highlighted messages to the clipboard.
191
 
    NOTE: To highlight a message
192
 
    hold down the CTRL key (Windows) or Command key (Mac)
193
 
    and then click on the messages you want to store in the clipboard.
194
 
    When done click on the 'Copy selected messages' button to copy them
195
 
    to the clipboard.
196
 
</ul>
197
 
 
198
 
<h2>The Statistics tab</h2>
199
 
<p>
200
 
Shows some simple charts and graphs about the user and host progress
201
 
<br><br>
202
 
<img src=mgrstatistics.png>
203
 
<p>
204
 
NOTE: This feature requires three connections to each project scheduler on three
205
 
   different days before it starts to work properly.
206
 
<h3>Command view</h3>
207
 
Click on any of the buttons to change to a different chart:
208
 
<ul>
209
 
<li> <b>Show user total</b>:
210
 
    Shows the user's credit totals for each project.
211
 
<li> <b>Show user average</b>:
212
 
    Shows the user's credit averages for each project.
213
 
<li> <b>Show host total</b>:
214
 
    Shows this computer's credit totals for each project.
215
 
<li> <b>Show host average</b>:
216
 
    Shows this computer's credit averages for each project.
217
 
</ul>
218
 
 
219
 
<h3>Project</h3>
220
 
Switch between projects when displaying one project at a time:
221
 
<ul>
222
 
<li> <b>Previous project</b>:
223
 
    Click this button to select the previous project.
224
 
<li> <b>Next project</b>:
225
 
    Click this button to select the next project
226
 
</ul>
227
 
<h3>Mode view</h3>
228
 
Click on any of the buttons to change the view:
229
 
<ul>
230
 
<li> <b>All projects</b>:
231
 
    Show all projects, one chart per project
232
 
<li> <b>One project</b>:
233
 
    Shows one project at a time.
234
 
    The chart and a list of projects will be shown,
235
 
    <br>switch between
236
 
    them using 'previous project' and 'next project' buttons.
237
 
<li> <b> All projects(sum)</b>
238
 
    Shows all projects in one chart.
239
 
</ul>
240
 
 
241
 
<h2>The Disk tab</h2>
242
 
<p>This shows how much disk space is currently being used by each project.
243
 
<br><br>
244
 
<img src=mgrdisk.png>
245
 
 
246
 
<h2>BOINC Manager Menus</h2>
247
 
 
248
 
The BOINC manager has the following menus:
249
 
<ul>
250
 
<li> <b>File</b>
251
 
    <ul>
252
 
    <li> <b>Exit</b>:  exit the BOINC manager and all running BOINC applications.
253
 
        No further work will take place until you run the BOINC manager again.
254
 
        <br>(On Mac OS X, this is under the BOINC menu as <b>Quit BOINC</b>.)
255
 
    </ul>
256
 
 
257
 
<br>
258
 
<li> <b>Tools</b>
259
 
    <ul>
260
 
    <li> <b>Attach to project</b>:
261
 
        enroll this computer in a project.
262
 
        You will be asked to enter the project's URL and
263
 
        your email address and password.
264
 
<!-- ** ROM ** Please add a link to a page with details on using the Wizard. -->
265
 
    <li> <b>Account Manager</b>: attach to one or more new projects using an
266
 
        account manager web site.
267
 
        See <a href=/acct_mgrs.php>Account managers</a>
268
 
    </ul>
269
 
 
270
 
<br>
271
 
<a name=activity/></a>
272
 
<li> <b>Activity</b>
273
 
    <ul>
274
 
    <li> <b>Run always</b>: do work, regardless of preferences.
275
 
    <li> <b>Run based on preferences</b>: do work
276
 
        when your <a href=prefs.php>preferences</a> allow it.
277
 
    <li> <b>Suspend</b>: stop work (computation and file transfer).
278
 
    <li> <b>Network activity always available</b>: always allow BOINC to
279
 
        contact the project servers when it needs to.
280
 
    <li> <b>Network activity based on preferences</b>: allow BOINC to contact
281
 
        the project servers only when your <a href=prefs.php>preferences</a>
282
 
        allow it.
283
 
    <li> <b>Network activity suspended</b>: setting this keeps BOINC
284
 
        from attempting to contact any of the project servers.  It is useful
285
 
        for those on dial-up connections who do not want to be bothered with
286
 
        BOINC prompting to connect or disconnect for a time.
287
 
    </ul>
288
 
<br>
289
 
Notes:
290
 
<ul>
291
 
<li> Selecting an option that requires contacting a project
292
 
will temporarily enable network activity regardless of the network setting.
293
 
This includes updating a project, retrying file transfers,
294
 
retrying communications and attaching to projects.
295
 
Network activity will remain enabled for five minutes.
296
 
<li> Selecting <b>Snooze</b> from the <a href=#icon>icon menu</a>
297
 
overrides the 'run....' setting and suspends activity for one hour.
298
 
Unselecting <b>Snooze</b>, or Selecting the <b>Activity</b> menu items
299
 
<b>Run always</b> or <b>Run based on preferences</b>
300
 
cancels <b>Snooze</b>.
301
 
</ul>
302
 
 
303
 
<br>
304
 
<li> <b>Advanced</b>
305
 
    <ul>
306
 
    <li> <b>Options</b>: opens a dialog allowing you to select your preferred
307
 
        language, how often you wish to be reminded of the need to connect to
308
 
        the project servers (for dial-up users), etc.
309
 
        <br>If you connect to the web through an HTTP or SOCKS proxy,
310
 
        use this dialog to enter its address and port.
311
 
        <br>Windows only: use this dialog to tell BOINC your method of connecting
312
 
        to the Internet.
313
 
<!--  ** ROM ** Please add a link to a page with details on using this dialog. -->
314
 
    <li><b>Select Computer</b>: Allows you to control BOINC on a different
315
 
        computer
316
 
<!--  ** ROM ** is this correct?  Please add more details as appropriate -->
317
 
 
318
 
    <li><b>Run Benchmarks</b>:
319
 
        run benchmark functions, which measure the speed of your processor.
320
 
        BOINC does this automatically,
321
 
        but you can repeat it whenever you want.
322
 
        The results are shown in the Messages tab.
323
 
    <li><b>Retry Communications</b>: retry any deferred communications.
324
 
    </ul>
325
 
 
326
 
<br>
327
 
<li> <b>Help</b>
328
 
    <ul>
329
 
    <li> <b>BOINC Manager</b>:
330
 
        open this web page with instructions for using the BOINC manager.
331
 
        The F1 function key also does this.
332
 
    <li> <b>BOINC website</b>: open the main BOINC web page.
333
 
    <li> <b>About BOINC Manager</b>: show BOINC manager version number (on Mac OS X,
334
 
        this command is under the BOINC menu.)
335
 
    </ul>
336
 
</ul>
337
 
 
338
 
<p>
339
 
Menu names and other text in the BOINC manager can be displayed in
340
 
<a href=translation.php>languages other than English</a>.
341
 
";
342
 
page_tail();
343
 
?>