Folding client userguide

[Allan]

Ripped from the stanford page here:
http://folding.stanford.edu/console-userguide.txt

-----

Folding@Home (version 3.1)
The Stanford Molecular Biology Research Program

Last updated: 7/15/2002


CONSOLE CLIENT CONFIGURATION OPTIONS

-config
Allows users to change their configuration information. This includes user & team names (reflected in the stats), whether or not to ask before a network connection is made to fetch/send work, set up proxy servers, preferred work unit type (Folding/Genome), process priority, CPU usage requested (5-100%), and Machine ID changes.

-delete x
Delete item #x from work queue. This option should only be used if there is a serious error with the current unit that the client does not automatically recover from (e.g. crash-inducing). This should not normally happen, and if it does we would be grateful if you could send us the FAHlog.txt file from the unit that causes the error.

-license
Displays the End-user License agreement

-queueinfo
Get information on queued work units. Includes for each unit the status (READY/FINISHED/EMPTY), unit type (Folding/Genome), originating server, and date when the unit was received (local time in GMT)

-send x
Send result #x back to server. Exits after trying to send unit (successfully or unsuccessfully). Use "-send all" to send all results outstanding. If unit x is not a completed work unit then the client exits without doing anything.

-verbosity x Sets the output level, from 1 to 9 (max). The default is 3. This option should be used if the user wishes to see more detailed client output, particularly useful if there is a problem which needs to be reported to the Folding@Home client development team.


Windows Specific (will be accepted but ignored by the clients for other operating systems):

-local
Use configuration files from local directory. This instructs the client to read its config information from the client.cfg file in the current directory rather than from the installation directory specified in the registry. The machine ID is not affected by this flag, since it is stored in the registry, not the client.cfg file, but all other information, such as the user name, team name, proxy information, machine ID are maintained in the client.cfg file.

Use "-local" only if you are planning on running more than one instance of Folding@Home on the same machine (this is only useful if you are running on a multi-processor machine). Create as many directories as there are processors on the machine, copy the exe files and client.cfg file into each of these directories, run "FAH3Console -local -config" on each and specify unique machine IDs for each directory (under the Advanced Settings option). From then onwards you may run each copy by switching to its directory and running with the -local flag.

-pause
Pause after finishing & trying to send current unit. Allows a user to shut down after finishing a unit, by pressing Ctrl-C, without then getting new work to process. This is recommended if you are planning on shutting down your machine for a long time (e.g. for a vacation), or are planning to un/re-install Folding@Home after finishing the currently processing work unit.

-service
Run in service mode (for programs such as firedaemon). This prevents the client from exiting when it detects the current user is logging out. If this option is used when the client is not run as a service then it will run normally, but will not shut down automatically if the user logs out, and windows will display a "Wait for program to close" dialog box.