Ticket #1229: manpages.diff

File manpages.diff, 47.3 KB (added by Christian Beer, 11 years ago)

  • client/boinc_cmd.cpp 

    diff --git a/client/boinc_cmd.cpp b/client/boinc_cmd.cpp
index e16d2a5..a56186d 100644
    a b Commands:\n\ 
    7777 --lookup_account URL email passwd\n\
    7878 --network_available                retry deferred network communication\n\
    7979 --project URL op                   project operation\n\
    80    op = reset | detach | update | suspend | resume | nomorework | allowmorework\n\
     80   op = reset | detach | update | suspend | resume | nomorework | allowmorework | detach_when_done | dont_detach_when_done\n\
    8181 --project_attach URL auth          attach to project\n\
    8282 --quit                             tell client to exit\n\
    8383 --quit_acct_mgr                    quit current account manager\n\
    … … Commands:\n\ 
    8787 --set_debts URL1 std1 ltd1 [URL2 std2 ltd2 ...]\n\
    8888 --set_gpu_mode mode duration       set GPU run mode for given duration\n\
    8989   mode = always | auto | never\n\
    90  --set_network_mode mode duration\n\
     90 --set_network_mode mode duration   set network mode for given duration\n\
     91   mode = always | auto | never\n\
    9192 --set_proxy_settings\n\
    9293 --set_run_mode mode duration       set run mode for given duration\n\
    9394   mode = always | auto | never\n\

  • client/cs_cmdline.cpp 

    diff --git a/client/cs_cmdline.cpp b/client/cs_cmdline.cpp
index ce169fe..657bec4 100644
    a b static void print_options(char* prog) { 
    7070#ifdef SANDBOX
    7171        "    --insecure                     disable app sandboxing (Unix)\n"
    7272#endif
     73#ifdef __APPLE__
    7374        "    --launched_by_manager          client was launched by Manager\n"
     75#endif
    7476        "    --master_fetch_interval N      limiting period of master retry\n"
    7577        "    --master_fetch_period N        reload master URL after N RPC failures\n"
    7678        "    --master_fetch_retry_cap N     exponential backoff limit\n"
    … … static void print_options(char* prog) { 
    8688        "    --retry_cap N                  exponential backoff limit\n"
    8789        "    --run_cpu_benchmarks           run the CPU benchmarks\n"
    8890        "    --run_by_updater               set by updater\n"
     91#ifdef __APPLE__
    8992        "    --saver                        client was launched by screensaver\n"
     93#endif
    9094        "    --sched_retry_delay_max N      max for RPC exponential backoff\n"
    9195        "    --sched_retry_delay_min N      min for RPC exponential backoff\n"
    9296        "    --show_projects                show attached projects\n"

  • client/scripts/boinc.bash 

    diff --git a/client/scripts/boinc.bash b/client/scripts/boinc.bash
index f52e345..2fefa37 100644
    a b _boinc() 
    1515    # Handle options that require one or more arguments.
    1616    case "$prev" in
    1717        --attach_project|--detach_project|--reset_project|--update_prefs|\
    18         --gui_rpc_port)
     18        --gui_rpc_port|--start_delay|--dir)
    1919            return 0
    2020        ;;
    2121    esac
    … … _boinccmd() 
    7474
    7575    # Handle options/commands that require one or more arguments.
    7676    case "$prev" in
    77         --get_messages|--passwd)
     77        --get_messages|--passwd|--get_notices)
    7878            return 0
    7979        ;;
    8080
    … … _boinccmd() 
    8383            return 0
    8484        ;;
    8585
    86         --set_run_mode|--set_network_mode)
     86        --set_run_mode|--set_network_mode|--set_gpu_mode)
    8787            COMPREPLY=( $(compgen -W "always auto never" -- "$cur") )
    8888            return 0
    8989        ;;
    90 
    91         --set_screensaver_mode)
    92             COMPREPLY=( $(compgen -W "on off" -- "$cur") )
    93             return 0
    94         ;;
    9590    esac
    9691}
    9792complete -F _boinccmd boinccmd

  • doc/manpages/boinc.xml 

    diff --git a/doc/manpages/boinc.xml b/doc/manpages/boinc.xml
index 1b28dd3..175fb54 100644
    a b  
    11<?xml version="1.0" encoding="UTF-8"?>
    22
    33<!--
    4  This is the manual page for the BOINC core client (boinc).
     4 This is the manual page for the BOINC client (boinc).
    55
    6  Copyright © 2007-2008 University of California
     6 Copyright © 2007-2013 University of California
    77
    88 Permission is granted to copy, distribute and/or modify this document
    99 under the terms of the GNU Free Documentation License, Version 1.2 or
    … …  
    1717  <!ENTITY % COMMON SYSTEM "common.ent">
    1818  %COMMON;
    1919
    20   <!ENTITY date "<date>April 06, 2008</date>">
     20  <!ENTITY date "<date>04 March 2013</date>">
    2121]>
    2222
    2323<refentry>
    2424  <refentryinfo>
    2525    <authorgroup>
    2626      <author>
     27        <firstname>Christian</firstname>
     28        <lastname>Beer</lastname>
     29        <email>djangofett@gmx.net</email>
     30      </author>
     31      <author>
    2732        <firstname>Steffen</firstname>
    2833        <lastname>Moeller</lastname>
    2934        <email>steffen_moeller@gmx.de</email>
    … …  
    4146   </authorgroup>
    4247    <copyright>
    4348      <year>2007</year>
    44       <year>2008</year>
     49      <year>2013</year>
    4550      <holder>University of California</holder>
    4651    </copyright>
    4752    &date;
    … …  
    5459
    5560  <refnamediv>
    5661    <refname>&boinc;</refname>
    57     <refpurpose>The BOINC core client program.</refpurpose>
     62    <refpurpose>The BOINC client program.</refpurpose>
    5863  </refnamediv>
    5964
    6065  <refsynopsisdiv>
    … …  
    6671
    6772  <refsect1>
    6873    <title>DESCRIPTION</title>
    69     <para>The BOINC "core client", &cmd_boinc;, is the heart of BOINC.
     74    <para>The BOINC "client", &cmd_boinc;, is the heart of BOINC.
    7075      It controls which project applications are run on your computer,
    71       downloading "Workunits" and uploading the "Result" files from completed
     76      downloading "Tasks" and uploading the resulting files from completed
    7277      tasks. &cmd_boinc; is usually run in the background, ideally as a
    7378      daemon. It can then be controlled either by a graphical tool called the
    7479      BOINC Manager, &man_boincmgr;, or a command-line tool called
    75       &man_boinccmd;, by means of Remote Proceedure Calls (RPCs) over port
     80      &man_boinccmd;, by means of Remote Procedure Calls (RPCs) over port
    7681      &rpc_port;.</para>
    7782
    78     <para>The BOINC core client can be controlled by command-line options,
     83    <para>The BOINC client can be controlled by command-line options,
    7984      configuration files, and environment variables. Standard usage is simply
    8085      to start the client running in the background.</para>
    8186  </refsect1>
    … …  
    8590    <para>These command-line options for &cmd_boinc; can be used to control
    8691      how BOINC is started. Once the client has started, you should use a
    8792      separate program, (&man_boincmgr; or &man_boinccmd;) which communicates
    88       with it by means of Remote Proceedure Calls (RPCs).</para>
    89 
    90     <variablelist>
    91       <varlistentry>
    92         <term><option>--help</option></term>
    93         <listitem>
    94           <para>show options</para>
    95         </listitem>
    96       </varlistentry>
    97 
    98 
    99       <varlistentry>
    100         <term><option>--version</option></term>
    101         <listitem>
    102           <para>show version info</para>
    103         </listitem>
    104       </varlistentry>
    105 
    106       <varlistentry>
    107         <term><option>--exit_when_idle</option></term>
    108         <listitem>
    109           <para>exit when there are no results</para>
    110         </listitem>
    111       </varlistentry>
    112 
    113       <varlistentry>
    114         <term><option>--show_projects</option></term>
    115         <listitem>
    116           <para>show attached projects</para>
    117         </listitem>
    118       </varlistentry>
    119 
    120       <varlistentry>
    121         <term>
    122           <option>--detach_project <replaceable>URL</replaceable></option>
    123         </term>
    124         <listitem>
    125           <para>detach from a project</para>
    126         </listitem>
    127       </varlistentry>
    128 
    129       <varlistentry>
    130         <term>
    131           <option>--reset_project <replaceable>URL</replaceable></option>
    132         </term>
    133         <listitem>
    134           <para>reset (clear) a project</para>
    135         </listitem>
    136       </varlistentry>
    137 
    138       <varlistentry>
    139         <term>
    140           <option>--attach_project <replaceable>URL</replaceable>
    141             <replaceable>key</replaceable></option>
    142         </term>
    143         <listitem>
    144           <para>attach to a project</para>
    145         </listitem>
    146       </varlistentry>
    147 
    148       <varlistentry>
    149         <term>
    150           <option>--update_prefs <replaceable>URL</replaceable></option>
    151         </term>
    152         <listitem>
    153           <para>contact a project to update preferences</para>
    154         </listitem>
    155       </varlistentry>
    156 
    157       <varlistentry>
    158         <term><option>--run_cpu_benchmarks</option></term>
    159         <listitem>
    160           <para>run the CPU benchmarks</para>
    161         </listitem>
    162       </varlistentry>
    163 
    164       <varlistentry>
    165         <term><option>--check_all_logins</option></term>
    166         <listitem>
    167           <para>for idle detection, check remote logins too</para>
    168         </listitem>
    169       </varlistentry>
    170 
    171       <varlistentry>
    172         <term><option>--allow_remote_gui_rpc</option></term>
    173         <listitem>
    174           <para>allow remote GUI RPC connections</para>
    175         </listitem>
    176       </varlistentry>
    177 
    178       <varlistentry>
    179         <term>
    180           <option>--gui_rpc_port <replaceable>port</replaceable></option>
    181         </term>
    182         <listitem>
    183           <para>port for GUI RPCs</para>
    184         </listitem>
    185       </varlistentry>
    186 
    187       <varlistentry>
    188         <term><option>--redirectio</option></term>
    189         <listitem>
    190           <para>redirect stdout and stderr to log files</para>
    191         </listitem>
    192       </varlistentry>
    193 
    194       <varlistentry>
    195         <term><option>--dir <replaceable>path</replaceable></option></term>
    196         <listitem>
    197           <para>use given dir as BOINC home</para>
    198         </listitem>
    199       </varlistentry>
    200 
    201       <varlistentry>
    202         <term><option>--no_gui_rpc</option></term>
    203         <listitem>
    204           <para>Omits creation of a socket as required for the remote control
    205             of the client. Consequently the client cannot be controlled by
    206             external tools like GUIs (&cmd_boincmgr; etc.) or the console
    207             command tool (&cmd_boinccmd;).</para>
    208         </listitem>
    209       </varlistentry>
    210 
    211       <varlistentry>
    212         <term><option>--daemon</option></term>
    213         <listitem>
    214           <para>run as daemon</para>
    215         </listitem>
    216       </varlistentry>
    217 
    218       <varlistentry>
    219         <term><option>--exit_before_start</option></term>
    220         <listitem>
    221           <para>exit right before starting a job</para>
    222         </listitem>
    223       </varlistentry>
    224 
    225       <varlistentry>
    226         <term><option>--exit_after_finish</option></term>
    227         <listitem>
    228           <para>exit right after finishing a job</para>
    229         </listitem>
    230       </varlistentry>
    231 
    232       <varlistentry>
    233         <term><option>--insecure</option></term>
    234         <listitem>
    235           <para>disable app sandboxing</para>
    236         </listitem>
    237       </varlistentry>
    238 
    239       <varlistentry>
    240         <term><option>--launched_by_manager</option></term>
    241         <listitem>
    242           <para>core client was launched by Manager</para>
    243         </listitem>
    244       </varlistentry>
    245 
    246       <varlistentry>
    247         <term><option>--run_by_updater</option></term>
    248         <listitem>
    249           <para>set by updater</para>
    250         </listitem>
    251       </varlistentry>
    252     </variablelist>
     93      with it by means of Remote Procedure Calls (RPCs).</para>
     94
     95    <refsect2>
     96      <title>General options</title>
     97      <variablelist>
     98
     99        <varlistentry>
     100          <term><option>--help</option></term>
     101          <listitem>
     102           <para>Show options.</para>
     103          </listitem>
     104        </varlistentry>
     105
     106        <varlistentry>
     107          <term><option>--version</option></term>
     108          <listitem>
     109            <para>Show version info.</para>
     110          </listitem>
     111        </varlistentry>
     112
     113        <varlistentry>
     114          <term><option>--run_cpu_benchmarks</option></term>
     115          <listitem>
     116            <para>Run the CPU benchmarks.</para>
     117          </listitem>
     118        </varlistentry>
     119
     120        <varlistentry>
     121          <term><option>--check_all_logins</option></term>
     122          <listitem>
     123            <para>For idle detection, check remote logins too.</para>
     124          </listitem>
     125        </varlistentry>
     126
     127        <varlistentry>
     128          <term><option>--daemon</option></term>
     129          <listitem>
     130            <para>Run as daemon. Will redirect stderr and stdout to syslog.</para>
     131          </listitem>
     132        </varlistentry>
     133
     134        <varlistentry>
     135          <term><option>--dir <replaceable>path</replaceable></option></term>
     136          <listitem>
     137            <para>Use given dir as the client working directory.</para>
     138          </listitem>
     139        </varlistentry>
     140
     141        <varlistentry>
     142          <term><option>--no_gpus</option></term>
     143          <listitem>
     144            <para>Don't check for GPUs.</para>
     145          </listitem>
     146        </varlistentry>
     147
     148        <varlistentry>
     149          <term><option>--no_info_fetch</option></term>
     150          <listitem>
     151            <para>Don't fetch project list or client version info from
     152              boinc.berkeley.edu.</para>
     153          </listitem>
     154        </varlistentry>
     155
     156        <varlistentry>
     157          <term><option>--skip_cpu_benchmarks</option></term>
     158          <listitem>
     159            <para>Don't run CPU benchmarks.</para>
     160          </listitem>
     161        </varlistentry>
     162
     163        <varlistentry>
     164          <term>
     165            <option>--start_delay <replaceable>X</replaceable></option>
     166          </term>
     167          <listitem>
     168            <para>Delay starting apps for X secs.</para>
     169          </listitem>
     170        </varlistentry>
     171      </variablelist>
     172    </refsect2>
     173
     174    <refsect2>
     175      <title>Project options</title>
     176      <variablelist>
     177        <title>PROJECT CONTROL</title>
     178
     179        <varlistentry>
     180          <term>
     181            <option>--attach_project <replaceable>URL</replaceable>
     182              <replaceable>key</replaceable></option>
     183          </term>
     184          <listitem>
     185            <para>Attach to a project using URL and authenticator.</para>
     186          </listitem>
     187        </varlistentry>
     188
     189        <varlistentry>
     190          <term><option>--show_projects</option></term>
     191          <listitem>
     192            <para>Show attached projects.</para>
     193          </listitem>
     194        </varlistentry>
     195
     196        <varlistentry>
     197          <term>
     198            <option>--detach_project <replaceable>URL</replaceable></option>
     199          </term>
     200          <listitem>
     201            <para>Detach from project specified by URL.</para>
     202          </listitem>
     203        </varlistentry>
     204
     205        <varlistentry>
     206          <term>
     207            <option>--reset_project <replaceable>URL</replaceable></option>
     208          </term>
     209          <listitem>
     210            <para>Reset (clear) the projectspecified by URL.</para>
     211          </listitem>
     212        </varlistentry>
     213
     214        <varlistentry>
     215          <term>
     216            <option>--update_prefs <replaceable>URL</replaceable></option>
     217          </term>
     218          <listitem>
     219            <para>Contact the project specified by URL to update preferences</para>
     220          </listitem>
     221        </varlistentry>
     222      </variablelist>
     223    </refsect2>
     224
     225    <refsect2>
     226      <title>Communication options</title>
     227      <variablelist>
     228        <varlistentry>
     229          <term><option>--allow_remote_gui_rpc</option></term>
     230          <listitem>
     231            <para>Allow RPC connections from remote hosts.</para>
     232          </listitem>
     233        </varlistentry>
     234
     235        <varlistentry>
     236          <term>
     237            <option>--gui_rpc_port <replaceable>port</replaceable></option>
     238          </term>
     239          <listitem>
     240            <para>Port for RPCs.</para>
     241          </listitem>
     242        </varlistentry>
     243<!-- this option is for Apple only
     244        <varlistentry>
     245          <term><option>--launched_by_manager</option></term>
     246          <listitem>
     247            <para>Client was launched by Manager.</para>
     248          </listitem>
     249        </varlistentry>
     250-->
     251        <varlistentry>
     252          <term><option>--no_gui_rpc</option></term>
     253          <listitem>
     254            <para>Omits creation of a socket as required for the remote control
     255              of the client. Consequently the client cannot be controlled by
     256              external tools like GUIs (&cmd_boincmgr; etc.) or the console
     257              command tool (&cmd_boinccmd;).</para>
     258          </listitem>
     259        </varlistentry>
     260<!-- this option is for Apple only
     261        <varlistentry>
     262          <term><option>--saver</option></term>
     263          <listitem>
     264            <para>client was launched by screensaver</para>
     265          </listitem>
     266        </varlistentry>
     267-->
     268      </variablelist>
     269    </refsect2>
     270
     271    <refsect2>
     272      <title>Debugging options</title>
     273      <variablelist>
     274        <varlistentry>
     275          <term><option>--abort_jobs_on_exit</option></term>
     276          <listitem>
     277            <para>When client exits, abort and report tasks.</para>
     278          </listitem>
     279        </varlistentry>
     280
     281        <varlistentry>
     282          <term><option>--allow_multiple_clients</option></term>
     283          <listitem>
     284            <para>Allow more than one client instance per host.</para>
     285          </listitem>
     286        </varlistentry>
     287
     288        <varlistentry>
     289          <term>
     290            <option>--exit_after_app_start <replaceable>N</replaceable></option>
     291          </term>
     292          <listitem>
     293            <para>Exit N seconds after an app starts. Useful to look at the
     294              files in the slot directory.</para>
     295          </listitem>
     296        </varlistentry>
     297
     298        <varlistentry>
     299          <term><option>--exit_after_finish</option></term>
     300          <listitem>
     301            <para>Exit right after finishing a task. Useful to look at the
     302              files in the slot directory.</para>
     303          </listitem>
     304        </varlistentry>
     305
     306        <varlistentry>
     307          <term><option>--exit_before_start</option></term>
     308          <listitem>
     309            <para>Exit right before starting a task. Useful to look at the
     310                files in the slot directory.</para>
     311          </listitem>
     312        </varlistentry>
     313
     314        <varlistentry>
     315          <term><option>--exit_before_upload</option></term>
     316          <listitem>
     317            <para>Exit right before starting an upload.</para>
     318          </listitem>
     319        </varlistentry>
     320
     321        <varlistentry>
     322          <term><option>--exit_when_idle</option></term>
     323          <listitem>
     324            <para>Exit when there are no more tasks to work on.</para>
     325          </listitem>
     326        </varlistentry>
     327
     328        <varlistentry>
     329          <term><option>--fetch_minimal_work</option></term>
     330          <listitem>
     331            <para>Fetch only 1 task per device.</para>
     332          </listitem>
     333        </varlistentry>
     334
     335        <varlistentry>
     336          <term><option>--file_xfer_giveup_period <replaceable>N</replaceable></option></term>
     337          <listitem>
     338            <para>Give up on file transfers after N sec.</para>
     339          </listitem>
     340        </varlistentry>
     341
     342        <varlistentry>
     343          <term><option>--master_fetch_interval <replaceable>N</replaceable></option></term>
     344          <listitem>
     345            <para>Limiting the period of project master file dowload retries.</para>
     346          </listitem>
     347        </varlistentry>
     348
     349        <varlistentry>
     350          <term><option>--master_fetch_period <replaceable>N</replaceable></option></term>
     351          <listitem>
     352            <para>Reload a project's master file after N RPC failures.</para>
     353          </listitem>
     354        </varlistentry>
     355
     356        <varlistentry>
     357          <term><option>--master_fetch_retry_cap <replaceable>N</replaceable></option></term>
     358          <listitem>
     359            <para>Exponential backoff limit for downloading project master files.</para>
     360          </listitem>
     361        </varlistentry>
     362
     363        <varlistentry>
     364          <term><option>--no_priority_change</option></term>
     365          <listitem>
     366            <para>Run applications at same priority as client.</para>
     367          </listitem>
     368        </varlistentry>
     369
     370        <varlistentry>
     371          <term><option>--pers_giveup <replaceable>N</replaceable></option></term>
     372          <listitem>
     373            <para>Giveup time for persistent file transfer errors.</para>
     374          </listitem>
     375        </varlistentry>
     376
     377        <varlistentry>
     378          <term><option>--pers_retry_delay_max <replaceable>N</replaceable></option></term>
     379          <listitem>
     380            <para>Maximum time (sec) for file transfer exponential backoff.</para>
     381          </listitem>
     382        </varlistentry>
     383
     384        <varlistentry>
     385          <term><option>--pers_retry_delay_min <replaceable>N</replaceable></option></term>
     386          <listitem>
     387            <para>Minimum time (sec) for file transfer exponential backoff.</para>
     388          </listitem>
     389        </varlistentry>
     390
     391        <varlistentry>
     392          <term><option>--redirectio</option></term>
     393          <listitem>
     394              <para>Redirect stdout and stderr to log files
     395                (<filename>stdoutdae.txt</filename> and <filename>stderrdae.txt</filename>).
     396              </para>
     397          </listitem>
     398        </varlistentry>
     399
     400        <varlistentry>
     401          <term><option>--retry_cap <replaceable>N</replaceable></option></term>
     402          <listitem>
     403            <para>Limit the maximum exponential backoff time.</para>
     404          </listitem>
     405        </varlistentry>
     406
     407        <varlistentry>
     408          <term><option>--sched_retry_delay_max <replaceable>N</replaceable></option></term>
     409          <listitem>
     410            <para>Maximum time (sec) for project RPC exponential backoff.</para>
     411          </listitem>
     412        </varlistentry>
     413
     414        <varlistentry>
     415          <term><option>--sched_retry_delay_min <replaceable>N</replaceable></option></term>
     416          <listitem>
     417            <para>Minimum time (sec) for project RPC exponential backoff.</para>
     418          </listitem>
     419        </varlistentry>
     420
     421        <varlistentry>
     422          <term><option>--unsigned_apps_ok</option></term>
     423          <listitem>
     424            <para>Allow unsigned apps (for testing).</para>
     425          </listitem>
     426        </varlistentry>
     427      </variablelist>
     428    </refsect2>
    253429  </refsect1>
    254430
    255431  <refsect1>
    256432    <title>Access control for GUI RPC</title>
    257     <para>By default the core client accepts GUI RPC connections only from
     433    <para>By default the client accepts GUI RPC connections only from
    258434      programs on the same host, which means that any user on this host can
    259       control the core client.</para>
     435      control the client.</para>
    260436  </refsect1>
    261437
    262438  <refsect1>
    … …  
    264440    <para>&man_boinccmd;, &man_boincmgr;</para>
    265441    <para>
    266442      <ulink
    267         url="http://boinc.berkeley.edu/wiki/Client_configuration_(advanced)"/>
     443        url="http://boinc.berkeley.edu/wiki/Client_configuration#Command-line_options"/>
    268444    </para>
    269445  </refsect1>
    270446
    271447  <refsect1>
    272448    <title>COPYRIGHT</title>
    273     <para>Copyright © 2007-2008 University of California.</para>
     449    <para>Copyright © 2007-2013 University of California.</para>
    274450    <para>Permission is granted to copy, distribute and/or modify this
    275451      document under the terms of the &gnu; Free Documentation License,
    276452      Version 1.2 or any later version published by the Free Software

  • doc/manpages/boinccmd.xml 

    diff --git a/doc/manpages/boinccmd.xml b/doc/manpages/boinccmd.xml
index f5aac57..36a96c1 100644
    a b  
    22
    33<!--
    44 This is the manual page for boinccmd, a command tool that provides an
    5  interactive command-line interface for the core client.
     5 interactive command-line interface for the client.
    66
    7  Copyright © 2007-2008 University of California
     7 Copyright © 2007-2013 University of California
    88
    99 Permission is granted to copy, distribute and/or modify this document
    1010 under the terms of the GNU Free Documentation License, Version 1.2 or
    … …  
    1818  <!ENTITY % COMMON SYSTEM "common.ent">
    1919  %COMMON;
    2020
    21   <!ENTITY date "<date>11 January 2008</date>">
     21  <!ENTITY date "<date>04 March 2013</date>">
    2222]>
    2323
    2424<refentry>
    2525  <refentryinfo>
    2626    <authorgroup>
    2727      <author>
     28        <firstname>Christian</firstname>
     29        <lastname>Beer</lastname>
     30        <email>djangofett@gmx.net</email>
     31      </author>
     32      <author>
    2833        <firstname>Frank</firstname>
    2934        <lastname>Thomas</lastname>
    3035        <email>frank@thomas-alfeld.de</email>
    3136      </author>
    32 
    3337      <author>
    3438        <firstname>Peter</firstname>
    3539        <lastname>Bailis</lastname>
    … …  
    3842    </authorgroup>
    3943    <copyright>
    4044      <year>2007</year>
    41       <year>2008</year>
     45      <year>2013</year>
    4246      <holder>University of California</holder>
    4347    </copyright>
    4448    &date;
    … …  
    5054  </refmeta>
    5155
    5256  <refnamediv>
    53     <refname>&boinccmd;</refname> 
    54     <refpurpose>command line interface to the BOINC core client</refpurpose>
     57    <refname>&boinccmd;</refname>
     58    <refpurpose>The command line interface to the BOINC client.</refpurpose>
    5559  </refnamediv>
    5660
    5761  <refsynopsisdiv>
    … …  
    7680  <refsect1>
    7781    <title>DESCRIPTION</title>
    7882    <para>The BOINC command tool (&cmd_boinccmd;) provides a command line
    79       interface to a running BOINC core client (&man_boinc;).</para>
     83      interface to control a running BOINC client (&man_boinc;). It communicates
     84      with a running client using port &rpc_port; over TCP/IP. It can only
     85      connect to one client at a time.</para>
    8086  </refsect1>
    8187
    8288  <refsect1>
    … …  
    163169            <replaceable>account_key</replaceable>
    164170          </term>
    165171          <listitem>
    166             <para>Attach to an account.</para>
     172              <para>Attach to an account using the project URL and authenticator
     173                (send via email after <option>--create_account</option> was
     174                succesfull).</para>
    167175          </listitem>
    168176        </varlistentry>
    169177
    … …  
    175183            <replaceable>passwd</replaceable>
    176184          </term>
    177185          <listitem>
    178             <para>Attach to an account manager (or do RPC if already
    179               attached).</para>
     186            <para>Attach to an account manager (or do RPC if already attached).
     187              The account has to be created via the account manager website.
     188            </para>
    180189          </listitem>
    181190        </varlistentry>
    182191
    … …  
    201210        </varlistentry>
    202211
    203212        <varlistentry>
    204           <term><option>--get_results</option></term>
     213          <term><option>--get_cc_status</option></term>
     214              <listitem>
     215            <para>Show only current CPU, GPU and network modes.</para>
     216          </listitem>
     217        </varlistentry>
     218
     219        <varlistentry>
     220          <term><option>--get_tasks</option></term>
    205221          <listitem>
    206             <para>Show all results.</para>
     222            <para>Show all tasks of the client (in progress, waiting and
     223              completed only). Tasks that where reported to the project server
     224              are not shown here.</para>
    207225          </listitem>
    208226        </varlistentry>
    209227
    210228        <varlistentry>
    211229          <term><option>--get_simple_gui_info</option></term>
    212230          <listitem>
    213             <para>Show status of projects and active results.</para>
     231            <para>Show status of projects and active tasks.</para>
    214232          </listitem>
    215233        </varlistentry>
    216234
    … …  
    252270          </listitem>
    253271        </varlistentry>
    254272
     273        <varlistentry>
     274          <term>
     275            <option>--get_message_count</option>
     276          </term>
     277          <listitem>
     278            <para>Show largest message sequence number.</para>
     279          </listitem>
     280        </varlistentry>
     281
     282        <varlistentry>
     283          <term>
     284            <option>--get_notices</option> <replaceable>seqno</replaceable>
     285          </term>
     286          <listitem>
     287            <para>Show project notices with sequence numbers beyond
     288              <replaceable>seqno</replaceable>.</para>
     289          </listitem>
     290        </varlistentry>
     291
    255292        <varlistentry>
    256293          <term><option>--get_host_info</option></term>
    257294          <listitem>
    … …  
    259296              client is running.</para>
    260297          </listitem>
    261298        </varlistentry>
     299
     300        <varlistentry>
     301          <term><option>--get_daily_xfer_history</option></term>
     302          <listitem>
     303            <para>Show network traffic history of the BOINC client.</para>
     304          </listitem>
     305        </varlistentry>
    262306      </variablelist>
    263307    </refsect2>
    264308
    … …  
    268312      <variablelist>
    269313        <varlistentry>
    270314          <term>
    271             <option>--result</option>
     315            <option>--task</option>
    272316            <replaceable>URL</replaceable>
    273             <replaceable>result_name</replaceable>
    274             {suspend | resume | abort | graphics_window | graphics_fullscreen}
    275             <optional>
    276               <option>--desktop</option> <replaceable>dt</replaceable> |
    277               <option>--window_station</option> <replaceable>ws</replaceable> |
    278               <option>--display</option> <replaceable>dp</replaceable>
    279             </optional>
     317            <replaceable>task_name</replaceable>
     318            {suspend | resume | abort}
    280319          </term>
    281320          <listitem>
    282             <para>Do operation on a result.</para>
     321            <para>Do operation on a task.</para>
    283322
    284323            <variablelist>
    285324              <varlistentry>
    286325                <term><option>suspend</option></term>
    287326                <listitem>
    288                   <para>Temporarily stop work on result.</para>
     327                  <para>Temporarily stop work on task.</para>
    289328                </listitem>
    290329              </varlistentry>
    291330
    292331              <varlistentry>
    293332                <term><option>resume</option></term>
    294333                <listitem>
    295                   <para>Allow work on result.</para>
     334                  <para>Allow work on task.</para>
    296335                </listitem>
    297336              </varlistentry>
    298337
    299338              <varlistentry>
    300339                <term><option>abort</option></term>
    301340                <listitem>
    302                   <para>Permanently stop work on result.</para>
    303                 </listitem>
    304               </varlistentry>
    305 
    306               <varlistentry>
    307                 <term><option>graphics_window</option></term>
    308                 <listitem>
    309                   <para>Open graphics in a window. The optional desktop /
    310                     window_station (Windows) or display (X11) arguments
    311                     specify the display.</para>
    312                 </listitem>
    313               </varlistentry>
    314 
    315               <varlistentry>
    316                 <term><option>graphics_fullscreen</option></term>
    317                 <listitem>
    318                   <para>Open graphics fullscreen.</para>
     341                  <para>Permanently stop work on task.</para>
    319342                </listitem>
    320343              </varlistentry>
    321344            </variablelist>
    … …  
    326349          <term>
    327350            <option>--project</option>
    328351            <replaceable>URL</replaceable>
    329             {reset | detach | update | suspend | resume | nomorework 
    330             | allowmorework | detach_when_done}
     352            {reset | detach | update | suspend | resume | nomorework
     353            | allowmorework | detach_when_done | dont_detach_when_done}
    331354          </term>
    332355          <listitem>
    333356            <para>Do operation on a project, identified by its master
    … …  
    337360              <varlistentry>
    338361                <term><option>reset</option></term>
    339362                <listitem>
    340                   <para>Delete current work and get more.</para>
     363                  <para>Delete current tasks, applications and other files from
     364                    this project, request new tasks.</para>
    341365                </listitem>
    342366              </varlistentry>
    343367
    344368              <varlistentry>
    345369                <term><option>detach</option></term>
    346370                <listitem>
    347                   <para>Delete current work and don't get more.</para>
     371                  <para>Delete current tasks applications and other files from
     372                    this project, don't request any new tasks.</para>
    348373                </listitem>
    349374              </varlistentry>
    350375
    351376              <varlistentry>
    352377                <term><option>update</option></term>
    353378                <listitem>
    354                   <para>Contact scheduling server.</para>
     379                  <para>Contact project scheduling server.</para>
    355380                </listitem>
    356381              </varlistentry>
    357382
    358383              <varlistentry>
    359384                <term><option>suspend</option></term>
    360385                <listitem>
    361                   <para>Stop work for project.</para>
     386                  <para>Stop all tasks for project.</para>
    362387                </listitem>
    363388              </varlistentry>
    364389
    365390              <varlistentry>
    366391                <term><option>resume</option></term>
    367392                <listitem>
    368                   <para>Resume work for project.</para>
     393                  <para>Resume tasks for project.</para>
    369394                </listitem>
    370395              </varlistentry>
    371396
    372397              <varlistentry>
    373398                <term><option>nomorework</option></term>
    374399                <listitem>
    375                   <para>Finish current work but don't get more.</para>
     400                  <para>Finish all downloaded tasks but don't get more.</para>
    376401                </listitem>
    377402              </varlistentry>
    378403
    … …  
    386411              <varlistentry>
    387412                <term><option>detach_when_done</option></term>
    388413                <listitem>
    389                   <para>Detach project.</para>
     414                  <para>Detach project after all tasks are finished.</para>
     415                </listitem>
     416              </varlistentry>
     417
     418              <varlistentry>
     419                <term><option>dont_detach_when_done</option></term>
     420                <listitem>
     421                  <para>Undo <option>detach_when_done</option>.</para>
    390422                </listitem>
    391423              </varlistentry>
    392424            </variablelist>
    … …  
    402434          </term>
    403435          <listitem>
    404436            <para>Do operation on a file transfer.</para>
     437            <variablelist>
     438              <varlistentry>
     439                <term><option>retry</option></term>
     440                <listitem>
     441                  <para>Retry file transfer.</para>
     442                </listitem>
     443              </varlistentry>
     444
     445              <varlistentry>
     446                <term><option>abort</option></term>
     447                <listitem>
     448                  <para>Permanently abort file transfer.</para>
     449                </listitem>
     450              </varlistentry>
     451            </variablelist>
    405452          </listitem>
    406453        </varlistentry>
    407454
    … …  
    412459            <optional><replaceable>duration</replaceable></optional>
    413460          </term>
    414461          <listitem>
    415             <para>Set run mode.</para>
     462            <para>Set run mode (applies to CPU and GPU).</para>
    416463
    417464            <variablelist>
    418465              <varlistentry>
    419466                <term><option>always</option></term>
    420467                <listitem>
    421                   <para>Do CPU work always.</para>
     468                  <para>Do work always.</para>
    422469                </listitem>
    423470              </varlistentry>
    424471
    … …  
    437484              </varlistentry>
    438485            </variablelist>
    439486            <para>If <replaceable>duration</replaceable> is zero or absent,
    440               this mode is permanent. Otherwise, after <replaceable
    441               >duration</replaceable> seconds elapse, revert to last
     487              this mode is permanent. Otherwise, after
     488              <replaceable>duration</replaceable> seconds elapse, revert to last
    442489              permanent mode.</para>
    443490          </listitem>
    444491        </varlistentry>
    … …  
    457504
    458505        <varlistentry>
    459506          <term>
     507            <option>--set_gpu_mode</option>
     508            {always | auto | never}
     509            <optional><replaceable>duration</replaceable></optional>
     510          </term>
     511          <listitem>
     512            <para>Set GPU mode. Like <option>--set_run_mode</option> but
     513              applies to GPU processing only.</para>
     514          </listitem>
     515        </varlistentry>
     516
     517        <varlistentry>
     518          <term>
    460519            <option>--set_proxy_settings</option>
    461520            <replaceable>http_server_name</replaceable>
    462521            <replaceable>http_server_port</replaceable>
    … …  
    464523            <replaceable>http_user_passwd</replaceable>
    465524            <replaceable>socks_server_name</replaceable>
    466525            <replaceable>socks_server_port</replaceable>
    467             <replaceable>socks_version</replaceable>
    468526            <replaceable>socks5_user_name</replaceable>
    469527            <replaceable>socks5_user_passwd</replaceable>
     528            <replaceable>noproxy_hosts</replaceable>
    470529          </term>
    471530          <listitem>
    472             <para>Set proxy settings. All fields are mandantory.</para>
     531            <para>Set proxy settings. All fields are mandatory.</para>
    473532          </listitem>
    474533        </varlistentry>
    475534
    … …  
    481540        </varlistentry>
    482541
    483542        <varlistentry>
    484           <term>
    485             <option>--set_screensaver_mode</option> {on | off}
    486             <replaceable>blank_time</replaceable>
    487             <optional>
    488               <option>--desktop</option> <replaceable>dt</replaceable> |
    489               <option>--window_station</option> <replaceable>ws</replaceable> |
    490               <option>--display</option> <replaceable>dp</replaceable>
    491             </optional>
    492           </term>
    493           <listitem>
    494             <para>Tell the core client to start or stop doing fullscreen
    495               graphics, and going to black after
    496               <replaceable>blank_time</replaceable> seconds. The optional
    497               arguments specify which desktop / windows_station (Windows)
    498               or display (X11) to use.</para>
    499           </listitem>
    500         </varlistentry>
    501 
    502         <varlistentry>
    503543          <term><option>--read_global_prefs_override</option></term>
    504544          <listitem>
    505             <para>Tell the core client to read the <filename
    506               >global_prefs_override.xml</filename> file and
     545            <para>Tell the client to read the
     546              <filename>global_prefs_override.xml</filename> file and
    507547              incorporate any global preferences indicated there.</para>
    508548          </listitem>
    509549        </varlistentry>
    … …  
    511551        <varlistentry>
    512552          <term><option>--quit</option></term>
    513553          <listitem>
    514             <para>Tell the core client to quit.</para>
     554            <para>Tell the client to quit.</para>
    515555          </listitem>
    516556        </varlistentry>
    517557
    518558        <varlistentry>
    519559          <term><option>--read_cc_config</option></term>
    520560          <listitem>
    521             <para>Reread the configuration file
     561            <para>Tell the client to reread the configuration file
    522562              (<filename>cc_config.xml</filename>).</para>
    523563          </listitem>
    524564        </varlistentry>
    525565
    526566        <varlistentry>
    527567          <term>
    528             <option>--set_debts</option>
    529             <replaceable>URL1</replaceable>
    530             <replaceable>STD1</replaceable>
    531             <replaceable>LTD1</replaceable>
    532             <optional><replaceable>URL2</replaceable>
    533               <replaceable>STD2</replaceable>
    534               <replaceable>LTD2</replaceable>
    535               ...</optional>
    536           </term>
    537           <listitem>
    538             <para>Set the short- and long-term debts of one or more projects.
    539               Note, if you adjust the debts of a single project, the debts of
    540               other projects are changed. So if you want to set the debts of
    541               multiple projects, do it in a single command.</para>
    542           </listitem>
    543         </varlistentry>
    544 
    545         <varlistentry>
    546           <term>
    547568            <option>--get_project_config</option>
    548569            <replaceable>URL</replaceable>
    549570          </term>
    550571          <listitem>
    551             <para>Fetch configuration at project located at
     572            <para>Fetch configuration of project located at
    552573              <replaceable>URL</replaceable>.</para>
    553574          </listitem>
    554575        </varlistentry>
    555576
    556577        <varlistentry>
    557           <term><option>--get_project_config_poll</option></term>
    558         </varlistentry>
    559 
    560         <varlistentry>
    561578          <term><option>--network_available</option></term>
     579              <listitem>
     580            <para>Tell the client to retry deferred network communication.</para>
     581          </listitem>
    562582        </varlistentry>
    563583
    564         <varlistentry>
    565           <term><option>--get_cc_status</option></term>
    566         </varlistentry>
    567584      </variablelist>
    568585    </refsect2>
    569586  </refsect1>
    … …  
    576593
    577594  <refsect1>
    578595    <title>COPYRIGHT</title>
    579     <para>Copyright © 2007-2008 University of California.</para>
     596    <para>Copyright © 2007-2013 University of California.</para>
    580597    <para>Permission is granted to copy, distribute and/or modify this
    581598      document under the terms of the &gnu; Free Documentation License,
    582599      Version 1.2 or any later version published by the Free Software

  • doc/manpages/boincmgr.xml 

    diff --git a/doc/manpages/boincmgr.xml b/doc/manpages/boincmgr.xml
index 0f1ec04..dd54e36 100644
    a b  
    22
    33<!--
    44 This is the manual page for the BOINC manager (boincmgr), a monitor
    5  and control utility for the core client.
     5 and control utility for the client.
    66
    77 Copyright © 2007-2008 University of California
    88
    … …  
    1818  <!ENTITY % COMMON SYSTEM "common.ent">
    1919  %COMMON;
    2020
    21   <!ENTITY date "<date>13 January 2008</date>">
     21  <!ENTITY date "<date>04 March 2013</date>">
    2222]>
    2323
    2424<refentry>
    2525  <refentryinfo>
    26     <author>
    27       <firstname>Frank</firstname>
    28       <lastname>Thomas</lastname>
    29       <email>frank@thomas-alfeld.de</email>
    30     </author>
     26    <authorgroup>
     27      <author>
     28        <firstname>Christian</firstname>
     29        <lastname>Beer</lastname>
     30        <email>djangofett@gmx.net</email>
     31      </author>
     32      <author>
     33        <firstname>Frank</firstname>
     34        <lastname>Thomas</lastname>
     35        <email>frank@thomas-alfeld.de</email>
     36      </author>
     37    </authorgroup>
    3138    <copyright>
    3239      <year>2007</year>
    33       <year>2008</year>
     40      <year>2013</year>
    3441      <holder>University of California</holder>
    3542    </copyright>
    3643    &date;
    … …  
    4249  </refmeta>
    4350
    4451  <refnamediv>
    45     <refname>&boincmgr;</refname> 
    46     <refpurpose>The graphical BOINC manager for the core client.</refpurpose>
     52    <refname>&boincmgr;</refname>
     53    <refpurpose>The graphical BOINC manager for the client.</refpurpose>
    4754  </refnamediv>
    4855
    4956  <refsynopsisdiv>
    5057    <cmdsynopsis>
    5158      &cmd_boincmgr;
    5259      <arg><option>--verbose</option></arg>
    53       <arg><option>-s</option></arg>
     60      <arg><option>-a</option></arg>
     61      <arg><option>-e</option> <replaceable>client_dir</replaceable></arg>
     62      <arg><option>-d</option> <replaceable>data_dir</replaceable></arg>
     63      <arg><option>-n</option> <replaceable>hostname</replaceable></arg>
     64      <arg><option>-g</option> <replaceable>port</replaceable></arg>
     65      <arg><option>-p</option> <replaceable>passwd</replaceable></arg>
    5466      <arg><option>-b</option> <replaceable>BOINC_ARGS</replaceable></arg>
    5567      <arg><option>-i</option></arg>
     68      <arg><option>-c</option></arg>
     69      <arg><option>-m</option></arg>
    5670    </cmdsynopsis>
    5771    <cmdsynopsis>
    5872      &cmd_boincmgr;
    … …  
    6579
    6680  <refsect1>
    6781    <title>DESCRIPTION</title>
    68     <para>The BOINC manager (&cmd_boincmgr;) is a controling and monitoring
    69       utility for the BOINC core client (&man_boinc;).</para>
     82    <para>The BOINC manager (&cmd_boincmgr;) is a graphical controlling and monitoring
     83      utility for the BOINC client (&man_boinc;). It communicates with a running
     84      client using port &rpc_port; over TCP/IP. It can only connect to one client at a time.
     85    </para>
    7086  </refsect1>
    7187
    7288  <refsect1>
    7389    <title>OPTIONS</title>
    74     <para>A full summary of options is included below.</para>
     90    <para></para>
    7591
    7692    <variablelist>
    7793      <varlistentry>
    … …  
    89105      </varlistentry>
    90106
    91107      <varlistentry>
    92         <term><option>-s</option>, <option>--systray</option></term>
     108        <term><option>-a</option>, <option>--autostart</option></term>
     109        <listitem>
     110          <para>Tells the BOINC Manager that it was started by the operating system
     111                automatically. Use this if the Manager is started at login time.
     112          </para>
     113        </listitem>
     114      </varlistentry>
     115
     116      <varlistentry>
     117        <term>
     118          <option>-e</option> <replaceable>client_dir</replaceable>,
     119          <option>--clientdir=</option><replaceable>client_dir</replaceable>
     120        </term>
     121        <listitem>
     122            <para>Directory containing the <filename>locale</filename> directory
     123            containing the Manager localisation files.
     124            </para>
     125        </listitem>
     126      </varlistentry>
     127
     128      <varlistentry>
     129        <term>
     130          <option>-d</option> <replaceable>data_dir</replaceable>,
     131          <option>--datadir=</option><replaceable>data_dir</replaceable>
     132        </term>
     133        <listitem>
     134          <para>Directory containing the configuration files .
     135          </para>
     136        </listitem>
     137      </varlistentry>
     138
     139      <varlistentry>
     140        <term>
     141          <option>-n</option> <replaceable>hostname</replaceable>,
     142          <option>--namehost=</option><replaceable>hostname</replaceable>
     143        </term>
     144        <listitem>
     145          <para>Hostname or IP address of client to which the manager should connect to.</para>
     146        </listitem>
     147      </varlistentry>
     148
     149      <varlistentry>
     150        <term>
     151          <option>-g</option> <replaceable>port</replaceable>,
     152          <option>--gui_rpc_port=</option><replaceable>port</replaceable>
     153        </term>
    93154        <listitem>
    94           <para>Startup BOINC Manager so only the system tray icon is
    95             visible.</para>
     155          <para>RPC port number used to communicate with the client. Has to be the same value as on the client (see &man_boinc;).</para>
     156        </listitem>
     157      </varlistentry>
     158
     159      <varlistentry>
     160        <term>
     161          <option>-p</option> <replaceable>passwd</replaceable>,
     162          <option>--password=</option><replaceable>passwd</replaceable>
     163        </term>
     164        <listitem>
     165          <para>Use <replaceable>passwd</replaceable> as password for RPC
     166            authentication. If the current working directory contains a file
     167            <filename>gui_rpc_auth.cfg</filename>, &cmd_boincmgr; will read
     168            the password from this file.</para>
    96169        </listitem>
    97170      </varlistentry>
    98171
    … …  
    102175          <option>--boincargs=</option><replaceable>BOINC_ARGS</replaceable>
    103176        </term>
    104177        <listitem>
    105           <para>Startup BOINC with these optional arguments.</para>
     178          <para>Startup the BOINC client with these optional arguments if necessary.</para>
    106179        </listitem>
    107180      </varlistentry>
    108181
    … …  
    112185          <para>Disable BOINC security users and permissions.</para>
    113186        </listitem>
    114187      </varlistentry>
     188
     189      <varlistentry>
     190        <term><option>-c</option>, <option>--checkskins</option></term>
     191        <listitem>
     192          <para>Set skin debugging mode to enable skin manager error messages.</para>
     193        </listitem>
     194      </varlistentry>
     195
     196      <varlistentry>
     197        <term><option>-m</option>, <option>--multiple</option></term>
     198        <listitem>
     199          <para>Allow multiple instances of BOINC manager on this host.</para>
     200        </listitem>
     201      </varlistentry>
    115202    </variablelist>
    116203  </refsect1>
    117204
    … …  
    125212
    126213  <refsect1>
    127214    <title>COPYRIGHT</title>
    128     <para>Copyright © 2007-2008 University of California.</para>
     215    <para>Copyright © 2007-2013 University of California.</para>
    129216    <para>Permission is granted to copy, distribute and/or modify this
    130217      document under the terms of the &gnu; Free Documentation License,
    131218      Version 1.2 or any later version published by the Free Software