Thanks to Markus (aka Krauty) and Steve for putting quite a lot of work in here. Note that this document is open to any kind of suggestions. Drop a note if something is missing.
There is one very important rule about the new SetiHide version: be patient!! SetiHide is written in a way that makes sure as little CPU time is taken away from the SETI client as possible. One of the ways to obtain this, is to raise the time between file- and status checks. So, whenever you find yourself asking, "Why is SetiHide not doing, what I just told it to?" then simply give it a little time!
Table of contents
1.1 First time
1.2 Updating from version 1.4.x
2.1 Windows Startup
2.2 Display mode
2.3 Client priority
2.4 Connection mode
2.5 Connection timeout
2.6 Proxy settings
2.6.1 Socks proxy
2.7 Seti client name
2.8 PC Name
2.10 Network cache
2.11 Network cache path
2.12 Auto restore
2.13 More options
3. Work-unit caching
3.1 Main frame
3.3 set cron job
3.4 Cache count
4. Main page
4.3 User info
4.4 Work-unit info
4.5 The performance chart
5. Log page
5.1 The log
6.1 Installation issues
6.1.1 Where to get the DOS-client for Seti@Home?
6.1.2 Special .ini settings
6.1.3 The "halt_if_running.txt" file
6.2 General problems
6.2.1 Seti cli won't start
6.2.2 clicked SetiHide.exe, but won't run
1. Installation top
1.1 First time installation (NOTE: SetiHide does NOT work with the screensaver version of the client. You must obtain the command-line client). If you already have the SETI client and a work-unit present on your PC, go straight to section 1.1.3
1.2 Updating from SetiHide version 1.4.x
- 1.1.1 In case you don't have it already - get the SETI client!
- 1.1.2 In case you don't have a work-unit yet, launch the SETI client manually in order to get one.
- 1.1.3 Make sure the SETI client is not running! (how to terminate it)
- 1.1.4 Unzip SetiHide.exe to the folder where your SETI client is located.
- 1.1.5 Run SetiHide.exe. Proceed to section 2 for customization.
1.2.1 Get the update program, unzip it to your SetiHide folder and run it.
1.2.2 Run SetiHide.exe. Proceed to section 2 for customization.
2. Settings top
2.1 "Run SetiHide on Windows startup" [ yes | no | run, launch SETI client and exit ] (Supported on Win95/Win98/WinME only at this time. Next version will come in two flavours, one will be a service for WinNT/Win2K/WinXP. Currently, SetiHide.exe can be placed in the startup folder. Note that SetiHide was succesfully tested with AppToService!)
2.2 "SetiHide display mode at startup" [ normal | run in tray | invisible ] - This sets how SetiHide is displayed when first run either at startup or by user command.
- [ yes ] - Launch SetiHide when Windows starts or a new user logs on.
- [ no ] - should be self-explanatory... ;)
- [ run, launch SETI client and exit ] - Same as [ yes ], but SetiHide terminates itself as soon as the SETI client was launched. No logging will be done. When the SETI client is done with a work-unit it won't switch to the next one. It will attempt to download a new one and begin processing it.
2.3 "Seti client priority" [ idle | normal | high ] - This setting controlls how CPU resources are allocated to the SETI client and applies to all installed CPUs.
- [ normal ] - SetiHide window is displayed.
- [ run in tray ] - SetiHide Window is not visible, but the SetiHide icon is visible in the system tray. Single left click the icon to display the SetiHide window.
- [ invisible ] - SetiHide is run in "stealth mode." This mode creates a file "setihide_is_hidden.txt" inside the ..\files\ directroy. Delete this file to display the SetiHide window. Minimizing SetiHide will re-hide it and re-create "setihide_is_hidden.txt".
2.4 "Connection mode" [ online | offline ]
- [ idle ] - The SETI client will run at idle priority using only spare CPU cycles. Aside from the RAM that the client uses, this setting minimizes the affect of the client on overall system performance. This is the recommended setting.
- [ normal ] - SETI client will run at normal priority taking CPU time according to other programs running. Overall system performance is slowed. No noticeable performance advantage unless other processes are taking more than their "fair share" of CPU time, e.g., An unattended nightly backup program that "hogs" CPU time can be thwarted by setting the client priority to "normal." This will maximize the client CPU time and likely have negligible effect on the backup program.
- [ high ] - Use with caution. Overall system performance will be very sluggish. Again, there is no noticeable performance boost under normal circumstances.
2.5 "Connection timeout" [ 120 sec | 240 sec | 360 sec | 480 sec | 600 sec ] - Specifies how long (in seconds) SetiHide tries to connect to the Seti@Home server in Berkeley before it gives up.
- [ online ] - For PCs that have a permanent connection to the internet. SetiHide does flushing/fetching automatically.
- [ offline ] - For dial-up connections to the internet (modem). SetiHide will not flush/fetch until you tell it to do so.
2.6 "Use a proxy server" [ yes | no ]
2.6.1 "Socks proxy" [ yes | no ]
- [ yes ] - If you have to use a proxy server for your internet connection, choose this option and type in it's name and port.
- [ no ] - If you don't have to use a proxy or don't know what a proxy is, choose no and leave the fields as they are.
2.7 "Seti client program name" - Specifies the name of the executable of the SETI client itself. During setup SetiHide will detect the SETI client itself. If this was changed or if the automatic detection failed, simply enter the name of the SETI client executable here. If you didn't change it, it's probably "setiathome-3.03.i386-winnt-cmdline.exe"
- [yes] - Passes the entered username and password to the proxy server for authification. Please note that the encryption algorythm is weak, so a skilled person will be able to decrypt this password (stored inside setihide.ini).
- [no] - opposite of [yes]
2.8 "SetiHide referrs to this PC as" - Each installation of SetiHide is considered as a resource with [X] processors, where [X] can be 1 up to 4. This field specifies how SetiHide will refer to an installation. If you don't use a network cache, you can choose a desired name here. Otherwise, SetiHide will select the assigned computer name. If you use a network cache, every installation must have it's own unique resource name.
2.9 "Number of processors to be used" [ 1 (default) | 2 | 3 | 4 ] - If you change this option, be sure you have at least as much local work units cached as the number of CPUs you selected. You must exit and re-start SetiHide to apply the new setting. You're able to use more processors than the number of processors that are present in your system, but this will not give any performance advantage.
2.10 "Use a network cache" [ yes | no ]
[ yes ] - SetiHide will use network wu-caches or at least (if cache count is zero) it will keep a central log file and charts. Also, this will enable remote controling of other SetiHide resources. Please note: You need to add two new, empty directories to your network cache directory before using it for the first time: "files" and "charts", e.g., let's pretend you want to use "seti" as the network cache directory. The structure has to look like this before using the network cache for the first time:
[ no ] - SetiHide will only use local caches.
NOTE/WARNING ABOUT NETWORK CACHING: The greater the number of network caches available, the more resources SetiHide requires to update the caches screen, e.g., an 800MHz Athlon with 256MB RAM on a 100MBps network requires approximately 25% of CPU resources every five seconds to update the caches screen with 66 caches present EVEN WHEN MINIMIZED! When on the main screen viewing local or network resources, there is little or no additional CPU demand detected on the example system.
2.11 "Network cache path" - This specifies the location of the network cache. It is recommended to use a server name instead of a drive mapping, e.g., "\\MyServer\data\seti\setihide". SetiHide needs read/write/delete/modify rights to this directory. You can use any kind of connection mode that Windows supports, so this will also work: "\\172.20.40.3\data\user\oli\private\setihide\".
2.12 "Auto restore" [ yes | no ]
[ yes ] - If you chose to use a network cache, but the connection is not available when SetiHide is launched, SetiHide will try to restore the network connection - very helpful if SetiHide gets started before user logon. Again, please note that the encryption for the password is weak.
2.13 "More options"
Note: done followed by Apply Settings will update the setihide.ini file. In order for the changes to take effect, restart SetiHide.
- Confirm before exiting SetiHide - Request Y, N or Cancel confirmation upon exit.
- Flush/fetch only one cache after another (slow internet connection) - If this is not selected, SetiHide will flush/fetch multiple WU without consideration for slower connections.
- Log starmap data - Enabling this option saves starmap data for completed WU for viewing in the log.
- Use "-cpu" flag on multiprocessor PCs - forces client to use -cpu N flag on multiprocessor machines. If you have a multiprocessor machine, and you are experiencing problems, try this option.
- Use alternative colors (256 color support) - changes to a different palette indended for displays using fewer colors.
3. Work-unit caching top
3.1 Main frame
3.2 Scheduling frame
- [ Cache ] shows local and network caches.
- [ Work-unit Status ] If a state.sah file is present, the progress is displayed, otherwise it reads "n/a". Note that "n/a" does NOT automatically mean that there's no wu, it means there is either no wu or the wu has not been started yet.
- [ Cache Status ] can be one or more of the following:
- - ok There is a work unit present.
- - empty There is no work unit and no result present.
- - active The work unit inside this cache is currently being crunched.
- - result The work unit inside this cache is finished.
- - locked SetiHide needs to lock network caches sometimes, ignore this.
- - delete-mark This cache will be deleted as soon as possible.
- - flush_only No new work unit will be downloaded to this cache.
- - fetch-attempt The SETI client connects to berkeley in order to get a new wu.
- - fetching The SETI client is downloading a new work unit.
- - flushing The SETI client is uploading the result inside this cache.
- [ Current resource ] Tells you which resource is currently active inside this cache.
- [ Schedule time ] If there is a scheduled task for this cache, the date and time of the scheduled event is displayed here.
- [ Scheduled task ] If there is a scheduled task for this cache, this specifies the type of action that will be performed. A scheduled task can be deleted using the popup-menu - "Delete scheduled task...".
- [ Resource to perform scheduled task ] If there is a scheduled task for this cache, this specifies which resource will perform the scheduled task. This can be modified using the popup-menu - "Assign scheduled task to other resource".
- POPUP menu - right-clicking on a cache opens a menu with the following options:
- Flush/Fetch selected cache(s).
- Flush selected cache(s).
- Fetch selected cache(s).
- Delete scheduled task for selected cache(s).
- Assign scheduled task for selected cache(s) to another resource.
- Start seti client visible in selected cache for debug reasons.
- Show extended caches-info.
Clicking [ OK ] finalizes the schedule settings.
- [ Action ]
- flush/fetch - flush current and fetch new WU
- flush - flush current WU
- fetch - fetch new WU
- stop client - stop client in this cache
- [ Cache selection ]
- all caches
- all local caches
- all network caches
- selected caches - select caches with shift/ctrl mouse click conventions.
- [ Action time ] - set time in hours and minutes here
- [ Action date ] - today or tomorrow
3.3 set cron job
One may specify that at a given hour on a given day of the week, SH will flush/fetch all WU in ALL caches (local and network). This may be done up to seven times a week, once for each day of the week. Click done to accept changes. This option has been added to allow users to schedule WU transfers when a connection is available or during periods of low connection utilization.
3.4 Cache count frame
3.5 Export frame - Left click cache(s) to export in main frame, click path field to browse for a destination and click export to export the selected WU(s) to the chosen destination.
- [ local caches | network caches ] - Display number of local or network caches.
- [ ±1 | ±5 | ±10 | ±20 ] - Adjust the number of local or network caches.
3.6 Import frame - Left click cache(s) in main frame in which to import, click path field to browse for a source, choose local or network cache, click import and select WU(s) to import into to the chosen destination.
4. Main Screen top
4.1 Resource to display - If there is more than one CPU or there are other systems set up to use network caching over a LAN, that resource can be selected and it's data displayed. The "Last time up" indicates the last time SetiHide updated the progress data. If this value varies by more than a few minutes from your system time, something may be wrong. Terminating the client and restarting SetiHide might be prudent or even a full system restart. With the "delete from list" item network resources can be removed from this list.
4.2 Progress - This frame displays the progress of the current WU for the selected resource in % completed. ("Status) indicated the status of the client for the selected resource, active or inactive. While active clicking on the status displays the following options:
While not active, clicking on the status displays the following options:
- leave active - do nothing.
- stop now - terminate client immediately. Current progress on new segment of data is discarded, and processing is terminated at the displayed progress point.
- stop after next checkpoint - terminate client upon completion of current data segment, i.e., the client will terminate when the progress meter is next incremented.
The "Processing rate (now)" indicates the actual processing rate of the currently crunched work unit (how long does it approx. take to finish this wu). "Processing rate (avg.)" indicates the average processing rate of work units crunched with the current resource. "Time left" is an estimate of the time remaining for the current WU. "CPU time" is the total CPU time consumed by the current WU.
- leave inactive - do nothing.
- start client hidden - start client while keeping its output hidden.
- start client visible - start client with window visible and its output displayed (diagnostic tool).
4.3 User info - User name, user number and total WU completed by user are displayed here. "update" will update these fields. Clicking on the user number (name) will open your browser and load the SETI@home status page for the user. Note: if SetiHide is not able to update, edit the "user_info.sah" with a text editor (e.g., notepad) in the SetiHide directory. Enter the correct e-mail address in the "email_addr=" field, and SetiHide should be able to accurately update the data.
4.4 Work unit info - The name of the work unit, when it was recorded, etc. are displayed here. For a detailed list of all the information presented, visit the Berkeley site here. Clicking on the name of the work-unit will display the sky map (1024x768 or greater resolution recommended).
4.5 The performance chart - The chart plots the current processing rate of the client processing the work unit for the selected resource. Options are as follows:
- L - Chart is plotted as a line.
- B - Chart is plotted as unfilled bars.
- ^ and v - Scale Y axis up and down.
- > and < - Pan along X axis.
5. Log page top
5.1 The log - No, we're not talking about a hunk of wood here. Here the results of all crunched work units (local or network) are displayed. SetiHide displays the name and the date/time it finished/stopped. An asterisk (*) in the work unit name indicates the active work unit. An asterisk in the date finished column indicates SetiHide has not logged all data for the corresponding work unit. For details on the other values reported, visit the Berkeley site here. Other options are as follows:
Chart navigation buttons are identical to the main screen 4.5.
- Show Charts - [ on ] - displays the chart associated with the selected WU log entry. [ off ] - charts are not displayed.
- Logfile - local or network to display local or network cache logfiles.
- Skymap - Clicking Skymap will display the skymap for the selected WU.
- Export - Allows the user export to tab-seperated ascii file at desired filename/location.
- Edit - Allows the user to delete individual log entries and import log files.
- Analyse logfile - Reports total WU completed, total CPU time, average CPU time and average processing rate.
- Clear logfile - Erases the log file and starts anew. User is prompted to confirm emptying of logfile.
6. FAQ top
For general questions relating the command line client, visit the seti@home help page. Don't be impatient! In order to take away as little CPU-time as possible, SetiHide does not perform checks every 5 ms, e.g., after a WU is finished, SetiHide might report not active for a few seconds. This does not mean it has failed to load the next WU. It likely means that SetiHide has not internally detected that the SETI client is finished with the previous wu and subsequently updated the display information.
6.1 Installation Issues
6.1.1 You can download the required dos client for the seti@home project
here! In case this link is broken, please check here!
Note: SetiHide does not work with the screensaver client!
6.1.2 Special .ini settings:
"ASKBEFOREEXIT=1" - Adding this line to setihide.ini forces SetiHide to prompt the user before exiting. This was incorporated for users accustomed to the behaviour of SetiHide 1.4.x, which would minimize to the system tray when clicking the "X" on the right top corner.
6.1.3 The "halt_if_running.txt" file
Enter path and filename of any application that is supposed to pause the SETI client. Recommended for disk defraggers, scan disk utilities or even taskmgr.exe on NT... ;-)
6.2 General problems
6.2.1 SETI client won't start
6.2.2 Clicked SetiHide.exe, but it won't run.
- Confirm the command line version of the SETI client is installed!
- Confirm the SetiHide program name and the path in the settings screen of SetiHide match (the current name given by Berkeley is "setiathome-3.03.i386-winnt-cmdline.exe").
- See 6.2.2.
- Confirm the presence of local or network work unit(s).
- Diagnose by starting client visible in a cache with a WU present.
- Confirm there are no scheduled tasks that may stop the SETI client.
Check the ..\files\ directory. If "setihide_is_hidden.txt" is present. If so, delete it, and SetiHide will become visible. This option is selected here.
Launch SETI client manually
- Open MS-DOS or Command Prompt session.
- cd to the directory you saved the client to.
- Type the client name, e.g. "seti", and press <ENTER>
- Login with old or new username as desired.
- Once the WU is downloaded and the display has stopped updating, press Ctrl-C.
Exiting the client manually
There are four principal ways to stop the SETI client:
- Terminate all local or network clients (as desired) on the main screen of SetiHide. Select the client you want to terminate in the 'resource to display' frame and change the status from 'active' to 'stop'.
- To stop a client on the LAN remotely), mark the network cache for that client and then select 'action: stop client' in the upper right frame and click OK.
- Terminate SetiHide by pressing the 'X'-Button. The SETI client(s) is/are still active. Terminate it by pressing ctrl+alt+del. Select the task, "Winoldap", and end it (Win 9x/Me). For WinNT/2000, ctrl+alt+del, select Task Manager, select seti.exe and terminate.
- If the client is running in a DOS window, terminate it by pressing Ctrl-C.
- 08-11-2001 - Minor editorial changes. Moved note concerning addition of "files" and "charts" directories from 2.9.2 to 2.9.1 and added "no" description and "note/warning" to 2.9.1. Revised the "Exiting the client manually" and 6.2.1 sections for clarity.
- 27-11-2001 - Added "startup folder" sentence to 2.1. 5.1 updated to document new log features (edit, export) and new data in analyze (avg CPU time). 2.2 updated to document that SetiHide will re-hide itself when minimized if display mode is set to invisible.
- 24-03-2002 - Renumbered 2.9.1 through 2.9.3 as 2.10 through 2.12, respectively. Added 2.13 for "More options". Added "POPUP menu" to 3.1. Inserted new 3.3 and renumbered subsequent sections. Added "time left" and "CPU Time comments to 4.2. Added reference to user link at Berkley and made minor editorial changes in 4.3. Added recommended resolution in 4.4. Added "Skymap" to 5.1. Added previously missing instructions for starting the client manually. Added 4th client termination options.