Rooba
/
boinc
mirror of https://github.com/BOINC/boinc.git
1
0
Fork 0
Code Issues 1 Packages Projects Releases Wiki Activity

*** empty log message *** 

svn path=/trunk/boinc/; revision=8802
This commit is contained in:
David Anderson 2005-11-05 07:08:42 +00:00
parent aed14358e1
commit aae5740462
9 changed files with 229 additions and 200 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
INSTALL
View File

@ -1,5 +1,5 @@
BOINC documentation is kept online at
http://boinc.berkeley.edu/create_project.html
http://boinc.berkeley.edu/create_project.php
The documentation is also part of the source tree
(in the doc/ directory).

2
doc/bare_core.php
View File

@ -1,6 +1,6 @@
<?php
require_once("docutil.php");
page_head("Installing the command-line core client");
page_head("Installing the command-line client");
echo "
This type of installation requires that you be familiar with the
UNIX command-line interface.

121
doc/boinc_cmd.php Normal file
View File

@ -0,0 +1,121 @@
<?php
require_once("docutil.php");
page_head("The command tool");
echo "
<p>
The command-line interface program (boinc_cmd)
provides a command-line interface to a running BOINC core client.
boinc_cmd has the following interface:
<pre>
boinc_cmd [--host hostname] [--passwd passwd] command
</pre>
The options and commands are as follows:
";
list_start();
list_item("--help, -h", "help (show commands)");
list_item("--version, -V", "show version");
list_item("--host", "The host to connect to (default: localhost)");
list_item("--password", "The password for RPC authentication
(default: boinc_cmd will look for a file 'gui_rpc_auth.cfg'
and use the password it contains)"
);
list_item("--get_state", "show client state");
list_item("--get_results", "show results");
list_item("--get_file_transfers", "show file transfers");
list_item("--get_project_status", "show status of all projects");
list_item("--get_disk_usage", "Show disk usage by project");
list_item("--result URL result_name
<br>{suspend | resume | abort | graphics_window | graphics_fullscreen}
<br>{--window_station ws} {--desktop dt} {--display dp}
",
"Do operation on a result, identified by the project master URL
and the result name.
<ul>
<li> suspend: temporarily stop work on result
<li> resume: allow work on result
<li> abort: permanently stop work on result
<li> graphics_window: open graphics in a window.
The optional desktop/window_station (Windows) or display (X11)
arguments specify the display.
<li> graphics_fullscreen: open graphics fullscreen
</ul>
"
);
list_item("--project URL
<br>{reset | detach | update | suspend | resume | nomorework | allowmorework}
",
"Do operation on a project, identified by its master URL.
<ul>
<li>reset: delete current work and get more;
<li>detach: delete current work and don't get more;
<li>update: contact scheduling server;
<li>suspend: stop work for project;
<li>result: resume work for projrect;
<li>nomorework: finish current work but don't get more;
<li>allowmorework: undo nomorework
</ul>
"
);
list_item("--project_attach URL auth","Attach to an account");
list_item("--file_transfer URL filename
{retry | abort}
",
"Do operation on a file transfer"
);
list_item("--get_run_mode","Get current run mode");
list_item("--set_run_mode {always | auto | never}",
"Set run mode.
<br>always: do work (network + CPU) always
<br>auto: do work only when allowed by preferences
<br>never: don't do work (same as suspending all projects)
"
);
list_item("--get_network_mode","Get current network mode");
list_item("--set_network_mode {always | auto | never}",
"Set network mode
<br> Like set_run_mode but applies only to network transfers
"
);
list_item("--get_proxy_settings", "Get proxy settings");
list_item(
"--set_proxy_settings
http_server_name
http_server_port
http_user_name
http_user_passwd
socks_server_name
socks_server_port
socks_version
socks5_user_name
socks5_user_passwd
",
"Set proxy settings (all fields are mandatory)"
);
list_item("--get_messages seqno",
"show messages with sequence numbers beyond the given seqno"
);
list_item("--get_host_info", "Show host info");
list_item("--acct_mgr_rpc URL name password",
"Instruct core client to contact an account manager server."
);
list_item("--run_benchmarks", "Run CPU benchmarks");
list_item("--get_screensaver_mode", "");
list_item(
"--set_screensaver_mode on|off blank_time
<br>{--desktop desktop}
<br>{--window_station window_station}
<br>{--display display}
",
"Tell the core client to start or stop doing fullscreen graphics,
and going to black after blank_time seconds.
The optional arguments specify which desktop/windows_station (Windows)
or display (X11) to use.
"
);
list_item("--quit", "");
list_end();
page_tail();
?>

1
doc/boinc_dev.php
View File

@ -76,7 +76,6 @@ Various implementation notes:
<li> <a href=client_logic.php>Main loop logic</a>
<li> <a href=sched.php>Client scheduling policies (new)</a>
<li> <a href=client_sched.php>Client scheduling policies (old)</a>
<li> <a href=client_debug.php>Debugging</a>
<li> <a href=host_measure.php>Host measurements</a>
<li> <a href=host_id.php>Host identification</a>
<li> <a href=client_app.php>Core client/application interaction (basic)</a>

79
doc/client_debug.php
View File

@ -1,79 +0,0 @@
<?php
require_once("docutil.php");
page_head("Core client: debugging");
echo "
<h3>Command-line options</h3>
<p>
Some command-line options intended for debugging:
<dl>
<dt> -exit_when_idle
<dd> Exit when we're not working on anything and a scheduling server
gives a 'no work' return.
<dt> -no_time_test
<dd> Don't run performance benchmarks; used fixed numbers instead.
<dt> -exit_after N
<dd> Exit after about N seconds
<dt> -giveup_after N
<dd> Give up on file transfers after N seconds (default is 2 weeks)
<dt> -limit_transfer_rate N
<dd> Limit total network traffic to N bytes/sec.
<dt> -min
<dd> Put client in the background after starting up
</dl>
<h3>Logging and error output</h3>
<p>
The core client writes error messages to stderr.
This mechanism is reserved for serious problems,
i.e. those that reflect bugs in the core
client program or conditions that require user intervention.
<p>
In addition, the core client can write a variety of 'logging'
information to stdout.
The logging options are read from a file
<b>log_flags.xml</b>.
This file has the following format:
<pre>
&lt;log_flags&gt;
[ flags ]
&lt;/log_flags&gt;
</pre>
The flags are as follows:
<dl>
<dt> &lt;task/&gt;
<dd> Log the start, restart and completion of computational tasks.
<dt> &lt;file_xfer/&gt;
<dd> Log the start, restart and completion of file transfers.
<dt> &lt;sched_ops/&gt;
<dd> Log connections with scheduling servers.
<dt> &lt;state_debug/&gt;
<dd> Log changes to the 'client state' data structures.
<dt> &lt;task_debug/&gt;
<dd> Log debugging information about task execution.
<dt> &lt;file_xfer_debug/&gt;
<dd> Log debugging information about file transfers.
<dt> &lt;sched_op_debug/&gt;
<dd> Log the request and reply messages of exchanges with scheduling servers.
<dt> &lt;http_debug/&gt;
<dd> Log debugging information about HTTP operations.
<dt> &lt;proxy_debug/&gt;
<dd> Log debugging information about HTTP proxy operations.
<dt> &lt;time_debug/&gt;
<dd> Log the passage of time.
<dt> &lt;net_xfer_debug/&gt;
<dd> Log debugging information about network communication.
<dt> &lt;measurement_debug/&gt;
<dd> Log debugging information about measurements of CPU speed, platform, disk space, etc.
<dt> &lt;poll_debug/&gt;
<dd> Show what poll functions do
<dt> &lt;guirpc_debug/&gt;
<dd> Log debugging information about the GUI RPC interface.
<dt> &lt;sched_cpu_debug/&gt;
<dd> Log debugging information about the CPU scheduler.
<dt> &lt;scrsave_debug/&gt;
<dd> Log debugging information about the screen saver.
<dt> &lt;dont_check_file_sizes/&gt;
<dd> Don't check file sizes
</dl>
";
page_tail();
?>

79
doc/client_msgs.php Normal file
View File

@ -0,0 +1,79 @@
<?php
require_once("docutil.php");
page_head("Controlling message from the core client");
echo "
The core client generates messages:
informational messages saying what it's doing,
and error messages when it encounters problems.
If you run the BOINC manager, these appear in the Messages tab -
informational messages in black, error messages in red.
On Unix, informational messages are written to standard output,
and error messages are written to standard error.
<p>
addition, the core client can write a variety of 'logging' messages.
The logging options are read from a file
<b>log_flags.xml</b>.
This file has the following format:
".html_text("
<log_flags>
[ flags ]
</log_flags>
")."
The flags are as follows:
";
list_start();
list_item_func("<task/>",
"Log the start, restart and completion of computational tasks."
);
list_item_func("<file_xfer/>",
" Log the start, restart and completion of file transfers. "
);
list_item_func("<sched_ops/>",
" Log connections with scheduling servers. "
);
list_item_func("<state_debug/>",
" Log changes to the 'client state' data structures. "
);
list_item_func("<task_debug/>",
" Log debugging information about task execution. "
);
list_item_func("<file_xfer_debug/>",
" Log debugging information about file transfers. "
);
list_item_func("<sched_op_debug/>",
" Log the request and reply messages of exchanges with scheduling servers. "
);
list_item_func("<http_debug/>",
" Log debugging information about HTTP operations. "
);
list_item_func("<proxy_debug/>",
" Log debugging information about HTTP proxy operations. "
);
list_item_func("<time_debug/>",
" Log the passage of time. "
);
list_item_func("<net_xfer_debug/>",
" Log debugging information about network communication. "
);
list_item_func("<measurement_debug/>",
" Log debugging information about measurements of CPU speed, platform, disk space, etc. "
);
list_item_func("<poll_debug/>",
" Show what poll functions do"
);
list_item_func("<guirpc_debug/>",
" Log debugging information about the GUI RPC interface. "
);
list_item_func("<sched_cpu_debug/>",
" Log debugging information about the CPU scheduler. "
);
list_item_func("<scrsave_debug/>",
" Log debugging information about the screen saver. "
);
list_item_func("<dont_check_file_sizes/>",
" Don't check file sizes"
);
list_end();
page_tail();
?>

141
doc/client_unix.php
View File

@ -1,24 +1,22 @@
<?php
require_once("docutil.php");
page_head("The BOINC command-line client");
page_head("The BOINC core client as a command-line program");
echo "
<h2>Components</h2>
<p>
The BOINC client software can be run in a command-line
The BOINC core client can be run in a command-line
(non-graphical) environment.
This involves two programs:
<ul>
<li> The <b>core client</b> (boinc_client),
a non-interactive program intended to be run as a background or daemon process.
<li> A <b>command tool</b> (boinc_cmd) that provides
an interactive command-line interface to a running core client.
</ul>
Command-line options provide minimal control
(e.g. the ability attach and detach projects).
More detailed control, and the ability to interact
with a running client,
is provided by a separate command
<a href=boinc_cmd.php>command tool</a>.
<p>
Instructions for installing these programs,
and for automatic startup of the core client, are
<a href=bare_core.php>here</a>.
<h2>The core client (boinc_client)</h2>
<p>
<h3>command-line options</h3>
<h3>Command-line options</h3>
";
list_start();
list_item("-help",
@ -74,8 +72,7 @@ list_item("-no_gui_rpc",
);
list_end();
echo "
<p>
The core client has the following optional environment variables:
<h2>Environment variables</h2>
";
list_start();
list_item("HTTP_PROXY", "URL of HTTP proxy");
@ -87,116 +84,28 @@ list_item("SOCKS5_USER", "User name for SOCKS authentication");
list_item("SOCKS5_PASSWD", "Password for SOCKS authentication");
list_end();
echo "
<h2>The command tool (boinc_cmd)</h2>
<p>
The command-line interface program has the following interface:
<pre>
boinc_cmd [--host hostname] [--passwd passwd] command
</pre>
The options and commands are as follows:
<h2>Command-line options for debugging</h2>
";
list_start();
list_item("--help, -h", "help (show commands)");
list_item("--version, -V", "show version");
list_item("--host", "The host to connect to (default: localhost)");
list_item("--password", "The password for RPC authentication
(default: boinc_cmd will look for a file 'gui_rpc_auth.cfg'
and use the password it contains)"
list_item(" -exit_when_idle ",
" Exit when we're not working on anything and a scheduling server
gives a 'no work' return."
);
list_item("--get_state", "show client state");
list_item("--get_results", "show results");
list_item("--get_file_transfers", "show file transfers");
list_item("--get_project_status", "show status of all projects");
list_item("--get_disk_usage", "Show disk usage by project");
list_item("--result URL result_name
<br>{suspend | resume | abort | graphics_window | graphics_fullscreen}
<br>{--window_station ws} {--desktop dt} {--display dp}
",
"Do operation on a result, identified by the project master URL
and the result name.
<ul>
<li> suspend: temporarily stop work on result
<li> resume: allow work on result
<li> abort: permanently stop work on result
<li> graphics_window: open graphics in a window.
The optional desktop/window_station (Windows) or display (X11)
arguments specify the display.
<li> graphics_fullscreen: open graphics fullscreen
</ul>
"
list_item(" -no_time_test",
" Don't run performance benchmarks; used fixed numbers instead."
);
list_item("--project URL
<br>{reset | detach | update | suspend | resume | nomorework | allowmorework}
",
"Do operation on a project, identified by its master URL.
<ul>
<li>reset: delete current work and get more;
<li>detach: delete current work and don't get more;
<li>update: contact scheduling server;
<li>suspend: stop work for project;
<li>result: resume work for projrect;
<li>nomorework: finish current work but don't get more;
<li>allowmorework: undo nomorework
</ul>
"
list_item(" -exit_after N",
" Exit after about N seconds"
);
list_item("--project_attach URL auth","Attach to an account");
list_item("--file_transfer URL filename
{retry | abort}
",
"Do operation on a file transfer"
list_item(" -giveup_after N",
" Give up on file transfers after N seconds (default is 2 weeks)"
);
list_item("--get_run_mode","Get current run mode");
list_item("--set_run_mode {always | auto | never}",
"Set run mode.
<br>always: do work (network + CPU) always
<br>auto: do work only when allowed by preferences
<br>never: don't do work (same as suspending all projects)
"
list_item(" -limit_transfer_rate N",
" Limit total network traffic to N bytes/sec."
);
list_item("--get_network_mode","Get current network mode");
list_item("--set_network_mode {always | auto | never}",
"Set network mode
<br> Like set_run_mode but applies only to network transfers
"
list_item(" -min",
" Put client in the background after starting up"
);
list_item("--get_proxy_settings", "Get proxy settings");
list_item(
"--set_proxy_settings
http_server_name
http_server_port
http_user_name
http_user_passwd
socks_server_name
socks_server_port
socks_version
socks5_user_name
socks5_user_passwd
",
"Set proxy settings (all fields are mandatory)"
);
list_item("--get_messages seqno",
"show messages with sequence numbers beyond the given seqno"
);
list_item("--get_host_info", "Show host info");
list_item("--acct_mgr_rpc URL name password",
"Instruct core client to contact an account manager server."
);
list_item("--run_benchmarks", "Run CPU benchmarks");
list_item("--get_screensaver_mode", "");
list_item(
"--set_screensaver_mode on|off blank_time
<br>{--desktop desktop}
<br>{--window_station window_station}
<br>{--display display}
",
"Tell the core client to start or stop doing fullscreen graphics,
and going to black after blank_time seconds.
The optional arguments specify which desktop/windows_station (Windows)
or display (X11) to use.
"
);
list_item("--quit", "");
list_end();
page_tail();
?>

2
doc/client_windows.php
View File

@ -67,7 +67,7 @@ The work manager window has several tabs:
<li> <b>Messages</b>:
Shows status and error messages.
Messages can be sorted by project or time.
You can <a href=client_debug.php>control what messages are shown</a>.
You can <a href=client_msgs.php>control what messages are shown</a>.
Messages are also written to a file 'messages.txt'.
<li> <b>Disk</b>:

2
doc/manager.php
View File

@ -150,7 +150,7 @@ computer it is connected too.
<h2>Messages</h2>
<p>Shows status and error messages.
Messages can be sorted by project or time.
You can <a href=client_debug.php>control what messages are shown</a>.
You can <a href=client_msgs.php>control what messages are shown</a>.
Messages are also written to a file 'stdoutdae.txt'.</p>
<img src=mgrmessages.png>