Commit b664b1a9 authored by Frank Thomas's avatar Frank Thomas

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
parent bb5f54d3
......@@ -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
......@@ -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])
......
## -*- 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)
<?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>
This diff is collapsed.
<?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>
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment