Difference between revisions of "BOINCCMD command line switches"

From BOINC Wiki
Jump to: navigation, search
(italicize explanations)
(alphabetize)
Line 12: Line 12:
  
 
:'''--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: e.g. '''boinccmd --create_account http://setiathome.berkeley.edu [email protected] RoVeR12 Joe''' .. Watch out with case sensitivity on password!''
  
:'''--project_attach URL auth'''<br>
+
:'''--file_transfer URL filename operation'''<br>
:''Attach to project using your authenticator key.''
+
:''File transfer operation options = retry | abort''
 +
 
 +
:'''--get_cc_status'''<br>
 +
:''Unknown''
  
:'''--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>
 
:'''--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.''
 
  
 
:'''--get_proxy_settings'''<br>
 
:'''--get_proxy_settings'''<br>
 
:''Show proxy settings.''
 
:''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_simple_gui_info'''<br>
 +
:''Show status of projects and active tasks.''
  
:'''--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 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>
+
:'''--project_attach URL auth'''<br>
:''File transfer operation options = retry | abort''
+
:''Attach to project using your authenticator key.''
 +
 
 +
:'''--quit'''<br>
 +
:''Quit running the BOINC client.''
  
:'''--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_benchmarks'''<br>
 
:''Run CPU benchmarks.''
 
:''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 [email protected]). 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 [email protected]).''
+
:''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.''
  
:'''--network_available'''<br>
 
:''Unknown''
 
  
:'''--get_cc_status'''<br>
 
:''Unknown''
 
  
 
{| class="wikitable" style="text-align: center;"
 
{| class="wikitable" style="text-align: center;"

Revision as of 23:42, 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: e.g. boinccmd --create_account http://setiathome.berkeley.edu [email protected] RoVeR12 Joe .. Watch out with case sensitivity on password!
--file_transfer URL filename operation
File transfer operation options = retry | abort
--get_cc_status
Unknown
--get_disk_usage
Show disk usage per project attached.
--get_file_transfers
Show file transfers.
--get_host_info
Shows details about your host, such as CPU used, Network name, operating system, disk size, etc.
--get_messages
Show messages, if need be output per sequence number.
--get_message_count
Show largest message sequence number.
--get_project_config URL
Unknown
--get_project_config_poll
Unknown
--get_project_status
Show status of all attached projects.
--get_proxy_settings
Show proxy settings.
--get_results
Show tasks. BOINC 6.12 and before.
--get_simple_gui_info
Show status of projects and active tasks.
--get_state
Show entire state.
--get_tasks
Show tasks. BOINC 7.0 and later.
--join_acct_mgr URL name passwd
Attach to an account manager.
--network_available
Retry deferred network communication.
--project URL operation
Project operation options = reset | detach | update | suspend | resume | nomorework | allowmorework
--project_attach URL auth
Attach to project using your authenticator key.
--quit
Quit running the BOINC client.
--quit_acct_mgr
Quit using your current account manager.
--read_cc_config
(Re-)read the client configuration file (cc_config.xml).
--read_global_prefs_override
(Re-)Read the global_prefs_override.xml file.
--result url task_name operation
Job operation options = suspend | resume | abort | graphics_window | graphics_fullscreen
--run_benchmarks
Run CPU benchmarks.
--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]). No longer available on BOINC 7.0 and above.
--set_gpu_mode
Sets GPU mode. Options 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.
--set_run_mode mode duration
Set run mode for given duration mode = always | auto | never
--version, -V
Show core client version.


Original writer Original FAQ Date
Jorden 503 20-11-2009