mirror of https://github.com/BOINC/boinc.git
265 lines
7.5 KiB
XML
265 lines
7.5 KiB
XML
|
<?xml version="1.0" encoding="UTF-8" ?>
|
||
|
|
|
||
|
|
<!--
|
||
|
|
This is the manual page for the BOINC core client (boinc_client).
|
||
|
|
|
||
|
|
Copyright © 2007 University of California
|
||
|
|
|
||
|
|
Permission is granted to copy, distribute and/or modify this document
|
||
|
|
under the terms of the GNU Free Documentation License, Version 1.2 or
|
||
|
|
any later version published by the Free Software Foundation; with no
|
||
|
|
Invariant Sections, no Front-Cover Texts, and no Back-Cover Texts.
|
||
|
|
-->
|
||
|
|
|
||
|
|
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN"
|
||
|
|
"file:///usr/share/xml/docbook/schema/dtd/4.2/docbookx.dtd" [
|
||
|
|
|
||
|
|
<!ENTITY dhbinary "boinc_client">
|
||
|
|
<!ENTITY dhdate "<date>October 06, 2007</date>">
|
||
|
|
<!ENTITY gnu "<acronym>GNU</acronym>">
|
||
|
|
]>
|
||
|
|
|
||
|
|
<refentry>
|
||
|
|
<refentryinfo>
|
||
|
|
<authorgroup>
|
||
|
|
<author>
|
||
|
|
<firstname>Steffen</firstname>
|
||
|
|
<lastname>Moeller</lastname>
|
||
|
|
<email>steffen_moeller@gmx.de</email>
|
||
|
|
</author>
|
||
|
|
|
||
|
|
<author>
|
||
|
|
<firstname>Frank</firstname>
|
||
|
|
<lastname>Thomas</lastname>
|
||
|
|
<email>frank@thomas-alfeld.de</email>
|
||
|
|
</author>
|
||
|
|
</authorgroup>
|
||
|
|
<copyright>
|
||
|
|
<year>2007</year>
|
||
|
|
<holder>University of California</holder>
|
||
|
|
</copyright>
|
||
|
|
&dhdate;
|
||
|
|
</refentryinfo>
|
||
|
|
|
||
|
|
<refmeta>
|
||
|
|
<refentrytitle>&dhbinary;</refentrytitle>
|
||
|
|
<manvolnum>1</manvolnum>
|
||
|
|
</refmeta>
|
||
|
|
|
||
|
|
<refnamediv>
|
||
|
|
<refname>&dhbinary;</refname>
|
||
|
|
<refpurpose>The BOINC core client program.</refpurpose>
|
||
|
|
</refnamediv>
|
||
|
|
|
||
|
|
<refsynopsisdiv>
|
||
|
|
<cmdsynopsis>
|
||
|
|
<command>&dhbinary;</command>
|
||
|
|
<arg><replaceable>options</replaceable></arg>
|
||
|
|
</cmdsynopsis>
|
||
|
|
</refsynopsisdiv>
|
||
|
|
|
||
|
|
<refsect1>
|
||
|
|
<title>DESCRIPTION</title>
|
||
|
|
<para><command>&dhbinary;</command> starts a client for communication with
|
||
|
|
the Berkeley Open Infrastructure for Network Computing. For a graphical
|
||
|
|
interface to the BOINC client, use BOINC Manager. For a command-line
|
||
|
|
interface to the BOINC client, use boinc_cmd.</para>
|
||
|
|
</refsect1>
|
||
|
|
|
||
|
|
<refsect1>
|
||
|
|
<title>OPTIONS</title>
|
||
|
|
<para>A full summary of options is included below.</para>
|
||
|
|
|
||
|
|
<variablelist>
|
||
|
|
<varlistentry>
|
||
|
|
<term><option>--help</option></term>
|
||
|
|
<listitem>
|
||
|
|
<para>show options</para>
|
||
|
|
</listitem>
|
||
|
|
</varlistentry>
|
||
|
|
|
||
|
|
<varlistentry>
|
||
|
|
<term><option>--version</option></term>
|
||
|
|
<listitem>
|
||
|
|
<para>show version info</para>
|
||
|
|
</listitem>
|
||
|
|
</varlistentry>
|
||
|
|
|
||
|
|
<varlistentry>
|
||
|
|
<term><option>--exit_when_idle</option></term>
|
||
|
|
<listitem>
|
||
|
|
<para>exit when there are no results</para>
|
||
|
|
</listitem>
|
||
|
|
</varlistentry>
|
||
|
|
|
||
|
|
<varlistentry>
|
||
|
|
<term><option>--show_projects</option></term>
|
||
|
|
<listitem>
|
||
|
|
<para>show attached projects</para>
|
||
|
|
</listitem>
|
||
|
|
</varlistentry>
|
||
|
|
|
||
|
|
<varlistentry>
|
||
|
|
<term><option>--return_results_immediately</option></term>
|
||
|
|
<listitem>
|
||
|
|
<para>contact server when have results</para>
|
||
|
|
</listitem>
|
||
|
|
</varlistentry>
|
||
|
|
|
||
|
|
<varlistentry>
|
||
|
|
<term>
|
||
|
|
<option>--detach_project <replaceable>URL</replaceable></option>
|
||
|
|
</term>
|
||
|
|
<listitem>
|
||
|
|
<para>detach from a project</para>
|
||
|
|
</listitem>
|
||
|
|
</varlistentry>
|
||
|
|
|
||
|
|
<varlistentry>
|
||
|
|
<term>
|
||
|
|
<option>--reset_project <replaceable>URL</replaceable></option>
|
||
|
|
</term>
|
||
|
|
<listitem>
|
||
|
|
<para>reset (clear) a project</para>
|
||
|
|
</listitem>
|
||
|
|
</varlistentry>
|
||
|
|
|
||
|
|
<varlistentry>
|
||
|
|
<term>
|
||
|
|
<option>--attach_project <replaceable>URL</replaceable>
|
||
|
|
<replaceable>key</replaceable></option>
|
||
|
|
</term>
|
||
|
|
<listitem>
|
||
|
|
<para>attach to a project</para>
|
||
|
|
</listitem>
|
||
|
|
</varlistentry>
|
||
|
|
|
||
|
|
<varlistentry>
|
||
|
|
<term>
|
||
|
|
<option>--update_prefs <replaceable>URL</replaceable></option>
|
||
|
|
</term>
|
||
|
|
<listitem>
|
||
|
|
<para>contact a project to update preferences</para>
|
||
|
|
</listitem>
|
||
|
|
</varlistentry>
|
||
|
|
|
||
|
|
<varlistentry>
|
||
|
|
<term><option>--run_cpu_benchmarks</option></term>
|
||
|
|
<listitem>
|
||
|
|
<para>run the CPU benchmarks</para>
|
||
|
|
</listitem>
|
||
|
|
</varlistentry>
|
||
|
|
|
||
|
|
<varlistentry>
|
||
|
|
<term><option>--check_all_logins</option></term>
|
||
|
|
<listitem>
|
||
|
|
<para>for idle detection, check remote logins too</para>
|
||
|
|
</listitem>
|
||
|
|
</varlistentry>
|
||
|
|
|
||
|
|
<varlistentry>
|
||
|
|
<term><option>--allow_remote_gui_rpc</option></term>
|
||
|
|
<listitem>
|
||
|
|
<para>allow remote GUI RPC connections</para>
|
||
|
|
</listitem>
|
||
|
|
</varlistentry>
|
||
|
|
|
||
|
|
<varlistentry>
|
||
|
|
<term>
|
||
|
|
<option>--gui_rpc_port <replaceable>port</replaceable></option>
|
||
|
|
</term>
|
||
|
|
<listitem>
|
||
|
|
<para>port for GUI RPCs</para>
|
||
|
|
</listitem>
|
||
|
|
</varlistentry>
|
||
|
|
|
||
|
|
<varlistentry>
|
||
|
|
<term><option>--redirectio</option></term>
|
||
|
|
<listitem>
|
||
|
|
<para>redirect stdout and stderr to log files</para>
|
||
|
|
</listitem>
|
||
|
|
</varlistentry>
|
||
|
|
|
||
|
|
<varlistentry>
|
||
|
|
<term><option>--dir <replaceable>path</replaceable></option></term>
|
||
|
|
<listitem>
|
||
|
|
<para>use given dir as BOINC home</para>
|
||
|
|
</listitem>
|
||
|
|
</varlistentry>
|
||
|
|
|
||
|
|
<varlistentry>
|
||
|
|
<term><option>--no_gui_rpc</option></term>
|
||
|
|
<listitem>
|
||
|
|
<para>Omits creation of a socket as required for the remote control
|
||
|
|
of the client. Consequently the client cannot be controlled by
|
||
|
|
external tools like GUIs (<command>boincmgr</command> etc.) or the
|
||
|
|
console command tool (<command>boinc_cmd</command>).</para>
|
||
|
|
</listitem>
|
||
|
|
</varlistentry>
|
||
|
|
|
||
|
|
<varlistentry>
|
||
|
|
<term><option>--daemon</option></term>
|
||
|
|
<listitem>
|
||
|
|
<para>run as daemon</para>
|
||
|
|
</listitem>
|
||
|
|
</varlistentry>
|
||
|
|
|
||
|
|
<varlistentry>
|
||
|
|
<term><option>--exit_before_start</option></term>
|
||
|
|
<listitem>
|
||
|
|
<para>exit right before starting a job</para>
|
||
|
|
</listitem>
|
||
|
|
</varlistentry>
|
||
|
|
|
||
|
|
<varlistentry>
|
||
|
|
<term><option>--exit_after_finish</option></term>
|
||
|
|
<listitem>
|
||
|
|
<para>exit right after finishing a job</para>
|
||
|
|
</listitem>
|
||
|
|
</varlistentry>
|
||
|
|
|
||
|
|
<varlistentry>
|
||
|
|
<term><option>--insecure</option></term>
|
||
|
|
<listitem>
|
||
|
|
<para>disable app sandboxing</para>
|
||
|
|
</listitem>
|
||
|
|
</varlistentry>
|
||
|
|
|
||
|
|
<varlistentry>
|
||
|
|
<term><option>--launched_by_manager</option></term>
|
||
|
|
<listitem>
|
||
|
|
<para>core client was launched by Manager</para>
|
||
|
|
</listitem>
|
||
|
|
</varlistentry>
|
||
|
|
|
||
|
|
<varlistentry>
|
||
|
|
<term><option>--run_by_updater</option></term>
|
||
|
|
<listitem>
|
||
|
|
<para>set by updater</para>
|
||
|
|
</listitem>
|
||
|
|
</varlistentry>
|
||
|
|
</variablelist>
|
||
|
|
</refsect1>
|
||
|
|
|
||
|
|
<refsect1>
|
||
|
|
<title>Access control for GUI RPC</title>
|
||
|
|
<para>By default the core client accepts GUI RPC connections only from
|
||
|
|
programs on the same host, which means that any user on this host can
|
||
|
|
control the core client.</para>
|
||
|
|
</refsect1>
|
||
|
|
|
||
|
|
<refsect1>
|
||
|
|
<title>SEE ALSO</title>
|
||
|
|
<para><ulink url="http://boinc.berkeley.edu/trac/wiki/UnixClient"/></para>
|
||
|
|
</refsect1>
|
||
|
|
|
||
|
|
<refsect1>
|
||
|
|
<title>COPYRIGHT</title>
|
||
|
|
<para>Copyright © 2007 University of California. Permission is granted to
|
||
|
|
copy, distribute and/or modify this document under the terms of the
|
||
|
|
&gnu; Free Documentation License, Version 1.2 or any later version
|
||
|
|
published by the Free Software Foundation; with no Invariant Sections,
|
||
|
|
no Front-Cover Texts, and no Back-Cover Texts.</para>
|
||
|
|
</refsect1>
|
||
|
|
</refentry>
|