Changes between Version 87 and Version 88 of WrapperApp

Timestamp:

Jul 4, 2014, 12:06:46 PM (10 years ago)

Author:

davea

Comment:

--

WrapperApp

@@ -3 +3 @@
 = The BOINC Wrapper =
 
-Any existing application (or sequence of applications)
+An existing application (or sequence of applications)
 can be run under BOINC using a '''wrapper''' program supplied by BOINC.
 The wrapper runs the applications as subprocesses,
@@ -84 +84 @@
   This is used by the wrapper to report overall fraction done.
  '''exec_dir''':: The directory to start the application in (relative to slot, or use the $PROJECT_DIR macro)
- '''multi_process''':: Include this if the application creates multiple processes.  '''Note: each parent process must wait for its children to exit.'''
- '''setenv''':: Environmental variable needed for the applications run-time environment - you can have more than one <setenv> entry, use the VARNAME=VAR_VALUE form, e.g. LD_LIBRARY_PATH=$PROJECT_DIR:$LD_LIBRARY_PATH.  You can also use the $NTHREADS or $GPU_DEVICE_NUM macro.
- '''daemon''':: Denotes that this task is a 'daemon' process that should run in the background asynchronously while the other tasks are run sequentially.  The wrapper will shut down this daemon when the last task has exited
- '''append_cmdline_args''':: if set, the wrapper's command-line arguments (specified in the [JobTemplates#Inputtemplates input template]) are passed to the worker program, after those in <command_line>.
- '''time_limit''':: if given, kill the task after the given amount of elapsed (running) time.  Note: on Windows, tasks are killed using !TerminateProcess(), which doesn't flush stdio buffers; take this into account.
+ '''multi_process''':: Include this if the application creates multiple processes.
+   '''Note: each parent process must wait for its children to exit.'''
+ '''setenv''':: Environment variable needed by the applications.
+   You can have more than one <setenv> entry.
+   Use the VARNAME=VAR_VALUE form, e.g. LD_LIBRARY_PATH=$PROJECT_DIR:$LD_LIBRARY_PATH.
+   You can also use the $NTHREADS or $GPU_DEVICE_NUM macro.
+ '''daemon''':: this task is a 'daemon' process that should run in the background asynchronously
+    while the other tasks are run sequentially.
+    The wrapper will shut down this daemon when the last task has exited.
+ '''append_cmdline_args''':: if set, the wrapper's command-line arguments
+   (specified in the [JobTemplates#Inputtemplates input template])
+    are passed to the worker program, after those in <command_line>.
+ '''time_limit''':: if given, kill the task after the given amount of elapsed (running) time.
+    Note: on Windows, tasks are killed using !TerminateProcess(),
+    which doesn't flush stdio buffers; take this into account.
 
 The job file can specify multiple tasks.
@@ -103 +113 @@
 
 The wrapper can optionally zip output files:
- '''zip_output''':: after all tasks are completed, the wrapper will zip output files (specified by one or more regular expressions) into a zip file with the given name.
+ '''zip_output''':: after all tasks are completed,
+    the wrapper will zip output files (specified by one or more regular expressions) into a zip file with the given name.
 
 Notes:
@@ -120 +131 @@
   You will therefore want to make and track different versions for each app_version you are supporting.
 
+== Command-line options ==
+
+The wrapper has the following command-line options:
+
+ '''--device N''': macro-substitute N for '''$GPU_DEVICE_NUM'''
+   in worker command lines and environment variables.
+ '''--nthreads X''': macro-substitute X for '''$NTHREADS'''
+   in worker command lines and environment variables.
+ '''--trickle X''': send a trickle-up message reporting runtime every X seconds.
+
 == Example ==
 
@@ -240 +261 @@
 The homepage is [http://genwrapper.sourceforge.net here],
 and documentation is [http://sourceforge.net/apps/trac/genwrapper/wiki/manual here].
-
-
-
-