From b664b1a9309b29b57070a1d3f1720e3a9397800f Mon Sep 17 00:00:00 2001 From: Frank Thomas Date: Sun, 7 Oct 2007 10:14:58 +0000 Subject: [PATCH] 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 --- Makefile.am | 2 +- checkin_notes | 15 + configure.ac | 13 +- doc/manpages/Makefile.am | 20 ++ doc/manpages/boinc_client.xml | 264 +++++++++++++++++ doc/manpages/boinc_cmd.xml | 514 ++++++++++++++++++++++++++++++++++ doc/manpages/boincmgr.xml | 117 ++++++++ 7 files changed, 941 insertions(+), 4 deletions(-) create mode 100644 doc/manpages/Makefile.am create mode 100644 doc/manpages/boinc_client.xml create mode 100644 doc/manpages/boinc_cmd.xml create mode 100644 doc/manpages/boincmgr.xml diff --git a/Makefile.am b/Makefile.am index 3aa449e4ab..414c405908 100644 --- a/Makefile.am +++ b/Makefile.am @@ -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. diff --git a/checkin_notes b/checkin_notes index e6d265694c..17dcb063d4 100755 --- a/checkin_notes +++ b/checkin_notes @@ -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 + diff --git a/configure.ac b/configure.ac index 0b9e4a0a69..c4b2ab6749 100644 --- a/configure.ac +++ b/configure.ac @@ -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]) diff --git a/doc/manpages/Makefile.am b/doc/manpages/Makefile.am new file mode 100644 index 0000000000..5395a75977 --- /dev/null +++ b/doc/manpages/Makefile.am @@ -0,0 +1,20 @@ +## -*- 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) diff --git a/doc/manpages/boinc_client.xml b/doc/manpages/boinc_client.xml new file mode 100644 index 0000000000..e60e9d1fb5 --- /dev/null +++ b/doc/manpages/boinc_client.xml @@ -0,0 +1,264 @@ + + + + + + October 06, 2007"> + GNU"> +]> + + + + + + Steffen + Moeller + steffen_moeller@gmx.de + + + + Frank + Thomas + frank@thomas-alfeld.de + + + + 2007 + University of California + + &dhdate; + + + + &dhbinary; + 1 + + + + &dhbinary; + The BOINC core client program. + + + + + &dhbinary; + options + + + + + DESCRIPTION + &dhbinary; 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. + + + + OPTIONS + A full summary of options is included below. + + + + + + show options + + + + + + + show version info + + + + + + + exit when there are no results + + + + + + + show attached projects + + + + + + + contact server when have results + + + + + + + + + detach from a project + + + + + + + + + reset (clear) a project + + + + + + + + + attach to a project + + + + + + + + + contact a project to update preferences + + + + + + + run the CPU benchmarks + + + + + + + for idle detection, check remote logins too + + + + + + + allow remote GUI RPC connections + + + + + + + + + port for GUI RPCs + + + + + + + redirect stdout and stderr to log files + + + + + + + use given dir as BOINC home + + + + + + + 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). + + + + + + + run as daemon + + + + + + + exit right before starting a job + + + + + + + exit right after finishing a job + + + + + + + disable app sandboxing + + + + + + + core client was launched by Manager + + + + + + + set by updater + + + + + + + Access control for GUI RPC + 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. + + + + SEE ALSO + + + + + COPYRIGHT + 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. + + diff --git a/doc/manpages/boinc_cmd.xml b/doc/manpages/boinc_cmd.xml new file mode 100644 index 0000000000..c8a3688ae9 --- /dev/null +++ b/doc/manpages/boinc_cmd.xml @@ -0,0 +1,514 @@ + + + + + + October 06, 2007"> + GNU"> +]> + + + + + + Frank + Thomas + frank@thomas-alfeld.de + + + + Peter + Bailis + pbailis@gmail.com + + + + 2007 + University of California + + &dhdate; + + + + &dhbinary; + 1 + + + + &dhbinary; + command line interface to the BOINC core client + + + + + &dhbinary; + --host hostname:port + --passwd passwd + command + + + &dhbinary; + -hV + + Notice that the order of the options is important. The --host and + --passwd options must precede any command. + + + + DESCRIPTION + The BOINC command tool (boinc_cmd) provides + a command line interface to a running BOINC core client. + + + + OPTIONS + + + + + + + + + Connect to the host hostname. + The default host is localhost. + + + + + + + + + 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. + + + + + + + Show a help message and all commands. + + + + + + + Show the version of the program. + + + + + + + COMMANDS + + + + + + + Show entire core client state. + + + + + + + Show all results. + + + + + + + Show all current file transfers. + + + + + + + Show status of all projects. + + + + + + + Show disk usage of all projects. + + + + + + + + + Do operation on a result. + + + + + + Temporarily stop work on a result. + + + + + + + Allow work on a result. + + + + + + + Permanently stop work on result. + + + + + + + Open graphics in a window. The optional desktop / + window_station (Windows) or display (X11) arguments + specify the display. + + + + + + + Open graphics fullscreen. + + + + + + + + + + + + Do operation on a project. + + + + + + Delete current work and get more. + + + + + + + Delete current work and don't get more. + + + + + + + Contact scheduling server. + + + + + + + Stop work for project. + + + + + + + Resume work for project. + + + + + + + Finish current work but don't get more. + + + + + + + Undo . + + + + + + + + + + + + Attach to an account via auth, the + authorization key from the project. + + + + + + + + + + + + + + + Set run mode. + + + + + + Do work (network + CPU) always. + + + + + + + Do work only when allowed by preferences. + + + + + + + Don't do work (same as suspending all projects). + + + + + + + + + + + + Set network mode. Like but + applies only to network transfers. + + + + + + + + + + + + + + + Set proxy settings. All fields are mandantory. + + + + + + + + + Show messages with sequence numbers beyond + seqno. + + + + + + + Show system information about the host where the BOINC core + client is running. + + + + + + + + + Instruct core client to contact an account manager + server. + + + + + + + Run CPU benchmarks. + + + + + + + + + + + + + Tell the core client to start or stop doing fullscreen + graphics, and going to black after + blank_time seconds. The optional + arguments specify which desktop / windows_station (Windows) or + display (X11) to use. + + + + + + + + + Fetch configuration at project located at + url. + + + + + + + + + + + + + + + + + + + + + + + Tell the core client to read the global_prefs_override.xml file + and incorporate any global preferences indicated there. + + + + + + + Reread the configuration file (cc_config.xml). + + + + + + + + + + + + + + + Stop the running BOINC core client. + + + + + + + SEE ALSO + + + + + COPYRIGHT + 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. + + diff --git a/doc/manpages/boincmgr.xml b/doc/manpages/boincmgr.xml new file mode 100644 index 0000000000..e230da7c5b --- /dev/null +++ b/doc/manpages/boincmgr.xml @@ -0,0 +1,117 @@ + + + + + + October 06, 2007"> + GNU"> +]> + + + + + Frank + Thomas + frank@thomas-alfeld.de + + + 2007 + University of California + + &dhdate; + + + + &dhbinary; + 1 + + + + &dhbinary; + The graphical BOINC manager for the core client. + + + + + &dhbinary; + + + + + DESCRIPTION + The BOINC manager (&dhbinary;) is a controling + and monitoring utility for the BOINC core client. + + + + OPTIONS + A full summary of options is included below. + + + + + + Show all options. + + + + + + + Generate verbose log messages. + + + + + + + Startup BOINC Manager so only the system tray icon is + visible. + + + + + + + Startup BOINC with these optional arguments. + + + + + + + Disable BOINC security users and permissions. + + + + + + + SEE ALSO + + + + + + + COPYRIGHT + 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. + +