.TH "fxsproxy" 1 "June 26, 2009"
.SH NAME
fxsproxy \- A proxy to process ALICE TRD FEE configuration
.SH SYNOPSIS
.B /etc/rc.d/init.d/fxsproxy
[start|stop|restart|reload|status|force-start]
.PP
.B fxsproxy
[config_file] [bg]
.SH DESCRIPTION
fxsproxy is a tool for the acquisition of all TRD FEE configuration data via DIM acknowledge channel, triggered by a DIM command consisting of the run number. This command can be launched from everywhere, as default from within the PVSS SOR/EOR scripts.

All data is in XML format. A XSL style sheet is provided to visualize a digest of the data within a web bowser e.g. firefox.

The resulting summary file is finally copied to the DCS FXS (file exchange server) und registered in the corresponding DCS FXS MySQL DB. It is also kept temporarily locally for debugging purposes.

When the program is running in the background, all output is reported to syslog with serverity LOG_INFO; thus, it is logged in /var/log/messages. Since only users with root privileges are able to read this file a copy of the output may be logged to /tmp/fxs.log. If you do not tell fxsproxy to run in the background all messages will be sent to sdtout.

Unless there is an error the fxsproxy should run without intervention. If the confiuration needs to be reloaded then one can either use 
.B fxsproxy_testrealod
or send it a 
.B SIGUSR1 
signal to gracefully reload the configuration file with out stopping and starting the program.
.PP
.SH OPERATION
In standard operation the fxsproxy should be running as a background process. Like this, it can be operated via /etc/rc.d/init.d/fxsproxy [argument] while possible arguments are the following:
.TP
start
Starts the program in standard mode.
.TP
stop
Stops the program.
.TP
restart
Does stop and start in one go.
.TP
reload
Gracefully reloads the configuration file without restarting fxsproxy.
.TP
status
Checks the status of the program.
.TP
force-start
After killing the program or after a crash (what of course shouldn't happen) the lock file (that prevents from multiple startups) is not removed. To get the program starting delete it before or use this option.
.PP
Another way of running the fxsproxy is from command line with the synopsis as listed above (fxsproxy [config_file] [bg]). All arguments are optional. If no argument is provided the configuration is read out from the standard file (see FILES). 
If a full path and file name is provided this file is taken as config file instead. 
If a second argument is given (just the existence of a second argument is checked) the program is started as a forked background process with closed standard output.

The possibility of starting the fxsproxy from command line is only intended for debugging purposes.
.SH FILES
.TP
/etc/rc.d/init.d/fxsproxy
the service script for starting the fxsproxy as a daemon (bash)
.TP
/etc/trd/fxsproxy.conf
the file including all config information of the proxy itself - see chapter CONFIGURATION (ascii)
.TP
/etc/trd/fxsproxy_xml_displayer.xsl
the style sheet for viewing the xml output in a browser (xsl)
.SH CONFIGURATION
Currently the following settings are supported:
.TP
TIMEOUT 
This is the maximum number of attempts to retreive information of a DCS board (waiting one second between two attempts).
.TP
TEMPDIR
This is the place for the temporary storage of the XML file.
.TP
WORKINGDIR
This is the directory where the program will change to while collecting all the information needed for the XML generation.
.TP
FXSSCRIPT
This is the full path to the script that that copies the XML data to the FXS.
.TP
FILESTACKSIZE
How many XML summary files of preceding runs to be kept in temporary local storage (TEMPDIR).
.TP
FEETAG
This is the actual wing_db tag for requesting the config information of the DCS boards.
.TP
FILENAME
This is the name of the resulting xml file.
.TP
LOGFILE
This is the full path of the the file to which fxsproxy will save a copy of its output for debugging/monitoring purposes.
.TP
LOGTOSYSLOG
Takes a boolean value of either true or false, if true, it will send a copy of the output from fxsproxy to the system logger deamon using syslog().
.TP
DIMDNSNODE
If the program is started as a background process the environmental variable DIM_DNS_NODE is not accessible for it and needs to be specified here.
.SH SIGNALS
.TP
SIGUSR1 
May be sent to fxsproxy to tell it to reload its configuration file. This can be done with the following command: "kill -SIGUSR1 `pidof fsxproxy`"
.SH ERRORS
If errors occur, they are reported to LOG_INFO. Codes of known errors are:
.TP
\-1
failed writing xml head to file
.TP
\-2
failed writing xml foot to file
.TP
\-3
failed writing xml data to file
.TP
\-5
no valid tag issued
.TP
\-6
FXS error
.SH AUTHOR
Written by Frederick Kramer
.SH REPORTING BUGS
Report bugs to Frederick.Kramer@cern.ch
.SH "SEE ALSO"
fxsproxy_testclient(1), fxsproxy_testreload(1)