BOINCCMD command line switches - Revision history

Jord: adding missing descriptions, adding missing flags

2016-11-22T00:07:20Z

adding missing descriptions, adding missing flags

Jord: explaining the unknown ones

2016-11-21T23:53:36Z

explaining the unknown ones

Jord: missed one

2016-11-21T23:42:54Z

missed one

Jord: alphabetize

2016-11-21T23:42:21Z

alphabetize

Jord: italicize explanations

2016-11-21T23:24:42Z

italicize explanations

Jord: indenting all

2016-11-21T23:22:02Z

indenting all

Jord: removing time from table

2016-08-29T16:12:13Z

removing time from table

Bowtieguru at 23:25, 5 June 2016

2016-06-05T23:25:43Z

Jord: add formatting and table

2016-06-02T19:44:37Z

add formatting and table

Jord: Adding FAQ 503

2016-05-21T22:31:46Z

Adding FAQ 503

New page

The BOINCCMD program is the command line control program for BOINC. While you can start the BOINC client with its own set of switches, you can set these only once.

The BOINCCMD program allows you to control BOINC multiple times, especially useful for when you lack a GUI (BOINC Manager). Multiple commands per line are possible.

Usage: Boinccmd --command1 --command2 --command3

--lookup_account URL email passwd
Used to check up on your account and get your authenticator key and details sent to you.

--create_account URL email passwd name
Used to make an account at a project, using password such and so, your email address and what nickname to go on the account. Usage: boinccmd --create_account http://setiathome.berkeley.edu joe@email.com RoVeR12 Joe .. Watch out with case sensitivity on password!

--project_attach URL auth
Attach to project using your authenticator key.

--join_acct_mgr URL name passwd
Attach to an account manager.

--quit_acct_mgr
Quit using your current account manager.

--get_state
Show entire state.

--get_results
Show tasks. BOINC 6.12 and before.

--get_tasks
Show tasks. BOINC 7.0 and later.

--get_simple_gui_info
Show status of projects and active tasks.

--get_file_transfers
Show file transfers.

--get_project_status
Show status of all attached projects.

--get_disk_usage
Show disk usage per project attached.

--get_proxy_settings
Show proxy settings.

--get_messages
Show messages, if need be output per sequence number.

--get_message_count
Show largest message sequence number.

--get_host_info
Shows details about your host, such as CPU used, Network name, operating system, disk size, etc.

--version, -V
Show core client version.

--result url task_name operation
Job operation options = suspend | resume | abort | graphics_window | graphics_fullscreen

--project URL operation
Project operation options = reset | detach | update | suspend | resume | nomorework | allowmorework

--file_transfer URL filename operation
File transfer operation options = retry | abort

--set_gpu_mode
Sets GPU mode. Options always | auto | never

--set_run_mode mode duration
Set run mode for given duration mode = always | auto | never

--set_network_mode mode duration
Set run mode for given duration mode = always | auto | never

--set_proxy_settings
Set up your proxy settings.

--run_benchmarks
Run CPU benchmarks.

--read_global_prefs_override
(Re-)Read the global_prefs_override.xml file.

--quit
Quit running the BOINC client.

--read_cc_config
(Re-)read the client configuration file (cc_config.xml).

--set_debts URL1 std1 ltd1
Used to (re-)set the short term and long term debts of any given project. Usage: boinccmd --set_debts http://setiathome.berkeley.edu 0 0 (to reset the short term and long term debts on Seti@Home).

--get_project_config URL
Unknown

--get_project_config_poll
Unknown

--network_available
Unknown

--get_cc_status
Unknown

| Jorden
| 2
| 1
| 00:00:00
| 0000-00-00
| 180663
| 1
| 503
| 2009-11-20 22:20:43
| 2012-06-04 09:39:06

@@ Line 8: / Line 8: @@
   Boinccmd --command1 --command2 --command3
-:'''--create_account URL email passwd name'''<br>
+:'''--client_version'''
 :''Used to make an account at a project, using password such and so, your email address and what nickname to go on the account.''
 :''Usage: e.g. '''boinccmd --create_account http://setiathome.berkeley.edu joe@email.com RoVeR12 Joe''' .. Watch out with case sensitivity on password!''
@@ Line 17: / Line 20: @@
 :'''--get_cc_status'''<br>
 :''Gets the status of the CPU, GPU and Network, its present run status, and what your preference setting is for the run mode (based on preferences, always on or suspended).''
 :'''--get_disk_usage'''<br>
@@ Line 26: / Line 32: @@
 :'''--get_host_info'''<br>
 :''Shows details about your host, such as CPU used, Network name, operating system, disk size, etc.''
 :'''--get_messages [ seqno ]'''<br>
 :''Show messages, if need be output per sequence number.''
 :'''--get_notices [ seqno ]'''<br>
@@ Line 57: / Line 63: @@
 :''Show tasks. BOINC 7.0 and later.''
-:'''--join_acct_mgr URL name passwd'''<br>
+:'''--join_acct_mgr URL name password'''<br>
 :''Attach to an account manager.''
-:'''--lookup_account URL email passwd'''<br>
+:'''--lookup_account URL email password'''<br>
 :''Used to check up on your account and get your authenticator key and details sent to you.''
@@ Line 69: / Line 75: @@
 :''Project operation options = reset | detach | update | suspend | resume | nomorework | allowmorework''
-:'''--project_attach URL auth'''<br>
+:'''--project_attach URL authenticator'''<br>
 :''Attach to project using your authenticator key.''
@@ Line 84: / Line 90: @@
 :''(Re-)Read the global_prefs_override.xml file.''
-:'''--result url task_name operation'''<br>
+:'''--result URL task_name operation'''<br>
 :''Job operation options = suspend | resume | abort | graphics_window | graphics_fullscreen''
 :'''--run_benchmarks'''<br>
@@ Line 93: / Line 100: @@
 :''Used to (re-)set the short term and long term debts of any given project. Usage: boinccmd --set_debts http://setiathome.berkeley.edu 0 0 (to reset the short term and long term debts on Seti@Home). No longer available on BOINC 7.0 and above.''
-:'''--set_gpu_mode'''<br>
+:'''--set_gpu_mode mode duration'''<br>
-:''Sets GPU mode. Options always | auto | never''
+:''Sets GPU mode. Options always | auto | never''<br>
 :'''--set_network_mode mode duration'''<br>
-:''Set run mode for given duration mode = always | auto | never''
+:''Set run mode for given duration mode = always | auto | never''<br>
 :'''--set_proxy_settings'''<br>
@@ Line 106: / Line 118: @@
 :'''--task URL task_name op'''<br>
-:''Task operations. Options suspend | resume | abort
+:''Task operations. Options suspend | resume | abort. BOINC 7.0 and above.''
 :'''--version, -V'''<br>
-:''Show core client version.''
+:''Show BOINCCMD tool version.''

@@ Line 16: / Line 16: @@
 :'''--get_cc_status'''<br>
-:''Unknown''
+:''Gets the status of the CPU, GPU and Network, its present run status, and what your preference setting is for the run mode (based on preferences, always on or suspended).''
 :'''--get_disk_usage'''<br>
@@ Line 27: / Line 27: @@
 :''Shows details about your host, such as CPU used, Network name, operating system, disk size, etc.''
-:'''--get_messages'''<br>
+:'''--get_messages [ seqno ]'''<br>
 :''Show messages, if need be output per sequence number.''
 :'''--get_message_count'''<br>
 :''Show largest message sequence number.''
 :'''--get_project_config URL'''<br>
-:''Unknown''
+:''Polls the project in the URL for the short project name, minimum password length and if it requires unique user names.''
 :'''--get_project_status'''<br>
@@ Line 104: / Line 104: @@
 :'''--set_run_mode mode duration'''<br>
 :''Set run mode for given duration mode = always | auto | never''
 :'''--version, -V'''<br>

@@ Line 7: / Line 7: @@
   Boinccmd --command1 --command2 --command3
 :'''--create_account URL email passwd name'''<br>
@@ Line 62: / Line 59: @@
 :'''--join_acct_mgr URL name passwd'''<br>
 :''Attach to an account manager.''
 :'''--network_available'''<br>

@@ Line 12: / Line 12: @@
 :'''--create_account URL email passwd name'''<br>
-:''Used to make an account at a project, using password such and so, your email address and what nickname to go on the account. Usage: boinccmd --create_account http://setiathome.berkeley.edu joe@email.com RoVeR12 Joe .. Watch out with case sensitivity on password!''
+:''Used to make an account at a project, using password such and so, your email address and what nickname to go on the account.''
-:'''--project_attach URL auth'''<br>
+:'''--file_transfer URL filename operation'''<br>
-:''Attach to project using your authenticator key.''
+:''File transfer operation options = retry | abort''
-:'''--join_acct_mgr URL name passwd'''<br>
+:'''--get_disk_usage'''<br>
-:''Attach to an account manager.''
+:''Show disk usage per project attached.''
-:'''--quit_acct_mgr'''<br>
+:'''--get_file_transfers'''<br>
-:''Quit using your current account manager.''
+:''Show file transfers.''
-:'''--get_state'''<br>
+:'''--get_host_info'''<br>
-:''Show entire state.''
+:''Shows details about your host, such as CPU used, Network name, operating system, disk size, etc.''
-:'''--get_results'''<br>
+:'''--get_messages'''<br>
-:''Show tasks. BOINC 6.12 and before.''
+:''Show messages, if need be output per sequence number.''
-:'''--get_tasks'''<br>
+:'''--get_message_count'''<br>
-:''Show tasks. BOINC 7.0 and later.''
+:''Show largest message sequence number.''
-:'''--get_simple_gui_info'''<br>
+:'''--get_project_config URL'''<br>
-:''Show status of projects and active tasks.''
+:''Unknown''
-:'''--get_file_transfers'''<br>
+:'''--get_project_config_poll'''<br>
-:''Show file transfers.''
+:''Unknown''
 :'''--get_project_status'''<br>
 :''Show status of all attached projects.''
 :'''--get_proxy_settings'''<br>
 :''Show proxy settings.''
-:'''--get_messages'''<br>
+:'''--get_results'''<br>
-:''Show messages, if need be output per sequence number.''
+:''Show tasks. BOINC 6.12 and before.''
-:'''--get_message_count'''<br>
+:'''--get_state'''<br>
-:''Show largest message sequence number.''
+:''Show entire state.''
-:'''--get_host_info'''<br>
+:'''--get_tasks'''<br>
-:''Shows details about your host, such as CPU used, Network name, operating system, disk size, etc.''
+:''Show tasks. BOINC 7.0 and later.''
-:'''--version, -V'''<br>
+:'''--join_acct_mgr URL name passwd'''<br>
-:''Show core client version.''
+:''Attach to an account manager.''
-:'''--result url task_name operation'''<br>
+:'''--network_available'''<br>
-:''Job operation options = suspend | resume | abort | graphics_window | graphics_fullscreen''
+:''Retry deferred network communication.''
 :'''--project URL operation'''<br>
 :''Project operation options = reset | detach | update | suspend | resume | nomorework | allowmorework''
-:'''--file_transfer URL filename operation'''<br>
+:'''--project_attach URL auth'''<br>
-:''File transfer operation options = retry | abort''
+:''Attach to project using your authenticator key.''
-:'''--set_gpu_mode'''<br>
+:'''--quit_acct_mgr'''<br>
-:''Sets GPU mode. Options always | auto | never''
+:''Quit using your current account manager.''
-:'''--set_run_mode mode duration'''<br>
+:'''--read_cc_config'''<br>
-:''Set run mode for given duration mode = always | auto | never''
+:''(Re-)read the client configuration file (cc_config.xml).''
-:'''--set_network_mode mode duration'''<br>
+:'''--read_global_prefs_override'''<br>
-:''Set run mode for given duration mode = always | auto | never''
+:''(Re-)Read the global_prefs_override.xml file.''
-:'''--set_proxy_settings'''<br>
+:'''--result url task_name operation'''<br>
-:''Set up your proxy settings. ''
+:''Job operation options = suspend | resume | abort | graphics_window | graphics_fullscreen''
 :'''--run_benchmarks'''<br>
 :''Run CPU benchmarks.''
-:'''--read_global_prefs_override'''<br>
+:'''--set_debts URL1 std1 ltd1'''<br>
-:''(Re-)Read the global_prefs_override.xml file.''
+:''Used to (re-)set the short term and long term debts of any given project. Usage: boinccmd --set_debts http://setiathome.berkeley.edu 0 0 (to reset the short term and long term debts on Seti@Home). No longer available on BOINC 7.0 and above.''
-:'''--quit'''<br>
+:'''--set_gpu_mode'''<br>
-:''Quit running the BOINC client.''
+:''Sets GPU mode. Options always | auto | never''
-:'''--read_cc_config'''<br>
+:'''--set_network_mode mode duration'''<br>
-:''(Re-)read the client configuration file (cc_config.xml).''
+:''Set run mode for given duration mode = always | auto | never''
-:'''--set_debts URL1 std1 ltd1'''<br>
+:'''--set_proxy_settings'''<br>
-:''Used to (re-)set the short term and long term debts of any given project. Usage: boinccmd --set_debts http://setiathome.berkeley.edu 0 0 (to reset the short term and long term debts on Seti@Home).''
+:''Set up your proxy settings. ''
-:'''--get_project_config URL'''<br>
+:'''--set_run_mode mode duration'''<br>
-:''Unknown''
+:''Set run mode for given duration mode = always | auto | never''
-:'''--get_project_config_poll'''<br>
+:'''--version, -V'''<br>
-:''Unknown''
+:''Show core client version.''
 {| class="wikitable" style="text-align: center;"

@@ Line 9: / Line 9: @@
 :'''--lookup_account URL email passwd'''<br>
-:Used to check up on your account and get your authenticator key and details sent to you.
+:''Used to check up on your account and get your authenticator key and details sent to you.''
 :'''--create_account URL email passwd name'''<br>
-:Used to make an account at a project, using password such and so, your email address and what nickname to go on the account. Usage: boinccmd --create_account http://setiathome.berkeley.edu joe@email.com RoVeR12 Joe .. Watch out with case sensitivity on password!
+:''Used to make an account at a project, using password such and so, your email address and what nickname to go on the account. Usage: boinccmd --create_account http://setiathome.berkeley.edu joe@email.com RoVeR12 Joe .. Watch out with case sensitivity on password!''
 :'''--project_attach URL auth'''<br>
-:Attach to project using your authenticator key.
+:''Attach to project using your authenticator key.''
 :'''--join_acct_mgr URL name passwd'''<br>
-:Attach to an account manager.
+:''Attach to an account manager.''
 :'''--quit_acct_mgr'''<br>
-:Quit using your current account manager.
+:''Quit using your current account manager.''
 :'''--get_state'''<br>
-:Show entire state.
+:''Show entire state.''
 :'''--get_results'''<br>
-:Show tasks. BOINC 6.12 and before.
+:''Show tasks. BOINC 6.12 and before.''
 :'''--get_tasks'''<br>
-:Show tasks. BOINC 7.0 and later.
+:''Show tasks. BOINC 7.0 and later.''
 :'''--get_simple_gui_info'''<br>
-:Show status of projects and active tasks.
+:''Show status of projects and active tasks.''
 :'''--get_file_transfers'''<br>
-:Show file transfers.
+:''Show file transfers.''
 :'''--get_project_status'''<br>
-:Show status of all attached projects.
+:''Show status of all attached projects.''
 :'''--get_disk_usage'''<br>
-:Show disk usage per project attached.
+:''Show disk usage per project attached.''
 :'''--get_proxy_settings'''<br>
-:Show proxy settings.
+:''Show proxy settings.''
 :'''--get_messages'''<br>
-:Show messages, if need be output per sequence number.
+:''Show messages, if need be output per sequence number.''
 :'''--get_message_count'''<br>
-:Show largest message sequence number.
+:''Show largest message sequence number.''
 :'''--get_host_info'''<br>
-:Shows details about your host, such as CPU used, Network name, operating system, disk size, etc.
+:''Shows details about your host, such as CPU used, Network name, operating system, disk size, etc.''
 :'''--version, -V'''<br>
-:Show core client version.
+:''Show core client version.''
 :'''--result url task_name operation'''<br>
-:Job operation options = suspend | resume | abort | graphics_window | graphics_fullscreen
+:''Job operation options = suspend | resume | abort | graphics_window | graphics_fullscreen''
 :'''--project URL operation'''<br>
-:Project operation options = reset | detach | update | suspend | resume | nomorework | allowmorework
+:''Project operation options = reset | detach | update | suspend | resume | nomorework | allowmorework''
 :'''--file_transfer URL filename operation'''<br>
-:File transfer operation options = retry | abort
+:''File transfer operation options = retry | abort''
 :'''--set_gpu_mode'''<br>
-:Sets GPU mode. Options always | auto | never
+:''Sets GPU mode. Options always | auto | never''
 :'''--set_run_mode mode duration'''<br>
-:Set run mode for given duration mode = always | auto | never
+:''Set run mode for given duration mode = always | auto | never''
 :'''--set_network_mode mode duration'''<br>
-:Set run mode for given duration mode = always | auto | never
+:''Set run mode for given duration mode = always | auto | never''
 :'''--set_proxy_settings'''<br>
-:Set up your proxy settings.
+:''Set up your proxy settings. ''
 :'''--run_benchmarks'''<br>
-:Run CPU benchmarks.
+:''Run CPU benchmarks.''
 :'''--read_global_prefs_override'''<br>
-:(Re-)Read the global_prefs_override.xml file.
+:''(Re-)Read the global_prefs_override.xml file.''
 :'''--quit'''<br>
-:Quit running the BOINC client.
+:''Quit running the BOINC client.''
 :'''--read_cc_config'''<br>
-:(Re-)read the client configuration file (cc_config.xml).
+:''(Re-)read the client configuration file (cc_config.xml).''
 :'''--set_debts URL1 std1 ltd1'''<br>
-:Used to (re-)set the short term and long term debts of any given project. Usage: boinccmd --set_debts http://setiathome.berkeley.edu 0 0 (to reset the short term and long term debts on Seti@Home).
+:''Used to (re-)set the short term and long term debts of any given project. Usage: boinccmd --set_debts http://setiathome.berkeley.edu 0 0 (to reset the short term and long term debts on Seti@Home).''
 :'''--get_project_config URL'''<br>
-:Unknown
+:''Unknown''
 :'''--get_project_config_poll'''<br>
-:Unknown
+:''Unknown''
 :'''--network_available'''<br>
-:Unknown
+:''Unknown''
 :'''--get_cc_status'''<br>
-:Unknown
+:''Unknown''
 {| class="wikitable" style="text-align: center;"

@@ Line 110: / Line 110: @@
   ! Original writer
   ! Original FAQ
-  ! Date & time
+  ! Date
   |-
   | Jorden
   | [http://boincfaq.mundayweb.com/index.php?language=1&view=503 503]
-  | 20-11-2009 22:20:43
+  | 20-11-2009
   |-
 |}

@@ Line 3: / Line 3: @@
 The BOINCCMD program allows you to control BOINC multiple times, especially useful for when you lack a GUI (BOINC Manager).  Multiple commands per line are possible.
 Usage: Boinccmd --command1 --command2 --command3
 '''--lookup_account URL email passwd'''<br>