Skip site navigation (1)Skip section navigation (2)

FreeBSD Manual Pages

  
 
  

home | help
FAHCLIENT(8)		     System Manager's Manual		    FAHCLIENT(8)

NAME
     fahclient -- service daemon for the Folding@home Client

SYNOPSIS
     fahclient command [args ...]
     fahclient log
     fahclient showconfig

DESCRIPTION
     fahclient is an rc(8) daemon for the Folding@home Client.

     Configure fahclient with the following rc.conf(5) variables:

       fahclient_enable       Toggle to enable fahclient.  Default: "NO".

       fahclient_chdir	      Working	 directory   of   fahclient.	Default:
			      "/var/db/fahclient".

       fahclient_config       Configuration	      file.		Default:
			      "/usr/local/etc/fahclient/config.xml".

       fahclient_donor	      Donor to attribute work units to.  Settings in the
			      configuration   file  take  precedence.	Default:
			      "Anonymous".

       fahclient_extra_flags  Extra flags passed to the Folding@home Client  af-
			      ter other flags.	Default: empty.

       fahclient_flags	      Extra  flags  passed to daemon(8) before any other
			      flags.  Default: empty.

       fahclient_logfile      Log file.  Takes precedence over settings  in  the
			      configuration	       file.		Default:
			      "/var/db/fahclient/log.txt".

       fahclient_team	      Folding@home team to join and attribute work units
			      to.   Settings  in  the  configuration  file  take
			      precedence.  Default: `11743', Team FreeBSD.

       fahclient_pidfile      PID		  file. 		Default:
			      "/var/db/fahclient/fahclient.pid".

       fahclient_user	      System  user  to	run  fahclient	 as.	Default:
			      `fahclient'.

     fahclient supports the following extra commands:

       log	   View fahclient's folding logs.

       showconfig  Show  the final configuration of fahclient after all configu-
		   ration files and command-line flags are processed.

     The Web  Dashboard  is  available	at  https://v8-4.foldingathome.org/  and
     http://localhost:7396/  when fahclient is running.  Visit the Web Dashboard
     to connect fahclient to a Folding@home Account and manage folding work.

     Link fahclient to an existing account with an Account Token.   Generate  it
     on  the  Web  Dashboard.  Add the Account Token to either the configuration
     file or specify it a command-line argument to fahclient:
	   sysrc fahclient_extra_flags+=" --account-token=<Account-Token>"

     Refer to the Folding@home Client's help message for more usage information:
	   /usr/local/bin/fah-client --help

FILES
     /usr/local/bin/fah-client	Folding@home  Client  program  invoked	by   the
				fahclient daemon.

EXAMPLES
   Example 1: Quick Start
     Start fahclient by executing the following steps:

	   # Mount linprocfs(5) at /compat/linux/proc:
	   mount -t linprocfs linprocfs /compat/linux/proc
	   # Mount linsysfs(5) at /compat/linux/proc:
	   mount -t linsysfs linsysfs /compat/linux/sys
	   # Enable fahclient:
	   service fahclient enable
	   # Optionally, set the desired donor name:
	   sysrc fahclient_donor="Anonymous"
	   # Start fahclient:
	   service fahclient start

     Open the Folding@home Web Dashboard to finish the setup.

     Add linprocfs(5) and linsysfs(5) entries to fstab(5) to make the setup per-
     sistent across reboots.

SEE ALSO
     Folding@home v8.4 Client Guide

     Folding@home FAQ

     Folding Forum

     Team FreeBSD Statistics

HISTORY
     Team FreeBSD was founded by Frank Mayhar.

AUTHORS
     The   fahclient   manual	page   was   written   by   Mateusz   Piotrowski
     <0mp@FreeBSD.org>.

CAVEATS
     The working directory of fahclient must have the  execute	permissions  en-
     abled  to	function  properly.   For  example,  on  a  zfs(4) dataset where
     /var/db/fahclient is located the `exec' property must be set to `on'.

FreeBSD ports 15.quarterly	  June 9, 2026			    FAHCLIENT(8)

Want to link to this manual page? Use this URL:
<https://man.freebsd.org/cgi/man.cgi?query=fahclient&sektion=8&manpath=FreeBSD+Ports+15.1.quarterly>

home | help