← Back to branch summary

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

« back to all changes in this revision

Viewing changes to doc/client_unix.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_unix.php
1
 
<?php
2
 
require_once("docutil.php");
3
 
page_head("Core client configuration files, command-line options, and environment variables");
4
 
echo "
5
 
The BOINC core client can be controlled by command-line options,
6
 
configuration files, and environment variables.
7
 
<p>
8
 
<b>These features are generally useful only for
9
 
advanced users.</b>
10
 
 
11
 
<h3>Configuration files</h3>
12
 
<p>
13
 
BOINC uses the following configuration files.
14
 
You can pre-populate these files to control BOINC in various ways.
15
 
";
16
 
list_start();
17
 
list_item("<a href=client_files.php>Account files</a>",
18
 
    "each one describes an attached project."
19
 
);
20
 
list_item("<a href=prefs_override.php>global_prefs_override.xml</a>",
21
 
    "override global preferences"
22
 
);
23
 
list_item("<a href=client_msgs.php>cc_config.xml</a>",
24
 
    "turn log messages on/off by category,
25
 
    and other core client configuration options."
26
 
);
27
 
list_item("<a href=gui_rpc_auth.php>remote_hosts.cfg</a>",
28
 
    "hosts from which remote GUI RPCs is allowed"
29
 
);
30
 
list_item("<a href=gui_rpc_auth.php>gui_rpc_auth.cfg</a>",
31
 
    "GUI RPC password"
32
 
);
33
 
list_item("<a href=client_startup.php>project_init.xml</a>",
34
 
    "startup project"
35
 
);
36
 
list_item("<a href=client_startup.php>acct_mgr_url.xml</a>",
37
 
    "account manager URL"
38
 
);
39
 
list_item("<a href=client_startup.php>acct_mgr_login.xml</a>",
40
 
    "account manager login"
41
 
);
42
 
list_end();
43
 
echo "
44
 
<h3>Command-line options</h3>
45
 
<p>
46
 
The core client has
47
 
command-line options that provide minimal control
48
 
(e.g. the ability attach and detach projects).
49
 
<p>
50
 
More detailed control, and the ability to interact
51
 
with a running client, is provided by the
52
 
<a href=boinc_cmd.php>BOINC command tool</a>.
53
 
<p>
54
 
";
55
 
list_start();
56
 
list_item("--help",
57
 
    "Show client options."
58
 
);
59
 
list_item("--version",
60
 
    "Show client version."
61
 
);
62
 
list_item("<nobr>--attach_project URL account_key</nobr>",
63
 
    "Attach this computer to a new project."
64
 
);
65
 
list_item("--show_projects",
66
 
    "Print a list of projects to which this computer is attached."
67
 
);
68
 
 
69
 
list_item("--detach_project URL",
70
 
    "Detach this computer from a project."
71
 
);
72
 
 
73
 
list_item("--reset_project URL",
74
 
    "Clear pending work for a project.
75
 
    Use this if there is a problem that is preventing
76
 
    your computer from working."
77
 
);
78
 
list_item("--update_prefs URL",
79
 
    "Contact a project's server to obtain new preferences.
80
 
    This will also report completed results
81
 
    and get new work if needed."
82
 
);
83
 
list_item("--return_results_immediately",
84
 
    "Report each result as soon as it's done."
85
 
);
86
 
list_item("--run_cpu_benchmarks",
87
 
    "Run CPU benchmarks.
88
 
    Do this if you have modified your computer's hardware."
89
 
);
90
 
list_item("--check_all_logins",
91
 
    "(Unix) If 'run if user active' preference is off,
92
 
    check for input activity on all current logins;
93
 
    default is to check only local mouse/keyboard"
94
 
);
95
 
list_item("--exit_when_idle",
96
 
    "Get, process and report work, then exit."
97
 
);
98
 
list_item("--gui_rpc_port N",
99
 
    "Specify port for GUI RPCs"
100
 
);
101
 
list_item("--allow_remote_gui_rpc",
102
 
    "Allow GUI RPCs from remote hosts"
103
 
);
104
 
list_item("--dir abs_path",
105
 
    "Use the given directory as BOINC home"
106
 
);
107
 
list_item("--detach",
108
 
    "Detach from console (Windows only)"
109
 
);
110
 
list_item("--no_gui_rpc",
111
 
    "Don't allow GUI RPCs."
112
 
);
113
 
list_item("--daemon",
114
 
    "Linux: detach from controlling terminal; Windows: run as service"
115
 
);
116
 
list_end();
117
 
echo "
118
 
<h2>Environment variables</h2>
119
 
";
120
 
list_start();
121
 
list_item("HTTP_PROXY", "URL of HTTP proxy");
122
 
list_item("HTTP_USER_NAME", "User name for proxy authentication");
123
 
list_item("HTTP_USER_PASSWD", "Password for proxy authentication");
124
 
list_item("SOCKS4_SERVER", "URL of SOCKS 4 server");
125
 
list_item("SOCKS5_SERVER", "URL of SOCKS 5 server");
126
 
list_item("SOCKS5_USER", "User name for SOCKS authentication");
127
 
list_item("SOCKS5_PASSWD", "Password for SOCKS authentication");
128
 
list_end();
129
 
echo "
130
 
<h2>Implementation and debugging command-line options</h2>
131
 
";
132
 
list_start();
133
 
list_item(" --exit_when_idle ",
134
 
    " Exit when we have no work and a scheduling server
135
 
gives a 'no work' return."
136
 
);
137
 
list_item(" --no_time_test",
138
 
    " Don't run performance benchmarks; used fixed numbers instead."
139
 
);
140
 
list_item(" --exit_after_app_start N",
141
 
    " Exit about N seconds after first application starts"
142
 
);
143
 
list_item(" --min",
144
 
    " Put client in the background after starting up"
145
 
);
146
 
list_item(" --skip_cpu_benchmarks",
147
 
    " Don't run CPU benchmarks"
148
 
);
149
 
list_item(" --file_xfer_giveup_period N",
150
 
    " Specify giveup period for file transfers"
151
 
);
152
 
list_item(" --started_by_screensaver N",
153
 
    " Passed by screensaver when it launches client"
154
 
);
155
 
list_end();
156
 
page_tail();
157
 
?>