boinc/doc/manpages/boincmgr.xml

<?xml version="1.0" encoding="UTF-8"?>

<!--
 This is the manual page for the BOINC manager (boincmgr), a monitor
 and control utility for the client.

 Copyright © 2007-2020 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.4//EN"
"file:///usr/share/xml/docbook/schema/dtd/4.4/docbookx.dtd" [

  <!ENTITY % COMMON SYSTEM "common.ent">
  %COMMON;

  <!ENTITY date "<date>03 February 2020</date>">
]>

<refentry>
  <refentryinfo>
    <authorgroup>
      <author>
        <firstname>Christian</firstname>
        <lastname>Beer</lastname>
        <email>djangofett@gmx.net</email>
      </author>
      <author>
        <firstname>Frank</firstname>
        <lastname>Thomas</lastname>
        <email>frank@thomas-alfeld.de</email>
      </author>
    </authorgroup>
    <copyright>
      <year>2007</year>
      <year>2020</year>
      <holder>University of California</holder>
    </copyright>
    &date;
  </refentryinfo>

  <refmeta>
    <refentrytitle>&boincmgr;</refentrytitle>
    <manvolnum>1</manvolnum>
  </refmeta>

  <refnamediv>
    <refname>&boincmgr;</refname>
    <refpurpose>The graphical BOINC manager for the client.</refpurpose>
  </refnamediv>

  <refsynopsisdiv>
    <cmdsynopsis>
      &cmd_boincmgr;
      <arg><option>--verbose</option></arg>
      <arg><option>-a</option></arg>
      <arg><option>-e</option> <replaceable>client_dir</replaceable></arg>
      <arg><option>-d</option> <replaceable>data_dir</replaceable></arg>
      <arg><option>-n</option> <replaceable>hostname</replaceable></arg>
      <arg><option>-g</option> <replaceable>port</replaceable></arg>
      <arg><option>-p</option> <replaceable>passwd</replaceable></arg>
      <arg><option>-b</option> <replaceable>BOINC_ARGS</replaceable></arg>
      <arg><option>-i</option></arg>
      <arg><option>-c</option></arg>
      <arg><option>-m</option></arg>
    </cmdsynopsis>
    <cmdsynopsis>
      &cmd_boincmgr;
      <group>
        <arg><option>-h</option></arg>
        <arg><option>--help</option></arg>
      </group>
    </cmdsynopsis>
  </refsynopsisdiv>

  <refsect1>
    <title>DESCRIPTION</title>
    <para>The BOINC manager (&cmd_boincmgr;) is a graphical controlling and monitoring
      utility for the BOINC client (&man_boinc;). It communicates with a running
      client using port &rpc_port; over TCP/IP. It can only connect to one client at a time.
    </para>
  </refsect1>

  <refsect1>
    <title>OPTIONS</title>
    <para></para>

    <variablelist>
      <varlistentry>
        <term><option>-h</option>, <option>--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>-a</option>, <option>--autostart</option></term>
        <listitem>
          <para>Tells the BOINC Manager that it was started by the operating system
                automatically. Use this if the Manager is started at login time.
          </para>
        </listitem>
      </varlistentry>

      <varlistentry>
        <term>
          <option>-e</option> <replaceable>client_dir</replaceable>,
          <option>--clientdir=</option><replaceable>client_dir</replaceable>
        </term>
        <listitem>
            <para>Directory containing the <filename>locale</filename> directory
            containing the Manager localisation files.
            </para>
        </listitem>
      </varlistentry>

      <varlistentry>
        <term>
          <option>-d</option> <replaceable>data_dir</replaceable>,
          <option>--datadir=</option><replaceable>data_dir</replaceable>
        </term>
        <listitem>
          <para>Directory containing the configuration files .
          </para>
        </listitem>
      </varlistentry>

      <varlistentry>
        <term>
          <option>-n</option> <replaceable>hostname</replaceable>,
          <option>--namehost=</option><replaceable>hostname</replaceable>
        </term>
        <listitem>
          <para>Hostname or IP address of client to which the manager should connect to.</para>
        </listitem>
      </varlistentry>

      <varlistentry>
        <term>
          <option>-g</option> <replaceable>port</replaceable>,
          <option>--gui_rpc_port=</option><replaceable>port</replaceable>
        </term>
        <listitem>
          <para>RPC port number used to communicate with the client. Has to be the same value as on the client (see &man_boinc;).</para>
        </listitem>
      </varlistentry>

      <varlistentry>
        <term>
          <option>-p</option> <replaceable>passwd</replaceable>,
          <option>--password=</option><replaceable>passwd</replaceable>
        </term>
        <listitem>
          <para>Use <replaceable>passwd</replaceable> as password for RPC
            authentication. If the current working directory contains a file
            <filename>gui_rpc_auth.cfg</filename>, &cmd_boincmgr; will read
            the password from this file.</para>
        </listitem>
      </varlistentry>

      <varlistentry>
        <term>
          <option>-b</option> <replaceable>BOINC_ARGS</replaceable>,
          <option>--boincargs=</option><replaceable>BOINC_ARGS</replaceable>
        </term>
        <listitem>
          <para>Startup the BOINC client with these optional arguments if necessary.</para>
        </listitem>
      </varlistentry>

      <varlistentry>
        <term><option>-i</option>, <option>--insecure</option></term>
        <listitem>
          <para>Disable BOINC security users and permissions.</para>
        </listitem>
      </varlistentry>

      <varlistentry>
        <term><option>-c</option>, <option>--checkskins</option></term>
        <listitem>
          <para>Set skin debugging mode to enable skin manager error messages.</para>
        </listitem>
      </varlistentry>

      <varlistentry>
        <term><option>-m</option>, <option>--multiple</option></term>
        <listitem>
          <para>Allow multiple instances of BOINC manager on this host.</para>
        </listitem>
      </varlistentry>
    </variablelist>
  </refsect1>

  <refsect1>
    <title>SEE ALSO</title>
    <para>&man_boinc;, &man_boinccmd;</para>
    <para>
      <ulink url="https://boinc.berkeley.edu/wiki/The_BOINC_Manager"/>
    </para>
  </refsect1>

  <refsect1>
    <title>COPYRIGHT</title>
    <para>Copyright © 2007-2020 University of California.</para>
    <para>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>