mirror of https://github.com/BOINC/boinc.git
Added manpages in DocBook/XML source format and integrated them in the
autotools build process. They are compiled into troff format using docbook2x-man if it is available on the build system. For more information, see these posts to the boinc_dev mailing list: http://lists.ssl.berkeley.edu/pipermail/boinc_dev/2007-September/008907.html http://lists.ssl.berkeley.edu/pipermail/boinc_dev/2007-October/008930.html svn path=/trunk/boinc/; revision=13787
This commit is contained in:
Frank Thomas
parent
bb5f54d31f
commit
b664b1a930
|
|
@ -22,7 +22,7 @@ endif
|
|||
|
||||
# ORDER MATTERS below. One must build dependencies FIRST, then things
|
||||
# that depend on them later
|
||||
SUBDIRS = m4 $(API_SUBDIRS) $(SERVER_SUBDIRS) $(CLIENT_SUBDIRS) $(CLIENTGUI_SUBDIRS)
|
||||
SUBDIRS = m4 $(API_SUBDIRS) $(SERVER_SUBDIRS) $(CLIENT_SUBDIRS) $(CLIENTGUI_SUBDIRS) doc/manpages
|
||||
|
||||
# Putting a directory name recursively copies the entire contents - the
|
||||
# dist-hook below gets rid of CVS directories.
|
||||
|
|
|
|||
|
|
@ -9252,3 +9252,18 @@ David 5 Oct 2007
|
|||
feeder.C
|
||||
hr_info.C
|
||||
sched_send.C
|
||||
|
||||
Frank Thomas 7 Oct 2007
|
||||
- Added manpages in DocBook/XML source format and integrated them in the
|
||||
autotools build process. They are compiled into troff format using
|
||||
docbook2x-man if it is available on the build system.
|
||||
|
||||
configure.ac
|
||||
Makefile.am
|
||||
doc/
|
||||
manpages/
|
||||
Makefile.am
|
||||
boincmgr.xml
|
||||
boinc_client.xml
|
||||
boinc_cmd.xml
|
||||
|
||||
|
|
|
|||
13
configure.ac
13
configure.ac
|
|
@ -145,6 +145,12 @@ AC_PROG_RANLIB
|
|||
SAH_LINKS
|
||||
AM_PROG_CC_C_O
|
||||
|
||||
dnl Check for docbook2x-man, which we use to create the manpages in
|
||||
dnl doc/manpages, and set the conditional HAVE_DOCBOOK2X_MAN to build
|
||||
dnl the manpages only if docbook2x-man is available.
|
||||
AC_PATH_PROG(DOCBOOK2X_MAN, docbook2x-man)
|
||||
AM_CONDITIONAL(HAVE_DOCBOOK2X_MAN, [test -n "${DOCBOOK2X_MAN}"])
|
||||
|
||||
AC_SUBST([CLIENT_BIN_FILENAME],[boinc${EXEEXT}])
|
||||
AC_SUBST([CLIENT_CMD_BIN_FILENAME],[boinccmd${EXEEXT}])
|
||||
AC_SUBST([CLIENT_GUI_BIN_FILENAME],[boincmgr${EXEEXT}])
|
||||
|
|
@ -668,6 +674,7 @@ AC_CONFIG_FILES([
|
|||
client/Makefile
|
||||
client/win/boinc_path_config.py:py/Boinc/boinc_path_config.py.in
|
||||
db/Makefile
|
||||
doc/manpages/Makefile
|
||||
lib/Makefile
|
||||
Makefile
|
||||
py/Boinc/boinc_path_config.py:py/Boinc/boinc_path_config.py.in
|
||||
|
|
@ -684,9 +691,9 @@ AC_CONFIG_FILES([
|
|||
tools/boinc_path_config.py:py/Boinc/boinc_path_config.py.in
|
||||
tools/Makefile
|
||||
zip/Makefile
|
||||
zip/zip/Makefile
|
||||
zip/unzip/Makefile
|
||||
m4/Makefile
|
||||
zip/zip/Makefile
|
||||
zip/unzip/Makefile
|
||||
m4/Makefile
|
||||
])
|
||||
|
||||
dnl AC_CONFIG_HEADER([config.h])
|
||||
|
|
|
|||
|
|
@ -0,0 +1,20 @@
|
|||
## -*- mode: make; tab-width: 4 -*-
|
||||
## $Id$
|
||||
|
||||
include $(top_srcdir)/Makefile.incl
|
||||
|
||||
if HAVE_DOCBOOK2X_MAN
|
||||
man_MANS = \
|
||||
boinc_client.1 \
|
||||
boinc_cmd.1 \
|
||||
boincmgr.1
|
||||
else
|
||||
man_MANS =
|
||||
endif
|
||||
|
||||
%.1: %.xml
|
||||
$(DOCBOOK2X_MAN) $<
|
||||
|
||||
all-local: $(man_MANS)
|
||||
|
||||
CLEANFILES = $(man_MANS)
|
||||
|
|
@ -0,0 +1,264 @@
|
|||
<?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>
|
||||
|
|
@ -0,0 +1,514 @@
|
|||
<?xml version="1.0" encoding="UTF-8" ?>
|
||||
|
||||
<!--
|
||||
This is the manual page for boinc_cmd, a command tool that provides an
|
||||
interactive command-line interface for the core 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_cmd">
|
||||
<!ENTITY dhdate "<date>October 06, 2007</date>">
|
||||
<!ENTITY gnu "<acronym>GNU</acronym>">
|
||||
]>
|
||||
|
||||
<refentry>
|
||||
<refentryinfo>
|
||||
<authorgroup>
|
||||
<author>
|
||||
<firstname>Frank</firstname>
|
||||
<lastname>Thomas</lastname>
|
||||
<email>frank@thomas-alfeld.de</email>
|
||||
</author>
|
||||
|
||||
<author>
|
||||
<firstname>Peter</firstname>
|
||||
<lastname>Bailis</lastname>
|
||||
<email>pbailis@gmail.com</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>command line interface to the BOINC core client</refpurpose>
|
||||
</refnamediv>
|
||||
|
||||
<refsynopsisdiv>
|
||||
<cmdsynopsis>
|
||||
<command>&dhbinary;</command>
|
||||
<arg>--host <replaceable>hostname</replaceable><arg
|
||||
>:<replaceable>port</replaceable></arg></arg>
|
||||
<arg>--passwd <replaceable>passwd</replaceable></arg>
|
||||
<arg choice="plain"><replaceable>command</replaceable></arg>
|
||||
</cmdsynopsis>
|
||||
<cmdsynopsis>
|
||||
<command>&dhbinary;</command>
|
||||
<arg>-hV</arg>
|
||||
</cmdsynopsis>
|
||||
<para>Notice that the order of the options is important. The --host and
|
||||
--passwd options must precede any command.</para>
|
||||
</refsynopsisdiv>
|
||||
|
||||
<refsect1>
|
||||
<title>DESCRIPTION</title>
|
||||
<para>The BOINC command tool (<command>boinc_cmd</command>) provides
|
||||
a command line interface to a running BOINC core client.</para>
|
||||
</refsect1>
|
||||
|
||||
<refsect1>
|
||||
<title>OPTIONS</title>
|
||||
<para></para>
|
||||
|
||||
<variablelist>
|
||||
<varlistentry>
|
||||
<term>
|
||||
<option>--host <replaceable>hostname</replaceable><optional
|
||||
>:<replaceable>port</replaceable></optional></option>
|
||||
</term>
|
||||
<listitem>
|
||||
<para>Connect to the host <replaceable>hostname</replaceable>.
|
||||
The default host is localhost.</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
|
||||
<varlistentry>
|
||||
<term>
|
||||
<option>--passwd <replaceable>passwd</replaceable></option>
|
||||
</term>
|
||||
<listitem>
|
||||
<para>Use <replaceable>passwd</replaceable> as password for RPC
|
||||
authentication. If the current working directory contains a file
|
||||
'gui_rpc_auth.cfg', <command>boinc_cmd</command> will read the
|
||||
password from this file.</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
|
||||
<varlistentry>
|
||||
<term><option>-h, --help</option></term>
|
||||
<listitem>
|
||||
<para>Show a help message and all commands.</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
|
||||
<varlistentry>
|
||||
<term><option>-V, --version</option></term>
|
||||
<listitem>
|
||||
<para>Show the version of the program.</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
</variablelist>
|
||||
</refsect1>
|
||||
|
||||
<refsect1>
|
||||
<title>COMMANDS</title>
|
||||
<para></para>
|
||||
|
||||
<variablelist>
|
||||
<varlistentry>
|
||||
<term><option>--get_state</option></term>
|
||||
<listitem>
|
||||
<para>Show entire core client state.</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
|
||||
<varlistentry>
|
||||
<term><option>--get_results</option></term>
|
||||
<listitem>
|
||||
<para>Show all results.</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
|
||||
<varlistentry>
|
||||
<term><option>--get_file_transfers</option></term>
|
||||
<listitem>
|
||||
<para>Show all current file transfers.</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
|
||||
<varlistentry>
|
||||
<term><option>--get_project_status</option></term>
|
||||
<listitem>
|
||||
<para>Show status of all projects.</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
|
||||
<varlistentry>
|
||||
<term><option>--get_disk_usage</option></term>
|
||||
<listitem>
|
||||
<para>Show disk usage of all projects.</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
|
||||
<varlistentry>
|
||||
<term>
|
||||
<option>--result
|
||||
<replaceable>url</replaceable>
|
||||
<replaceable>result_name</replaceable>
|
||||
{suspend | resume | abort | graphics_window | graphics_fullscreen}
|
||||
{--window_station ws} {--desktop dt} {--display dp}
|
||||
</option>
|
||||
</term>
|
||||
<listitem>
|
||||
<para>Do operation on a result.</para>
|
||||
|
||||
<variablelist>
|
||||
<varlistentry>
|
||||
<term><option>suspend</option></term>
|
||||
<listitem>
|
||||
<para>Temporarily stop work on a result.</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
|
||||
<varlistentry>
|
||||
<term><option>resume</option></term>
|
||||
<listitem>
|
||||
<para>Allow work on a result.</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
|
||||
<varlistentry>
|
||||
<term><option>abort</option></term>
|
||||
<listitem>
|
||||
<para>Permanently stop work on result.</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
|
||||
<varlistentry>
|
||||
<term><option>graphics_window</option></term>
|
||||
<listitem>
|
||||
<para>Open graphics in a window. The optional desktop /
|
||||
window_station (Windows) or display (X11) arguments
|
||||
specify the display.</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
|
||||
<varlistentry>
|
||||
<term><option>graphics_fullscreen</option></term>
|
||||
<listitem>
|
||||
<para>Open graphics fullscreen.</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
</variablelist>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
|
||||
<varlistentry>
|
||||
<term>
|
||||
<option>--project
|
||||
<replaceable>url</replaceable>
|
||||
{reset | detach | update | suspend | resume | nomorework
|
||||
| allowmorework}
|
||||
</option>
|
||||
</term>
|
||||
<listitem>
|
||||
<para>Do operation on a project.</para>
|
||||
|
||||
<variablelist>
|
||||
<varlistentry>
|
||||
<term><option>reset</option></term>
|
||||
<listitem>
|
||||
<para>Delete current work and get more.</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
|
||||
<varlistentry>
|
||||
<term><option>detach</option></term>
|
||||
<listitem>
|
||||
<para>Delete current work and don't get more.</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
|
||||
<varlistentry>
|
||||
<term><option>update</option></term>
|
||||
<listitem>
|
||||
<para>Contact scheduling server.</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
|
||||
<varlistentry>
|
||||
<term><option>suspend</option></term>
|
||||
<listitem>
|
||||
<para>Stop work for project.</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
|
||||
<varlistentry>
|
||||
<term><option>resume</option></term>
|
||||
<listitem>
|
||||
<para>Resume work for project.</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
|
||||
<varlistentry>
|
||||
<term><option>nomorework</option></term>
|
||||
<listitem>
|
||||
<para>Finish current work but don't get more.</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
|
||||
<varlistentry>
|
||||
<term><option>allowmorework</option></term>
|
||||
<listitem>
|
||||
<para>Undo <option>nomorework</option>.</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
</variablelist>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
|
||||
<varlistentry>
|
||||
<term>
|
||||
<option>--project_attach
|
||||
<replaceable>url</replaceable>
|
||||
<replaceable>auth</replaceable>
|
||||
</option>
|
||||
</term>
|
||||
<listitem>
|
||||
<para>Attach to an account via <replaceable>auth</replaceable>, the
|
||||
authorization key from the project.</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
|
||||
<varlistentry>
|
||||
<term>
|
||||
<option>--file_transfer
|
||||
<replaceable>url</replaceable>
|
||||
<replaceable>filename</replaceable>
|
||||
{retry | abort}
|
||||
</option>
|
||||
</term>
|
||||
</varlistentry>
|
||||
|
||||
<varlistentry>
|
||||
<term>
|
||||
<option>--set_run_mode {always | auto | never}
|
||||
[<replaceable>duration</replaceable>]
|
||||
</option>
|
||||
</term>
|
||||
<listitem>
|
||||
<para>Set run mode.</para>
|
||||
|
||||
<variablelist>
|
||||
<varlistentry>
|
||||
<term><option>always</option></term>
|
||||
<listitem>
|
||||
<para>Do work (network + CPU) always.</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
|
||||
<varlistentry>
|
||||
<term><option>auto</option></term>
|
||||
<listitem>
|
||||
<para>Do work only when allowed by preferences.</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
|
||||
<varlistentry>
|
||||
<term><option>never</option></term>
|
||||
<listitem>
|
||||
<para>Don't do work (same as suspending all projects).</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
</variablelist>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
|
||||
<varlistentry>
|
||||
<term>
|
||||
<option>--set_network_mode {always | auto | never}
|
||||
[<replaceable>duration</replaceable>]
|
||||
</option>
|
||||
</term>
|
||||
<listitem>
|
||||
<para>Set network mode. Like <option>--set_run_mode</option> but
|
||||
applies only to network transfers.</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
|
||||
<varlistentry>
|
||||
<term>
|
||||
<option>--get_proxy_settings</option>
|
||||
</term>
|
||||
</varlistentry>
|
||||
|
||||
<varlistentry>
|
||||
<term>
|
||||
<option>--set_proxy_settings
|
||||
<replaceable>http_server_name</replaceable>
|
||||
<replaceable>http_server_port</replaceable>
|
||||
<replaceable>http_user_name</replaceable>
|
||||
<replaceable>http_user_passwd</replaceable>
|
||||
<replaceable>socks_server_name</replaceable>
|
||||
<replaceable>socks_server_port</replaceable>
|
||||
<replaceable>socks_version</replaceable>
|
||||
<replaceable>socks5_user_name</replaceable>
|
||||
<replaceable>socks5_user_passwd</replaceable>
|
||||
</option>
|
||||
</term>
|
||||
<listitem>
|
||||
<para>Set proxy settings. All fields are mandantory.</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
|
||||
<varlistentry>
|
||||
<term>
|
||||
<option>--get_messages <replaceable>seqno</replaceable></option>
|
||||
</term>
|
||||
<listitem>
|
||||
<para>Show messages with sequence numbers beyond
|
||||
<replaceable>seqno</replaceable>.</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
|
||||
<varlistentry>
|
||||
<term><option>--get_host_info</option></term>
|
||||
<listitem>
|
||||
<para>Show system information about the host where the BOINC core
|
||||
client is running.</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
|
||||
<varlistentry>
|
||||
<term>
|
||||
<option>--acct_mgr_rpc
|
||||
<replaceable>url</replaceable>
|
||||
<replaceable>name</replaceable>
|
||||
<replaceable>password</replaceable>
|
||||
</option>
|
||||
</term>
|
||||
<listitem>
|
||||
<para>Instruct core client to contact an account manager
|
||||
server.</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
|
||||
<varlistentry>
|
||||
<term><option>--run_benchmarks</option></term>
|
||||
<listitem>
|
||||
<para>Run CPU benchmarks.</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
|
||||
<varlistentry>
|
||||
<term><option>--get_screensaver_mode</option></term>
|
||||
</varlistentry>
|
||||
|
||||
<varlistentry>
|
||||
<term>
|
||||
<option>--set_screensaver_mode {on | off}
|
||||
<replaceable>blank_time</replaceable>
|
||||
{--desktop desktop} {--window_station window_station}
|
||||
{--display display}
|
||||
</option>
|
||||
</term>
|
||||
<listitem>
|
||||
<para>Tell the core client to start or stop doing fullscreen
|
||||
graphics, and going to black after
|
||||
<replaceable>blank_time</replaceable> seconds. The optional
|
||||
arguments specify which desktop / windows_station (Windows) or
|
||||
display (X11) to use.</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
|
||||
<varlistentry>
|
||||
<term>
|
||||
<option>--get_project_config
|
||||
<replaceable>url</replaceable>
|
||||
</option>
|
||||
</term>
|
||||
<listitem>
|
||||
<para>Fetch configuration at project located at
|
||||
<replaceable>url</replaceable>.</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
|
||||
<varlistentry>
|
||||
<term><option>--get_project_config_poll</option></term>
|
||||
</varlistentry>
|
||||
|
||||
<varlistentry>
|
||||
<term>
|
||||
<option>--lookup_account
|
||||
<replaceable>url</replaceable>
|
||||
<replaceable>email</replaceable>
|
||||
<replaceable>passwd</replaceable>
|
||||
</option>
|
||||
</term>
|
||||
</varlistentry>
|
||||
|
||||
<varlistentry>
|
||||
<term>
|
||||
<option>--create_account
|
||||
<replaceable>url</replaceable>
|
||||
<replaceable>email</replaceable>
|
||||
<replaceable>passwd</replaceable>
|
||||
<replaceable>name</replaceable>
|
||||
</option>
|
||||
</term>
|
||||
</varlistentry>
|
||||
|
||||
<varlistentry>
|
||||
<term><option>--read_global_prefs_override</option></term>
|
||||
<listitem>
|
||||
<para>Tell the core client to read the global_prefs_override.xml file
|
||||
and incorporate any global preferences indicated there.</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
|
||||
<varlistentry>
|
||||
<term><option>--read_cc_config</option></term>
|
||||
<listitem>
|
||||
<para>Reread the configuration file (cc_config.xml).</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
|
||||
<varlistentry>
|
||||
<term><option>--network_available</option></term>
|
||||
</varlistentry>
|
||||
|
||||
<varlistentry>
|
||||
<term><option>--get_cc_status</option></term>
|
||||
</varlistentry>
|
||||
|
||||
<varlistentry>
|
||||
<term><option>--quit</option></term>
|
||||
<listitem>
|
||||
<para>Stop the running BOINC core client.</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
</variablelist>
|
||||
</refsect1>
|
||||
|
||||
<refsect1>
|
||||
<title>SEE ALSO</title>
|
||||
<para><ulink url="http://boinc.berkeley.edu/trac/wiki/BoincCmd"/></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>
|
||||
|
|
@ -0,0 +1,117 @@
|
|||
<?xml version="1.0" encoding="UTF-8" ?>
|
||||
|
||||
<!--
|
||||
This is the manual page for the BOINC manager (boincmgr), a monitor
|
||||
and control utility for the core 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 "boincmgr">
|
||||
<!ENTITY dhdate "<date>October 06, 2007</date>">
|
||||
<!ENTITY gnu "<acronym>GNU</acronym>">
|
||||
]>
|
||||
|
||||
<refentry>
|
||||
<refentryinfo>
|
||||
<author>
|
||||
<firstname>Frank</firstname>
|
||||
<lastname>Thomas</lastname>
|
||||
<email>frank@thomas-alfeld.de</email>
|
||||
</author>
|
||||
<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 graphical BOINC manager for the core client.</refpurpose>
|
||||
</refnamediv>
|
||||
|
||||
<refsynopsisdiv>
|
||||
<cmdsynopsis>
|
||||
<command>&dhbinary;</command>
|
||||
</cmdsynopsis>
|
||||
</refsynopsisdiv>
|
||||
|
||||
<refsect1>
|
||||
<title>DESCRIPTION</title>
|
||||
<para>The BOINC manager (<command>&dhbinary;</command>) is a controling
|
||||
and monitoring utility for the BOINC core client.</para>
|
||||
</refsect1>
|
||||
|
||||
<refsect1>
|
||||
<title>OPTIONS</title>
|
||||
<para>A full summary of options is included below.</para>
|
||||
|
||||
<variablelist>
|
||||
<varlistentry>
|
||||
<term><option>-h, --help</option></term>
|
||||
<listitem>
|
||||
<para>Show all options.</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
|
||||
<varlistentry>
|
||||
<term><option>--verbose</option></term>
|
||||
<listitem>
|
||||
<para>Generate verbose log messages.</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
|
||||
<varlistentry>
|
||||
<term><option>-s, --systray</option></term>
|
||||
<listitem>
|
||||
<para>Startup BOINC Manager so only the system tray icon is
|
||||
visible.</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
|
||||
<varlistentry>
|
||||
<term><option>-b, --boincargs</option></term>
|
||||
<listitem>
|
||||
<para>Startup BOINC with these optional arguments.</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
|
||||
<varlistentry>
|
||||
<term><option>-i, --insecure</option></term>
|
||||
<listitem>
|
||||
<para>Disable BOINC security users and permissions.</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
</variablelist>
|
||||
</refsect1>
|
||||
|
||||
<refsect1>
|
||||
<title>SEE ALSO</title>
|
||||
<para>
|
||||
<ulink url="http://boinc.berkeley.edu/trac/wiki/ManagerAdvanced"/>
|
||||
</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>
|
||||
Loading…
Reference in New Issue