The command line interface to the boinc client.
boinccmd \kx [--host hostname[:port]] [--passwd passwd] {command} boinccmd \kx [-hV]
Notice that the order of the options is important. The \*(T<--host\*(T> and \*(T<--passwd\*(T> options must precede any command.
The BOINC command tool (boinccmd) provides a command line interface to control a running BOINC client (boinc(1)). It communicates with a running client using port 31416 over TCP/IP. It can only connect to one client at a time.
\*(T<--host\*(T> hostname[:port]
Connect to the host hostname. The default host is localhost.
\*(T<--passwd\*(T> passwd
Use passwd as password for RPC authentication. If the current working directory contains a file \*(T<gui_rpc_auth.cfg\*(T>, boinccmd will read the password from this file.
\*(T<-h\*(T>, \*(T<--help\*(T>
Show a help message and all commands.
\*(T<-V\*(T>, \*(T<--version\*(T>
Show the version of the program.
\*(T<--lookup_account\*(T> URL email passwd
Look up account and print account key.
\*(T<--create_account\*(T> URL email passwd name
Create account with the given email address, password, and user name.
\*(T<--project_attach\*(T> URL account_key
Attach to an account using the project URL and authenticator (send via email after \*(T<--create_account\*(T> was succesfull).
\*(T<--join_acct_mgr\*(T> URL name passwd
Attach to an account manager (or do RPC if already attached). The account has to be created via the account manager website.
\*(T<--quit_acct_mgr\*(T>
Detach from the current account manager.
\*(T<--get_state\*(T>
Show complete client state.
\*(T<--get_cc_status\*(T>
Show only current CPU, GPU and network modes.
\*(T<--get_tasks\*(T>
Show all tasks of the client (in progress, waiting and completed only). Tasks that where reported to the project server are not shown here.
\*(T<--get_simple_gui_info\*(T>
Show status of projects and active tasks.
\*(T<--get_file_transfers\*(T>
Show all current file transfers.
\*(T<--get_project_status\*(T>
Show status of all projects.
\*(T<--get_disk_usage\*(T>
Show disk usage of all projects.
\*(T<--get_proxy_settings\*(T>
Get proxy settings.
\*(T<--get_messages\*(T> seqno
Show messages with sequence numbers beyond seqno.
\*(T<--get_message_count\*(T>
Show largest message sequence number.
\*(T<--get_notices\*(T> seqno
Show project notices with sequence numbers beyond seqno.
\*(T<--get_host_info\*(T>
Show system information about the host where the BOINC client is running.
\*(T<--get_daily_xfer_history\*(T>
Show network traffic history of the BOINC client.
\*(T<--task\*(T> URL task_name {suspend | resume | abort}
Do operation on a task.
\*(T<suspend\*(T>
Temporarily stop work on task.
\*(T<resume\*(T>
Allow work on task.
\*(T<abort\*(T>
Permanently stop work on task.
\*(T<--project\*(T> URL {reset | detach | update | suspend | resume | nomorework | allowmorework | detach_when_done | dont_detach_when_done}
Do operation on a project, identified by its master URL.
\*(T<reset\*(T>
Delete current tasks, applications and other files from this project, request new tasks.
\*(T<detach\*(T>
Delete current tasks applications and other files from this project, don't request any new tasks.
\*(T<update\*(T>
Contact project scheduling server.
\*(T<suspend\*(T>
Stop all tasks for project.
\*(T<resume\*(T>
Resume tasks for project.
\*(T<nomorework\*(T>
Finish all downloaded tasks but don't get more.
\*(T<allowmorework\*(T>
Undo \*(T<nomorework\*(T>.
\*(T<detach_when_done\*(T>
Detach project after all tasks are finished.
\*(T<dont_detach_when_done\*(T>
Undo \*(T<detach_when_done\*(T>.
\*(T<--file_transfer\*(T> URL filename {retry | abort}
Do operation on a file transfer.
\*(T<retry\*(T>
Retry file transfer.
\*(T<abort\*(T>
Permanently abort file transfer.
\*(T<--set_run_mode\*(T> {always | auto | never} [duration]
Set run mode (applies to CPU and GPU).
\*(T<always\*(T>
Do work always.
\*(T<auto\*(T>
Do work only when allowed by preferences.
\*(T<never\*(T>
Don't do work.
If duration is zero or absent, this mode is permanent. Otherwise, after duration seconds elapse, revert to last permanent mode.
\*(T<--set_network_mode\*(T> {always | auto | never} [duration]
Set network mode. Like \*(T<--set_run_mode\*(T> but applies to network transfers only.
\*(T<--set_gpu_mode\*(T> {always | auto | never} [duration]
Set GPU mode. Like \*(T<--set_run_mode\*(T> but applies to GPU processing only.
\*(T<--set_proxy_settings\*(T> http_server_name http_server_port http_user_name http_user_passwd socks_server_name socks_server_port socks5_user_name socks5_user_passwd noproxy_hosts
Set proxy settings. All fields are mandatory.
\*(T<--run_benchmarks\*(T>
Run CPU benchmarks.
\*(T<--read_global_prefs_override\*(T>
Tell the client to read the \*(T<global_prefs_override.xml\*(T> file and incorporate any global preferences indicated there.
\*(T<--quit\*(T>
Tell the client to quit.
\*(T<--read_cc_config\*(T>
Tell the client to reread the configuration file (\*(T<cc_config.xml\*(T>).
\*(T<--get_project_config\*(T> URL
Fetch configuration of project located at URL.
\*(T<--network_available\*(T>
Tell the client to retry deferred network communication.
\$2 \(la\$1\(ra\$3
Copyright © 2007-2008 University of California.
Permission is granted to copy, distribute and/or modify this document under the terms of the GNU Free Documentation License, Version 1.2 or any later version published by the Free Software Foundation; with no Invariant Sections, no Front-Cover Texts, and no Back-Cover Texts.