/ 
UMLS-Similarity-1.47
River stage one • 1 direct dependent • 1 total dependent
/ umls_similarity_server.pl

NAME

umls_similarity_server.pl - [Web] The backend UMLS::Similarity server for the Web Interface

SYNOPSIS

Usage: umls_similarity_server.pl [--port PORTNUMBER] [--logfile LOGFILE] [--maxchild NUM] | --help | --version

DESCRIPTION

This script implements the backend of the web interface for UMLS::Similarity.

This script listens to a port waiting for a request form similarity.cgi or wps.cgi. The client script sends a message to this script as series of queries (see QUERY FORMAT). After all the queries, the client sends a message containing only CRLF (carriage-return line-feed, or \015\012).

The server (this script) responds with the results (see MESSAGE FORMAT) terminated by a message containing only CRLF.

Example:

Client:
g car#n#1CRLF
CRLF

Sever responds:
g car#n#1 4-wheeled motor vehicle; usually propelled by an internal
combustion engine; "he needs a car to get to work"CRLF
CRLF

OPTIONS

--port=PORTNUMBER Specify the port PORTNUMBER for the server to listen on.

--logfile=LOGFILE The output LOGFILE where any error or warning messages should be written out.

--maxchild=NUM Specify the maximum number NUM of the processes that should be forked to handle the requests.

--help Display the help message and quit.

--version Display the version information and quit.

QUERY FORMAT

<CRLF> means carriage-return line-feed "\r\n" on Unix, "\n\r" on Macs, \015\012 everywhere and anywhere (i.e., don't use \n or \r, use \015\012).

The queries consist of messages in the following formats:

s <word1> <word2><CRLF> - server will return all senses of word1 and
word2

g <word><CRLF> - server will return the gloss for each synset to which
word belongs

r <wps1> <wps2> <measure> <etc...><CRLF> - server will return the
relatedness of wps1 and wps2 using measure.

v <CRLF> - get version information

MESSAGE FORMAT

The messages sent from this server will be in the following formats:

! <msg><CRLF> - indicates an error or warning

g <wps> <gloss><CRLF> - the gloss of wps

r <wps1> <wps2> <score><CRFL> - the relatedness score of wps1 and wps2

t <msg><CRLF> - the trace output for the previous relatedness score

s <wps1> <wps2> ... <wpsN><CRLF> - a synset

v <package> <version number><CRLF> - the version of 'package' being used

BUGS

Report to UMLS::Similarity mailing list : http://groups.yahoo.com/group/umls-similarity

SEE ALSO

UMLS::Similarity

AUTHORS

Ted Pedersen, University of Minnesota, Duluth
tpederse at d.umn.edu

Bridget T McInnes
bthomson at umn.edu

Jason Michelizzi

COPYRIGHT

Copyright (c) 2005-2011, Ted Pedersen, Jason Michelizzi and Bridget T McInnes

This program is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 2 of the License, or (at your option) any later version. This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.

You should have received a copy of the GNU General Public License along with this program; if not, write to:

The Free Software Foundation, Inc., 
59 Temple Place - Suite 330, 
Boston, MA  02111-1307, USA.