boinccmd(1)

NAME
boinccmd - The command line interface to the BOINC client.

SYNOPSIS
\FCboinccmd\F[]
[\FC--host\F[] hostname[:port]] [\FC--passwd\F[] passwd] {command}
\FCboinccmd\F[]
[\FC-hV\F[]]

Notice that the order of the options is important. The \FC--host\F[] and \FC--passwd\F[] 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--host\F[] hostname[:port]
    Connect to the host hostname. The default host is localhost.

\FC--passwd\F[] passwd
    Use passwd as password for RPC authentication. If the current working directory contains a file \FCgui_rpc_auth.cfg\F[], boinccmd will read the password from this file.

\FC-h\F[], \FC--help\F[]
    Show a help message and all commands.

\FC-V\F[], \FC--version\F[]
    Show the version of the program.

COMMANDS

  ACCOUNT QUERY AND ATTACH

\FC--lookup_account\F[] URL email passwd
    Look up account and print account key.

\FC--create_account\F[] URL email passwd name
    Create account with the given email address, password, and user name.

\FC--project_attach\F[] URL account_key
    Attach to an account using the project URL and authenticator (sent via email after \FC--create_account\F[] was successful).

\FC--join_acct_mgr\F[] 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_mgr\F[]
    Detach from the current account manager.

  STATE QUERIES

\FC--get_state\F[]
    Show complete client state.

\FC--get_cc_status\F[]
    Show only current CPU, GPU and network modes.

\FC--get_tasks\F[]
    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_info\F[]
    Show status of projects and active tasks.

\FC--get_file_transfers\F[]
    Show all current file transfers.

\FC--get_project_status\F[]
    Show status of all projects.

\FC--get_disk_usage\F[]
    Show disk usage of all projects.

\FC--get_proxy_settings\F[]
    Get proxy settings.

\FC--get_messages\F[] seqno
    Show messages with sequence numbers beyond seqno.

\FC--get_message_count\F[]
    Show largest message sequence number.

\FC--get_notices\F[] seqno
    Show project notices with sequence numbers beyond seqno.

\FC--get_host_info\F[]
    Show system information about the host where the BOINC client is running.

\FC--get_daily_xfer_history\F[]
    Show network traffic history of the BOINC client.

  CONTROL OPERATIONS

\FC--task\F[] URL task_name {suspend | resume | abort}
    Do operation on a task.

    \FCsuspend\F[]
        Temporarily stop work on task.

    \FCresume\F[]
        Allow work on task.

    \FCabort\F[]
        Permanently stop work on task.

\FC--project\F[] 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.

    \FCreset\F[]
        Delete current tasks, applications and other files from this project, request new tasks.

    \FCdetach\F[]
        Delete current tasks applications and other files from this project, don't request any new tasks.

    \FCupdate\F[]
        Contact project scheduling server.

    \FCsuspend\F[]
        Stop all tasks for project.

    \FCresume\F[]
        Resume tasks for project.

    \FCnomorework\F[]
        Finish all downloaded tasks but don't get more.

    \FCallowmorework\F[]
        Undo \FCnomorework\F[].

    \FCdetach_when_done\F[]
        Detach project after all tasks are finished.

    \FCdont_detach_when_done\F[]
        Undo \FCdetach_when_done\F[].

\FC--file_transfer\F[] URL filename {retry | abort}
    Do operation on a file transfer.

    \FCretry\F[]
        Retry file transfer.

    \FCabort\F[]
        Permanently abort file transfer.

\FC--set_run_mode\F[] {always | auto | never} [duration]
    Set run mode (applies to CPU and GPU).

    \FCalways\F[]
        Do work always.

    \FCauto\F[]
        Do work only when allowed by preferences.

    \FCnever\F[]
        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_mode\F[] {always | auto | never} [duration]
    Set network mode. Like \FC--set_run_mode\F[] but applies to network transfers only.

\FC--set_gpu_mode\F[] {always | auto | never} [duration]
    Set GPU mode. Like \FC--set_run_mode\F[] but applies to GPU processing only.

\FC--set_proxy_settings\F[] 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_benchmarks\F[]
    Run CPU benchmarks.

\FC--read_global_prefs_override\F[]
    Tell the client to read the \FCglobal_prefs_override.xml\F[] file and incorporate any global preferences indicated there.

\FC--quit\F[]
    Tell the client to quit.

\FC--read_cc_config\F[]
    Tell the client to reread the configuration file (\FCcc_config.xml\F[]).

\FC--get_project_config\F[] URL
    Fetch configuration of project located at URL.

\FC--network_available\F[]
    Tell the client to retry deferred network communication.

SEE ALSO
boinc(1), boincmgr(1)

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.