NAME
boinccmd - The command line interface to the BOINC client.
SYNOPSIS
FCboinccmdF[0] [FC--hostF[0] hostname[:port]] [FC--passwdF[0] passwd] {command} FCboinccmdF[0] [FC-hVF[0]]
Notice that the order of the options is important. The FC--hostF[0] and FC--passwdF[0] options must precede any command.
DESCRIPTION
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.
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 using the project URL and authenticator (sent via email after FC--create_accountF[0] was successful).
- FC--join_acct_mgrF[0] 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.
- FC--quit_acct_mgrF[0]
-
Detach from the current account manager.
STATE QUERIES
- FC--get_stateF[0]
-
Show complete client state.
- FC--get_cc_statusF[0]
-
Show only current CPU, GPU and network modes.
- FC--get_tasksF[0]
-
Show all tasks of the client (in progress, waiting and completed only). Tasks that where reported to the project server are not shown here.
- FC--get_simple_gui_infoF[0]
-
Show status of projects and active tasks.
- 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_message_countF[0]
-
Show largest message sequence number.
- FC--get_noticesF[0] seqno
-
Show project notices with sequence numbers beyond seqno.
- FC--get_host_infoF[0]
-
Show system information about the host where the BOINC client is running.
- FC--get_daily_xfer_historyF[0]
-
Show network traffic history of the BOINC client.
CONTROL OPERATIONS
- FC--taskF[0] URL task_name {suspend | resume | abort}
-
Do operation on a task.
- FCsuspendF[0]
-
Temporarily stop work on task.
- FCresumeF[0]
-
Allow work on task.
- FCabortF[0]
-
Permanently stop work on task.
- FC--projectF[0] 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.
- FCresetF[0]
-
Delete current tasks, applications and other files from this project, request new tasks.
- FCdetachF[0]
-
Delete current tasks applications and other files from this project, don't request any new tasks.
- FCupdateF[0]
-
Contact project scheduling server.
- FCsuspendF[0]
-
Stop all tasks for project.
- FCresumeF[0]
-
Resume tasks for project.
- FCnomoreworkF[0]
-
Finish all downloaded tasks but don't get more.
- FCallowmoreworkF[0]
-
Undo FCnomoreworkF[0].
- FCdetach_when_doneF[0]
-
Detach project after all tasks are finished.
- FCdont_detach_when_doneF[0]
-
Undo FCdetach_when_doneF[0].
- FC--file_transferF[0] URL filename {retry | abort}
-
Do operation on a file transfer.
- FCretryF[0]
-
Retry file transfer.
- FCabortF[0]
-
Permanently abort file transfer.
- FC--set_run_modeF[0] {always | auto | never} [duration]
-
Set run mode (applies to CPU and GPU).
- FCalwaysF[0]
-
Do 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_gpu_modeF[0] {always | auto | never} [duration]
-
Set GPU mode. Like FC--set_run_modeF[0] but applies to GPU processing only.
- FC--set_proxy_settingsF[0] 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.
- FC--run_benchmarksF[0]
-
Run CPU benchmarks.
- FC--read_global_prefs_overrideF[0]
-
Tell the client to read the FCglobal_prefs_override.xmlF[0] file and incorporate any global preferences indicated there.
- FC--quitF[0]
-
Tell the client to quit.
- FC--read_cc_configF[0]
-
Tell the client to reread the configuration file (FCcc_config.xmlF[0]).
- FC--get_project_configF[0] URL
-
Fetch configuration of project located at URL.
- FC--network_availableF[0]
-
Tell the client to retry deferred network communication.
SEE ALSO
⟨https://boinc.berkeley.edu/wiki/Boinccmd_tool⟩
COPYRIGHT
Copyright © 2007-2020 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.