Difference between revisions of "BOINC command line switches"
From BOINC Wiki
(second better outline of the table) |
(write out abbreviations, make every sentence start with capital) |
||
(3 intermediate revisions by the same user not shown) | |||
Line 1: | Line 1: | ||
When you start BOINC from the command line, you can give it the following switches as extra commands. Multiple commands in a row are possible. | When you start BOINC from the command line, you can give it the following switches as extra commands. Multiple commands in a row are possible. | ||
− | :--abort_jobs_on_exit | + | :'''--abort_jobs_on_exit''' |
− | :When the client exits, abort and report jobs. | + | :''When the client exits, abort and report jobs.'' |
− | :--allow_remote_gui_rpc | + | :'''--allow_remote_gui_rpc''' |
− | :Allow remote GUI RPC connections. | + | :''Allow remote GUI RPC connections.'' |
− | :--allow_multiple_clients | + | :'''--allow_multiple_clients''' |
− | :Allow more than one instance of the client to run per host. | + | :''Allow more than one instance of the client to run per host.'' |
− | :--attach_project <URL> <key> | + | :'''--attach_project <URL> <key>''' |
− | :Attach to a project using the project URL and the strong account key. This requires you have an account on the project already. | + | :''Attach to a project using the project URL and the strong account key. This requires you have an account on the project already.'' |
− | :E.g. Boinc --attach_project http://setiathome.berkeley.edu 1234567890abcdef1234567890abcdef | + | :''E.g. Boinc --attach_project http://setiathome.berkeley.edu 1234567890abcdef1234567890abcdef'' |
− | :--check_all_logins | + | :'''--check_all_logins''' |
− | :For idle detection, check remote logins too. | + | :''For idle detection, check remote logins too.'' |
− | :--daemon | + | :'''--daemon''' |
− | :Run as daemon (Unix). When installed as a service on Windows, starting Boinc will automatically start the service. It won't on Unix. | + | :''Run as daemon (Unix). When installed as a service on Windows, starting Boinc will automatically start the service. It won't on Unix.'' |
− | :--detach | + | :'''--detach''' |
− | :Detach from console (Windows). This closes the command line window that otherwise stays open when you start Boinc. | + | :''Detach from console (Windows). This closes the command line window that otherwise stays open when you start Boinc.'' |
− | :--detach_project <URL> | + | :'''--detach_project <URL>''' |
− | :Detach from a project. | + | :''Detach from a project.'' |
− | :--dir <path> | + | :'''--dir <path>''' |
− | :Use given directory path as BOINC home directory. | + | :''Use given directory path as BOINC home directory.'' |
− | :--exit_after_app_start N | + | :'''--exit_after_app_start N''' |
− | :Exit N seconds after an application starts. | + | :''Exit N seconds after an application starts.'' |
− | :--exit_after_finish | + | :'''--exit_after_finish''' |
− | :Exit right after finishing a job. | + | :''Exit right after finishing a job.'' |
− | :--exit_before_start | + | :'''--exit_before_start''' |
− | :Exit right before starting a job. | + | :''Exit right before starting a job.'' |
− | :--exit_before_upload | + | :'''--exit_before_upload''' |
− | :Exit right before starting an upload. | + | :''Exit right before starting an upload.'' |
− | :--exit_when_idle | + | :'''--exit_when_idle''' |
− | :Exit when there are no tasks. | + | :''Exit when there are no tasks.'' |
− | :--fetch_minimal_work | + | :'''--fetch_minimal_work''' |
− | :Get only one task per CPU core or GPU. | + | :''Get only one task per CPU core or GPU.'' |
− | :--file_xfer_giveup_period N | + | :'''--file_xfer_giveup_period N''' |
− | :Give up on file | + | :''Give up on file transfers after N seconds.'' |
− | :--get_daily_xfer_history | + | :'''--get_daily_xfer_history''' |
− | :Show network traffic history. | + | :''Show network traffic history.'' |
− | :--gui_rpc_port <port> | + | :'''--gui_rpc_port <port>''' |
− | :Port for GUI RPCs. Default port is 31416. | + | :''Port for GUI RPCs. Default port is 31416.'' |
− | :--help | + | :'''--help''' |
− | :Show command line switch options. | + | :''Show command line switch options.'' |
− | :--launched_by_manager | + | :'''--launched_by_manager''' |
− | :Client was launched by Manager. | + | :''Client was launched by Manager.'' |
− | :--master_fetch_interval N | + | :'''--master_fetch_interval N''' |
− | :Limiting or increasing period of master retry. | + | :''Limiting or increasing period of master retry.'' |
− | :--master_fetch_period N | + | :'''--master_fetch_period N''' |
− | :Reload master URL after N RPC failures. | + | :''Reload master URL after N RPC failures.'' |
− | :--master_fetch_retry_cap N | + | :'''--master_fetch_retry_cap N''' |
− | :Exponential | + | :''Exponential back-off limit.'' |
− | :--no_gui_rpc | + | :'''--no_gui_rpc''' |
− | :Don't allow GUI RPC, don't make socket. | + | :''Don't allow GUI RPC, don't make socket.'' |
− | :--no_gpus | + | :'''--no_gpus''' |
− | :Don't check for GPUs. | + | :''Don't check for GPUs.'' |
− | :--no_info_fetch | + | :'''--no_info_fetch''' |
− | :Suppresses the fetch of project list and of current client version #. Use when running on grid nodes. | + | :''Suppresses the fetch of project list and of current client version #. Use when running on grid nodes.'' |
− | :--no_priority_change | + | :'''--no_priority_change''' |
− | :Run apps at same priority as client. | + | :''Run apps at same priority as client.'' |
− | :--pers_giveup N | + | :'''--pers_giveup N''' |
− | : | + | :''Give-up time for persistent file transfer.'' |
− | :--pers_retry_delay_max N | + | :'''--pers_retry_delay_max N''' |
− | : | + | :''Maximum delay for file transfer exponential back-off.'' |
− | :--pers_retry_delay_min N | + | :'''--pers_retry_delay_min N''' |
− | : | + | :''Minimum delay for file transfer exponential back-off'' |
− | :--redirectio | + | :'''--redirectio''' |
− | :Redirect | + | :''Redirect the event log output to the stdoutdae and stderrdae log files. Else they'll output to the command window.'' |
− | :--reset_project <URL> | + | :'''--reset_project <URL>''' |
− | :Reset (clear) a project. | + | :''Reset (clear) a project.'' |
− | :--retry_cap N | + | :'''--retry_cap N''' |
− | :Exponential | + | :''Exponential back-off limit.'' |
− | :--run_cpu_benchmarks | + | :'''--run_cpu_benchmarks''' |
− | :Run the CPU benchmarks. | + | :''Run the CPU benchmarks.'' |
− | :--run_by_updater | + | :'''--run_by_updater''' |
− | :Set by updater. | + | :''Set by updater.'' |
− | :--saver | + | :'''--saver''' |
− | :Client was launched by screensaver. | + | :''Client was launched by screensaver.'' |
− | :--sched_retry_delay_max N | + | :'''--sched_retry_delay_max N''' |
− | : | + | :''Maximum delay for RPC exponential back-off.'' |
− | :--sched_retry_delay_min N | + | :'''--sched_retry_delay_min N''' |
− | : | + | :''Minimum delay for RPC exponential back-off.'' |
− | :--show_projects | + | :'''--show_projects''' |
− | :Show attached projects. | + | :''Show attached projects.'' |
− | :--skip_cpu_benchmarks | + | :'''--skip_cpu_benchmarks''' |
− | :Don't run CPU benchmarks. | + | :''Don't run CPU benchmarks.'' |
− | :--start_delay X | + | :'''--start_delay X''' |
− | :Delay starting apps for X secs. | + | :''Delay starting apps for X secs.'' |
− | :--unsigned_apps_ok | + | :'''--unsigned_apps_ok''' |
− | :Allow unsigned apps (for testing). | + | :''Allow unsigned apps (for testing).'' |
− | :--update_prefs <URL> | + | :'''--update_prefs <URL>''' |
− | :Contact a project to update preferences. | + | :''Contact a project to update preferences.'' |
− | :--version | + | :'''--version''' |
− | : | + | :''Show version info.'' |
{| class="wikitable" style="text-align: center;" | {| class="wikitable" style="text-align: center;" | ||
! Original writer | ! Original writer | ||
− | ! Original | + | ! Original FAQ |
− | ! Date | + | ! Date |
|- | |- | ||
| Jorden | | Jorden | ||
− | | 502 | + | | [http://boincfaq.mundayweb.com/index.php?language=1&view=502 502] |
− | | 20-11-2009 | + | | 20-11-2009 |
|- | |- | ||
|} | |} |
Latest revision as of 23:30, 21 November 2016
When you start BOINC from the command line, you can give it the following switches as extra commands. Multiple commands in a row are possible.
- --abort_jobs_on_exit
- When the client exits, abort and report jobs.
- --allow_remote_gui_rpc
- Allow remote GUI RPC connections.
- --allow_multiple_clients
- Allow more than one instance of the client to run per host.
- --attach_project <URL> <key>
- Attach to a project using the project URL and the strong account key. This requires you have an account on the project already.
- E.g. Boinc --attach_project http://setiathome.berkeley.edu 1234567890abcdef1234567890abcdef
- --check_all_logins
- For idle detection, check remote logins too.
- --daemon
- Run as daemon (Unix). When installed as a service on Windows, starting Boinc will automatically start the service. It won't on Unix.
- --detach
- Detach from console (Windows). This closes the command line window that otherwise stays open when you start Boinc.
- --detach_project <URL>
- Detach from a project.
- --dir <path>
- Use given directory path as BOINC home directory.
- --exit_after_app_start N
- Exit N seconds after an application starts.
- --exit_after_finish
- Exit right after finishing a job.
- --exit_before_start
- Exit right before starting a job.
- --exit_before_upload
- Exit right before starting an upload.
- --exit_when_idle
- Exit when there are no tasks.
- --fetch_minimal_work
- Get only one task per CPU core or GPU.
- --file_xfer_giveup_period N
- Give up on file transfers after N seconds.
- --get_daily_xfer_history
- Show network traffic history.
- --gui_rpc_port <port>
- Port for GUI RPCs. Default port is 31416.
- --help
- Show command line switch options.
- --launched_by_manager
- Client was launched by Manager.
- --master_fetch_interval N
- Limiting or increasing period of master retry.
- --master_fetch_period N
- Reload master URL after N RPC failures.
- --master_fetch_retry_cap N
- Exponential back-off limit.
- --no_gui_rpc
- Don't allow GUI RPC, don't make socket.
- --no_gpus
- Don't check for GPUs.
- --no_info_fetch
- Suppresses the fetch of project list and of current client version #. Use when running on grid nodes.
- --no_priority_change
- Run apps at same priority as client.
- --pers_giveup N
- Give-up time for persistent file transfer.
- --pers_retry_delay_max N
- Maximum delay for file transfer exponential back-off.
- --pers_retry_delay_min N
- Minimum delay for file transfer exponential back-off
- --redirectio
- Redirect the event log output to the stdoutdae and stderrdae log files. Else they'll output to the command window.
- --reset_project <URL>
- Reset (clear) a project.
- --retry_cap N
- Exponential back-off limit.
- --run_cpu_benchmarks
- Run the CPU benchmarks.
- --run_by_updater
- Set by updater.
- --saver
- Client was launched by screensaver.
- --sched_retry_delay_max N
- Maximum delay for RPC exponential back-off.
- --sched_retry_delay_min N
- Minimum delay for RPC exponential back-off.
- --show_projects
- Show attached projects.
- --skip_cpu_benchmarks
- Don't run CPU benchmarks.
- --start_delay X
- Delay starting apps for X secs.
- --unsigned_apps_ok
- Allow unsigned apps (for testing).
- --update_prefs <URL>
- Contact a project to update preferences.
- --version
- Show version info.
Original writer | Original FAQ | Date |
---|---|---|
Jorden | 502 | 20-11-2009 |