1 files changed, 107 insertions, 63 deletions
diff --git a/astro/setiathome/files/setiathome.1 b/astro/setiathome/files/setiathome.1
index b718c0d86601..4ac329052633 100644
--- a/astro/setiathome/files/setiathome.1
+++ b/astro/setiathome/files/setiathome.1
@@ -1,5 +1,5 @@
 .\" $FreeBSD$
-.Dd May 19, 1999
+.Dd Dec 12, 2000
 .Dt setiathome 1 LOCAL
 .Os FreeBSD
 .Sh NAME
@@ -37,14 +37,14 @@ and direct its output to
 if you like.
 .Pp
 .Nm
-can be freely aborted and restarted.
+can be freely stopped and restarted.
 It saves its state in files, and will pick up where it left off.
 .Pp
 If you want to run multiple instances of
 .Nm
 (on a multiprocessor machine, or on multiple machines
 that share a filesystem) each one must be run in a different directory.
-.Pp
+.Sh IMPLEMENTATION NOTES
 .Nm
 requires about 0.5\ MBytes of disk space per working directory, and about
 15\ MBytes of memory per instance.
@@ -56,6 +56,63 @@ requires a permanent or
 Internet connection to upload results to and download new work units from the
 .Tn SETI@home
 server at any time.
+.Sh OPTIONS
+.Bl -tag -width countries
+.It Fl countries
+Show list of country codes.
+.It Fl email
+Send E-mail (to login E-mail address) on errors.
+Useful if you run in background directed to
+.Pa /dev/null .
+.It Fl graphics
+Generate a data stream for the
+.Xr xsetiathome 1
+graphical interface.
+.It Fl login
+Login or create new account.
+.It Fl nice Ar N
+Set
+.Xr nice 1
+priority to
+.Ar N
+(default 1).
+.It Fl nolock
+Omit the multiple-instance check, which uses file locking
+(not available on some NFS systems).
+.It Fl proxy Ar hostname : Ns Ar port
+Connect to
+.Tn SETI@home
+server via specified HTTP proxy server and port.
+.It Fl socks_passwd Ar password
+SOCKS
+.Ar password .
+.It Fl socks_server Ar hostname : Ns Ar port
+Connect to
+.Tn SETI@home
+server via specified SOCKS server and port.
+Overrides
+.Ev SOCKS_SERVER .
+SOCKS versions 4 and 5 are supported.
+.It Fl socks_user Ar name
+SOCKS user
+.Ar name .
+.It Fl stop_after_process
+Stop after processing current work unit.
+Do not send result.
+.It Fl stop_after_xfer
+Stop after current work unit has been sent to the SETI
+server and a new work unit has been obtained.
+(See also
+.Pa stop_after_send.txt
+mentioned in
+.Sx FILES
+below.)
+.It Fl verbose
+Print a running summary of the work being done.
+.It Fl version
+Show software version.
+.El
+.Sh USAGE
 .Ss Starting setiathome
 This
 .Fx
@@ -95,9 +152,11 @@ If you change values in the configuration file, you need to stop and start
 .Nm Ns ,
 and possibly reconfigure the working directory for the changes to take
 effect. Run
+.Pp
 .Dl /usr/local/etc/rc.d/setiathome.sh stop
 .Dl /usr/local/etc/rc.d/setiathome.sh register
 .Dl /usr/local/etc/rc.d/setiathome.sh start
+.Pp
 to do that.
 .Ss Setting up setiathome
 You can use the start-up script to set up a working directory
@@ -126,62 +185,6 @@ to
 .Ed
 .Pp
 to the user's crontab.
-.Sh OPTIONS
-.Bl -tag -width countries
-.It Fl countries
-Show list of country codes.
-.It Fl email
-Send E-mail (to login E-mail address) on errors.
-Useful if you run in background directed to
-.Pa /dev/null .
-.It Fl graphics
-Generate a data stream for the
-.Xr xsetiathome 1
-graphical interface.
-.It Fl login
-Login or create new account.
-.It Fl nice Ar N
-Set
-.Xr nice 1
-priority to
-.Ar N
-(default 1).
-.It Fl nolock
-Omit the multiple-instance check, which uses file locking
-(not available on some NFS systems).
-.It Fl proxy Ar hostname : Ns Ar port
-Connect to
-.Tn SETI@home
-server via specified HTTP proxy server and port.
-.It Fl socks_passwd Ar password
-SOCKS
-.Ar password .
-.It Fl socks_server Ar hostname : Ns Ar port
-Connect to
-.Tn SETI@home
-server via specified SOCKS server and port.
-Overrides
-.Ev SOCKS_SERVER .
-SOCKS versions 4 and 5 are supported.
-.It Fl socks_user Ar name
-SOCKS user
-.Ar name .
-.It Fl stop_after_process
-Stop after processing current work unit.
-Do not send result.
-.It Fl stop_after_xfer
-Stop after current work unit has been sent to the SETI
-server and a new work unit has been obtained.
-(See also
-.Pa stop_after_send.sah
-mentioned in
-.Sx FILES
-below.)
-.It Fl verbose
-Print a running summary of the work being done.
-.It Fl version
-Show software version.
-.El
 .Sh ENVIRONMENT
 .Bl -tag -width SOCKS_SERVER
 .It Ev HTTP_PROXY
@@ -207,45 +210,60 @@ will query you.
 .El
 .Sh FILES
 .Bl -tag -width /var/db -compact
-.It Pa /usr/local/etc/setiathome.conf
-Optional configuration file for the start-up script.
 .It Pa /usr/local/etc/rc.d/setiathome.sh
 Start-up script.
+.Pp
+.It Pa /usr/local/etc/setiathome.conf
+Optional configuration file for the start-up script.
+.Pp
 .It Pa /var/db/setiathome/
 Primary working directory.
+.Pp
 .It Pa /var/db/setiathome/user_info.sah
 Registration data.
+.Pp
 .It Pa /var/db/setiathome/ Ns Va n Ns Pa /
 Working directories for additional process
 .Va n
 (when running more than one instance).
+.Pp
 .It Pa /var/db/setiathome/ Ns Xo
 .Op Ns Va n Ns Pa / Ns 
 .Pa lock.sah
 .Xc
 Lock file to prevent multiple instances to work on the same data.
+.Pp
 .It Pa /var/db/setiathome/ Ns Xo
 .Op Ns Va n Ns Pa / Ns 
 .Pa *.sah
 .Xc
 Working files.
 These should not be modified.
+.Pp
 .It Pa /var/db/setiathome/ Ns Xo
 .Op Ns Va n Ns Pa / Ns 
 .Pa pid.sah
 .Xc
 The process ID of the current instance.
+.Pp
 .It Pa /var/db/setiathome/ Ns Xo
 .Op Ns Va n Ns Pa / Ns 
-.Pa stop_after_send.sah
+.Pa stop_after_send.txt
 .Xc
 While the client is running, touch this file in the working directory
 to finish up your current work unit, return your result, and not
 download a new work unit.
 When the processing is finished, and the result sent, the client will stop.
+Note this one file extension is
+.Pa .txt ,
+while all other files used by
+the client have extensions
+.Pa .sah .
 .El
 .Sh SEE ALSO
-.Xr xsetiathome 1
+.Xr xsetiathome 1 ,
+.Xr ipcs 1 ,
+.Xr ipcrm 1 .
 .Sh AUTHORS
 .Tn SETI@home
 was developed by David Anderson, Jeff Cobb, Charles Congdon, Charlie Fenton,
@@ -256,3 +274,29 @@ Silen, Woody Sullivan, and Dan Werthimer.
 amended the original manual page for this
 .Fx
 port.
+.Sh BUGS
+Outstanding shared memory segments and semaphores may be left
+active in case of an abnormal exit of the
+.Ic setiathome -graphics
+process.  These can prevent any future invocation of
+.Ic setiathome -graphics .
+To resolve this problem, use
+.Xr ipcs 1
+and
+.Xr ipcrm 1
+to remove shared memory segments and semaphores that
+are not associated with a process.  This behavior may vary
+depending upon how your
+.Ux
+system handles this situation.
+.Pp
+For version 3.* clients, the estimated progress as indicated
+by the
+.Pa prog=
+line in the
+.Pa state.sah
+file in not exactly linear
+in relationship to completion time.  Using this value to
+predict completion time may not be completely accurate.
+The linear relationship will vary depending upon the characteristics
+of the work unit parameters.