boinc_cmd1

Command line interface to the boinc core client

Part of boinccmd(1).

Usage

boinccmd [--host hostname [:port]] [--passwd passwd] command boinccmd [-hV]

Overview

The BOINC command tool (boinccmd) provides a command line interface to a running BOINC core client (boinc(1)).

Options

FC--hostF[0] hostname[:port]: Connect to the host hostname. The default host is localhost.

FC--passwdF[0] passwd: Use passwd as password for RPC authentication. If the current working directory contains a file FCgui_rpc_auth.cfgF[0], boinccmd will read the password from this file.

FC-hF[0], FC--helpF[0]: Show a help message and all commands.

FC-VF[0], FC--versionF[0]: Show the version of the program.

Commands

Account query and attach

`FC--lookup_accountF[0] URL email passwd`	Look up account and print account key.
`FC--create_accountF[0] URL email passwd name`	Create account with the given email address, password, and user name.
`FC--project_attachF[0] URL account_key`	Attach to an account.
`FC--join_acct_mgrF[0] URL name passwd`	Attach to an account manager (or do RPC if already attached).
`FC--quit_acct_mgrF[0]`	Detach from the current account manager.

State queries

`FC--get_stateF[0]`	Show complete client state.
`FC--get_resultsF[0]`	Show all results.
`FC--get_simple_gui_infoF[0]`	Show status of projects and active results.
`FC--get_file_transfersF[0]`	Show all current file transfers.
`FC--get_project_statusF[0]`	Show status of all projects.
`FC--get_disk_usageF[0]`	Show disk usage of all projects.
`FC--get_proxy_settingsF[0]`	Get proxy settings.
`FC--get_messagesF[0] seqno`	Show messages with sequence numbers beyond seqno.
`FC--get_host_infoF[0]`	Show system information about the host where the BOINC client is running.

Control operations

FC--resultF[0] URL result_name {suspend | resume | abort | graphics_window | graphics_fullscreen} [--desktop dt | --window_station ws | --display dp]

Do operation on a result.

FCsuspendF[0]: Temporarily stop work on result.

FCresumeF[0]: Allow work on result.

FCabortF[0]: Permanently stop work on result.

FCgraphics_windowF[0]: Open graphics in a window. The optional desktop / window_station (Windows) or display (X11) arguments specify the display.

FCgraphics_fullscreenF[0]: Open graphics fullscreen.

FC--projectF[0] URL {reset | detach | update | suspend | resume | nomorework | allowmorework | detach_when_done}

Do operation on a project, identified by its master URL.

FCresetF[0]: Delete current work and get more.

FCdetachF[0]: Delete current work and don't get more.

FCupdateF[0]: Contact scheduling server.

FCsuspendF[0]: Stop work for project.

FCresumeF[0]: Resume work for project.

FCnomoreworkF[0]: Finish current work but don't get more.

FCallowmoreworkF[0]: Undo FCnomoreworkF[0].

FCdetach_when_doneF[0]: Detach project.

FC--file_transferF[0] URL filename {retry | abort}: Do operation on a file transfer.

FC--set_run_modeF[0] {always | auto | never} [duration]

Set run mode.

FCalwaysF[0]: Do CPU work always.

FCautoF[0]: Do work only when allowed by preferences.

FCneverF[0]: Don't do work.

If duration is zero or absent, this mode is permanent. Otherwise, after duration seconds elapse, revert to last permanent mode.

FC--set_network_modeF[0] {always | auto | never} [duration]: Set network mode. Like FC--set_run_modeF[0] but applies to network transfers only.

FC--set_proxy_settingsF[0] 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 mandantory.

FC--run_benchmarksF[0]: Run CPU benchmarks.

FC--set_screensaver_modeF[0] {on | off} blank_time [--desktop dt | --window_station ws | --display dp]: 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.

FC--read_global_prefs_overrideF[0]: Tell the core client to read the FCglobal_prefs_override.xmlF[0] file and incorporate any global preferences indicated there.

FC--quitF[0]: Tell the core client to quit.

FC--read_cc_configF[0]: Reread the configuration file (FCcc_config.xmlF[0]).

FC--set_debtsF[0] URL1 STD1 LTD1 [URL2 STD2 LTD2 ...]: Set the short- and long-term debts of one or more projects. Note, if you adjust the debts of a single project, the debts of other projects are changed. So if you want to set the debts of multiple projects, do it in a single command.

FC--get_project_configF[0] URL: Fetch configuration at project located at URL.

FC--get_project_config_pollF[0]

FC--network_availableF[0]

FC--get_cc_statusF[0]

Releases

2 releases since Debian 4.0 (Etch); the text changed 1 time.

--create_account_poll until Debian 4.0 (Etch); --get_disk_usage until Debian 4.0 (Etch); --get_file_transfers until Debian 4.0 (Etch); --get_host_info until Debian 4.0 (Etch); --get_messages until Debian 4.0 (Etch); --get_network_mode until Debian 4.0 (Etch); --get_project_config until Debian 4.0 (Etch); --get_project_config_poll until Debian 4.0 (Etch); --get_project_status until Debian 4.0 (Etch); --get_proxy_settings until Debian 4.0 (Etch); --get_results until Debian 4.0 (Etch); --get_run_mode until Debian 4.0 (Etch); --get_screensaver_mode until Debian 4.0 (Etch); --get_state until Debian 4.0 (Etch); --help until Debian 4.0 (Etch); --host until Debian 4.0 (Etch); --lookup_account_poll until Debian 4.0 (Etch); --passwd until Debian 4.0 (Etch); --quit until Debian 4.0 (Etch); --read_global_prefs_override until Debian 4.0 (Etch); --run_benchmarks until Debian 4.0 (Etch); --version until Debian 4.0 (Etch); -V until Debian 4.0 (Etch); -h until Debian 4.0 (Etch).