aboutsummaryrefslogtreecommitdiff
path: root/net/boinc-client/files
diff options
context:
space:
mode:
Diffstat (limited to 'net/boinc-client/files')
-rw-r--r--net/boinc-client/files/boinc-client6
-rw-r--r--net/boinc-client/files/boinc-client.1170
-rw-r--r--net/boinc-client/files/boinc.sh61
-rw-r--r--net/boinc-client/files/patch-api::boinc_gl.h19
4 files changed, 256 insertions, 0 deletions
diff --git a/net/boinc-client/files/boinc-client b/net/boinc-client/files/boinc-client
new file mode 100644
index 000000000000..43b01c2a39d3
--- /dev/null
+++ b/net/boinc-client/files/boinc-client
@@ -0,0 +1,6 @@
+#!/bin/sh
+
+args="$@"
+
+exec idprio 31 su - %%BOINC_USER%% -c "%%BOINC_DATADIR%%/client/%%BOINC_BINARY%% $args"
+
diff --git a/net/boinc-client/files/boinc-client.1 b/net/boinc-client/files/boinc-client.1
new file mode 100644
index 000000000000..7f712dc506a9
--- /dev/null
+++ b/net/boinc-client/files/boinc-client.1
@@ -0,0 +1,170 @@
+.TH boinc-client 1 "October 1, 2004" "" "BOINC"
+.SH NAME
+boinc-client \- client for Berkeley Open Infrastructure for Network Computing
+.SH SYNOPSIS
+boinc-client [ options ]
+.PP
+sh /usr/local/etc/rc.d/boinc.sh start|stop|restart|status
+.SH DESCRIPTION
+.I boinc-client
+is the client for the Berkeley Open Infrastructure for Network
+Computing (BOINC) service. It is used by projects such as SETI@HOME
+and ClimatePredictor to offer your spare CPU cycles to such projects.
+BOINC allows you to configure one or more projects to which you offer
+your spare CPU cycles for their computations.
+.PP
+BOINC is a scheduler; you configure projects under BOINC and BOINC
+then runs each one according to what percentage of time you have
+specified for that project.
+When a project is run, BOINC runs the project's client program to
+download computational work units from the project, then perform the
+work unit computation, and finally upload the results back to the
+project. If no work is available for one of your projects, BOINC
+will run another of your projects.
+.PP
+BOINC runs project clients at low priority, with a
+.IR nice (1)
+value of 19, to ensure that as soon as you need your computer for
+any other work, BOINC projects stop so that you are not delayed
+by them.
+.PP
+After choosing which projects to participate in, you must register
+with each on the project's website. You can find out about BOINC
+projects on the BOINC website. Upon registering with a project,
+you will receive an account ID for the project.
+Run
+.I "boinc-client -attach_project"
+to add new projects to your BOINC configuration using the project
+URL and your account ID.
+Depending on what operating system platforms the project supports
+you may be able to immediately start the project or you may need to
+download the project client's source code and compile it. For
+further information, see the BOINC web site and the project's own
+website. Some projects are already available as FreeBSD ports
+(e.g., SETI@HOME in port astro/boinc-setiathome). Not all projects
+support FreeBSD and some do not make their client's source code
+available. In such cases, you will not be able to participate in
+that project from FreeBSD.
+.PP
+Running
+.I boinc-client
+with no arguments starts the service and any configured projects.
+.PP
+You can edit both BOINC general preferences and project-specific
+preferences on the website of any BOINC projects which you are
+registered with. Preferences will take effect next time BOINC
+contacts that project's server, e.g., to download more work or
+to upload results.
+.PP
+.I /usr/local/etc/rc.d/boinc.sh
+script is run automatically at system boot time.
+The
+.I /etc/rc.conf
+variable
+.I boinc_enable
+must be set to
+.I boinc_enable="YES"
+for this script to start BOINC at boot time.
+.PP
+The user
+.I %%BOINC_USER%%
+needs to exist; all invocations of boinc-client will run as this
+user. If you want users other than root to be able to start
+BOINC, set a password on this account so that anyone can run
+.I boinc_client
+and supply the password.
+.PP
+IMPORTANT NOTE: The project clients are programs running
+on your computer with full access (as the user
+.IR %%BOINC_USER%% )
+to all files and resources of your computer. Before running any
+project client, you should establish for yourself that the
+program is trustworthy and will not abuse your computer. The
+BOINC scheduler does not restrict clients in any way other than to
+run them as the user
+.IR %%BOINC_USER%% .
+.SH OPTIONS
+The command-line client has the following command-line options:
+.IP -attach_project
+Attach this computer to a new project.
+You must have an account with that project.
+You will be asked for the project URL and the account ID.
+.IP -show_projects
+Print a list of projects to which this computer is attached.
+.IP -detach_project URL
+Detach this computer from a project.
+.IP -reset_project URL
+Clear pending work for a project.
+Use this if there is a problem that is preventing
+your computer from working.
+.IP -update_prefs URL
+Contact a project's server to obtain new preferences.
+This will also report completed results
+and get new work if needed.
+.IP -return_results_immediately
+Contact scheduler as soon as any result done.
+.IP -run_cpu_benchmarks
+Run CPU benchmarks.
+Do this if you have modified your computer's hardware.
+.IP -check_all_logins
+If 'run if user active' preference is off,
+check for input activity on all current logins;
+default is to check only local mouse/keyboard
+.IP -exit_when_idle
+Get, process and report work, then exit.
+.IP -allow_remote_gui_rpc
+Allow GUI RPCs from remote hosts
+.IP -help
+Show client options.
+.IP -version
+Show client version.
+.SH "ENVIRONMENT VARIABLES"
+The command-line client has the following optional environment variables:
+.IP HTTP_PROXY
+URL of HTTP proxy
+.IP HTTP_USER_NAME
+User name for proxy authentication
+.IP HTTP_USER_PASSWD
+Password for proxy authentication
+.IP SOCKS4_SERVER
+URL of SOCKS 4 server
+.IP SOCKS5_SERVER
+URL of SOCKS 5 server
+.IP SOCKS5_USER
+User name for SOCKS authentication
+.IP SOCKS5_PASSWD
+Password for SOCKS authentication
+.SH FILES
+.IP %%BOINC_HOME%%
+default home directory for
+.I %%BOINC_USER%%
+user
+.IP %%BOINC_HOME%%/*
+boinc-client configuration files
+.IP %%BOINC_HOME%%/projects/*
+BOINC projects
+.IP %%BOINC_HOME%%/projects/*/*
+BOINC project work unit files
+.IP %%BOINC_DATADIR%%
+boinc-client and BOINC project programs
+.SH BUGS
+Suspending
+.I boinc-client
+using ^Z works, but resuming using
+.I fg
+or
+.I bg
+does not resume any client processes (e.g., SETI). These need to be
+restarted using
+.I "kill -CONT"
+for each process.
+.PP
+Placing files in %%BOINC_HOME%% or its subdirectories can cause work
+to fail as those files will be counted in disk usage limit checks. In
+addition to configurable overall disk usage limits, each client may
+further restrict the size of its project or slot directories.
+.PP
+On a hyperthreadded processor, performance may be limited due to shared
+use of processor modules such as the FPU.
+.SH "SEE ALSO"
+http://boinc.berkeley.edu/
diff --git a/net/boinc-client/files/boinc.sh b/net/boinc-client/files/boinc.sh
new file mode 100644
index 000000000000..77fc535ab612
--- /dev/null
+++ b/net/boinc-client/files/boinc.sh
@@ -0,0 +1,61 @@
+#!/bin/sh
+#
+# $FreeBSD: /tmp/pcvs/ports/net/boinc-client/files/Attic/boinc.sh,v 1.1 2004-10-16 19:29:30 pav Exp $
+#
+# Start or stop BOINC
+#
+
+. /etc/rc.subr
+
+name="boinc"
+rcvar=`set_rcvar`
+
+boinc_user=%%BOINC_USER%%
+boinc_home=%%BOINC_HOME%%
+program_file=%%BOINC_BINARY%%
+program_path=%%BOINC_DATADIR%%/client/${program_file}
+
+[ -z "$boinc_enable" ] && boinc_enable="NO"
+
+load_rc_config $name
+
+case "$1" in
+start)
+ if checkyesno boinc_enable
+ then
+ if [ ! -x ${program_path} ]
+ then
+ logger -sp ${syslog_facility} -t ${program_file} \
+ "unable to start: ${program_path} is missing."
+ exit 72
+ fi
+ if ps axo ucomm | egrep ${program_file}; then
+ logger -sp ${syslog_facility} -t ${program_file} \
+ "unable to start: ${program_file} is already running."
+ exit 72
+ fi
+ echo -n "BOINC "
+ idprio 31 su - ${boinc_user} -c "${program_path} >/dev/null &"
+ fi
+ ;;
+
+stop)
+ program=`expr ${program_file} : '^\(...................\).*$'`
+ killall ${program} 2> /dev/null
+ ;;
+
+restart)
+ $0 stop
+ $0 start
+ ;;
+
+status)
+ ps auxww | egrep ${program_file} | egrep -v "($0|egrep)"
+ ;;
+
+*)
+ echo "usage: ${name} {start|stop|restart|status}" >&2
+ exit 64
+ ;;
+esac
+
diff --git a/net/boinc-client/files/patch-api::boinc_gl.h b/net/boinc-client/files/patch-api::boinc_gl.h
new file mode 100644
index 000000000000..a9c41321c9cc
--- /dev/null
+++ b/net/boinc-client/files/patch-api::boinc_gl.h
@@ -0,0 +1,19 @@
+--- api/boinc_gl.h.orig Wed Sep 1 19:15:30 2004
++++ api/boinc_gl.h Fri Oct 1 12:06:47 2004
+@@ -54,8 +54,6 @@
+ # include <OpenGL/glu.h>
+ # endif
+
+-# include "GL/glut.h"
+-/*
+ # if defined(HAVE_GLUT_H)
+ # include "glut.h"
+ # elif defined(HAVE_GL_GLUT_H)
+@@ -65,7 +63,6 @@
+ # elif defined(HAVE_GLUT_GLUT_H)
+ # include <GLUT/glut.h>
+ # endif
+-*/
+
+ #endif // _WIN32
+