← Back to branch summary

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

« back to all changes in this revision

Viewing changes to doc/client_files.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/client_files.php
1
 
<?php
2
 
require_once("docutil.php");
3
 
page_head("Core client: file structure");
4
 
echo "
5
 
<p>
6
 
The core client runs in a <b>BOINC home directory</b>.
7
 
It creates and uses the following files and directories within the
8
 
home directory: 
9
 
<ul>
10
 
<li>
11
 
<b>prefs.xml</b>:
12
 
The user's general preferences; see below.
13
 
<li>
14
 
<b>client_state.xml</b> describes of the files,
15
 
application, workunits and results present on this client.
16
 
<li>
17
 
<b>Account files</b> describes the participant's account
18
 
in each subscribed project,
19
 
including the resource share and project-specific preferences.
20
 
It contains no host-specific information.
21
 
The name of the account file is <b>account_PROJECT.xml</b>,
22
 
where PROJECT is an encoded version of the project's master URL.
23
 
<li>
24
 
A directory <b>projects</b>,
25
 
which contains a <b>project directory</b> for each subscribed project.
26
 
The name of a project directory is an encoded
27
 
version of the project's master URL.
28
 
The project directory contains all files (inputs,
29
 
outputs, executables) related to the project.
30
 
<li>
31
 
<b>slots</b>: this directory contains one subdirectory for each
32
 
result in progress.
33
 
The subdirectories are named 0, 1, ... N-1.
34
 
</ul>
35
 
<p>
36
 
Each result executes in particular slot directory.
37
 
The core client creates 'soft link' files in the slot directory,
38
 
linking to the corresponding files in the project directory.
39
 
 
40
 
<h3>Format of account files</h3>
41
 
The format of an account file is as follows:
42
 
<pre>
43
 
";
44
 
echo htmlspecialchars("
45
 
<account>
46
 
    <master_url>http://www.myproject.com/</master_url>
47
 
    <authenticator>3f7b90793a0175ad0bda68684e8bd136</authenticator>
48
 
    [ <project_name>...</project_name> ]
49
 
    [ <tentative/> ]
50
 
    <project_preferences>
51
 
    <resource_share>1</resource_share>
52
 
    <project_specific>
53
 
        ...
54
 
    </project_specific>
55
 
    [ <venue>...</venue> ]
56
 
    </project_preferences>
57
 
</account>
58
 
");
59
 
echo "
60
 
</pre>
61
 
The &lt;project_preferences&gt; field is
62
 
the 'project_prefs' field of the user database record.
63
 
 
64
 
<h3>Format of prefs.xml</h3>
65
 
<p>
66
 
This format of prefs.xml is as follows:
67
 
 
68
 
<pre>
69
 
&lt;preferences>
70
 
    &lt;prefs_mod_time>1030128387&lt;/prefs_mod_time>
71
 
    &lt;from_project>http://www.myproject.com/&lt;/from_project>
72
 
    &lt;from_scheduler>http://server3.myproject.com/cgi-bin/scheduler_cgi&lt;/from_scheduler>
73
 
    &lt;mod_time>2&lt;/mod_time>
74
 
    &lt;high_water_days>2&lt;/high_water_days>
75
 
    &lt;low_water_days>1&lt;/low_water_days>
76
 
&lt;/preferences>
77
 
 
78
 
XXX this is not complete
79
 
</pre>
80
 
";
81
 
page_tail();
82
 
?>