.\" Automatically generated by Pod::Man 2.25 (Pod::Simple 3.16)
.\"
.\" Standard preamble:
.\" ========================================================================
.de Sp \" Vertical space (when we can't use .PP)
.if t .sp .5v
.if n .sp
..
.de Vb \" Begin verbatim text
.ft CW
.nf
.ne \\$1
..
.de Ve \" End verbatim text
.ft R
.fi
..
.\" Set up some character translations and predefined strings.  \*(-- will
.\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
.\" double quote, and \*(R" will give a right double quote.  \*(C+ will
.\" give a nicer C++.  Capital omega is used to do unbreakable dashes and
.\" therefore won't be available.  \*(C` and \*(C' expand to `' in nroff,
.\" nothing in troff, for use with C<>.
.tr \(*W-
.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
.ie n \{\
.    ds -- \(*W-
.    ds PI pi
.    if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
.    if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\"  diablo 12 pitch
.    ds L" ""
.    ds R" ""
.    ds C` ""
.    ds C' ""
'br\}
.el\{\
.    ds -- \|\(em\|
.    ds PI \(*p
.    ds L" ``
.    ds R" ''
'br\}
.\"
.\" Escape single quotes in literal strings from groff's Unicode transform.
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.\"
.\" If the F register is turned on, we'll generate index entries on stderr for
.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
.\" entries marked with X<> in POD.  Of course, you'll have to process the
.\" output yourself in some meaningful fashion.
.ie \nF \{\
.    de IX
.    tm Index:\\$1\t\\n%\t"\\$2"
..
.    nr % 0
.    rr F
.\}
.el \{\
.    de IX
..
.\}
.\"
.\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
.\" Fear.  Run.  Save yourself.  No user-serviceable parts.
.    \" fudge factors for nroff and troff
.if n \{\
.    ds #H 0
.    ds #V .8m
.    ds #F .3m
.    ds #[ \f1
.    ds #] \fP
.\}
.if t \{\
.    ds #H ((1u-(\\\\n(.fu%2u))*.13m)
.    ds #V .6m
.    ds #F 0
.    ds #[ \&
.    ds #] \&
.\}
.    \" simple accents for nroff and troff
.if n \{\
.    ds ' \&
.    ds ` \&
.    ds ^ \&
.    ds , \&
.    ds ~ ~
.    ds /
.\}
.if t \{\
.    ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
.    ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
.    ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
.    ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
.    ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
.    ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
.\}
.    \" troff and (daisy-wheel) nroff accents
.ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
.ds 8 \h'\*(#H'\(*b\h'-\*(#H'
.ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
.ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
.ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
.ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
.ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
.ds ae a\h'-(\w'a'u*4/10)'e
.ds Ae A\h'-(\w'A'u*4/10)'E
.    \" corrections for vroff
.if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
.if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
.    \" for low resolution devices (crt and lpr)
.if \n(.H>23 .if \n(.V>19 \
\{\
.    ds : e
.    ds 8 ss
.    ds o a
.    ds d- d\h'-1'\(ga
.    ds D- D\h'-1'\(hy
.    ds th \o'bp'
.    ds Th \o'LP'
.    ds ae ae
.    ds Ae AE
.\}
.rm #[ #] #H #V #F C
.\" ========================================================================
.\"
.IX Title "Client 3pm"
.TH Client 3pm "2007-11-01" "perl v5.14.2" "User Contributed Perl Documentation"
.\" For nroff, turn off justification.  Always turn off hyphenation; it makes
.\" way too many mistakes in technical documents.
.if n .ad l
.nh
.SH "NAME"
RefDB::Client \- Perl extension for talking to a RefDB server
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
.Vb 1
\&    use RefDB::Client;
.Ve
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
RefDB::Client provides functions to talk to a refdbd process like the RefDB C clients do. This module isn't a wrapper for the C clients but uses native Perl code to talk to the server.
.SH "FEEDBACK"
.IX Header "FEEDBACK"
.Vb 1
\&    Send bug reports, questions, and comments to the refdb\-users mailing list at:
\&
\&    refdb\-users@lists.sourceforge.net
\&
\&    For list information and archives, please visit:
.Ve
.PP
http://lists.sourceforge.net/lists/listinfo/refdb\-users
.SH "AUTHOR"
.IX Header "AUTHOR"
.Vb 1
\&    Markus Hoenicka, markus@mhoenicka.de
.Ve
.SH "SEE ALSO"
.IX Header "SEE ALSO"
.Vb 1
\&    This module is part of the RefDB package, a reference manager and bibliography tool for markup languages. Please visit http://refdb.sourceforge.net for further information.
.Ve
.SS "new"
.IX Subsection "new"
.Vb 1
\&    Title   : new
\&
\&    Usage   : new RefDB::Risdata();
.Ve
.PP
Function: Creates a new Risdata object
.SS "read_ris"
.IX Subsection "read_ris"
.Vb 1
\&    Title   : read_ris
\&
\&    Usage   : $data\->read_ris($file);
.Ve
.PP
Function: loads \s-1RIS\s0 data from a file
.PP
Parameter: \f(CW$file:\fR path of file
.SS "get_ris"
.IX Subsection "get_ris"
.Vb 1
\&    Title   : get_ris
\&
\&    Usage   : $data\->get_ris();
.Ve
.PP
Function: returns previously loaded \s-1RIS\s0 data
.SS "new"
.IX Subsection "new"
.Vb 1
\&    Title   : new
\&
\&    Usage   : new RefDB::Simplelist;
.Ve
.PP
Function: creates a new Simplelist element
.SS "new"
.IX Subsection "new"
.Vb 1
\&    Title   : new
\&
\&    Usage   : new RefDB::Enigma;
.Ve
.PP
Function: creates a new Enigma element
.SS "new"
.IX Subsection "new"
.Vb 1
\&    Title   : new
\&
\&    Usage   : new RefDB::Client;
.Ve
.PP
Function: creates a new Client element
.SS "set_conninfo"
.IX Subsection "set_conninfo"
.Vb 1
\&    Title   : set_conninfo
\&
\&    Usage   : $client\->set_conninfo($server_ip, $port_address, $username, $password, $database, $pdf_root, $css_url, $timeout);
.Ve
.PP
Function: sets the initial connection parameters of a Client object
.PP
Parameter: \f(CW$server_ip:\fR \s-1IP\s0 address or hostname of the server that runs refdbd
.PP
Parameter: \f(CW$port_address:\fR Port address at which refdbd listens
.PP
Parameter: \f(CW$username:\fR Username for database password authentication
.PP
Parameter: \f(CW$password:\fR Password for database password authentication
.PP
Parameter: \f(CW$database:\fR Name of the reference database
.PP
Parameter: \f(CW$pdf_root:\fR Path of the root directory of all electronic offprints
.PP
Parameter: \f(CW$css_url:\fR \s-1URL\s0 of a Cascading Stylesheets file for (X)HTML output
.PP
Parameter: \f(CW$timeout:\fR time in seconds after which a stale connection is dropped
.SS "get_status"
.IX Subsection "get_status"
.Vb 1
\&    Title   : get_status
\&
\&    Usage   : $client\->get_status();
.Ve
.PP
Function: returns the numerical server status
.SS "get_status_msg"
.IX Subsection "get_status_msg"
.Vb 1
\&    Title   : get_status_msg
\&
\&    Usage   : $client\->get_status_msg();
.Ve
.PP
Function: returns the server status message
.SS "translate_status"
.IX Subsection "translate_status"
.Vb 1
\&    Title   : translate_status
\&
\&    Usage   : $client\->translate_status($status);
.Ve
.PP
Function: translates a given server status into a human readable message
.SS "get_data"
.IX Subsection "get_data"
.Vb 1
\&    Title   : get_data
\&
\&    Usage   : $client\->get_data();
.Ve
.PP
Function: returns the data of the most recent command
.SS "get_summary"
.IX Subsection "get_summary"
.Vb 1
\&    Title   : get_summary
\&
\&    Usage   : $client\->get_summary();
.Ve
.PP
Function: returns the summary of the most recent command
.SS "refdb_addstyle"
.IX Subsection "refdb_addstyle"
.Vb 1
\&    Title   : refdb_addstyle
\&
\&    Usage   : $client\->refdb_addstyle($styledata);
.Ve
.PP
Function: adds a citation/bibliography style to the database
.PP
Parameter: \f(CW$styledata:\fR \s-1XML\s0 data representing the bibliography style
.SS "refdb_adduser"
.IX Subsection "refdb_adduser"
.Vb 1
\&    Title   : refdb_adduser
\&
\&    Usage   : $client\->refdb_adduser($host, $database, $newuserpassword, $username);
.Ve
.PP
Function: adds new users to the database
.PP
Parameter: \f(CW$host:\fR host specification from which the user is allowed to connect
.PP
Parameter: \f(CW$database:\fR name of the reference database
.PP
Parameter: \f(CW$newuserpassword:\fR password (required only for new users)
.PP
Parameter: \f(CW$username:\fR name of the user, as used to authenticate at the database engine
.SS "refdb_deleteuser"
.IX Subsection "refdb_deleteuser"
.Vb 1
\&    Title   : refdb_deleteuser
\&
\&    Usage   : $client\->refdb_deleteuser($host, $database, $username);
.Ve
.PP
Function: deletes users from the database
.PP
Parameter: \f(CW$host:\fR host specification from which the user is allowed to connect
.PP
Parameter: \f(CW$database:\fR name of the reference database
.PP
Parameter: \f(CW$username:\fR name of the user, as used to authenticate at the database engine
.SS "refdb_addword"
.IX Subsection "refdb_addword"
.Vb 1
\&    Title   : refdb_addword
\&
\&    Usage   : $client\->refdb_addword($words);
\&
\& Function: adds reserved words to the main database
.Ve
.PP
Parameter: \f(CW$words:\fR space-separated list of words
.SS "refdb_deleteword"
.IX Subsection "refdb_deleteword"
.Vb 1
\&    Title   : refdb_deleteword
\&
\&    Usage   : $summary = $client\->refdb_deleteword($words);
.Ve
.PP
Function: removes reserved words from the main database
.PP
Parameter: \f(CW$words:\fR space-separated list of words
.SS "refdb_confserv"
.IX Subsection "refdb_confserv"
.Vb 1
\&    Title   : refdb_confserv
\&
\&    Usage   : $client\->refdb_confserv($command);
.Ve
.PP
Function: sends a configuration command to the server
.PP
Parameter: \f(CW$command:\fR the command proper, optionally followed by an argument
.SS "refdb_createdb"
.IX Subsection "refdb_createdb"
.Vb 1
\&    Title   : refdb_createdb
\&
\&    Usage   : $client\->refdb_createdb($dbname, $encoding);
.Ve
.PP
Function: creates a new database
.PP
Parameter: \f(CW$dbname:\fR name of the reference database
.PP
Parameter: \f(CW$encoding:\fR character encoding
.SS "refdb_deletedb"
.IX Subsection "refdb_deletedb"
.Vb 1
\&    Title   : refdb_deletedb
\&
\&    Usage   : $client\->refdb_deletedb($databasename);
.Ve
.PP
Function: deletes a reference database
.PP
Parameter: \f(CW$dbname:\fR name of the database
.SS "refdb_deletestyle"
.IX Subsection "refdb_deletestyle"
.Vb 1
\&    Title   : refdb_deletestyle
\&
\&    Usage   : $client\->refdb_deletestyle($stylename_regexp);
.Ve
.PP
Function: deletes citation/bibliography styles
.PP
Parameter: \f(CW$stylename_regexp:\fR regular expression describing the names of the styles to be deleted
.SS "refdb_getstyle"
.IX Subsection "refdb_getstyle"
.Vb 1
\&    Title   : refdb_getstyle
\&
\&    Usage   : $client\->refdb_getstyle($stylename);
.Ve
.PP
Function: retrieves a citation/bibliography style as a citestylex doc
.PP
Parameter: \f(CW$stylename:\fR name of the style
.SS "refdb_listdb"
.IX Subsection "refdb_listdb"
.Vb 1
\&    Title   : refdb_listdb
\&
\&    Usage   : $client\->refdb_listdb($dbname_regexp);
.Ve
.PP
Function: lists matching databases
.PP
Parameter: \f(CW$dbname_regexp:\fR regular expression describing the database names
.SS "refdb_listuser"
.IX Subsection "refdb_listuser"
.Vb 1
\&    Title   : refdb_listuser
\&
\&    Usage   : $client\->refdb_listuser($dbname, $username_regexp);
.Ve
.PP
Function: lists matching user names
.PP
Parameter: \f(CW$username_regexp:\fR regular expression describing the user names
.SS "refdb_listword"
.IX Subsection "refdb_listword"
.Vb 1
\&    Title   : refdb_listword
\&
\&    Usage   : $client\->refdb_listword($word_regexp);
.Ve
.PP
Function: lists matching journal name words
.PP
Parameter: \f(CW$wordname_regexp:\fR regular expression describing the word names
.SS "refdb_liststyle"
.IX Subsection "refdb_liststyle"
.Vb 1
\&    Title   : refdb_liststyle
\&
\&    Usage   : $client\->refdb_liststyle($stylename_regexp);
.Ve
.PP
Function: lists matching citation/bibliography styles
.PP
Parameter: \f(CW$stylename_regexp:\fR regular expression describing the style names
.SS "refdb_viewstat"
.IX Subsection "refdb_viewstat"
.Vb 1
\&    Title   : refdb_viewstat
\&
\&    Usage   : $client\->refdb_viewstat();
.Ve
.PP
Function: requests version/connection info from the server
.SS "refdb_scankw"
.IX Subsection "refdb_scankw"
.Vb 1
\&    Title   : refdb_scankw
\&
\&    Usage   : $client\->refdb_scankw($dbname);
.Ve
.PP
Function: runs a thorough keyword scan in the given database
.PP
Parameter: \f(CW$dbname:\fR name of the reference database
.SS "refdb_addref"
.IX Subsection "refdb_addref"
.Vb 1
\&    Title   : refdb_addref
\&
\&    Usage   : $client\->refdb_addref($owner, $refdata, $type, $encoding);
.Ve
.PP
Function: adds references to the database
.PP
Parameter: \f(CW$owner:\fR name of the dataset owner, if different from current user
.PP
Parameter: \f(CW$refdata:\fR string containing the reference data
.PP
Parameter: \f(CW$type:\fR data type, must be one of 'ris' or 'risx'
.PP
Parameter: \f(CW$encoding:\fR character encoding of the input data (only for \s-1RIS\s0 data)
.SS "refdb_updateref"
.IX Subsection "refdb_updateref"
.Vb 1
\&    Title   : refdb_updateref
\&
\&    Usage   : $client\->refdb_updateref($owner, $is_personal, $risdata, $type, $encoding);
.Ve
.PP
Function: updates references in the database
.PP
Parameter: \f(CW$owner:\fR name of the dataset owner, if different from current user
.PP
Parameter: \f(CW$is_personal:\fR set to 't' if only the personal information shall be updated
.PP
Parameter: \f(CW$refdata:\fR string containing the reference data
.PP
Parameter: \f(CW$type:\fR data type, must be one of 'ris' or 'risx'
.PP
Parameter: \f(CW$encoding:\fR character encoding of the input data (only for \s-1RIS\s0 data)
.SS "refdb_checkref"
.IX Subsection "refdb_checkref"
.Vb 1
\&    Title   : refdb_checkref
\&
\&    Usage   : $client\->refdb_checkref($risdata, $type, $encoding, $outtype);
.Ve
.PP
Function: checks references for duplicates in the database
.PP
Parameter: \f(CW$refdata:\fR string containing the reference data
.PP
Parameter: \f(CW$type:\fR data type, must be one of 'ris' or 'risx'
.PP
Parameter: \f(CW$encoding:\fR character encoding of the input data (only for \s-1RIS\s0 data)
.PP
.Vb 1
\&  Parameter: $outtype: output type (scrn|xhtml)
.Ve
.SS "refdb_deleteref"
.IX Subsection "refdb_deleteref"
.Vb 1
\&    Title   : refdb_deleteref
\&
\&    Usage   : $client\->refdb_deleteref($idlist);
.Ve
.PP
Function: deletes references from the database
.PP
Parameter: \f(CW$idlist:\fR string specifying the IDs of the references to be deleted
.SS "refdb_addnote"
.IX Subsection "refdb_addnote"
.Vb 1
\&    Title   : refdb_addnote
\&
\&    Usage   : $client\->refdb_addnote($owner, $xnotedata);
.Ve
.PP
Function: adds notes to the database
.PP
Parameter: \f(CW$owner:\fR owner of the note, if different from the current user
.PP
Parameter: \f(CW$xnotedata:\fR \s-1XML\s0 data specifying the note
.SS "refdb_updatenote"
.IX Subsection "refdb_updatenote"
.Vb 1
\&    Title   : refdb_updatenote
\&
\&    Usage   : $client\->refdb_updatenote($owner, $xnotedata);
.Ve
.PP
Function: updates references in the database
.PP
Parameter: \f(CW$owner:\fR owner of the note, if different from the current user
.PP
Parameter: \f(CW$xnotedata:\fR \s-1XML\s0 data specifying the note
.SS "refdb_deletenote"
.IX Subsection "refdb_deletenote"
.Vb 1
\&    Title   : refdb_deletenote
\&
\&    Usage   : $client\->refdb_deletenote($idlist);
.Ve
.PP
Function: deletes notes from the database
.PP
Parameter: \f(CW$idlist:\fR string specifying the \s-1ID\s0 values of the notes to be deleted
.SS "refdb_addlink"
.IX Subsection "refdb_addlink"
.Vb 1
\&    Title   : refdb_addlink
\&
\&    Usage   : $client\->refdb_addlink($linkspec);
.Ve
.PP
Function: links notes to database objects
.PP
Parameter: \f(CW$linkspec:\fR string specifying the link(s) to be created
.SS "refdb_deletelink"
.IX Subsection "refdb_deletelink"
.Vb 1
\&    Title   : refdb_deletelink
\&
\&    Usage   : $client\->refdb_deletelink($linkspec);
.Ve
.PP
Function: unlinks notes from database objects
.PP
Parameter: \f(CW$linkspec:\fR string specifying the link(s) to be deleted
.SS "refdb_getas"
.IX Subsection "refdb_getas"
.Vb 1
\&    Title   : refdb_getas
\&
\&    Usage   : $client\->refdb_getas($limit_string, $freq, $name_regexp);
\&
\& Function: retrieves matching series authors
\&
\&  Parameter: $limit_string: specifies limit and offset
\& 
\&  Parameter: $freq: requests frequency information ("freq" | "relfreq")
\&
\&  Parameter: $name_regexp: regular expression describing the names to be retrieved
.Ve
.SS "refdb_getau"
.IX Subsection "refdb_getau"
.Vb 1
\&    Title   : refdb_getau
\&
\&    Usage   : $client\->refdb_getau($limit_string, $freq, $name_regexp);
.Ve
.PP
Function: retrieves matching part authors
.PP
Parameter: \f(CW$limit_string:\fR specifies limit and offset
.PP
Parameter: \f(CW$freq:\fR requests frequency information (\*(L"freq\*(R" | \*(L"relfreq\*(R")
.PP
Parameter: \f(CW$name_regexp:\fR regular expression describing the names to be retrieved
.SS "refdb_getax"
.IX Subsection "refdb_getax"
.Vb 1
\&    Title   : refdb_getax
\&
\&    Usage   : $client\->refdb_getax($limit_string, $freq, $name_regexp);
.Ve
.PP
Function: retrieves matching authors/editors (all levels)
.PP
Parameter: \f(CW$limit_string:\fR specifies limit and offset
.PP
Parameter: \f(CW$freq:\fR requests frequency information (\*(L"freq\*(R" | \*(L"relfreq\*(R")
.PP
Parameter: \f(CW$name_regexp:\fR regular expression describing the names to be retrieved
.SS "refdb_geted"
.IX Subsection "refdb_geted"
.Vb 1
\&    Title   : refdb_geted
\&
\&    Usage   : $client\->refdb_geted($limit_string, $freq, $name_regexp);
.Ve
.PP
Function: retrieves matching publication authors/editors
.PP
Parameter: \f(CW$limit_string:\fR specifies limit and offset
.PP
Parameter: \f(CW$freq:\fR requests frequency information (\*(L"freq\*(R" | \*(L"relfreq\*(R")
.PP
Parameter: \f(CW$name_regexp:\fR regular expression describing the names to be retrieved
.SS "refdb_getkw"
.IX Subsection "refdb_getkw"
.Vb 1
\&    Title   : refdb_getkw
\&
\&    Usage   : $client\->refdb_getkw($limit_string, $freq, $keyword_regexp);
.Ve
.PP
Function: retrieves matching keywords
.PP
Parameter: \f(CW$limit_string:\fR specifies limit and offset
.PP
Parameter: \f(CW$freq:\fR requests frequency information (\*(L"freq\*(R" | \*(L"relfreq\*(R")
.PP
Parameter: \f(CW$keyword_regexp:\fR regular expression describing the keywords to be retrieved
.SS "refdb_getjf"
.IX Subsection "refdb_getjf"
.Vb 1
\&    Title   : refdb_getjf
\&
\&    Usage   : $client\->refdb_getjf($is_all, $limit_string, $freq, $journal_regexp);
.Ve
.PP
Function: retrieves matching periodicals (full names)
.PP
Parameter: \f(CW$is_all:\fR set to 't' if all synonymous journal names shall be returned
.PP
Parameter: \f(CW$limit_string:\fR specifies limit and offset
.PP
Parameter: \f(CW$freq:\fR requests frequency information (\*(L"freq\*(R" | \*(L"relfreq\*(R")
.PP
Parameter: \f(CW$name_regexp:\fR regular expression describing the names to be retrieved
.SS "refdb_getjo"
.IX Subsection "refdb_getjo"
.Vb 1
\&    Title   : refdb_getjo
\&
\&    Usage   : $client\->refdb_getjo($is_all, $limit_string, $freq, $journal_regexp);
.Ve
.PP
Function: retrieves matching periodical names (abbrev)
.PP
Parameter: \f(CW$is_all:\fR set to 't' if all synonymous journal names shall be returned
.PP
Parameter: \f(CW$limit_string:\fR select limit and offset
.PP
Parameter: \f(CW$freq:\fR requests frequency information (\*(L"freq\*(R" | \*(L"relfreq\*(R")
.PP
Parameter: \f(CW$name_regexp:\fR regular expression describing the names to be retrieved
.SS "refdb_getj1"
.IX Subsection "refdb_getj1"
.Vb 1
\&    Title   : refdb_getj1
\&
\&    Usage   : $client\->refdb_getj1($is_all, $limit_string, $freq, $journal_regexp);
.Ve
.PP
Function: retrieves matching periodical names (custom abbrev 1)
.PP
Parameter: \f(CW$is_all:\fR set to 't' if all synonymous journal names shall be returned
Parameter: \f(CW$limit_string:\fR select limit and offset
.PP
Parameter: \f(CW$freq:\fR requests frequency information (\*(L"freq\*(R" | \*(L"relfreq\*(R")
.PP
Parameter: \f(CW$name_regexp:\fR regular expression describing the names to be retrieved
.SS "refdb_getj2"
.IX Subsection "refdb_getj2"
.Vb 1
\&    Title   : refdb_getj2
\&
\&    Usage   : $client\->refdb_getj2($is_all, $limit_string, $freq, $journal_regexp);
.Ve
.PP
Function: retrieves matching periodical names (custom abbrev 2)
.PP
Parameter: \f(CW$is_all:\fR set to 't' if all synonymous journal names shall be returned
.PP
Parameter: \f(CW$limit_string:\fR select limit and offset
.PP
Parameter: \f(CW$freq:\fR requests frequency information (\*(L"freq\*(R" | \*(L"relfreq\*(R")
.PP
Parameter: \f(CW$name_regexp:\fR regular expression describing the names to be retrieved
.SS "refdb_getref"
.IX Subsection "refdb_getref"
.Vb 1
\&    Title   : refdb_getref
\&
\&    Usage   : $client\->refdb_getref($type, $format_string, $sort_string, $listname, $encoding, $limit_string, $frequency, $query_string);
.Ve
.PP
Function: retrieves references
.PP
Parameter: \f(CW$type:\fR select output format
.PP
Parameter: \f(CW$format_string:\fR specify additional fields to be retrieved
.PP
Parameter: \f(CW$sort_string:\fR specify sorting key
.PP
Parameter: \f(CW$listname:\fR optional name of a personal reference list
.PP
Parameter: \f(CW$encoding:\fR the character encoding for the output data
.PP
Parameter: \f(CW$limit_string:\fR specifies limit and offset
.PP
Parameter: \f(CW$frequency:\fR if \*(L"t\*(R", include frequency information in output
.PP
Parameter: \f(CW$query_string:\fR the query that describes the datasets to be retrieved
.SS "refdb_countref"
.IX Subsection "refdb_countref"
.Vb 1
\&    Title   : refdb_countref
\&
\&    Usage   : $client\->refdb_countref($listname, $limit_string, $query_string);
.Ve
.PP
Function: counts references
.PP
Parameter: \f(CW$listname:\fR optional name of a personal reference list
.PP
Parameter: \f(CW$limit_string:\fR specifies limit and offset
.PP
Parameter: \f(CW$query_string:\fR the query that describes the datasets to be retrieved
.SS "refdb_pickref"
.IX Subsection "refdb_pickref"
.Vb 1
\&    Title   : refdb_pickref
\&
\&    Usage   : $client\->refdb_pickref($idlist, $listname);
.Ve
.PP
Function: adds references to a personal reference list
.PP
Parameters: \f(CW$idlist:\fR specifies the \s-1ID\s0 values of the references to be picked
            \f(CW$listname:\fR name of the personal reference list. If the string
                       is empty, use the default personal reference list
.SS "refdb_dumpref"
.IX Subsection "refdb_dumpref"
.Vb 1
\&    Title   : refdb_dumpref
\&
\&    Usage   : $client\->refdb_dumpref($idlist, $listname);
.Ve
.PP
Function: removes references from a personal reference list
.PP
Parameters: \f(CW$idlist:\fR specifies the \s-1ID\s0 values of the references to be dumped
            \f(CW$listname:\fR name of the personal reference list. If the string
                       is empty, use the default personal reference list
.SS "refdb_getnote"
.IX Subsection "refdb_getnote"
.Vb 1
\&    Title   : refdb_getnote
\&
\&    Usage   : $client\->refdb_getnote($type, $format_string, $sort_string, $encoding, $limit_string, $query_string);
.Ve
.PP
Function: retrieves references
.PP
Parameter: \f(CW$type:\fR select output format
.PP
Parameter: \f(CW$format_string:\fR specify additional fields to be retrieved
.PP
Parameter: \f(CW$sort_string:\fR specify sorting key
.PP
Parameter: \f(CW$encoding:\fR the character encoding for the output data
.PP
Parameter: \f(CW$limit_string:\fR specifies limit and offset
.PP
Parameter: \f(CW$query_string:\fR the query that describes the datasets to be retrieved
.SS "refdb_countnote"
.IX Subsection "refdb_countnote"
.Vb 1
\&    Title   : refdb_countnote
\&
\&    Usage   : $client\->refdb_countnote($listname, $limit_string, $query_string);
.Ve
.PP
Function: counts extended notes
.PP
Parameter: \f(CW$listname:\fR optional name of a personal reference list
.PP
Parameter: \f(CW$limit_string:\fR specifies limit and offset
.PP
Parameter: \f(CW$query_string:\fR the query that describes the datasets to be retrieved
.SS "refdb_selectdb"
.IX Subsection "refdb_selectdb"
.Vb 1
\&    Title   : refdb_selectdb
\&
\&    Usage   : $client\->refdb_selectdb($dbname);
.Ve
.PP
Function: selects an existing database as the current database
.PP
Parameter: \f(CW$dbname:\fR name of the reference database
.SS "refdb_whichdb"
.IX Subsection "refdb_whichdb"
.Vb 1
\&    Title   : refdb_whichdb
\&
\&    Usage   : $client\->refdb_whichdb();
.Ve
.PP
Function: displays information about the current database
.SS "refdb_updatejo"
.IX Subsection "refdb_updatejo"
.Vb 1
\&    Title   : refdb_updatejo
\&
\&    Usage   : $client\->refdb_updatejo($updaterequest);
.Ve
.PP
Function: updates journal name synonyms
.SS "refdb_texbib"
.IX Subsection "refdb_texbib"
.Vb 1
\&    Title   : refdb_texbib
\&
\&    Usage   : $client\->refdb_texbib($style, $cite_data);
.Ve
.PP
Function: retrieves a bibliography in bibtex format based on citationlistx data
.PP
Parameter: \f(CW$style:\fR the name of the citation/bibliography style
.PP
Parameter: \f(CW$cite_data:\fR \s-1XML\s0 data describing the references
.SS "refdb_dbib"
.IX Subsection "refdb_dbib"
.Vb 1
\&    Title   : refdb_dbib
\&
\&    Usage   : $client\->refdb_dbib($type, $style, $encoding, $cite_data);
.Ve
.PP
Function: retrieves a cooked \s-1XML/SGML\s0 bibliography based on citationlistx data
.PP
Parameter: \f(CW$type:\fR type of the bibliography output
.PP
Parameter: \f(CW$style:\fR name of the citation/bibliography style
.PP
Parameter: \f(CW$encoding:\fR character encoding of the output data
.PP
Parameter: \f(CW$cite_data:\fR \s-1XML\s0 data specifying the references
.SS "refdb_getrefx"
.IX Subsection "refdb_getrefx"
.Vb 1
\&    Title   : refdb_getrefx
\&
\&    Usage   : $client\->refdb_getrefx($type, $encoding, $cite_data);
.Ve
.PP
Function: retrieves a raw \s-1XML/SGML\s0 bibliography based on citationlistx data
.PP
Parameter: \f(CW$type:\fR type of the bibliography output
.PP
Parameter: \f(CW$encoding:\fR character encoding of the output data
.PP
Parameter: \f(CW$cite_data:\fR \s-1XML\s0 data specifying the references