Rooba
/
boinc
mirror of https://github.com/BOINC/boinc.git
1
0
Fork 0
Code Issues 1 Packages Projects Releases Wiki Activity

doc/manpages/: Put common entities together in common.ent. 

svn path=/trunk/boinc/; revision=15075
This commit is contained in:
Frank Thomas 2008-04-22 08:35:14 +00:00
parent 06efe14423
commit 4c5a3e2475
4 changed files with 85 additions and 75 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

61
doc/manpages/boinc_client.xml
View File

@ -14,21 +14,10 @@
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.4//EN" <!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.4//EN"
"file:///usr/share/xml/docbook/schema/dtd/4.4/docbookx.dtd" [ "file:///usr/share/xml/docbook/schema/dtd/4.4/docbookx.dtd" [
<!ENTITY binary "boinc_client"> <!ENTITY % COMMON SYSTEM "common.ent">
<!ENTITY command "<command>boinc_client</command>"> %COMMON;
<!ENTITY date "<date>April 06, 2008</date>"> <!ENTITY date "<date>April 06, 2008</date>">
<!ENTITY gnu "<acronym>GNU</acronym>">
<!ENTITY man_boincmgr
"<citerefentry>
<refentrytitle>boincmgr</refentrytitle>
<manvolnum>1</manvolnum>
</citerefentry>">
<!ENTITY man_boinc_cmd
"<citerefentry>
<refentrytitle>boinc_cmd</refentrytitle>
<manvolnum>1</manvolnum>
</citerefentry>">
<!ENTITY rpc_port "31416">
]> ]>
<refentry> <refentry>
@ -59,31 +48,32 @@
</refentryinfo> </refentryinfo>
<refmeta> <refmeta>
<refentrytitle>&binary;</refentrytitle> <refentrytitle>&boinc_client;</refentrytitle>
<manvolnum>1</manvolnum> <manvolnum>1</manvolnum>
</refmeta> </refmeta>
<refnamediv> <refnamediv>
<refname>&binary;</refname> <refname>&boinc_client;</refname>
<refpurpose>The BOINC core client program.</refpurpose> <refpurpose>The BOINC core client program.</refpurpose>
</refnamediv> </refnamediv>
<refsynopsisdiv> <refsynopsisdiv>
<cmdsynopsis> <cmdsynopsis>
<command>&binary;</command> &cmd_boinc_client;
<arg><replaceable>options</replaceable></arg> <arg><replaceable>options</replaceable></arg>
</cmdsynopsis> </cmdsynopsis>
</refsynopsisdiv> </refsynopsisdiv>
<refsect1> <refsect1>
<title>DESCRIPTION</title> <title>DESCRIPTION</title>
<para>The BOINC "core client", &command;, is the heart of BOINC. It <para>The BOINC "core client", &cmd_boinc_client;, is the heart of BOINC.
controls which project applications are run on your computer, It controls which project applications are run on your computer,
downloading "Workunits" and uploading the "Result" files from completed downloading "Workunits" and uploading the "Result" files from completed
tasks. &command; is usually run in the background, ideally as a daemon. tasks. &cmd_boinc_client; is usually run in the background, ideally as a
It can then be controlled either by a graphical tool called the BOINC daemon. It can then be controlled either by a graphical tool called the
Manager, &man_boincmgr;, or a command-line tool called &man_boinc_cmd;, BOINC Manager, &man_boincmgr;, or a command-line tool called
by means of Remote Proceedure Calls (RPCs) over port &rpc_port;.</para> &man_boinc_cmd;, by means of Remote Proceedure Calls (RPCs) over port
&rpc_port;.</para>
<para>The BOINC core client can be controlled by command-line options, <para>The BOINC core client can be controlled by command-line options,
configuration files, and environment variables. Standard usage is simply configuration files, and environment variables. Standard usage is simply
@ -92,10 +82,10 @@
<refsect1> <refsect1>
<title>OPTIONS</title> <title>OPTIONS</title>
<para>These command-line options for &command; can be used to control how <para>These command-line options for &cmd_boinc_client; can be used to
BOINC is started. Once the client has started, you should use a separate control how BOINC is started. Once the client has started, you should
program, (&man_boincmgr; or &man_boinc_cmd;) which communicates with it use a separate program, (&man_boincmgr; or &man_boinc_cmd;) which
by means of Remote Proceedure Calls (RPCs).</para> communicates with it by means of Remote Proceedure Calls (RPCs).</para>
<variablelist> <variablelist>
<varlistentry> <varlistentry>
@ -213,8 +203,8 @@
<listitem> <listitem>
<para>Omits creation of a socket as required for the remote control <para>Omits creation of a socket as required for the remote control
of the client. Consequently the client cannot be controlled by of the client. Consequently the client cannot be controlled by
external tools like GUIs (<command>boincmgr</command> etc.) or the external tools like GUIs (&cmd_boincmgr; etc.) or the console
console command tool (<command>boinc_cmd</command>).</para> command tool (&cmd_boinc_cmd;).</para>
</listitem> </listitem>
</varlistentry> </varlistentry>
@ -271,16 +261,17 @@
<refsect1> <refsect1>
<title>SEE ALSO</title> <title>SEE ALSO</title>
<para>&man_boincmgr;, &man_boinc_cmd;</para> <para>&man_boinc_cmd;, &man_boincmgr;</para>
<para><ulink url="http://boinc.berkeley.edu/trac/wiki/UnixClient"/></para> <para><ulink url="http://boinc.berkeley.edu/trac/wiki/UnixClient"/></para>
</refsect1> </refsect1>
<refsect1> <refsect1>
<title>COPYRIGHT</title> <title>COPYRIGHT</title>
<para>Copyright © 2007-2008 University of California. Permission is <para>Copyright © 2007-2008 University of California.</para>
granted to copy, distribute and/or modify this document under the terms <para>Permission is granted to copy, distribute and/or modify this
of the &gnu; Free Documentation License, Version 1.2 or any later document under the terms of the &gnu; Free Documentation License,
version published by the Free Software Foundation; with no Invariant Version 1.2 or any later version published by the Free Software
Sections, no Front-Cover Texts, and no Back-Cover Texts.</para> Foundation; with no Invariant Sections, no Front-Cover Texts, and no
Back-Cover Texts.</para>
</refsect1> </refsect1>
</refentry> </refentry>

39
doc/manpages/boinc_cmd.xml
View File

@ -15,9 +15,10 @@
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.4//EN" <!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.4//EN"
"file:///usr/share/xml/docbook/schema/dtd/4.4/docbookx.dtd" [ "file:///usr/share/xml/docbook/schema/dtd/4.4/docbookx.dtd" [
<!ENTITY dhbinary "boinc_cmd"> <!ENTITY % COMMON SYSTEM "common.ent">
<!ENTITY dhdate "<date>11 January 2008</date>"> %COMMON;
<!ENTITY gnu "<acronym>GNU</acronym>">
<!ENTITY date "<date>11 January 2008</date>">
]> ]>
<refentry> <refentry>
@ -40,30 +41,30 @@
<year>2008</year> <year>2008</year>
<holder>University of California</holder> <holder>University of California</holder>
</copyright> </copyright>
&dhdate; &date;
</refentryinfo> </refentryinfo>
<refmeta> <refmeta>
<refentrytitle>&dhbinary;</refentrytitle> <refentrytitle>&boinc_cmd;</refentrytitle>
<manvolnum>1</manvolnum> <manvolnum>1</manvolnum>
</refmeta> </refmeta>
<refnamediv> <refnamediv>
<refname>&dhbinary;</refname> <refname>&boinc_cmd;</refname>
<refpurpose>command line interface to the BOINC core client</refpurpose> <refpurpose>command line interface to the BOINC core client</refpurpose>
</refnamediv> </refnamediv>
<refsynopsisdiv> <refsynopsisdiv>
<para> <para>
<cmdsynopsis> <cmdsynopsis>
<command>&dhbinary;</command> &cmd_boinc_cmd;
<arg><option>--host</option> <replaceable>hostname</replaceable><arg <arg><option>--host</option> <replaceable>hostname</replaceable><arg
>:<replaceable>port</replaceable></arg></arg> >:<replaceable>port</replaceable></arg></arg>
<arg><option>--passwd</option> <replaceable>passwd</replaceable></arg> <arg><option>--passwd</option> <replaceable>passwd</replaceable></arg>
<arg choice="req"><replaceable>command</replaceable></arg> <arg choice="req"><replaceable>command</replaceable></arg>
</cmdsynopsis> </cmdsynopsis>
<cmdsynopsis> <cmdsynopsis>
<command>&dhbinary;</command> &cmd_boinc_cmd;
<arg><option>-hV</option></arg> <arg><option>-hV</option></arg>
</cmdsynopsis> </cmdsynopsis>
</para> </para>
@ -74,8 +75,8 @@
<refsect1> <refsect1>
<title>DESCRIPTION</title> <title>DESCRIPTION</title>
<para>The BOINC command tool (<command>boinc_cmd</command>) provides <para>The BOINC command tool (&cmd_boinc_cmd;) provides a command line
a command line interface to a running BOINC core client.</para> interface to a running BOINC core client (&man_boinc_client;).</para>
</refsect1> </refsect1>
<refsect1> <refsect1>
@ -101,9 +102,8 @@
<listitem> <listitem>
<para>Use <replaceable>passwd</replaceable> as password for RPC <para>Use <replaceable>passwd</replaceable> as password for RPC
authentication. If the current working directory contains a file authentication. If the current working directory contains a file
<filename>gui_rpc_auth.cfg</filename>, <filename>gui_rpc_auth.cfg</filename>, &cmd_boinc_cmd; will read
<command>boinc_cmd</command> will read the password from this the password from this file.</para>
file.</para>
</listitem> </listitem>
</varlistentry> </varlistentry>
@ -565,16 +565,17 @@
<refsect1> <refsect1>
<title>SEE ALSO</title> <title>SEE ALSO</title>
<para>&man_boinc_client;, &man_boincmgr;</para>
<para><ulink url="http://boinc.berkeley.edu/trac/wiki/BoincCmd"/></para> <para><ulink url="http://boinc.berkeley.edu/trac/wiki/BoincCmd"/></para>
</refsect1> </refsect1>
<refsect1> <refsect1>
<title>COPYRIGHT</title> <title>COPYRIGHT</title>
<para>Copyright © 2007-2008 University of California. Permission is <para>Copyright © 2007-2008 University of California.</para>
granted to copy, distribute and/or modify this document under the <para>Permission is granted to copy, distribute and/or modify this
terms of the &gnu; Free Documentation License, Version 1.2 or any document under the terms of the &gnu; Free Documentation License,
later version published by the Free Software Foundation; with no Version 1.2 or any later version published by the Free Software
Invariant Sections, no Front-Cover Texts, and no Back-Cover Foundation; with no Invariant Sections, no Front-Cover Texts, and no
Texts.</para> Back-Cover Texts.</para>
</refsect1> </refsect1>
</refentry> </refentry>

38
doc/manpages/boincmgr.xml
View File

@ -15,9 +15,10 @@
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.4//EN" <!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.4//EN"
"file:///usr/share/xml/docbook/schema/dtd/4.4/docbookx.dtd" [ "file:///usr/share/xml/docbook/schema/dtd/4.4/docbookx.dtd" [
<!ENTITY dhbinary "boincmgr"> <!ENTITY % COMMON SYSTEM "common.ent">
<!ENTITY dhdate "<date>13 January 2008</date>"> %COMMON;
<!ENTITY gnu "<acronym>GNU</acronym>">
<!ENTITY date "<date>13 January 2008</date>">
]> ]>
<refentry> <refentry>
@ -32,29 +33,29 @@
<year>2008</year> <year>2008</year>
<holder>University of California</holder> <holder>University of California</holder>
</copyright> </copyright>
&dhdate; &date;
</refentryinfo> </refentryinfo>
<refmeta> <refmeta>
<refentrytitle>&dhbinary;</refentrytitle> <refentrytitle>&boincmgr;</refentrytitle>
<manvolnum>1</manvolnum> <manvolnum>1</manvolnum>
</refmeta> </refmeta>
<refnamediv> <refnamediv>
<refname>&dhbinary;</refname> <refname>&boincmgr;</refname>
<refpurpose>The graphical BOINC manager for the core client.</refpurpose> <refpurpose>The graphical BOINC manager for the core client.</refpurpose>
</refnamediv> </refnamediv>
<refsynopsisdiv> <refsynopsisdiv>
<cmdsynopsis> <cmdsynopsis>
<command>&dhbinary;</command> &cmd_boincmgr;
<arg><option>--verbose</option></arg> <arg><option>--verbose</option></arg>
<arg><option>-s</option></arg> <arg><option>-s</option></arg>
<arg><option>-b</option> <replaceable>BOINC_ARGS</replaceable></arg> <arg><option>-b</option> <replaceable>BOINC_ARGS</replaceable></arg>
<arg><option>-i</option></arg> <arg><option>-i</option></arg>
</cmdsynopsis> </cmdsynopsis>
<cmdsynopsis> <cmdsynopsis>
<command>&dhbinary;</command> &cmd_boincmgr;
<group> <group>
<arg><option>-h</option></arg> <arg><option>-h</option></arg>
<arg><option>--help</option></arg> <arg><option>--help</option></arg>
@ -64,12 +65,8 @@
<refsect1> <refsect1>
<title>DESCRIPTION</title> <title>DESCRIPTION</title>
<para>The BOINC manager (<command>&dhbinary;</command>) is a controling <para>The BOINC manager (&cmd_boincmgr;) is a controling and monitoring
and monitoring utility for the BOINC core client utility for the BOINC core client (&man_boinc_client;).</para>
(<citerefentry>
<refentrytitle>boinc</refentrytitle>
<manvolnum>1</manvolnum>
</citerefentry>).</para>
</refsect1> </refsect1>
<refsect1> <refsect1>
@ -120,6 +117,7 @@
<refsect1> <refsect1>
<title>SEE ALSO</title> <title>SEE ALSO</title>
<para>&man_boinc_client;, &man_boinc_cmd;</para>
<para> <para>
<ulink url="http://boinc.berkeley.edu/trac/wiki/ManagerAdvanced"/> <ulink url="http://boinc.berkeley.edu/trac/wiki/ManagerAdvanced"/>
</para> </para>
@ -127,11 +125,11 @@
<refsect1> <refsect1>
<title>COPYRIGHT</title> <title>COPYRIGHT</title>
<para>Copyright © 2007-2008 University of California. Permission is <para>Copyright © 2007-2008 University of California.</para>
granted to copy, distribute and/or modify this document under the <para>Permission is granted to copy, distribute and/or modify this
terms of the &gnu; Free Documentation License, Version 1.2 or any document under the terms of the &gnu; Free Documentation License,
later version published by the Free Software Foundation; with no Version 1.2 or any later version published by the Free Software
Invariant Sections, no Front-Cover Texts, and no Back-Cover Foundation; with no Invariant Sections, no Front-Cover Texts, and no
Texts.</para> Back-Cover Texts.</para>
</refsect1> </refsect1>
</refentry> </refentry>

20
doc/manpages/common.ent Normal file
View File

@ -0,0 +1,20 @@
<!ENTITY boinc_client "boinc_client">
<!ENTITY boinc_cmd "boinc_cmd">
<!ENTITY boincmgr "boincmgr">
<!ENTITY cmd_boinc_client "<command>&boinc_client;</command>">
<!ENTITY cmd_boinc_cmd "<command>&boinc_cmd;</command>">
<!ENTITY cmd_boincmgr "<command>&boincmgr;</command>">
<!ENTITY gnu "<acronym>GNU</acronym>">
<!ENTITY man_boinc_client "<citerefentry>
<refentrytitle>&boinc_client;</refentrytitle>
<manvolnum>1</manvolnum>
</citerefentry>">
<!ENTITY man_boinc_cmd "<citerefentry>
<refentrytitle>&boinc_cmd;</refentrytitle>
<manvolnum>1</manvolnum>
</citerefentry>">
<!ENTITY man_boincmgr "<citerefentry>
<refentrytitle>&boincmgr;</refentrytitle>
<manvolnum>1</manvolnum>
</citerefentry>">
<!ENTITY rpc_port "31416">