'\" t ' # that line tells man to use tbl && col .\" @(#)$Header: /usr/aws/aws/src/reP/src/RCS/reP.man1,v 1.25 2000/01/09 02:02:05 dank Exp $ .\" ************************************************************** .\" Use this man page as a template for section 1 man pages in 2.0 .\" ************************************************************** .TH reP 1J $Date: 2000/01/09 02:02:05 $ .UC 4 .SH NAME .\" * name of component followed by a dash and a description (initial cap, .\" * no period) reP \- Producer that generates copies of a number of BTRS producer groups under a different name. .SH SYNOPSIS .\" * command syntax: put command name and parameters in bold and .\" * options in italics .B reP [\fB\-trace \fITrace\fR{on | off | 0 - 3}\fR] [\fB\-log \fILogging\fR{on | off}\fR] [\fB\-tp \fITracePath\fR] [\fB\-lp \fILogPath\fR] [\fB\-ep \fIEtcPath\fR] [\fB\-wt \fIWaitTimeout\fR] .SH DESCRIPTION .PP The BTRS Re-Producer process, .I reP, is designed to generate an exact copy of one or more BTRS producer groups, under a different name. This is used to facilitate multiple hops over WAN gateways. The outgoing producer group can be configured to request and re-produce instruments on demand whenever an application requests them, or request and re-produce every known instrument, regardless of application requests. The former is appropriate to interactive sources, whereas the latter is appropriate to broadcast sources. In the former case, it is also possible to specify a number of instruments that are to be watched regardless of any application requests; this provides a level of advanced cache management. .PP The BTRS producer groups are specified in the re-production file, .I reProducers.txt. .PP The re-producer starts off by reading in the re-production file, and then sets up any watches for any pre-watched instruments. In the case of producer groups where all instruments are to be watched, the re-producer watches the .I _plFolder instrument, and adds and deletes instruments in the outgoing producer group as they are added to and deleted from the incoming producer group. .PP If an ad-hoc request is received from an application, the instrument is requested from the incoming producer group. If this request is successful, the corresponding instrument is produced in the outgoing producer group. The initial request may be made as a record or a page, according to how the producer group in question is configured in .I reProducers.txt. If the responses indicates that the alternative is appropriate, a new request is made. .SH OPTIONS .\" * parameters (in bold) and options (in italics) followed by a description .IP "\fB\-trace \fITrace\fR{on | off | 0 - 3}" Specifies the level of trace to be dumped out. The trace file is called .I reP.out, and is located in the directory specified by the parameter .I TracePath (see below). Normally, trace should be left off, unless otherwise directed by JPA. The trace level may also be changed dynamically, by requesting the instrument .I trace= from the producer .I CTRLreP (see below). The request will be denied, but the trace level will be changed. .IP "\fB\-log \fILogging\fR{on | off}" Specifies whether significant events and errors are to be logged. The log file is called .I reP.log, and is located in the directory specified by the parameter .I LogPath (see below). .IP "\fB\-tp \fITracePath\fR" Specifies the location of the trace file, .I reP.out. .IP "\fB\-lp \fILogPath\fR" Specifies the location of the log file, .I reP.log. .IP "\fB\-ep \fIEtcPath\fR" Specifies the location of the re-production file, .I reProducers.txt (see below). .IP"\fB\-wt \fIWaitTimeout\fR" Specifies the time in seconds that the re-producer waits following a failure of the .I _plFolder instrument for an incoming producer group before re-requesting it. .SH DEFAULTS .\" * table of X11 defaults The following defaults are recognized by .I reP: .sp .TS box; c s s s c c c c l|l|l|l. DF Defaults = Xdefault Command Line Type Default Value _ Trace \-trace String off Logging \-log String off TracePath \-tp Path /usr/aws/jpa/tools/out LogPath \-lp Path /usr/aws/jpa/tools/log EtcPath \-ep Path /usr/aws/jpa/tools/etc WaitTimeout \-wt Integer 30 seconds .TE .SH CONTROL PRODUCER GROUP Commands may be issued to this producer group by requesting an instrument such as [=]. The re-producer will refuse to produce the instrument, with a suitably informative error message. The following commands may be issued: .IP "\fIadd=/\fR" This command requests that the specified instrument be added to the current list of those to be re-produced from the specified producer group, regardless of any application requests. .IP "\fItrace=\fR" This command changes the current trace level. Normally, trace should be left off (level 0), unless otherwise directed by JPA. .SH FILES .\" * tab-separated list of files used by the component and a description The re-production file, .I reProducers.txt specifies which incoming producer groups are to be watched, and what their outgoing producer group names are. It also specifies whether the re-producer should try first to see if incoming instruments are records or pages. Finally, it specifies whether instruments are to be re-produced on demand, or produced automatically, regardless of any application requests; in the latter case, this file specifies whether or not the entire producer group is to be re-produced, or only if certain specified instruments are to be re-produced. .PP This is an editable ASCII text file. Each line of this file consists of a keyword, followed by one or more parameters, separated by space or TAB characters. The following keywords may be used: .IP "\fIProducer\fR" This takes two mandatory parameters: the name of the incoming BTRS producer group and the name of the outgoing (re-produced) BTRS producer group. It may also take one or more optional parameters. At present, the only optional parameters are .I ALL, indicating that all the instruments in the producer group are to be re-produced regardless of any application requests, and .I PAGES, indicating that the re-producer should initially attempt to treat any application requests as page requests. By default, it treats application requests as record requests. .PP All subsequent lines up to the next .I Producer keyword relate to this producer group. .IP "\fIInstrument\fR" This takes one mandatory parameter: the name of an instrument (page or record). This specifies the name of an instrument that should be re-produced regardless of any application requests. If the current producer group is specified as type "ALL", lines of this type are redundant.