Core client/application interaction (basic)
diff --git a/doc/client_debug.php b/doc/client_debug.php
deleted file mode 100644
index 6d241a2dd6..0000000000
--- a/doc/client_debug.php
+++ /dev/null
@@ -1,79 +0,0 @@
-Command-line options
-
-Some command-line options intended for debugging:
-
-- -exit_when_idle
-
- Exit when we're not working on anything and a scheduling server
-gives a 'no work' return.
-
- -no_time_test
-
- Don't run performance benchmarks; used fixed numbers instead.
-
- -exit_after N
-
- Exit after about N seconds
-
- -giveup_after N
-
- Give up on file transfers after N seconds (default is 2 weeks)
-
- -limit_transfer_rate N
-
- Limit total network traffic to N bytes/sec.
-
- -min
-
- Put client in the background after starting up
-
-Logging and error output
-
-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.
-
-In addition, the core client can write a variety of 'logging'
-information to stdout.
-The logging options are read from a file
-log_flags.xml.
-This file has the following format:
-
-<log_flags>
- [ flags ]
-</log_flags>
-
-The flags are as follows:
-
-- <task/>
-
- Log the start, restart and completion of computational tasks.
-
- <file_xfer/>
-
- Log the start, restart and completion of file transfers.
-
- <sched_ops/>
-
- Log connections with scheduling servers.
-
- <state_debug/>
-
- Log changes to the 'client state' data structures.
-
- <task_debug/>
-
- Log debugging information about task execution.
-
- <file_xfer_debug/>
-
- Log debugging information about file transfers.
-
- <sched_op_debug/>
-
- Log the request and reply messages of exchanges with scheduling servers.
-
- <http_debug/>
-
- Log debugging information about HTTP operations.
-
- <proxy_debug/>
-
- Log debugging information about HTTP proxy operations.
-
- <time_debug/>
-
- Log the passage of time.
-
- <net_xfer_debug/>
-
- Log debugging information about network communication.
-
- <measurement_debug/>
-
- Log debugging information about measurements of CPU speed, platform, disk space, etc.
-
- <poll_debug/>
-
- Show what poll functions do
-
- <guirpc_debug/>
-
- Log debugging information about the GUI RPC interface.
-
- <sched_cpu_debug/>
-
- Log debugging information about the CPU scheduler.
-
- <scrsave_debug/>
-
- Log debugging information about the screen saver.
-
- <dont_check_file_sizes/>
-
- Don't check file sizes
-
-";
-page_tail();
-?>
diff --git a/doc/client_msgs.php b/doc/client_msgs.php
new file mode 100644
index 0000000000..6370f5a31c
--- /dev/null
+++ b/doc/client_msgs.php
@@ -0,0 +1,79 @@
+
+addition, the core client can write a variety of 'logging' messages.
+The logging options are read from a file
+log_flags.xml.
+This file has the following format:
+".html_text("
+
+ [ flags ]
+
+")."
+The flags are as follows:
+";
+list_start();
+list_item_func("",
+ "Log the start, restart and completion of computational tasks."
+);
+list_item_func("",
+ " Log the start, restart and completion of file transfers. "
+);
+list_item_func("",
+ " Log connections with scheduling servers. "
+);
+list_item_func("",
+ " Log changes to the 'client state' data structures. "
+);
+list_item_func("",
+ " Log debugging information about task execution. "
+);
+list_item_func("",
+ " Log debugging information about file transfers. "
+);
+list_item_func("",
+ " Log the request and reply messages of exchanges with scheduling servers. "
+);
+list_item_func("",
+ " Log debugging information about HTTP operations. "
+);
+list_item_func("",
+ " Log debugging information about HTTP proxy operations. "
+);
+list_item_func("",
+ " Log the passage of time. "
+);
+list_item_func("",
+ " Log debugging information about network communication. "
+);
+list_item_func("",
+ " Log debugging information about measurements of CPU speed, platform, disk space, etc. "
+);
+list_item_func("",
+ " Show what poll functions do"
+);
+list_item_func("",
+ " Log debugging information about the GUI RPC interface. "
+);
+list_item_func("",
+ " Log debugging information about the CPU scheduler. "
+);
+list_item_func("",
+ " Log debugging information about the screen saver. "
+);
+list_item_func("",
+ " Don't check file sizes"
+);
+list_end();
+
+page_tail();
+?>
diff --git a/doc/client_unix.php b/doc/client_unix.php
index dbb9348aad..aee9f31da9 100644
--- a/doc/client_unix.php
+++ b/doc/client_unix.php
@@ -1,24 +1,22 @@
Components
-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:
-
-- The core client (boinc_client),
-a non-interactive program intended to be run as a background or daemon process.
-
- A command tool (boinc_cmd) that provides
-an interactive command-line interface to a running core client.
-
+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
+command tool.
+
Instructions for installing these programs,
and for automatic startup of the core client, are
here.
-
The core client (boinc_client)
-
command-line options
+Command-line options
";
list_start();
list_item("-help",
@@ -74,8 +72,7 @@ list_item("-no_gui_rpc",
);
list_end();
echo "
-
-The core client has the following optional environment variables:
+
Environment variables
";
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 "
-The command tool (boinc_cmd)
-
-The command-line interface program has the following interface:
-
-boinc_cmd [--host hostname] [--passwd passwd] command
-
-The options and commands are as follows:
+Command-line options for debugging
";
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
-
{suspend | resume | abort | graphics_window | graphics_fullscreen}
-
{--window_station ws} {--desktop dt} {--display dp}
- ",
- "Do operation on a result, identified by the project master URL
- and the result name.
-
- - suspend: temporarily stop work on result
-
- resume: allow work on result
-
- abort: permanently stop work on result
-
- graphics_window: open graphics in a window.
- The optional desktop/window_station (Windows) or display (X11)
- arguments specify the display.
-
- graphics_fullscreen: open graphics fullscreen
-
- "
+list_item(" -no_time_test",
+ " Don't run performance benchmarks; used fixed numbers instead."
);
-list_item("--project URL
-
{reset | detach | update | suspend | resume | nomorework | allowmorework}
- ",
- "Do operation on a project, identified by its master URL.
-
- - reset: delete current work and get more;
-
- detach: delete current work and don't get more;
-
- update: contact scheduling server;
-
- suspend: stop work for project;
-
- result: resume work for projrect;
-
- nomorework: finish current work but don't get more;
-
- allowmorework: undo nomorework
-
- "
+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.
-
always: do work (network + CPU) always
-
auto: do work only when allowed by preferences
-
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
-
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
-
{--desktop desktop}
-
{--window_station window_station}
-
{--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();
?>
diff --git a/doc/client_windows.php b/doc/client_windows.php
index 026b2064be..9a33984d18 100644
--- a/doc/client_windows.php
+++ b/doc/client_windows.php
@@ -67,7 +67,7 @@ The work manager window has several tabs:
