Difference between revisions of "BOINCCMD command line switches"

From BOINC Wiki
Jump to: navigation, search
(removing time from table)
(indenting all)
Line 8: Line 8:
 
  Boinccmd --command1 --command2 --command3
 
  Boinccmd --command1 --command2 --command3
  
'''--lookup_account URL email passwd'''<br>
+
:'''--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>
+
:'''--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 [email protected] 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 [email protected] RoVeR12 Joe .. Watch out with case sensitivity on password!
  
'''--project_attach URL auth'''<br>
+
:'''--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>
+
:'''--join_acct_mgr URL name passwd'''<br>
Attach to an account manager.
+
:Attach to an account manager.
  
'''--quit_acct_mgr'''<br>
+
:'''--quit_acct_mgr'''<br>
Quit using your current account manager.
+
:Quit using your current account manager.
  
'''--get_state'''<br>
+
:'''--get_state'''<br>
Show entire state.
+
:Show entire state.
  
'''--get_results'''<br>
+
:'''--get_results'''<br>
Show tasks. BOINC 6.12 and before.
+
:Show tasks. BOINC 6.12 and before.
  
'''--get_tasks'''<br>
+
:'''--get_tasks'''<br>
Show tasks. BOINC 7.0 and later.
+
:Show tasks. BOINC 7.0 and later.
  
'''--get_simple_gui_info'''<br>
+
:'''--get_simple_gui_info'''<br>
Show status of projects and active tasks.
+
:Show status of projects and active tasks.
  
'''--get_file_transfers'''<br>
+
:'''--get_file_transfers'''<br>
Show file transfers.
+
:Show file transfers.
  
'''--get_project_status'''<br>
+
:'''--get_project_status'''<br>
Show status of all attached projects.
+
:Show status of all attached projects.
  
'''--get_disk_usage'''<br>
+
:'''--get_disk_usage'''<br>
Show disk usage per project attached.
+
:Show disk usage per project attached.
  
'''--get_proxy_settings'''<br>
+
:'''--get_proxy_settings'''<br>
Show proxy settings.
+
:Show proxy settings.
  
'''--get_messages'''<br>
+
:'''--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>
+
:'''--get_message_count'''<br>
Show largest message sequence number.
+
:Show largest message sequence number.
  
'''--get_host_info'''<br>
+
:'''--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>
+
:'''--version, -V'''<br>
Show core client version.
+
:Show core client version.
  
'''--result url task_name operation'''<br>
+
:'''--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 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 URL filename operation'''<br>
File transfer operation options = retry | abort
+
:File transfer operation options = retry | abort
  
'''--set_gpu_mode'''<br>
+
:'''--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 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_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_proxy_settings'''<br>
Set up your proxy settings.  
+
:Set up your proxy settings.  
  
'''--run_benchmarks'''<br>
+
:'''--run_benchmarks'''<br>
Run CPU benchmarks.
+
:Run CPU benchmarks.
  
'''--read_global_prefs_override'''<br>
+
:'''--read_global_prefs_override'''<br>
(Re-)Read the global_prefs_override.xml file.
+
:(Re-)Read the global_prefs_override.xml file.
  
'''--quit'''<br>
+
:'''--quit'''<br>
Quit running the BOINC client.
+
:Quit running the BOINC client.
  
'''--read_cc_config'''<br>
+
:'''--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>  
+
:'''--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 [email protected]).
+
: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 [email protected]).
  
'''--get_project_config URL'''<br>
+
:'''--get_project_config URL'''<br>
Unknown
+
:Unknown
  
'''--get_project_config_poll'''<br>
+
:'''--get_project_config_poll'''<br>
Unknown
+
:Unknown
  
'''--network_available'''<br>
+
:'''--network_available'''<br>
Unknown
+
:Unknown
  
'''--get_cc_status'''<br>
+
:'''--get_cc_status'''<br>
Unknown
+
:Unknown
  
 
{| class="wikitable" style="text-align: center;"
 
{| class="wikitable" style="text-align: center;"

Revision as of 23:22, 21 November 2016

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 [email protected] 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 [email protected]).
--get_project_config URL
Unknown
--get_project_config_poll
Unknown
--network_available
Unknown
--get_cc_status
Unknown
Original writer Original FAQ Date
Jorden 503 20-11-2009