Jump to content

Welcome to WatercoolingUK Community Forum
Register now to gain access to all of our features. Once registered and logged in, you will be able to create topics, post replies to existing threads, give reputation to your fellow members, get your own private messenger, post status updates, manage your profile and so much more. This message will be removed once you have signed in.
Login to Account Create an Account

Folding@home - Flags Tutorial

- - - - -

  • Please log in to reply
5 replies to this topic



    Level 5

  • Members
  • PipPipPipPipPip
  • 359 posts
Folding@Home Console Client: User Guide

Note: The below is intended for Folding@Home v.5. Older versions support similar flags, and an exact listing can be seen by running the program with the argument -?.

F@H Client Do's and Don'ts

The console is not an installer, but the actual Folding@Home client executable. In general, just download it, run it, and don't worry about it. However, if you like to be "hands on" with F@H, please keep in mind:

  • Each different running copy of F@H has to have its own Machine ID number. If you download each copy of F@H from the web site and configure fresh, there will be no problems.
  • Please don't manually retry to send WUs soon after a netsend failure. The netsend failure means that the server was probably overloaded and retrying will just make things worse.
  • Do not run multiple copies of FAH from the same directory
  • We have seen some issues with running the Windows console client with the service option and the Windows GUI version simultaneously. While we debug this, we recommend not combining these two options simultaneously.
Console Client Configuration Options

-configAllows 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%), whether or not to use assembly loops, whether or not to use deadline information, and Machine ID changes.
-configonlySame as above, but quit following configuration instead of beginning work.
-delete xDelete 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.
-licenseDisplays the end-user license agreement
-queueinfoGet 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), as well as deadline if the server sent that information.
-send xSend 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 xSets 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 F@H client development team.
-oneunitInstruct the client to quit following the completion of one work unit.
-forceasmInstruct the core to use SSE/3DNow assembly instructions if possible, even if it has previously made the determination that the machine may not be handling this well.
-advmethodsRequest to be assigned work units from new projects, before they are broadly released to the rest of Folding@home. As among the first to try out new advanced simulations, you may wish to post any observations (positive or negative), questions, or issues at the user Forum.
-localUse configuration files from local directory. This option has no meaning on Linux, but is vital on Windows and Macintosh for running multiple clients on a machine. It instructs the client to read its config information from the client.cfg file in the current directory rather than, on Windows, from the installation directory specified in the registry, or, on Macintosh, the Library/Folding@home directory. Information such as the user name, team name, proxy information, machine ID are maintained in the client.cfg file. The flag ensures that work does not conflict. 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.
-helpPrint out the command line flags available and then exit.

Windows Specific

-pausePause after finishing and 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 F@H after finishing the currently processing work unit.
-serviceRun 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 a "Wait for program to close." dialog box will be displayed.
-svcstartThis flag is used if you configure the console client to be run as a service (through the standard client Configuration). The user should NOT give this flag manually, it is automatically given by the Windows scheduler and is just listed here for information.
Linux Specific

-freeBSDFor use by those wishing to use the Linux client on a machine running FreeBSD. See our FAQ for details on how to do this, but with this flag, all Cores downloaded will automatically be branded as being a Linux executable.



    Level 5

  • Members
  • PipPipPipPipPip
  • 359 posts
NOTE: These instructions assume that the FAH client is not running as a service.

1. If you currently do not have a shortcut to the console client, one can easily be created several ways.

  • Right click the console executable.
  • Select Create Shortcut from the pop-up menu.
This will add a shortcut to the console client in the current dir.
Or you can:

  • Right click on the console executable.
  • Click Copy.
  • Go to where you want to place the shortcut to the console client.
  • Right Click on a blank area.
  • Selecet Paste Shortcut.
This will paste a shortcut to the console client where you want it.
2. To add a flag (or switch) to your console client:

  • Right click on the console shortcut.
  • Select Properties.
  • Go to the end of the line in the Target: box.
  • Add a space
  • Add the desired switch (including the leading hyphen.)
  • If you are adding more than one switch, be sure to use a space between each switch.
  • Click Apply.
  • Close the window.

  • NOTE: If the Target happens to be enclosed in quotation marks, the space, the hyphen, and the desired switches must be OUTSIDE of (AFTER) the right hand quotation mark.
Visual Examples:
Posted Image Posted Image

Repeat this process for each client you are running.
FAH will now use the switch(s) every time you start the console using this shortcut.
Or, you can place the shortcut in your startup folder, if you want the client to load every time you log on.
To make it load everytime any user logs on, you need to place the shortcut in to the ALL USERS -> Startup folder.
Or just use the consoles clients built in Windows NT/2000/XP service option.



    Level 5

  • Members
  • PipPipPipPipPip
  • 359 posts

To add flags to the Windows NT/2000/XP Console client, when run as a service, you have to make some changes in the registry. You MUST be logged into an account with Administrative privileges, to make any changes to the registry. Please read the Note: at the bottom, before even attempting this.

1. Shut down the folding instance through the Services manager snap-in.
There are several methods to get to the services snap-in as follows.

  • Click Start -> Click Run -> type in services.msc -> Click OK.
  • Click Start -> Go to Settings -> Click Control Panel -> Double Click Administrative Tools -> Double Click Services.
Find the service entry for folding. By default, it will be something that starts like this: FAH@......
To stop the service, use one of the following methods.

  • Click once on the Service to select it -> Click Action -> Click Stop.
  • Right Click on the Service -> Click Stop.
  • Double Click the Service -> Click Stop.
  • Right click on the Service -> Click Properties -> Click Stop.
You should see the Service stop.
You can then minimize the services snap-in, or close it.

2. Run regedit.

  • Click Start -> Click Run -> Type in regedit -> Click OK.
  • Go to HKEY_LOCAL_MACHINE\SYSTEM\CurrentControlSet\Services\<service name>
  • Right Click ImagePath -> Click Modify.
  • Add whatever flags you wish to the end (after a space).
  • EG....

Posted Image
  • Click OK.
  • Exit regedit.

3. Restart the Folding Service.

  • Re-open the Services manager snap-in.
  • Verify that your changes appear there.
  • Restart the service.
  • Basically the same way that you stopped it. Just click Start. ;)



    Level 10

  • Members
  • PipPipPipPipPipPipPipPipPipPip
  • 5,077 posts
Good work matey!

I was thinking as well its about time to update these pages :) They became obsolete while ago...

My Blog => http://adriank.org



    Level 5

  • Members
  • PipPipPipPipPip
  • 359 posts
The WCUK team is dying too, there are only few of us taking part on it.



    Level 10

  • Moderators
  • 2,896 posts
Well done there fella!

I thought about doing something similar but it's been so long since I set my clients up I've forgotten most of it.

We've got more active Folders now than we've had for a while.

With it being a small team we really suffer when people drop out and the cost of electricity nowadays has stopped quite a few.


0 user(s) are reading this topic

0 members, 0 guests, 0 anonymous users