From 4c5a3e24758a2381edbb091fdba6b266440e29bf Mon Sep 17 00:00:00 2001 From: Frank Thomas Date: Tue, 22 Apr 2008 08:35:14 +0000 Subject: [PATCH] doc/manpages/: Put common entities together in common.ent. svn path=/trunk/boinc/; revision=15075 --- doc/manpages/boinc_client.xml | 63 +++++++++++++++-------------------- doc/manpages/boinc_cmd.xml | 39 +++++++++++----------- doc/manpages/boincmgr.xml | 38 ++++++++++----------- doc/manpages/common.ent | 20 +++++++++++ 4 files changed, 85 insertions(+), 75 deletions(-) create mode 100644 doc/manpages/common.ent diff --git a/doc/manpages/boinc_client.xml b/doc/manpages/boinc_client.xml index 78f4f647b9..839b6a45b1 100644 --- a/doc/manpages/boinc_client.xml +++ b/doc/manpages/boinc_client.xml @@ -14,21 +14,10 @@ - boinc_client"> - April 06, 2008"> - GNU"> - - boincmgr - 1 - "> - - boinc_cmd - 1 - "> - + + %COMMON; + + April 06, 2008"> ]> @@ -59,31 +48,32 @@ - &binary; + &boinc_client; 1 - &binary; + &boinc_client; The BOINC core client program. - &binary; + &cmd_boinc_client; options DESCRIPTION - The BOINC "core client", &command;, is the heart of BOINC. It - controls which project applications are run on your computer, + The BOINC "core client", &cmd_boinc_client;, is the heart of BOINC. + It controls which project applications are run on your computer, downloading "Workunits" and uploading the "Result" files from completed - tasks. &command; is usually run in the background, ideally as a daemon. - It can then be controlled either by a graphical tool called the BOINC - Manager, &man_boincmgr;, or a command-line tool called &man_boinc_cmd;, - by means of Remote Proceedure Calls (RPCs) over port &rpc_port;. + tasks. &cmd_boinc_client; is usually run in the background, ideally as a + daemon. It can then be controlled either by a graphical tool called the + BOINC Manager, &man_boincmgr;, or a command-line tool called + &man_boinc_cmd;, by means of Remote Proceedure Calls (RPCs) over port + &rpc_port;. The BOINC core client can be controlled by command-line options, configuration files, and environment variables. Standard usage is simply @@ -92,10 +82,10 @@ OPTIONS - These command-line options for &command; can be used to control how - BOINC is started. Once the client has started, you should use a separate - program, (&man_boincmgr; or &man_boinc_cmd;) which communicates with it - by means of Remote Proceedure Calls (RPCs). + These command-line options for &cmd_boinc_client; can be used to + control how BOINC is started. Once the client has started, you should + use a separate program, (&man_boincmgr; or &man_boinc_cmd;) which + communicates with it by means of Remote Proceedure Calls (RPCs). @@ -213,8 +203,8 @@ 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 (boincmgr etc.) or the - console command tool (boinc_cmd). + external tools like GUIs (&cmd_boincmgr; etc.) or the console + command tool (&cmd_boinc_cmd;). @@ -271,16 +261,17 @@ SEE ALSO - &man_boincmgr;, &man_boinc_cmd; + &man_boinc_cmd;, &man_boincmgr; COPYRIGHT - Copyright © 2007-2008 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. + Copyright © 2007-2008 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. diff --git a/doc/manpages/boinc_cmd.xml b/doc/manpages/boinc_cmd.xml index 4d3392cc6f..4280a69200 100644 --- a/doc/manpages/boinc_cmd.xml +++ b/doc/manpages/boinc_cmd.xml @@ -15,9 +15,10 @@ - 11 January 2008"> - GNU"> + + %COMMON; + + 11 January 2008"> ]> @@ -40,30 +41,30 @@ 2008 University of California - &dhdate; + &date; - &dhbinary; + &boinc_cmd; 1 - &dhbinary; + &boinc_cmd; command line interface to the BOINC core client - &dhbinary; + &cmd_boinc_cmd; hostname:port passwd command - &dhbinary; + &cmd_boinc_cmd; @@ -74,8 +75,8 @@ DESCRIPTION - The BOINC command tool (boinc_cmd) provides - a command line interface to a running BOINC core client. + The BOINC command tool (&cmd_boinc_cmd;) provides a command line + interface to a running BOINC core client (&man_boinc_client;). @@ -101,9 +102,8 @@ Use passwd as password for RPC authentication. If the current working directory contains a file - gui_rpc_auth.cfg, - boinc_cmd will read the password from this - file. + gui_rpc_auth.cfg, &cmd_boinc_cmd; will read + the password from this file. @@ -565,16 +565,17 @@ SEE ALSO + &man_boinc_client;, &man_boincmgr; COPYRIGHT - Copyright © 2007-2008 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. + Copyright © 2007-2008 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. diff --git a/doc/manpages/boincmgr.xml b/doc/manpages/boincmgr.xml index aaf95c0cef..89cd853495 100644 --- a/doc/manpages/boincmgr.xml +++ b/doc/manpages/boincmgr.xml @@ -15,9 +15,10 @@ - 13 January 2008"> - GNU"> + + %COMMON; + + 13 January 2008"> ]> @@ -32,29 +33,29 @@ 2008 University of California - &dhdate; + &date; - &dhbinary; + &boincmgr; 1 - &dhbinary; + &boincmgr; The graphical BOINC manager for the core client. - &dhbinary; + &cmd_boincmgr; BOINC_ARGS - &dhbinary; + &cmd_boincmgr; @@ -64,12 +65,8 @@ DESCRIPTION - The BOINC manager (&dhbinary;) is a controling - and monitoring utility for the BOINC core client - ( - boinc - 1 - ). + The BOINC manager (&cmd_boincmgr;) is a controling and monitoring + utility for the BOINC core client (&man_boinc_client;). @@ -120,6 +117,7 @@ SEE ALSO + &man_boinc_client;, &man_boinc_cmd; @@ -127,11 +125,11 @@ COPYRIGHT - Copyright © 2007-2008 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. + Copyright © 2007-2008 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. diff --git a/doc/manpages/common.ent b/doc/manpages/common.ent new file mode 100644 index 0000000000..915a9526f7 --- /dev/null +++ b/doc/manpages/common.ent @@ -0,0 +1,20 @@ + + + +&boinc_client;"> +&boinc_cmd;"> +&boincmgr;"> +GNU"> + + &boinc_client; + 1 + "> + + &boinc_cmd; + 1 + "> + + &boincmgr; + 1 + "> +