Usage: fahclient [[--config] <filename>] [OPTIONS]...
Command line options:
Change directory before starting server. All files opened after this
point, such as the configuration file, must have paths relative to the new
Set configuration file.
Create a basic configuration file, then exit.
Dump either 'all' or a specific work unit, identified by its queue ID,
Finish all current work units, send the results, then exit.
Print help screen or help on a particular option and exit.
Print application and system information and exit.
Install the application as a Win32 service then exit.
License information and exit.
The application will watch for this process ID and exit if it goes away.
Usually the calling process' PID.
List the PCI bus devices, which can be helpful for finding GPU vendor and
Print configuration and exit.
Print work unit queue then exit.
Send all finished work units, then exit.
Send a command to an already running client.
Finish a slot or all slots on an already running client.
Pause a slot or all slots on an already running client.
Unpause a slot or all slots on an already running client.
Start Win32 service then exit.
Stop Win32 service then exit.
Uninstall the application as a Win32 service then exit.
Increase verbosity level.
Print application version and exit.
Increase verbosity level.
The following options can be specified in a configuration file or on the command
line using the following syntax:
or when marking boolean values true:
--<option> service-description <string=Folding@home Client>
The description for the Windows service control manager.
Configure Windows service to automatically restart on failure.
The amount of time in milliseconds to delay between restarts of the Windows
The number of client processing threads.
The maximum cycle frequency in Hz of client threads.
Run at most this many cycles. A value less than zero means run indefinitely.
The directory, relative to the current directory, where WU data and cores
Attempt to keep the system from sleeping when folding, unless on battery.
exec-directory <string=C:\Program Files (x86)\FAHClient>
The directory, relative to the current executable, where executables and
dynamic libraries are located.
Exit when all slots are paused.
Start folding even if not configured.
Make an operating system specific call to open the Web Control in a browser
once client is fully loaded
Rotate the configuration file to a backup when saving would overwrite the
Put rotated configs in this directory.
The maximum number of rotated configuration files to keep. A value of zero
will keep all configuration file backups.
The maximum number of errors before a slot is paused.
The maximum number of errors before a work unit is dumped.
Tell cores to checkpoint at least every # minutes.
The directory to store core files in.
Run this command on cores after they are downloaded. This option is useful
for running Linux cores on BSD machines.
Set the core priority. Valid values are: idle or low
If true, try to lock core processes to a fixed CPU
The maximum percentage of the CPU a core should use. Not implemented by all
GPU usage as a percent from 10-100
Tell cores to disable optimized assembly code.
Folding Slot Configuration:
The cause you prefer to support.
The client subtype
The client type. Can be 'normal', 'advanced' or 'beta'.
How many CPUs a slot should use. <= 0 will use all the CPUs detected in the
The CUDA device index of the GPU, counting starts from 0.
Pass extra arguments to the core.
Enable or disable auto-confiugration of GPU slots, requires appropriate
The index of the GPU as detected by the client. This index corresponds
directly to the GPUs listed in the client's '--info' output.
Max size in bytes of a work unit packet. Can be small=5MB, normal=10MB,
big=500MB or a number.
Override memory, in bytes, reported to Folding@home.
The OpenCL device index of the GPU, counting starts from 0.
Operating system species.
Operating system type.
Key for access to restricted testing projects.
Enable or disable auto-configuration of SMP slots, requires appropriate
Set to false to disable the GUI. A GUI is not currently supported on all
Client addresses which are allowed to connect to this server. This option
overrides IPs which are denied in the deny option. The pattern 0/0 matches
The maximum amount of time, in seconds, a connection can be idle before
Client address which are not allowed to connect to this server.
A space separated list of server address and port pairs to listen on in the
form <ip | hostname>[:<port>]
A space separated list of secure server address and port pairs to listen on
in the form <ip | hostname>[:<port>]
The maximum amount of time, in seconds, a client can be connected to the
Sets the maximum number of simultaneous connections.
Sets the maximum length of a client request packet.
The minimum amount of time, in seconds, a client must be connected to the
server before it can be dropped in favor or a new connection.
Sets the number of server threads.
HTTP Server SSL:
The servers certificate file in PEM format.
Supply a Certificate Revocation List. Overrides any internal CRL
The servers private key file in PEM format.
Set log file.
Print log messages with ANSI color coding.
Print carriage return and line feed at end of log lines.
Print date information with log entries.
Print date to log before new log entries if so many seconds have passed
since the last date was printed.
Disable or enable debugging info.
Print domain information with log entries.
log-domain-levels <string ...>
Set log levels by domain. Format is:
Entries are separated by white-space and or commas.
i - info
d - debug
For example: server:i:3 module:6
Set 'server' domain info messages to level 3 and 'module' info and debug
messages to level 6. All other domains will follow the system wide log
If <level> is negative it is relative to the system wide verbosity.
Enable log message headers.
Print level information with log entries.
Don't print 'INFO(#):' in header.
Redirect all output to log file. Implies !log-to-screen.
Rotate log files on each run.
Put rotated logs in this directory.
Maximum number of rotated logs to keep.
Print shortened level information with log entries.
Remove any leading directories and trailing file extensions from domains so
that source code file names can be easily used as log domains.
Print id with log entries.
Print thread prefixes, if set, with log entries.
Print time information with log entries.
Log to screen.
Truncate log file.
Set logging level for INFO and DEBUG messages.
Set proxy for outgoing HTTP connections
Enable proxy configuration
Set password for proxy connections
Set user name for proxy connections
Disable 'daemon', 'fork', 'pid' and 'respawn' options. Also defaults
'log-to-screen' to false. Used internally.
Short for --pid --service --respawn --log=''
Create PID file.
pid-file <string=Folding@home Client.pid>
Name of PID file.
Set the process priority. Valid values are: idle, low, normal, high or
Run the application as a child process and respawn if it is killed or exits.
Ignore user logout or hangup and interrupt signals
Remote Command Server:
The address to which the command server should be bound.
IP address ranges that are allowed access to the command server with out a
password if the 'password' option is set. These addresses will also have to
be allowed IP based access.
IP address ranges that are not allowed access to the command server with out
a password if the 'password' option is set. Overriden by
Set to false to disable the command server.
The port to which the command server should be bound.
Evaluate the argument as a script.
Set a command server password. Warning, setting a password disables the
default IP address blocking.
Run commands from a script file.
Only run slot when idle.
The maxumum amount of time to wait in seconds for a unit to exit on
Pause the client or slot when the OS indicates the machine is running on
If true the slot will be started in a paused state.
True of client is paused.
Set the client's power level. Valid values are 'light', 'medium' or 'full'.
This setting affects the defaults of several other options such as 'cpus',
The machine ID.
Your team number.
Your user name.
Client addresses which are allowed to connect to this Web server. This
option overrides IPs which are denied in the web-deny option. This option
differs from the 'allow'/'deny' options in that clients that are not allowed
are served an access denied page rather than simply dropping the connection.
The value '0/0' matches all IPs.
Client address which are not allowed to connect to this Web server.
Set to false to disable the web server.
Web Server Sessions:
The name of the session cookie.
The maximum session lifetime in seconds. Zero for unlimited session
The max maximum amount of time in seconds since the last time a session was
used before it timesout. Zero for no session timeout.
Work Unit Control:
Dump units if their deadline has passed.
Maximum units per slot in the work queue.
Process at most this number of units, then pause.
Pre-download the next work unit when the current one is this far along.
Values less than 90 are not allowed.
Attempt to detect stalled work units and restart them.
Minimum estimated percent work unit completion since last frame before a WU
can be considered stalled, if zero the percentage is ignored.
Minimum time, in seconds, since last frame before a WU can be considered