← Back to branch summary

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

« back to all changes in this revision

Viewing changes to doc/prefs_impl.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/prefs_impl.php
1
 
<?php
2
 
require_once("docutil.php");
3
 
page_head("Preferences implementation");
4
 
echo "
5
 
<h2>General preferences</h2>
6
 
General preferences are represented by an XML element of the form:
7
 
".html_text("
8
 
<global_preferences>
9
 
     <source_project>http://setiathome.berkeley.edu/</source_project>
10
 
     <source_scheduler>http://setiboinc.ssl.berkeley.edu/sah_cgi/cgi</source_scheduler>
11
 
    <mod_time>1140215730</mod_time>
12
 
    <run_if_user_active/>
13
 
    <idle_time_to_run>3</idle_time_to_run>
14
 
    <cpu_scheduling_period_minutes>60</cpu_scheduling_period_minutes>
15
 
    <hangup_if_dialed/>
16
 
    <work_buf_min_days>0.1</work_buf_min_days>
17
 
    <max_cpus>2</max_cpus>
18
 
    <disk_interval>60</disk_interval>
19
 
    <disk_max_used_gb>100</disk_max_used_gb>
20
 
    <disk_max_used_pct>50</disk_max_used_pct>
21
 
    <disk_min_free_gb>0.1</disk_min_free_gb>
22
 
    <vm_max_used_pct>75</vm_max_used_pct>
23
 
    <max_bytes_sec_down>0</max_bytes_sec_down>
24
 
    <max_bytes_sec_up>0</max_bytes_sec_up>
25
 
    <venue name=\"home\">
26
 
        <idle_time_to_run>3</idle_time_to_run>
27
 
        <cpu_scheduling_period_minutes>60</cpu_scheduling_period_minutes>
28
 
        <hangup_if_dialed/>
29
 
        <work_buf_min_days>0.1</work_buf_min_days>
30
 
        <max_cpus>2</max_cpus>
31
 
        <disk_interval>60</disk_interval>
32
 
        <disk_max_used_gb>100</disk_max_used_gb>
33
 
        <disk_max_used_pct>50</disk_max_used_pct>
34
 
        <disk_min_free_gb>0.001</disk_min_free_gb>
35
 
        <vm_max_used_pct>75</vm_max_used_pct>
36
 
        <max_bytes_sec_down>0</max_bytes_sec_down>
37
 
        <max_bytes_sec_up>0</max_bytes_sec_up>
38
 
    </venue>
39
 
</global_preferences>
40
 
")."
41
 
The first set of preferences are the default;
42
 
each set of venue-specific preferences is
43
 
enclosed in a &lt;venue> element.
44
 
The optional
45
 
&lt;source_project> and &lt;source_scheduler> elements indicate
46
 
the source of the preferences.
47
 
 
48
 
<p>
49
 
On the client, the global prefs are stored in global_prefs.xml
50
 
(present only if they've been obtained from a server).
51
 
 
52
 
<p>
53
 
A scheduler RPC request includes global_prefs.xml if it's present.
54
 
If the request includes global prefs,
55
 
the scheduler installs them in the DB if the DB copy is missing or older.
56
 
If the DB copy is newer, it includes it in the reply.
57
 
If the request has no prefs and they're present in the DB,
58
 
they're included in the reply.
59
 
<p>
60
 
When handling a scheduler RPC reply that includes global prefs,
61
 
the client writes them to global_prefs.xml,
62
 
prepending the project and scheduler URLs is absent.
63
 
 
64
 
<h2>Project preferences</h2>
65
 
Project preferences are represented by an XML element of the form:
66
 
".html_text("
67
 
<project_preferences>
68
 
    <resource_share>50</resource_share>
69
 
    <project_specific>
70
 
        <format_preset>Custom</format_preset>
71
 
        <text_style>Pillars</text_style>
72
 
        <graph_style>Rectangles</graph_style>
73
 
        <max_fps>30</max_fps>
74
 
        <max_cpu>50</max_cpu>
75
 
        <grow_time>10</grow_time>
76
 
        <hold_time>5</hold_time>
77
 
        <graph_alpha>0.7</graph_alpha>
78
 
        <roll_period>10</roll_period>
79
 
        <roll_range>20</roll_range>
80
 
        <pitch_period>30</pitch_period>
81
 
        <pitch_range>30</pitch_range>
82
 
        <starfield_size>2000</starfield_size>
83
 
        <starfield_speed>40</starfield_speed>
84
 
        <color_preset>Rainbow</color_preset>
85
 
        <start_hue>0</start_hue>
86
 
        <hue_change>1</hue_change>
87
 
        <app_file>
88
 
            <timestamp>1095011196</timestamp>
89
 
            <open_name>background</open_name>
90
 
            <url>http://setiweb.ssl.berkeley.edu/~davea/yosemite_08_04/800/P1010008.jpg</url>
91
 
        </app_file>
92
 
    </project_specific>
93
 
    <venue name=\"school\">
94
 
        <resource_share>100</resource_share>
95
 
        <project_specific>
96
 
            <format_preset>SETI@home classic</format_preset>
97
 
            <text_style>Pillars</text_style>
98
 
            <graph_style>Rectangles</graph_style>
99
 
            <max_fps>30</max_fps>
100
 
            <max_cpu>50</max_cpu>
101
 
            <grow_time>10</grow_time>
102
 
            <hold_time>5</hold_time>
103
 
            <graph_alpha>0.7</graph_alpha>
104
 
            <roll_period>10</roll_period>
105
 
            <roll_range>20</roll_range>
106
 
            <pitch_period>30</pitch_period>
107
 
            <pitch_range>30</pitch_range>
108
 
            <starfield_size>2000</starfield_size>
109
 
            <starfield_speed>40</starfield_speed>
110
 
            <color_preset>Rainbow</color_preset>
111
 
            <start_hue>0</start_hue>
112
 
            <hue_change>1</hue_change>
113
 
        </project_specific>
114
 
    </venue>
115
 
</project_preferences>
116
 
")."
117
 
 
118
 
On the client, the project prefs are stored
119
 
in a file account_XXX.xml,
120
 
which has the additional elements <lt;master_url&gt; and <lt;authenticator&gt;.
121
 
<p>
122
 
A scheduler RPC reply always includes project prefs.
123
 
<p>
124
 
When handling a scheduler RPC reply,
125
 
the client writes them to the account_X.xml file,
126
 
prepending the master URL and authenticator.
127
 
 
128
 
";
129
 
page_tail();
130
 
?>