boinc(1)

πŸ“¦
version 8.2.15 Β· 3 versions
, in debian trixie, ubuntu noble, ubuntu questing, ubuntu resolute, ubuntu stonking

πŸ’– boinc(1) β€” the BOINC client, but make it make sense πŸ’–

okay bestie, gather round, because we're talking about boinc, the actual client program β€” manual section 1, main character energy, no cap. it's the whole entire heart of BOINC and honestly? she runs the show.


✨ SYNOPSIS ✨

boinc [options]

like... that's it. that's the whole vibe. options go in, magic comes out. πŸ’…


πŸ¦‹ DESCRIPTION πŸ¦‹

so boinc β€” the BOINC "client" β€” is literally the heart of BOINC. she's the one calling the shots: she decides which project applications get to run on your computer, she's out here downloading "Tasks" and uploading the resulting files from the tasks that are done-done. multitasking queen. πŸ‘‘

most of the time boinc just vibes in the background, ideally as a daemon, like she's minding her own business. and then you can control her either with a graphical tool called the BOINC Manager, boincmgr(1), or with a command-line tool called boinccmd(1) β€” both of them talk to her through Remote Procedure Calls (RPCs) over port 31416. yes, 31416. it's giving pi-adjacent. iykyk. πŸ₯§

the BOINC client can be controlled by command-line options, configuration files, and environment variables. and the standard usage? bestie it is so simple β€” you just start the client running in the background. that's the whole thing. periodt. ✨


πŸŽ€ OPTIONS πŸŽ€

these command-line options for boinc are how you control how BOINC gets started. once the client is already up and running, pls don't try to poke her with these β€” use a separate program, boincmgr(1) or boinccmd(1), which communicates with her by means of Remote Procedure Calls (RPCs). she's already awake, just text her. πŸ“±

🌸 GENERAL OPTIONS 🌸

  • --help β€” show options. that's it. she's helping. 🫢
  • --version β€” show version info.
  • --run_cpu_benchmarks β€” run the CPU benchmarks.
  • --check_all_logins β€” for idle detection, check remote logins too.
  • --daemon β€” run as daemon. will redirect stderr and stdout to syslog. very "i'll be in the back, don't worry about me" of her.
  • --dir path β€” use the given dir as the client working directory.
  • --no_gpus β€” don't check for GPUs. she's not even looking. πŸ™ˆ
  • --no_info_fetch β€” don't fetch project list or client version info from boinc.berkeley.edu.
  • --skip_cpu_benchmarks β€” don't run CPU benchmarks.
  • --start_delay X β€” delay starting apps for X secs. a lil pause, a lil stretch, then go. 🧘

πŸ’œ PROJECT OPTIONS πŸ’œ

  • --attach_project URL key β€” attach to a project using URL and authenticator.
  • --show_projects β€” show attached projects. roll call! πŸ“‹
  • --detach_project URL β€” detach from the project specified by URL.
  • --reset_project URL β€” reset (clear) the project specified by URL.
  • --update_prefs URL β€” contact the project specified by URL to update preferences.

πŸ’Œ COMMUNICATION OPTIONS πŸ’Œ

  • --allow_remote_gui_rpc β€” allow RPC connections from remote hosts. letting the whole internet into the group chat, okay!! 😭
  • --gui_rpc_port port β€” port for RPCs.
  • --no_gui_rpc β€” omits creation of a socket as required for the remote control of the client. consequently the client cannot be controlled by external tools like GUIs (boincmgr etc.) or the console command tool (boinccmd). so like... she's offline-offline. do not do this and then be confused. πŸ’€

πŸ”₯ DEBUGGING OPTIONS πŸ”₯

  • --abort_jobs_on_exit β€” when client exits, abort and report tasks.
  • --allow_multiple_clients β€” allow more than one client instance per host.
  • --exit_after_app_start N β€” exit N seconds after an app starts. useful to look at the files in the slot directory.
  • --exit_after_finish β€” exit right after finishing a task. useful to look at the files in the slot directory.
  • --exit_before_start β€” exit right before starting a task. useful to look at the files in the slot directory.
  • --exit_before_upload β€” exit right before starting an upload.
  • --exit_when_idle β€” exit when there are no more tasks to work on.
  • --fetch_minimal_work β€” fetch only 1 task per device. minimalism era. πŸƒ
  • --file_xfer_giveup_period N β€” give up on file transfers after N sec.
  • --master_fetch_interval N β€” limiting the period of project master file dowload retries.
  • --master_fetch_period N β€” reload a project's master file after N RPC failures.
  • --master_fetch_retry_cap N β€” exponential backoff limit for downloading project master files.
  • --no_priority_change β€” run applications at same priority as client.
  • --pers_giveup N β€” giveup time for persistent file transfer errors.
  • --pers_retry_delay_max N β€” maximum time (sec) for file transfer exponential backoff.
  • --pers_retry_delay_min N β€” minimum time (sec) for file transfer exponential backoff.
  • --redirectio β€” redirect stdout and stderr to log files (stdoutdae.txt and stderrdae.txt).
  • --retry_cap N β€” limit the maximum exponential backoff time.
  • --sched_retry_delay_max N β€” maximum time (sec) for project RPC exponential backoff.
  • --sched_retry_delay_min N β€” minimum time (sec) for project RPC exponential backoff.
  • --unsigned_apps_ok β€” allow unsigned apps (for testing). testing only bestie, don't get comfy. πŸ§ͺ

πŸ” ACCESS CONTROL FOR GUI RPC πŸ”

by default the client accepts GUI RPC connections only from programs on the same host, which means that any user on this host can control the client.

no cap, that's the default. any user. same host. controls her. lock it down if that's not the vibe you want. πŸ‘€

🌈 SEE ALSO 🌈

boinccmd(1), boincmgr(1)

⟨https://boinc.berkeley.edu/wiki/Client_configuration#Command-line_options⟩


Copyright Β© 2007-2020 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.


and that's the whole page, bestie!! this one's from the 03 February 2020 era, and it lives in section 1 of the manual β€” boinc(1), iconic forever. go run some tasks, hydrate, and don't forget to lock down your RPC. mwah!! πŸ’–βœ¨πŸŽ€