---
name: "boinc_cmd"
section: "1"
platform: "linux"
package: "boinc-client"
version: "6.2.14-3"
release: "Debian 5.0 (Lenny)"
platforms: ["linux"]
url: "https://new.carta.tech/boinccmd"
---

# boinc\_cmd(1)

command line interface to the BOINC core client

Part of [boinccmd(1)](/boinccmd/1.md).

## NAME

boinccmd - command line interface to the BOINC core client

## SYNOPSIS

**boinccmd**  \[**--host** *hostname*\[:*port*\]\] \[**--passwd** *passwd*\] {*command*} **boinccmd**  \[**-hV**\]

Notice that the order of the options is important. The FC**--host**F\[0\] and FC**--passwd**F\[0\] options must precede any command.

## DESCRIPTION

The BOINC command tool (**boinccmd**) provides a command line interface to a running BOINC core client ([**boinc**(1)](/boinc/1.md)).

## OPTIONS

- FC**--host**F\[0\] *hostname*\[:*port*\]

  Connect to the host *hostname*. The default host is localhost.

- FC**--passwd**F\[0\] *passwd*

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

- FC**-h**F\[0\], FC**--help**F\[0\]

  Show a help message and all commands.

- FC**-V**F\[0\], FC**--version**F\[0\]

  Show the version of the program.

## COMMANDS

### ACCOUNT QUERY AND ATTACH

- FC**--lookup\_account**F\[0\] *URL* *email* *passwd*

  Look up account and print account key.

- FC**--create\_account**F\[0\] *URL* *email* *passwd* *name*

  Create account with the given email address, password, and user name.

- FC**--project\_attach**F\[0\] *URL* *account\_key*

  Attach to an account.

- FC**--join\_acct\_mgr**F\[0\] *URL* *name* *passwd*

  Attach to an account manager (or do RPC if already attached).

- FC**--quit\_acct\_mgr**F\[0\]

  Detach from the current account manager.

### STATE QUERIES

- FC**--get\_state**F\[0\]

  Show complete client state.

- FC**--get\_results**F\[0\]

  Show all results.

- FC**--get\_simple\_gui\_info**F\[0\]

  Show status of projects and active results.

- FC**--get\_file\_transfers**F\[0\]

  Show all current file transfers.

- FC**--get\_project\_status**F\[0\]

  Show status of all projects.

- FC**--get\_disk\_usage**F\[0\]

  Show disk usage of all projects.

- FC**--get\_proxy\_settings**F\[0\]

  Get proxy settings.

- FC**--get\_messages**F\[0\] *seqno*

  Show messages with sequence numbers beyond *seqno*.

- FC**--get\_host\_info**F\[0\]

  Show system information about the host where the BOINC client is running.

### CONTROL OPERATIONS

- FC**--result**F\[0\] *URL* *result\_name* {suspend \| resume \| abort \| graphics\_window \| graphics\_fullscreen} \[--desktop *dt* \| --window\_station *ws* \| --display *dp*\]

  Do operation on a result.

  - FC**suspend**F\[0\]

    Temporarily stop work on result.

  - FC**resume**F\[0\]

    Allow work on result.

  - FC**abort**F\[0\]

    Permanently stop work on result.

  - FC**graphics\_window**F\[0\]

    Open graphics in a window. The optional desktop / window\_station (Windows) or display (X11) arguments specify the display.

  - FC**graphics\_fullscreen**F\[0\]

    Open graphics fullscreen.

- FC**--project**F\[0\] *URL* {reset \| detach \| update \| suspend \| resume \| nomorework \| allowmorework \| detach\_when\_done}

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

  - FC**reset**F\[0\]

    Delete current work and get more.

  - FC**detach**F\[0\]

    Delete current work and don't get more.

  - FC**update**F\[0\]

    Contact scheduling server.

  - FC**suspend**F\[0\]

    Stop work for project.

  - FC**resume**F\[0\]

    Resume work for project.

  - FC**nomorework**F\[0\]

    Finish current work but don't get more.

  - FC**allowmorework**F\[0\]

    Undo FC**nomorework**F\[0\].

  - FC**detach\_when\_done**F\[0\]

    Detach project.

- FC**--file\_transfer**F\[0\] *URL* *filename* {retry \| abort}

  Do operation on a file transfer.

- FC**--set\_run\_mode**F\[0\] {always \| auto \| never} \[*duration*\]

  Set run mode.

  - FC**always**F\[0\]

    Do CPU work always.

  - FC**auto**F\[0\]

    Do work only when allowed by preferences.

  - FC**never**F\[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\_mode**F\[0\] {always \| auto \| never} \[*duration*\]

  Set network mode. Like FC**--set\_run\_mode**F\[0\] but applies to network transfers only.

- FC**--set\_proxy\_settings**F\[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\_benchmarks**F\[0\]

  Run CPU benchmarks.

- FC**--set\_screensaver\_mode**F\[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\_override**F\[0\]

  Tell the core client to read the FC*global\_prefs\_override.xml*F\[0\] file and incorporate any global preferences indicated there.

- FC**--quit**F\[0\]

  Tell the core client to quit.

- FC**--read\_cc\_config**F\[0\]

  Reread the configuration file (FC*cc\_config.xml*F\[0\]).

- FC**--set\_debts**F\[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\_config**F\[0\] *URL*

  Fetch configuration at project located at *URL*.

- FC**--get\_project\_config\_poll**F\[0\]

  - FC**--network\_available**F\[0\]

  - FC**--get\_cc\_status**F\[0\]

  ## SEE ALSO

[**boinc**(1)](/boinc/1.md), [**boincmgr**(1)](/boincmgr/1.md)

 ⟨http://boinc.berkeley.edu/trac/wiki/BoincCmd⟩

## COPYRIGHT

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.