<?xml version="1.0" ?> <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> <html xmlns="http://www.w3.org/1999/xhtml"> <head> <title>rdict</title> </head> <body> <h1><a name="label-0" id="label-0">NAME</a></h1><!-- RDLabel: "NAME" --> <p>rdict - a DICT protocol client</p> <h1><a name="label-1" id="label-1">SYNOPSIS</a></h1><!-- RDLabel: "SYNOPSIS" --> <pre>rdict [-h|--host server] [-p|--port service] [-d|--database dbname] [-m|--match] [-s|--strategy strategy] [-C|--nocorrect] [-D|--dbs] [-S|--strats] [-H|--serverhelp] [-i|--info dbname] [-I|--serverinfo] [-T|--status] [-b|--debug] [-u|--user user] [-k|--key key] [-v|--verbose] word1 [word2 ... wordn] rdict [--help|-v|--version]</pre> <h1><a name="label-2" id="label-2">DESCRIPTION</a></h1><!-- RDLabel: "DESCRIPTION" --> <p>rdict is an <a href="ftp://ftp.isi.edu/in-notes/rfc2229.txt">RFC 2229</a> compliant Dictionary Server Protocol (DICT) client that provides access to dictionary definitions from a set of natural language dictionary databases.</p> <h1><a name="label-3" id="label-3">OPTIONS</a></h1><!-- RDLabel: "OPTIONS" --> <dl> <dt><a name="label-4" id="label-4">-h <em>server</em> or --host <em>server</em></a></dt><!-- RDLabel: "-h server or ­­host server" --> <dd> Specifies the hostname for the DICT server. If no servers are specified, the default behavior is to try dict.org, followed by alt0.dict.org. </dd> <dt><a name="label-5" id="label-5">-p <em>port</em> or --port <em>port</em></a></dt><!-- RDLabel: "-p port or ­­port port" --> <dd> Specifies the port (e.g. 2628) or service (e.g. dict) for connections. The default is 2628, as specified in the DICT Protocol RFC. </dd> <dt><a name="label-6" id="label-6">-d <em>dbname</em> or --database <em>dbname</em></a></dt><!-- RDLabel: "-d dbname or ­­database dbname" --> <dd> Specifies a specific database to search. The default is to search all databases (a '*' from the DICT protocol). Note that a '!' in the DICT protocol means to search all of the databases until a match is found, and then stop searching. </dd> <dt><a name="label-7" id="label-7">-m or --match</a></dt><!-- RDLabel: "-m or ­­match" --> <dd> Instead of printing a definition, perform a match using the specified strategy. </dd> <dt><a name="label-8" id="label-8">-s <em>strategy</em> or --strategy <em>strategy</em></a></dt><!-- RDLabel: "-s strategy or ­­strategy strategy" --> <dd> Specify a matching strategy. By default, the server default match strategy is used. This is usually 'exact' for definitions, and a server-defined optimal spelling correction strategy for matches ('.' from the DICT protocol). The available strategies are dependent on the server implementation. For a list of available strategies, see the -S or --strats option. </dd> <dt><a name="label-9" id="label-9">-C or --nocorrect</a></dt><!-- RDLabel: "-C or ­­nocorrect" --> <dd> Usually, if a definition is requested and the word cannot be found, spelling correction is requested from the server, and a list of possible words are provided. This option disables the generation of this list. </dd> <dt><a name="label-10" id="label-10">-D or --dbs</a></dt><!-- RDLabel: "-D or ­­dbs" --> <dd> Query the server and display a list of available databases. </dd> <dt><a name="label-11" id="label-11">-S or --strats</a></dt><!-- RDLabel: "-S or ­­strats" --> <dd> Query the server and display a list of available search strategies. </dd> <dt><a name="label-12" id="label-12">-H or --serverhelp</a></dt><!-- RDLabel: "-H or ­­serverhelp" --> <dd> Query the server and display the help information that it provides. </dd> <dt><a name="label-13" id="label-13">-i <em>dbname</em> or --info <em>dbname</em></a></dt><!-- RDLabel: "-i dbname or ­­info dbname" --> <dd> Request information on the specified database (usually the server will provide origination, descriptive or other information about the database or its contents). </dd> <dt><a name="label-14" id="label-14">-I or --serverinfo</a></dt><!-- RDLabel: "-I or ­­serverinfo" --> <dd> Query the server and display information about the server. </dd> <dt><a name="label-15" id="label-15">-T or --status</a></dt><!-- RDLabel: "-T or ­­status" --> <dd> Query the server for status information. </dd> <dt><a name="label-16" id="label-16">-u <em>user</em> or --user <em>user</em></a></dt><!-- RDLabel: "-u user or ­­user user" --> <dd> Specifies the username for authentication. </dd> <dt><a name="label-17" id="label-17">-k <em>key</em> or --key <em>key</em></a></dt><!-- RDLabel: "-k key or ­­key key" --> <dd> Specifies the shared secret for authentication. </dd> <dt><a name="label-18" id="label-18">-V or --version</a></dt><!-- RDLabel: "-V or ­­version" --> <dd> Display version information. </dd> <dt><a name="label-19" id="label-19">--help</a></dt><!-- RDLabel: "­­help" --> <dd> Display help information. </dd> <dt><a name="label-20" id="label-20">-v or --verbose</a></dt><!-- RDLabel: "-v or ­­verbose" --> <dd> Be verbose. </dd> <dt><a name="label-21" id="label-21">-b or --debug</a></dt><!-- RDLabel: "-b or ­­debug" --> <dd> Display debugging information. This is long-winded, as the entire protocol exchange will be dumped. </dd> </dl> <h1><a name="label-22" id="label-22">EXAMPLES</a></h1><!-- RDLabel: "EXAMPLES" --> <dl> <dt><a name="label-23" id="label-23">$ rdict -D</a></dt><!-- RDLabel: "$ rdict -D" --> <dd> This will provide you with a list of databases you can query. </dd> <dt><a name="label-24" id="label-24">$ rdict -S</a></dt><!-- RDLabel: "$ rdict -S" --> <dd> This will provide you with a list of strategies you can employ to match words. </dd> <dt><a name="label-25" id="label-25">$ rdict -m -s prefix foo</a></dt><!-- RDLabel: "$ rdict -m -s prefix foo" --> <dd> This shows you a list of all words that begin with 'foo' in all of the databases. </dd> <dt><a name="label-26" id="label-26">$ rdict -s re '^(cu|ke)rb$'</a></dt><!-- RDLabel: "$ rdict -s re '^(cu|ke)rb$'" --> <dd> This shows you all the definitions relating to both 'curb' and 'kerb' from all the databases. The 're' strategy allows regular expression matching. </dd> <dt><a name="label-27" id="label-27">$ rdict -m -s suffix fix</a></dt><!-- RDLabel: "$ rdict -m -s suffix fix" --> <dd> This shows a list of all words that end in 'fix' in all of the databases. </dd> <dt><a name="label-28" id="label-28">$ rdict -d jargon -m -s prefix ''</a></dt><!-- RDLabel: "$ rdict -d jargon -m -s prefix ''" --> <dd> This displays a list of all the entries in the 'jargon' database. </dd> </dl> <h1><a name="label-29" id="label-29">AUTHOR</a></h1><!-- RDLabel: "AUTHOR" --> <p>Written by Ian Macdonald <ian@caliban.org></p> <h1><a name="label-30" id="label-30">COPYRIGHT</a></h1><!-- RDLabel: "COPYRIGHT" --> <pre>Copyright (C) 2002-2007 Ian Macdonald This is free software; see the source for copying conditions. There is NO warranty; not even for MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.</pre> <h1><a name="label-31" id="label-31">SEE ALSO</a></h1><!-- RDLabel: "SEE ALSO" --> <ul> <li><a href="http://www.caliban.org/ruby/">Ruby/DICT home page - http://www.caliban.org/ruby/</a></li> <li><!-- Reference, RDLabel "dict(3)" doesn't exist --><em class="label-not-found">dict(3)</em><!-- Reference end --></li> <li><a href="http://www.dict.org/">The DICT development group - http://www.dict.org/</a></li> <li><a href="ftp://ftp.isi.edu/in-notes/rfc2229.txt">RFC 2229 - ftp://ftp.isi.edu/in-notes/rfc2229.txt</a></li> </ul> <h1><a name="label-32" id="label-32">BUGS</a></h1><!-- RDLabel: "BUGS" --> <ul> <li>MIME is not implemented</li> <li>command pipelining is not implemented</li> <li>URL parsing is not implemented</li> </ul> </body> </html>