The nFoldMonOnly control file is a simple ascii text file.
The file may contain blank lines, which are ignored. Also, anything past a "#" character in any line is ignored. So a leading "#" may be used to make a line into a comment, and a "#" may be used to put comments at the end of a line.
Any white space in the file can be any combination of spaces and tab characters.
Lines other than comments are all of the form:
keyword: value
Keywords are case-sensitive. I recommend copying the sample control file supplied with the program and editing it, rather than typing from scratch.
First, a set of command lines introduce global settings that apply to the program as a whole. Then, a set of lines describe a specific folding task, and additional sets of lines for additional folding processes can follow.
So the general format of a control file is:
# Comments command lines setting global parameters command lines defining a folding task command lines defining another folding task command lines defining another folding task . . . etc . . .
The following keywords may appear at the beginning of the file, once only, and apply to all the folding processes that nFoldMonOnly is managing. (Once lines governing a specific folding process are introduced, these lines may no longer appear in the file.)
| Keyword | Value | Explanation |
| password: | string | The string following is used as the access password needed by any nFoldMan program trying to connect to this program over the network. If omitted, there will be no password protection (not recommended). |
| port: | integer | The port number on which the program listens for connections. (Must match the port number in the nFoldMan program trying to connect.) The default is 35123, and there is no reason to change it unless it is interfering with some other program on your machine. |
| timeout: | integer | How long, in seconds, should network connections wait before timing out. The default is 2 seconds, which should work for most applications. |
| avoid | string | This command may be omitted, or may be repeated any number of times. Each one specifies the full path name of an application that is to be avoided. If any application in the list is running, folding processes are automatically paused. Note that the full path name of the application, including the ".app" suffix, is needed. e.g. "/Applications/Address Book.app". See nFoldMan for more detail on the general subject of application avoidance. |
| traceNetworkServer: | YES or NO | Default NO. Displays a lot of debugging information about the server function. Not likely of interest to you. |
| traceProcessQuery: | YES or NO | Default NO. Displays a lot of debugging information about the software to query process status. Not likely of interest to you. |
| traceProcessCache: | YES or NO | Default NO. Displays a lot of debugging information about the software to cache recent process status queries. Not likely of interest to you. |
| traceProcessControl: | YES or NO | Default NO. Displays a lot of debugging information about the functions that control folding processes. Not likely of interest to you. |
The following keywords are used to describe a specific folding process. They begin with the "process:" line. After that, the remaining lines may appear in any order, and most may be omitted. The next folding process description, if any, is introduced by the next time a "process:" line appears.
| Keyword | Value | Explanation |
| process: | string | This required field gives this process a name. This name is how the remote nFoldMan programs refer to this process for monitoring purposes. |
| path: | string | This required field gives the absolute path name to the folding client. (The same executable file you would have poitned nFoldMan at.) e.g. /Users/richard/fahfolder/fah5 |
| allowControl: | YES or NO | Determines whether a remote nFoldMan program can control this folding process (YES) or only monitor its status (NO). Default NO. |
| autoStart: | YES or NO | Determines whether the folding process is automatically started when nFoldMonOnly starts. Default NO. |
| idleStart: | YES or NO | Determines whether the folding process is started after the computer is idle for a period of time. Defaut NO. |
| idleTime: | integer | How long to wait before considering the computer idle (used only if idleStart = YES). Default 10. |
| idleUnits: | SECONDS or MINUTES or HOURS | What are the units of the idleTime figure above? Default MINUTES. |
| stopWhenActive: | YES or NO | Determines whether a folding process started by the computer being idle is stopped when the computer becomes active again. Default NO. |
| stopOnExit: | YES or NO | Determines whether the folding process is stopped when nFoldMonOnly stops. Default NO. |
| stopOnExitOnlyMine: | YES or NO | If stopOnExit is YES, stop the folding process only if we started it (not if it was already running). Default NO. |
| clientOptions: | string | A string passed to the folding process as options. Not checked in any way - just passed on. Note that the "-local" option is always given. You will usually want to specify the "-advmethods" option here. |