'\" -*- coding: us-ascii -*-
.if \n(.g .ds T< \\FC
.if \n(.g .ds T> \\F[\n[.fam]]
.de URL
\\$2 \(la\\$1\(ra\\$3
..
.if \n(.g .mso www.tmac
.TH boinccmd 1 "04 March 2013" "" ""
.SH NAME
boinccmd \- The command line interface to the BOINC client.
.SH SYNOPSIS
'nh
.fi
.ad l
\fBboinccmd\fR \kx
.if (\nx>(\n(.l/2)) .nr x (\n(.l/5)
'in \n(.iu+\nxu
[\fB--host\fR \fIhostname\fR[:\fIport\fR]] [\fB--passwd\fR \fIpasswd\fR] {\fIcommand\fR}
'in \n(.iu-\nxu
.ad b
'hy
'nh
.fi
.ad l
\fBboinccmd\fR \kx
.if (\nx>(\n(.l/2)) .nr x (\n(.l/5)
'in \n(.iu+\nxu
[\fB-hV\fR]
'in \n(.iu-\nxu
.ad b
'hy
.PP
Notice that the order of the options is important. The \*(T<\fB\-\-host\fR\*(T> and \*(T<\fB\-\-passwd\fR\*(T> options must precede any
command.
.SH DESCRIPTION
The BOINC command tool (\fBboinccmd\fR) provides a command line
interface to control a running BOINC client (\fBboinc\fR(1)). It communicates
with a running client using port 31416 over TCP/IP. It can only
connect to one client at a time.
.SH OPTIONS
.TP 
\*(T<\fB\-\-host\fR\*(T> \fIhostname\fR[:\fIport\fR] 
Connect to the host \fIhostname\fR.
The default host is localhost.
.TP 
\*(T<\fB\-\-passwd\fR\*(T> \fIpasswd\fR 
Use \fIpasswd\fR as password for RPC
authentication. If the current working directory contains a file
\*(T<\fIgui_rpc_auth.cfg\fR\*(T>, \fBboinccmd\fR will read
the password from this file.
.TP 
\*(T<\fB\-h\fR\*(T>, \*(T<\fB\-\-help\fR\*(T>
Show a help message and all commands.
.TP 
\*(T<\fB\-V\fR\*(T>, \*(T<\fB\-\-version\fR\*(T>
Show the version of the program.
.SH COMMANDS
.SS "ACCOUNT QUERY AND ATTACH"
.TP 
\*(T<\fB\-\-lookup_account\fR\*(T> \fIURL\fR \fIemail\fR \fIpasswd\fR 
Look up account and print account key.
.TP 
\*(T<\fB\-\-create_account\fR\*(T> \fIURL\fR \fIemail\fR \fIpasswd\fR \fIname\fR 
Create account with the given email address, password, and
user name.
.TP 
\*(T<\fB\-\-project_attach\fR\*(T> \fIURL\fR \fIaccount_key\fR 
Attach to an account using the project URL and authenticator
(send via email after \*(T<\fB\-\-create_account\fR\*(T> was
successful).
.TP 
\*(T<\fB\-\-join_acct_mgr\fR\*(T> \fIURL\fR \fIname\fR \fIpasswd\fR 
Attach to an account manager (or do RPC if already attached).
The account has to be created via the account manager website.
.TP 
\*(T<\fB\-\-quit_acct_mgr\fR\*(T>
Detach from the current account manager.
.SS "STATE QUERIES"
.TP 
\*(T<\fB\-\-get_state\fR\*(T>
Show complete client state.
.TP 
\*(T<\fB\-\-get_cc_status\fR\*(T>
Show only current CPU, GPU and network modes.
.TP 
\*(T<\fB\-\-get_tasks\fR\*(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.
.TP 
\*(T<\fB\-\-get_simple_gui_info\fR\*(T>
Show status of projects and active tasks.
.TP 
\*(T<\fB\-\-get_file_transfers\fR\*(T>
Show all current file transfers.
.TP 
\*(T<\fB\-\-get_project_status\fR\*(T>
Show status of all projects.
.TP 
\*(T<\fB\-\-get_disk_usage\fR\*(T>
Show disk usage of all projects.
.TP 
\*(T<\fB\-\-get_proxy_settings\fR\*(T>
Get proxy settings.
.TP 
\*(T<\fB\-\-get_messages\fR\*(T> \fIseqno\fR 
Show messages with sequence numbers beyond
\fIseqno\fR.
.TP 
\*(T<\fB\-\-get_message_count\fR\*(T> 
Show largest message sequence number.
.TP 
\*(T<\fB\-\-get_notices\fR\*(T> \fIseqno\fR 
Show project notices with sequence numbers beyond
\fIseqno\fR.
.TP 
\*(T<\fB\-\-get_host_info\fR\*(T>
Show system information about the host where the BOINC
client is running.
.TP 
\*(T<\fB\-\-get_daily_xfer_history\fR\*(T>
Show network traffic history of the BOINC client.
.SS "CONTROL OPERATIONS"
.TP 
\*(T<\fB\-\-task\fR\*(T> \fIURL\fR \fItask_name\fR {suspend | resume | abort} 
Do operation on a task.
.RS 
.TP 
\*(T<\fBsuspend\fR\*(T>
Temporarily stop work on task.
.TP 
\*(T<\fBresume\fR\*(T>
Allow work on task.
.TP 
\*(T<\fBabort\fR\*(T>
Permanently stop work on task.
.RE
.TP 
\*(T<\fB\-\-project\fR\*(T> \fIURL\fR {reset | detach | update | suspend | resume | nomorework | allowmorework | detach_when_done | dont_detach_when_done} 
Do operation on a project, identified by its master
URL.
.RS 
.TP 
\*(T<\fBreset\fR\*(T>
Delete current tasks, applications and other files from
this project, request new tasks.
.TP 
\*(T<\fBdetach\fR\*(T>
Delete current tasks applications and other files from
this project, don't request any new tasks.
.TP 
\*(T<\fBupdate\fR\*(T>
Contact project scheduling server.
.TP 
\*(T<\fBsuspend\fR\*(T>
Stop all tasks for project.
.TP 
\*(T<\fBresume\fR\*(T>
Resume tasks for project.
.TP 
\*(T<\fBnomorework\fR\*(T>
Finish all downloaded tasks but don't get more.
.TP 
\*(T<\fBallowmorework\fR\*(T>
Undo \*(T<\fBnomorework\fR\*(T>.
.TP 
\*(T<\fBdetach_when_done\fR\*(T>
Detach project after all tasks are finished.
.TP 
\*(T<\fBdont_detach_when_done\fR\*(T>
Undo \*(T<\fBdetach_when_done\fR\*(T>.
.RE
.TP 
\*(T<\fB\-\-file_transfer\fR\*(T> \fIURL\fR \fIfilename\fR {retry | abort} 
Do operation on a file transfer.
.RS 
.TP 
\*(T<\fBretry\fR\*(T>
Retry file transfer.
.TP 
\*(T<\fBabort\fR\*(T>
Permanently abort file transfer.
.RE
.TP 
\*(T<\fB\-\-set_run_mode\fR\*(T> {always | auto | never} [\fIduration\fR] 
Set run mode (applies to CPU and GPU).
.RS 
.TP 
\*(T<\fBalways\fR\*(T>
Do work always.
.TP 
\*(T<\fBauto\fR\*(T>
Do work only when allowed by preferences.
.TP 
\*(T<\fBnever\fR\*(T>
Don't do work.
.RE

If \fIduration\fR is zero or absent,
this mode is permanent. Otherwise, after
\fIduration\fR seconds elapse, revert to last
permanent mode.
.TP 
\*(T<\fB\-\-set_network_mode\fR\*(T> {always | auto | never} [\fIduration\fR] 
Set network mode. Like \*(T<\fB\-\-set_run_mode\fR\*(T> but
applies to network transfers only.
.TP 
\*(T<\fB\-\-set_gpu_mode\fR\*(T> {always | auto | never} [\fIduration\fR] 
Set GPU mode. Like \*(T<\fB\-\-set_run_mode\fR\*(T> but
applies to GPU processing only.
.TP 
\*(T<\fB\-\-set_proxy_settings\fR\*(T> \fIhttp_server_name\fR \fIhttp_server_port\fR \fIhttp_user_name\fR \fIhttp_user_passwd\fR \fIsocks_server_name\fR \fIsocks_server_port\fR \fIsocks5_user_name\fR \fIsocks5_user_passwd\fR \fInoproxy_hosts\fR 
Set proxy settings. All fields are mandatory.
.TP 
\*(T<\fB\-\-run_benchmarks\fR\*(T>
Run CPU benchmarks.
.TP 
\*(T<\fB\-\-read_global_prefs_override\fR\*(T>
Tell the client to read the
\*(T<\fIglobal_prefs_override.xml\fR\*(T> file and
incorporate any global preferences indicated there.
.TP 
\*(T<\fB\-\-quit\fR\*(T>
Tell the client to quit.
.TP 
\*(T<\fB\-\-read_cc_config\fR\*(T>
Tell the client to reread the configuration file
(\*(T<\fIcc_config.xml\fR\*(T>).
.TP 
\*(T<\fB\-\-get_project_config\fR\*(T> \fIURL\fR 
Fetch configuration of project located at
\fIURL\fR.
.TP 
\*(T<\fB\-\-network_available\fR\*(T>
Tell the client to retry deferred network communication.
.SH "SEE ALSO"
\fBboinc\fR(1), \fBboincmgr\fR(1)
.PP
.URL https://boinc.berkeley.edu/wiki/Boinccmd_tool ""
.SH COPYRIGHT
Copyright \(co 2007-2008 University of California.
.PP
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.