/usr/share/doc/refdb/refdb-manual/re11.html is in refdb-doc 1.0.2-3ubuntu1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 | <?xml version="1.0" encoding="UTF-8" standalone="no"?>
<!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><meta http-equiv="Content-Type" content="text/html; charset=UTF-8" /><title>refdbc</title><link rel="stylesheet" type="text/css" href="manual.css" /><meta name="generator" content="DocBook XSL Stylesheets V1.79.1" /><link rel="home" href="index.html" title="RefDB handbook" /><link rel="up" href="ch14.html#idp66539984" title="Tools" /><link rel="prev" href="ch14.html" title="Chapter 14. Tools for reference and notes management" /><link rel="next" href="re12.html" title="bib2ris" /></head><body><div class="navheader"><table width="100%" summary="Navigation header"><tr><th colspan="3" align="center">refdbc</th></tr><tr><td width="20%" align="left"><a accesskey="p" href="ch14.html">Prev</a> </td><th width="60%" align="center">Tools</th><td width="20%" align="right"> <a accesskey="n" href="re12.html">Next</a></td></tr></table><hr /></div><div class="refentry"><a id="refentry-refdbc"></a><div class="titlepage"></div><div class="refnamediv"><a id="refdbc-name"></a><h2>Name</h2><p>refdbc — the reference and note management client of RefDB</p></div><div class="refsynopsisdiv"><a id="refdbc-synopsis"></a><h2>Synopsis</h2><p>Interactive mode:</p><div class="cmdsynopsis"><p><code class="command">refdbc</code> [<code class="option">-c</code> <em class="replaceable"><code>pager-command</code></em>] [<code class="option">-d</code> <em class="replaceable"><code>database</code></em>] [<code class="option">-e</code> <em class="replaceable"><code>log-destination</code></em>] [<code class="option">-f</code> <em class="replaceable"><code>stdin</code></em>] [<code class="option">-F</code> <em class="replaceable"><code>fields</code></em>] [<code class="option">-g</code> <em class="replaceable"><code>deffile</code></em>] [<code class="option">-G</code> <em class="replaceable"><code>CSS-file</code></em>] [<code class="option">-h</code> ] [<code class="option">-i</code> <em class="replaceable"><code>IP-address</code></em>] [<code class="option">-l</code> <em class="replaceable"><code>log-level</code></em>] [<code class="option">-L</code> <em class="replaceable"><code>log-file</code></em>] [<code class="option">-p</code> <em class="replaceable"><code>port</code></em>] [<code class="option">-q</code> ] [<code class="option">-R</code> <em class="replaceable"><code>pdfroot</code></em>] [<code class="option">-T</code> <em class="replaceable"><code>time</code></em>] [<code class="option">-u</code> <em class="replaceable"><code>name</code></em>] [<code class="option">-v</code> ] [<code class="option">-V</code> ] [<code class="option">-w</code> <em class="replaceable"><code>password</code></em>] [<code class="option">-x</code> ] [<code class="option">-y</code> <em class="replaceable"><code>confdir</code></em>]</p></div><p>Batch mode:</p><div class="cmdsynopsis"><p><code class="command">refdbc</code> <code class="option">-C</code> <em class="replaceable"><code>command</code></em> [<code class="option">-c</code> <em class="replaceable"><code>pager-command</code></em>] [<code class="option">-d</code> <em class="replaceable"><code>database</code></em>] [<code class="option">-e</code> <em class="replaceable"><code>log-destination</code></em>] [<code class="option">-f</code> <em class="replaceable"><code>stdin</code></em>] [<code class="option">-F</code> <em class="replaceable"><code>fields</code></em>] [<code class="option">-g</code> <em class="replaceable"><code>deffile</code></em>] [<code class="option">-G</code> <em class="replaceable"><code>CSS-file</code></em>] [<code class="option">-i</code> <em class="replaceable"><code>IP-address</code></em>] [<code class="option">-l</code> <em class="replaceable"><code>log-level</code></em>] [<code class="option">-</code>L <em class="replaceable"><code>log-file</code></em>] [<code class="option">-p</code> <em class="replaceable"><code>port</code></em>] [<code class="option">-q</code> ] [<code class="option">-R</code> <em class="replaceable"><code>pdfroot</code></em>] [<code class="option">-T</code> <em class="replaceable"><code>time</code></em>] [<code class="option">-u</code> <em class="replaceable"><code>name</code></em>] [<code class="option">-v</code> ] [<code class="option">-V</code> ] [<code class="option">-w</code> <em class="replaceable"><code>password</code></em>] [<code class="option">-x</code> ] [<code class="option">-y</code> <em class="replaceable"><code>confdir</code></em>]</p></div></div><div class="refsect1"><a id="refdbc-description"></a><h2>Description</h2><p>refdbc is a command-line client providing the commands to manage references and notes with RefDB(7). refdbc can be started in an interactive mode, providing a command prompt. Type <span class="emphasis"><em>?</em></span> or <span class="emphasis"><em>help</em></span> to see a list of available commands. Alternatively you can start refdbc in non-interactive mode. refdbc will execute the requested command and return. In this mode refdbc will accept input on stdin for a variety of commands, allowing Unix piping.</p></div><div class="refsect1"><a id="refdbc-options"></a><h2>Options</h2><div class="variablelist"><dl class="variablelist"><dt><span class="term"><code class="option">-c</code> <em class="replaceable"><code>pager-command</code></em></span></dt><dd><p>The command line of the pager that is to be used. Instead of a pager you can of course specify any valid command that accepts data on stdin. Use "stdout" to request data output to stdout. This is the default, but you may want to specify it on the command line if you need to temporarily override a default pager setting in your configuration file.</p></dd><dt><span class="term"><code class="option">-C</code> <em class="replaceable"><code>command</code></em></span></dt><dd><p>The command to be run in non-interactive mode. You can supply all options and parameters that the command accepts on the refdba command line.</p></dd><dt><span class="term"><code class="option">-d</code> <em class="replaceable"><code>database</code></em></span></dt><dd><p>The name of the default database. You can change the database anytime during an interactive session.</p></dd><dt><span class="term"><code class="option">-e</code> <em class="replaceable"><code>log-destination</code></em></span></dt><dd><p>log-destination can have the values 0, 1, or 2, or the equivalent strings <span class="emphasis"><em>stderr</em></span>, <span class="emphasis"><em>syslog</em></span>, or <span class="emphasis"><em>file</em></span>, respectively. This value specifies where the log information goes to. <code class="literal">0</code> (zero) means the messages are sent to stderr. They are immediately available on the screen but they may interfere with command output. <code class="literal">1</code> will send the output to the syslog facility. Keep in mind that syslog must be configured to accept log messages from user programs, see the syslog(8) man page for further information. Unix-like systems usually save these messages in <code class="filename">/var/log/user.log</code>. <code class="literal">2</code> will send the messages to a custom log file which can be specified with the <code class="option">-L</code> option.</p></dd><dt><span class="term"><code class="option">-f</code> <em class="replaceable"><code>stdin</code></em></span></dt><dd><p>Read data from stdin. refdbc usually knows when it should read from stdin. However, a few commands use data supplied in the command line but also allow to read from a file. Use this option to force refdbc to read from stdin <span class="emphasis"><em>in addition</em></span> to values supplied on the command line.</p></dd><dt><span class="term"><code class="option">-F</code> <em class="replaceable"><code>fields</code></em></span></dt><dd><p>Specify the default fields that are to be displayed in a <span class="emphasis"><em>getref</em></span> query.</p></dd><dt><span class="term"><code class="option">-g</code> <em class="replaceable"><code>deffile</code></em></span></dt><dd><p>This option can be used to add some default fields to all RIS references that are added or updated. The argument deffile is the filename of a RIS file containing these additional fields. refdbc first tries the filename as is, so it should be a valid relative or absolute path. If the file is not found, refdb looks for the file in <span class="emphasis"><em>$HOME</em></span>. The command aborts if the file cannot be found.</p></dd><dt><span class="term"><code class="option">-G</code> <em class="replaceable"><code>CSS-file</code></em></span></dt><dd><p>Specify the URL of a Cascading Style Sheets (CSS) file. This file will be used to customize the HTML output of the <span class="emphasis"><em>getref</em></span> command. The URL can be either a local path (e.g. <code class="filename">refdb.css</code>, <code class="filename">/home/myname/custom.css</code>) or the web address of a file on a web server (e.g. <span class="emphasis"><em><a class="ulink" href="http://www.mycomp.com/refdb.css" target="_top">http://www.mycomp.com/refdb.css</a></em></span>).</p></dd><dt><span class="term"><code class="option">-h</code></span></dt><dd><p>Displays help and usage screen, then exits.</p></dd><dt><span class="term"><code class="option">-i</code> <em class="replaceable"><code>IP-address</code></em></span></dt><dd><p>Set the IP address of the box which is running the application server refdbd(1). Instead of the IP address you can also specify the hostname as long as it can be properly resolved by your system.</p></dd><dt><span class="term"><code class="option">-l</code> <em class="replaceable"><code>log-level</code></em></span></dt><dd><p>Specify the priority up to which events are logged. This is either a number between <code class="literal">0</code> and <code class="literal">7</code> or one of the strings <span class="emphasis"><em>emerg</em></span>, <span class="emphasis"><em>alert</em></span>, <span class="emphasis"><em>crit</em></span>, <span class="emphasis"><em>err</em></span>, <span class="emphasis"><em>warning</em></span>, <span class="emphasis"><em>notice</em></span>, <span class="emphasis"><em>info</em></span>, <span class="emphasis"><em>debug</em></span>, respectively (see also Log level definitions). <code class="option">-1</code> disables logging completely. A low log level like <code class="literal">0</code> means that only the most critical messages are logged. A higher log level means that less critical events are logged as well. <code class="literal">7</code> will include debug messages. The latter can be verbose and abundant, so you want to avoid this log level unless you need to track down problems.</p></dd><dt><span class="term"><code class="option">-L</code> <em class="replaceable"><code>log-file</code></em></span></dt><dd><p>Specify the full path to a log file that will receive the log messages. Typically this would be <code class="filename">/var/log/refdba</code>.</p></dd><dt><span class="term"><code class="option">-p</code> <em class="replaceable"><code>port</code></em></span></dt><dd><p>Set the port of the box which is running the application server.</p></dd><dt><span class="term"><code class="option">-q</code></span></dt><dd><p>Start without reading the configuration files. The client will use the compile-time defaults for all values that you do not set with command-line switches. Useful for debugging configuration files.</p></dd><dt><span class="term"><code class="option">-R</code> <em class="replaceable"><code>pdfroot</code></em></span></dt><dd><p>Specify the root path of your collection of electronic offprints.</p></dd><dt><span class="term"><code class="option">-T</code> <em class="replaceable"><code>time</code></em></span></dt><dd><p>Set the timeout for client/application server dialogue in seconds. A connection with unsuccessful read or write attempts will be considered as dead and taken down after this amount of time has elapsed.</p></dd><dt><span class="term"><code class="option">-u</code> <em class="replaceable"><code>name</code></em></span></dt><dd><p>Set the username for the database access.
Note: This username need not be identical to the login name of the user. This is the username required to access the database server.</p></dd><dt><span class="term"><code class="option">-v</code></span></dt><dd><p>Prints version and copyright information, then exits.</p></dd><dt><span class="term"><code class="option">-V</code></span></dt><dd><p>Switches to verbose mode.</p></dd><dt><span class="term"><code class="option">-w</code> <em class="replaceable"><code>password</code></em></span></dt><dd><p>Set the password for the database access.
Note: This password need not be identical to the login password of the user. This is the password required to access the database server.</p></dd><dt><span class="term"><code class="option">-x</code></span></dt><dd><p>Send passwords unencrypted.</p></dd><dt><span class="term"><code class="option">-y</code> <em class="replaceable"><code>confdir</code></em></span></dt><dd><p>Specify the directory where the global configuration files are
Note: By default, all RefDB applications look for their configuration files in a directory that is specified during the configure step when building the package. That is, you don't need the <code class="option">-y</code> option unless you use precompiled binaries in unusual locations, e.g. by relocating a rpm package.</p></dd></dl></div></div><div class="refsect1"><a id="refdbc-diagnostics"></a><h2>Diagnostics</h2><p>The exit code is 0 if all went fine. It will be 1 if the command (when run in batch mode) or the last command (when run in interactive mode) returned an error, or if there was a general error condition during startup like a lack of available memory.</p></div><div class="refsect1"><a id="refdbc-configuration"></a><h2>Configuration</h2><p>refdbc evaluates the <code class="filename">refdbcrc</code> configuration file at startup to initialize itself.</p><div class="table"><a id="idp67834768"></a><p class="title"><strong>Table 14.1. refdbcrc</strong></p><div class="table-contents"><table class="table" summary="refdbcrc" border="1"><colgroup><col /><col /><col /></colgroup><thead><tr><th>Variable</th><th>Default</th><th>Comment</th></tr></thead><tbody><tr><td>cssurl</td><td>(none)</td><td>The URL of a Cascading Style Sheet (CSS) file. This file, if specified, is used to customize the visual appearance of the HTML output of the <a class="link" href="re11.html#app-c-command-getref" title="getref"><span class="command"><strong>getref</strong></span></a> command.</td></tr><tr><td>defaultdb</td><td>(none)</td><td>The default database. <span class="application">refdbc</span> will try to use this database unless you select a different one with the <a class="link" href="re11.html#app-c-command-selectdb" title="selectdb">selectdb</a> command.</td></tr><tr><td>defaultris</td><td>(none)</td><td>The path of a RIS file with entries that should be added to all new or updated references. This is typically used to set some default value for the RP field or to specify additional keywords.</td></tr><tr><td>fields</td><td>(none)</td><td>A list of additional fields which should be displayed by default in the reference output. The list is a simple concatenation of the field names. Possible fields are N1, N2, NX, AB, AD, RP, SN, PB, CY, UR, U1 through U5, M1 through M3. Use the string "ALL" to request all available fields.</td></tr><tr><td>fromencoding</td><td>ISO-8859-1</td><td>The default encoding of RIS input data. You can use any encoding that your local libiconv implementation supports.</td></tr><tr><td>logdest</td><td>file</td><td>Where the log output should be written to. Use either stderr, syslog, or file. For the latter to work, the logfile variable must be set appropriately</td></tr><tr><td>logfile</td><td>
<code class="filename">/var/log/refdbc.log</code>
</td><td>The full path of a custom log file.</td></tr><tr><td>loglevel</td><td>info</td><td>Set the level of log information that you would receive. Possible values, in order of increasing verbosity, are: emerg, alert, crit, err, warning, notice, info, debug</td></tr><tr><td>pager</td><td>stdout</td><td>The command line of a pager that accepts the output of refdb on stdin to allow scrolling and other nifty things. <span class="quote">“<span class="quote">stdout</span>”</span> sends the data to stdout.</td></tr><tr><td>passwd</td><td>*</td><td>The password which is used for authentication with the database server. It is potentially evil to store unencrypted passwords in disk files. At least make sure that the configuration file is not readable for anyone else. The default setting causes refdbc to ask for your password interactively.</td></tr><tr><td>pdfroot</td><td>(none)</td><td>This value will be used as the root of the paths to PDF or Postscript offprints that can be specified with the AV field in a RIS dataset. The path should not rely on shell expansion, e.g. use <code class="filename">/home/me/literature/</code> instead of <code class="filename">~/literature/</code>. The <a class="link" href="ch08s10.html" title="Use pdfroot">pdfroot</a> allows you to shorten the paths that you enter for each dataset and to maintain a certain portability if you have to move the offprints to a different directory or want to access them remotely. The html output routine will concatenate the relative path of each dataset with the pdfroot to construct the link to the offprint. Instead of a local path name you can specify an URL starting with http:// or ftp:// if your offprints are accessible through a web server or ftp server.</td></tr><tr><td>port</td><td>9734</td><td>The port on which <span class="application">refdbd</span> listens. Change this for all clients and the server if this value interferes with another program using this port.</td></tr><tr><td>serverip</td><td>127.0.0.1</td><td>The IP address or hostname of the machine where <span class="application">refdbd</span> runs. Use the default (localhost) address if the clients and refdbs run on the same machine.</td></tr><tr><td>timeout</td><td>180</td><td>The timeout in seconds. After this time has elapsed, a stalled connection is taken down. Increase this value if you encounter frequent timeout errors due to high network traffic or refdbd overload.</td></tr><tr><td>toencoding</td><td>(none)</td><td>The default encoding of output data. You can use any encoding that your local libiconv implementation supports. If this value is not set, the encoding of the database will be used without conversion.</td></tr><tr><td>username</td><td>login name</td><td>The username which is used for authentication with the database server. This may be different from the login name of the user.</td></tr><tr><td>verbose</td><td>f</td><td>Set this to t if you prefer verbose error messages.</td></tr><tr><td>no_encrypt</td><td>f</td><td>If set to 't', passwords are transmitted unencrypted. The default is to encrypt passwords.</td></tr></tbody></table></div></div><br class="table-break" /></div><div class="refsect1"><a id="refdbc-commands"></a><h2>Commands</h2><p>All commands consist of a single word which specifies the command. This may be followed by arguments and/or switches. The general syntax rules of the getopts library apply.</p><div class="refsect2"><a id="app-c-command-addlink"></a><h3>addlink</h3><div class="refsect3"><a id="refdbc-addlink-synopsis"></a><h4>Synopsis</h4><div class="cmdsynopsis"><p><code class="command">addlink</code> [<code class="option">-d</code> <em class="replaceable"><code>database</code></em>] [<code class="option">-h</code>] [[<code class="option">-c</code> <em class="replaceable"><code>command</code></em>] | [<code class="option">-o</code> <em class="replaceable"><code>outfile</code></em>] | [<code class="option">-O</code> <em class="replaceable"><code>outfile</code></em>]] {note-specifier} {link-target...}</p></div></div><div class="refsect3"><a id="refdbc-addlink-description"></a><h4>Description</h4><p>The <span class="command"><strong>addlink</strong></span> command links an extended note to one or more link targets.</p><p>You have to specify exactly one note on the command line, either by using the :NID: field selector to specify the note ID, or by using the :NCK: field selector to specify the note key. Then you need at least one link target. This can be one of :ID: (reference by ID), :CK: (reference by citation key), :AU: (author by name), :KW: (keyword by name), or one of :JF:, :JO:, :J1:, :J2: (periodical by full name, abbreviated name, or user abbreviations 1 and 2).</p></div><div class="refsect3"><a id="refdbc-addlink-options"></a><h4>Options</h4><div class="variablelist"><dl class="variablelist"><dt><span class="term"><code class="option">-c</code> <em class="replaceable"><code>command</code></em></span></dt><dd><p>Pipe the output through <em class="replaceable"><code>command</code></em>.</p></dd><dt><span class="term"><code class="option">-d</code> <em class="replaceable"><code>database</code></em></span></dt><dd><p>Specify the database.</p></dd><dt><span class="term"><code class="option">-h</code></span></dt><dd><p>Display a help message explaining the command.</p></dd><dt><span class="term"><code class="option">-o</code> <em class="replaceable"><code>filename</code></em></span></dt><dd><p>Write the output to <code class="filename">filename</code> instead of to stdout.</p></dd><dt><span class="term"><code class="option">-O</code> <em class="replaceable"><code>filename</code></em></span></dt><dd><p>Append the output to <code class="filename">filename</code> instead of sending it to stdout.</p></dd><dt><span class="term"><em class="replaceable"><code>note-specifier</code></em></span></dt><dd><p>Specify one note by either its :NID: or its :NCK: value.</p></dd><dt><span class="term"><em class="replaceable"><code>link-target</code></em></span></dt><dd><p>Specify one or more link targets by means of their :ID:, :CK:, :AU:, :KW:, :JF:, :JO:, :J1:, or :J2: values.</p></dd></dl></div></div><div class="refsect3"><a id="refdbc-addlink-example"></a><h4>Example</h4><pre class="screen">
<code class="prompt">refdbc: </code>
<strong class="userinput"><code>addlink :NID:=12 :CK:=Miller1999 :KW:=biochemistry</code></strong>
</pre><p>This command will link the note carrying the ID 12 with a reference specified by its citation key "Miller1999" and with the keyword "biochemistry".</p></div></div><div class="refsect2"><a id="app-c-command-addnote"></a><h3>addnote</h3><div class="refsect3"><a id="refdbc-addnote-synopsis"></a><h4>Synopsis</h4><div class="cmdsynopsis"><p><code class="command">addnote</code> [<code class="option">-d</code> <em class="replaceable"><code>database</code></em>] [<code class="option">-E</code> <em class="replaceable"><code>encoding</code></em>] [<code class="option">-h</code>] [[<code class="option">-c</code> <em class="replaceable"><code>command</code></em>] | [<code class="option">-o</code> <em class="replaceable"><code>outfile</code></em>] | [<code class="option">-O</code> <em class="replaceable"><code>outfile</code></em>]] [
<em class="replaceable"><code>file</code></em>
...]</p></div></div><div class="refsect3"><a id="refdbc-addnote-description"></a><h4>Description</h4><p>Adds the extended notes in <em class="replaceable"><code>file</code></em> to the current database. You can specify several files in one run. Any ID fields in the notes are ignored.</p></div><div class="refsect3"><a id="refdbc-addnote-options"></a><h4>Options</h4><div class="variablelist"><dl class="variablelist"><dt><span class="term"><code class="option">-c</code> <em class="replaceable"><code>command</code></em></span></dt><dd><p>Pipe the output through <em class="replaceable"><code>command</code></em>.</p></dd><dt><span class="term"><code class="option">-d</code> <em class="replaceable"><code>database</code></em></span></dt><dd><p>Specify the database.</p></dd><dt><span class="term"><code class="option">-E</code> <em class="replaceable"><code>encoding</code></em></span></dt><dd><p>Select the character encoding for the input data if it is different from the default UTF-8.</p></dd><dt><span class="term"><code class="option">-h</code></span></dt><dd><p>Display a help message explaining the command.</p></dd><dt><span class="term"><code class="option">-o</code> <em class="replaceable"><code>filename</code></em></span></dt><dd><p>Write the output to <code class="filename">filename</code> instead of to stdout.</p></dd><dt><span class="term"><code class="option">-O</code> <em class="replaceable"><code>filename</code></em></span></dt><dd><p>Append the output to <code class="filename">filename</code> instead of sending it to stdout.</p></dd></dl></div></div><div class="refsect3"><a id="refdbc-addnote-example"></a><h4>Example</h4><pre class="screen">
<code class="prompt">refdbc: </code>
<strong class="userinput"><code>addnote foo.xml</code></strong>
</pre><p>This command will add the extended notes in <code class="filename">foo.ris</code> to the currently selected database. If the notes do not specify a date, refdbd will insert a timestamp automatically.</p></div></div><div class="refsect2"><a id="app-c-command-addref"></a><h3>addref</h3><div class="refsect3"><a id="refdbc-addref-synopsis"></a><h4>Synopsis</h4><div class="cmdsynopsis"><p><code class="command">addref</code> [<code class="option">-d</code> <em class="replaceable"><code>database</code></em>] [<code class="option">-E</code> <em class="replaceable"><code>encoding</code></em>] [<code class="option">-h</code>] [[<code class="option">-c</code> <em class="replaceable"><code>command</code></em>] | [<code class="option">-o</code> <em class="replaceable"><code>outfile</code></em>] | [<code class="option">-O</code> <em class="replaceable"><code>outfile</code></em>]] [<code class="option">-t</code> <em class="replaceable"><code>type</code></em>] [<code class="option">-U</code> <em class="replaceable"><code>username</code></em>] [
<em class="replaceable"><code>file</code></em>
...]</p></div></div><div class="refsect3"><a id="refdbc-addref-description"></a><h4>Description</h4><p>Adds the references in <em class="replaceable"><code>file</code></em> to the current database. You can specify several files in one run. Any ID fields in the references are ignored unless you specify the <code class="option">-k</code> option.</p></div><div class="refsect3"><a id="refdbc-addref-options"></a><h4>Options</h4><div class="variablelist"><dl class="variablelist"><dt><span class="term"><code class="option">-c</code> <em class="replaceable"><code>command</code></em></span></dt><dd><p>Pipe the output through <em class="replaceable"><code>command</code></em>.</p></dd><dt><span class="term"><code class="option">-d</code> <em class="replaceable"><code>database</code></em></span></dt><dd><p>Specify the database.</p></dd><dt><span class="term"><code class="option">-E</code> <em class="replaceable"><code>encoding</code></em></span></dt><dd><p>Select the character encoding for the input data if it is different from the default setting. RIS datasets can use any encoding that your local libiconv supports (see <span class="command"><strong>man iconv_open</strong></span> for a list of available encodings), except UTF-16 and UTF-32. RISX datasets carry the encoding in the processing instructions, therefore this option is not needed and ignored.</p></dd><dt><span class="term"><code class="option">-h</code></span></dt><dd><p>Display a help message explaining the command.</p></dd><dt><span class="term"><code class="option">-o</code> <em class="replaceable"><code>filename</code></em></span></dt><dd><p>Write the output to <code class="filename">filename</code> instead of to stdout.</p></dd><dt><span class="term"><code class="option">-O</code> <em class="replaceable"><code>filename</code></em></span></dt><dd><p>Append the output to <code class="filename">filename</code> instead of sending it to stdout.</p></dd><dt><span class="term"><code class="option">-t</code> <em class="replaceable"><code>type</code></em></span></dt><dd><p>Select the input data type. Possible values are "ris" (default) and "risx". Other data types have to be converted to one of these types before adding them to the database.</p></dd><dt><span class="term"><code class="option">-U</code> <em class="replaceable"><code>username</code></em></span></dt><dd><p>Provide a different username than that of the current user, so e.g. some technician or administrative staff can add references in behalf of a researcher.</p></dd><dt><span class="term"><em class="replaceable"><code>file</code></em></span></dt><dd><p>All other command-line arguments will be interpreted as filenames to read references from. If no filenames are specified, the data will be read from stdin.</p></dd></dl></div></div><div class="refsect3"><a id="refdbc-addref-example"></a><h4>Example</h4><pre class="screen">
<code class="prompt">refdbc: </code>
<strong class="userinput"><code>addref -U doe -g .refdbdefault.ris -E ISO-8859-1 foo.ris</code></strong>
</pre><pre class="screen">
<code class="prompt">$ </code>
<strong class="userinput"><code>refdbc -C addref -U doe -g .refdbdefault.ris -d db1 < foo.ris</code></strong>
</pre><p>These commands will add the references in <code class="filename">foo.ris</code>. The references will be associated with the user <span class="quote">“<span class="quote">doe</span>”</span>. Every reference will use the specified values in <code class="filename">.refdbdefault.ris</code> in the appropriate fields. In the first (interactive) command, the active database will be used, and the encoding is set to ISO-8859-1, aka Latin-1. In the second (non-interactive) command, the database has to be specified explicitly with the <code class="option">-d</code> option, and the default encoding (UTF-8) is assumed.</p></div></div><div class="refsect2"><a id="app-c-command-checkref"></a><h3>checkref</h3><div class="refsect3"><a id="refdbc-checkref-synopsis"></a><h4>Synopsis</h4><div class="cmdsynopsis"><p><code class="command">checkref</code> [<code class="option">-A</code> <em class="replaceable"><code>output-type</code></em>] [<code class="option">-d</code> <em class="replaceable"><code>database</code></em>] [<code class="option">-E</code> <em class="replaceable"><code>encoding</code></em>] [<code class="option">-h</code>] [[<code class="option">-c</code> <em class="replaceable"><code>command</code></em>] | [<code class="option">-o</code> <em class="replaceable"><code>outfile</code></em>] | [<code class="option">-O</code> <em class="replaceable"><code>outfile</code></em>]] [<code class="option">-r</code> <em class="replaceable"><code>field-list</code></em>] [<code class="option">-s</code> <em class="replaceable"><code>field-list</code></em>] [<code class="option">-t</code> <em class="replaceable"><code>input-type</code></em>] [<code class="option">-U</code> <em class="replaceable"><code>username</code></em>] [
<em class="replaceable"><code>file</code></em>
...]</p></div></div><div class="refsect3"><a id="refdbc-checkref-description"></a><h4>Description</h4><p>Adds the references in <em class="replaceable"><code>file</code></em> to temporary tables in the current database. The command is similar to the <a class="link" href="re11.html#app-c-command-addref" title="addref">addref</a> command, except that it does not add the references permanently to your database. Instead, the import is "simulated" in temporary tables, and the resulting datasets are analyzed in terms of similarities to existing permanent entries. If a reference is similar to an existing one in terms of the location (periodical, volume, issue, startpage), of the titles, or of the citekey, you may want to check these references manually as they are probably duplicates. If an abbreviated periodical name is reported to match an existing full name, you may want to add both names to the new reference to make refdb aware that it is dealing with the same journal. If an author name using abbreviated first or middle names is reported to be a possible duplicate of an existing author or vice versa, you may want to check if these authors are indeed identical, and change the abbreviated one to the full version. In addition, keywords are checked for similar existing keywords (often there are singular and plural forms of the same keyword). You should prefer to use existing keywords if possible to make your database more consistent and easier to search.</p></div><div class="refsect3"><a id="refdbc-checkref-options"></a><h4>Options</h4><div class="variablelist"><dl class="variablelist"><dt><span class="term"><code class="option">-A</code> <em class="replaceable"><code>outtype</code></em></span></dt><dd><p>Select the output type of the report. Currently supported values are "scrn" for a terse screen output, and "xhtml" for a voluptuous xhtml report, bells and whistles included.</p></dd><dt><span class="term"><code class="option">-c</code> <em class="replaceable"><code>command</code></em></span></dt><dd><p>Pipe the output through <em class="replaceable"><code>command</code></em>.</p></dd><dt><span class="term"><code class="option">-d</code> <em class="replaceable"><code>database</code></em></span></dt><dd><p>Specify the database.</p></dd><dt><span class="term"><code class="option">-E</code> <em class="replaceable"><code>encoding</code></em></span></dt><dd><p>Select the character encoding for the input data if it is different from the default setting. RIS datasets can use any encoding that your local libiconv supports (see <span class="command"><strong>man iconv_open</strong></span> for a list of available encodings), except UTF-16 and UTF-32. RISX datasets carry the encoding in the processing instructions, therefore this option is not needed and ignored.</p></dd><dt><span class="term"><code class="option">-G</code> <em class="replaceable"><code>cssfile</code></em></span></dt><dd><p>Select the CSS stylesheet that is to be used for the xhtml output.</p></dd><dt><span class="term"><code class="option">-h</code></span></dt><dd><p>Display a help message explaining the command.</p></dd><dt><span class="term"><code class="option">-o</code> <em class="replaceable"><code>filename</code></em></span></dt><dd><p>Write the output to <code class="filename">filename</code> instead of to stdout.</p></dd><dt><span class="term"><code class="option">-O</code> <em class="replaceable"><code>filename</code></em></span></dt><dd><p>Append the output to <code class="filename">filename</code> instead of sending it to stdout.</p></dd><dt><span class="term"><code class="option">-r</code> <em class="replaceable"><code>fieldlist</code></em></span></dt><dd><p>Select fields to check. If this option is not used, all available checks are performed. This may result in a more comprehensive report than you want. You can instead check for particular fields, or a subset of the available fields. <em class="replaceable"><code>fieldlist</code></em> is a concatenation of the two-letter (pseudo) field codes: TX (all titles), PY (pubdate, volume, issue, pages), AX (all authors), JO (all journal names), CK, and KW.</p></dd><dt><span class="term"><code class="option">-s</code> <em class="replaceable"><code>fieldlist</code></em></span></dt><dd><p>Select additional fields to display with the default xhtml output. <em class="replaceable"><code>fieldlist</code></em> is a concatenation of the two-letter field codes of those fields which are not printed by default: N1, N2, NX, AB, AD, PB, CY, RP, SN, LX, U1-U5, and M1-M3.</p></dd><dt><span class="term"><code class="option">-t</code> <em class="replaceable"><code>input-type</code></em></span></dt><dd><p>Select the input data type. Possible values are "ris" (default) and "risx". Other data types have to be converted to one of these types before adding them to the database.</p></dd><dt><span class="term"><code class="option">-U</code> <em class="replaceable"><code>username</code></em></span></dt><dd><p>Provide a different username than that of the current user, so e.g. some technician or administrative staff can add references in behalf of a researcher.</p></dd><dt><span class="term"><em class="replaceable"><code>file</code></em></span></dt><dd><p>All other command-line arguments will be interpreted as filenames to read references from. If no filenames are specified, the data will be read from stdin.</p></dd></dl></div></div><div class="refsect3"><a id="refdbc-checkref-example"></a><h4>Example</h4><pre class="screen">
<code class="prompt">refdbc: </code>
<strong class="userinput"><code>checkref -A xhtml -G /usr/local/share/refdb/css/refdb-frequency.css -E ISO-8859-1 -s KW foo.ris</code></strong>
</pre><p>This command adds the data in <code class="filename">foo.ris</code> to temporary tables in the current database, using the <em class="replaceable"><code>ISO-8859-1</code></em> encoding. The result of the duplicate checks is requested in <em class="replaceable"><code>xhtml</code></em> format using a stylesheet that displays frequency information graphically. In addition to the default fields the keywords will be listed as well.</p></div></div><div class="refsect2"><a id="app-c-command-deletelink"></a><h3>deletelink</h3><div class="refsect3"><a id="refdbc-deletelink-synopsis"></a><h4>Synopsis</h4><div class="cmdsynopsis"><p><code class="command">deletelink</code> [<code class="option">-d</code> <em class="replaceable"><code>database</code></em>] [<code class="option">-h</code>] [[<code class="option">-c</code> <em class="replaceable"><code>command</code></em>] | [<code class="option">-o</code> <em class="replaceable"><code>outfile</code></em>] | [<code class="option">-O</code> <em class="replaceable"><code>outfile</code></em>]] {note-specifier} {link-target...}</p></div></div><div class="refsect3"><a id="refdbc-deletelink-description"></a><h4>Description</h4><p>The <span class="command"><strong>deletelink</strong></span> command removes links from an extended note to one or more link targets.</p><p>You have to specify exactly one note on the command line, either by using the :NID: field selector to specify the note ID, or by using the :NCK: field selector to specify the note key. Then you need at least one link target. This can be one of :ID: (reference by ID), :CK: (reference by citation key), :AU: (author by name), :KW: (keyword by name), or one of :JF:, :JO:, :J1:, :J2: (periodical by full name, abbreviated name, or user abbreviations 1 and 2).</p></div><div class="refsect3"><a id="refdbc-deletelink-options"></a><h4>Options</h4><div class="variablelist"><dl class="variablelist"><dt><span class="term"><code class="option">-c</code> <em class="replaceable"><code>command</code></em></span></dt><dd><p>Pipe the output through <em class="replaceable"><code>command</code></em>.</p></dd><dt><span class="term"><code class="option">-d</code> <em class="replaceable"><code>database</code></em></span></dt><dd><p>Specify the database.</p></dd><dt><span class="term"><code class="option">-h</code></span></dt><dd><p>Display a help message explaining the command.</p></dd><dt><span class="term"><code class="option">-o</code> <em class="replaceable"><code>filename</code></em></span></dt><dd><p>Write the output to <code class="filename">filename</code> instead of to stdout.</p></dd><dt><span class="term"><code class="option">-O</code> <em class="replaceable"><code>filename</code></em></span></dt><dd><p>Append the output to <code class="filename">filename</code> instead of sending it to stdout.</p></dd><dt><span class="term"><em class="replaceable"><code>note-specifier</code></em></span></dt><dd><p>Specify one note by either its :NID: or its :NCK: value.</p></dd><dt><span class="term"><em class="replaceable"><code>link-target</code></em></span></dt><dd><p>Specify one or more link targets by means of their :ID:, :CK:, :AU:, :KW:, :JF:, :JO:, :J1:, or :J2: values.</p></dd></dl></div></div><div class="refsect3"><a id="refdbc-deletelink-example"></a><h4>Example</h4><pre class="screen">
<code class="prompt">refdbc: </code>
<strong class="userinput"><code>deletelink :NID:=12 :CK:=Miller1999 :KW:=biochemistry</code></strong>
</pre><p>This command will delete the links from the note carrying the ID 12 to a reference specified by its citation key "Miller1999" and to the keyword "biochemistry".</p></div></div><div class="refsect2"><a id="app-c-command-deletenote"></a><h3>deletenote</h3><div class="refsect3"><a id="refdbc-deletenote-synopsis"></a><h4>Synopsis</h4><div class="cmdsynopsis"><p><code class="command">deletenote</code> [<code class="option">-d</code> <em class="replaceable"><code>database</code></em>] [<code class="option">-h</code>] [[<code class="option">-c</code> <em class="replaceable"><code>command</code></em>] | [<code class="option">-o</code> <em class="replaceable"><code>outfile</code></em>] | [<code class="option">-O</code> <em class="replaceable"><code>outfile</code></em>]] {{<em class="replaceable"><code>ID</code></em>...} | {<code class="option">-f</code> <em class="replaceable"><code>infile</code></em>}}</p></div></div><div class="refsect3"><a id="refdbc-deletenote-description"></a><h4>Description</h4><p>Deletes the extended note with the identifier <em class="replaceable"><code>ID</code></em> from the current database. Several extended notes may be specified in a single call of this command. Notes with consecutive ID values may be specified as ranges.</p><div class="caution" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title">Caution</h3><p>It is not possible to delete a note if it belongs to a different user.</p></div></div><div class="refsect3"><a id="refdbc-deletenote-options"></a><h4>Options</h4><div class="variablelist"><dl class="variablelist"><dt><span class="term"><code class="option">-c</code> <em class="replaceable"><code>command</code></em></span></dt><dd><p>Pipe the output through <em class="replaceable"><code>command</code></em>.</p></dd><dt><span class="term"><code class="option">-d</code> <em class="replaceable"><code>database</code></em></span></dt><dd><p>Specify the database.</p></dd><dt><span class="term"><code class="option">-f</code> <em class="replaceable"><code>infile</code></em></span></dt><dd><p>Read a list of NID values in the RIS format from <em class="replaceable"><code>infile</code></em>.</p></dd><dt><span class="term"><code class="option">-h</code></span></dt><dd><p>Display a help message explaining the command.</p></dd><dt><span class="term"><code class="option">-o</code> <em class="replaceable"><code>filename</code></em></span></dt><dd><p>Write the output to <code class="filename">filename</code> instead of to stdout.</p></dd><dt><span class="term"><code class="option">-O</code> <em class="replaceable"><code>filename</code></em></span></dt><dd><p>Append the output to <code class="filename">filename</code> instead of sending it to stdout.</p></dd><dt><span class="term"><em class="replaceable"><code>NID</code></em></span></dt><dd><p>All other arguments are interpreted as a list of noteID values. Ranges may be used to specify consecutive NIDs. If neither NIDs nor an <em class="replaceable"><code>infile</code></em> are provided, refdbc attempts to read the NIDs from stdin. You can ask refdbc to read NID values from stdin <span class="emphasis"><em>in addition</em></span> to other NIDs by using the <code class="option">-f stdin</code> option.</p></dd></dl></div></div><div class="refsect3"><a id="refdbc-deletenote-example"></a><h4>Example</h4><pre class="screen">
<code class="prompt">refdbc: </code>
<strong class="userinput"><code>deletenote 3 5-10 26</code></strong>
</pre><p>This command will delete the extended notes with the ID values 3, 5 through 10, and 26.</p></div></div><div class="refsect2"><a id="app-c-command-deleteref"></a><h3>deleteref</h3><div class="refsect3"><a id="refdbc-deleteref-synopsis"></a><h4>Synopsis</h4><div class="cmdsynopsis"><p><code class="command">deleteref</code> [<code class="option">-d</code> <em class="replaceable"><code>database</code></em>] [<code class="option">-h</code>] [[<code class="option">-c</code> <em class="replaceable"><code>command</code></em>] | [<code class="option">-o</code> <em class="replaceable"><code>outfile</code></em>] | [<code class="option">-O</code> <em class="replaceable"><code>outfile</code></em>]] {{
<em class="replaceable"><code>ID</code></em>
...} | {<code class="option">-f</code> <em class="replaceable"><code>infile</code></em>}}</p></div></div><div class="refsect3"><a id="refdbc-deleteref-description"></a><h4>Description</h4><p>Deletes the reference with the identifier <em class="replaceable"><code>ID</code></em> from the current database. Several references may be specified in a single call of this command. References with consecutive ID values may be specified as ranges.</p><div class="caution" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title">Caution</h3><p>It is not possible to delete a reference if it belongs to the personal reference list of more than one user.</p><p>If you're the only user of this reference and go ahead and delete it, all data saved in the specified references will be gone, so be careful with this command. Make sure you understand the difference between the <span class="command"><strong>deleteref</strong></span> command and the <a class="link" href="re11.html#app-c-command-dumpref" title="dumpref"><span class="command"><strong>dumpref</strong></span></a> command. The former deletes the data, the latter deletes only your personal data associated with the specified references (the notes, availability, and reprint data) and removes your association with this reference. In other words, <span class="command"><strong>deleteref</strong></span> removes the reference from the database, whereas <a class="link" href="re11.html#app-c-command-dumpref" title="dumpref"><span class="command"><strong>dumpref</strong></span></a> removes the reference from your personal reference list, leaving the remaining data for the other users of the database.</p></div></div><div class="refsect3"><a id="refdbc-deleteref-options"></a><h4>Options</h4><div class="variablelist"><dl class="variablelist"><dt><span class="term"><code class="option">-c</code> <em class="replaceable"><code>command</code></em></span></dt><dd><p>Pipe the output through <em class="replaceable"><code>command</code></em>.</p></dd><dt><span class="term"><code class="option">-d</code> <em class="replaceable"><code>database</code></em></span></dt><dd><p>Specify the database.</p></dd><dt><span class="term"><code class="option">-f</code> <em class="replaceable"><code>infile</code></em></span></dt><dd><p>Read a list of ID values in the RIS format from <em class="replaceable"><code>infile</code></em>. This list may be the result of a previous <a class="link" href="re11.html#app-c-command-getref" title="getref">getref</a> command.</p></dd><dt><span class="term"><code class="option">-h</code></span></dt><dd><p>Display a help message explaining the command.</p></dd><dt><span class="term"><code class="option">-o</code> <em class="replaceable"><code>filename</code></em></span></dt><dd><p>Write the output to <code class="filename">filename</code> instead of to stdout.</p></dd><dt><span class="term"><code class="option">-O</code> <em class="replaceable"><code>filename</code></em></span></dt><dd><p>Append the output to <code class="filename">filename</code> instead of sending it to stdout.</p></dd><dt><span class="term"><em class="replaceable"><code>ID</code></em></span></dt><dd><p>All other arguments are interpreted as a list of ID values. Ranges may be used to specify consecutive IDs. If neither IDs nor an <em class="replaceable"><code>infile</code></em> are provided, refdbc attempts to read the IDs from stdin. You can ask refdbc to read ID values from stdin <span class="emphasis"><em>in addition</em></span> to other IDs by using the <code class="option">-f stdin</code> option.</p></dd></dl></div></div><div class="refsect3"><a id="refdbc-deleteref-example"></a><h4>Example</h4><pre class="screen">
<code class="prompt">refdbc: </code>
<strong class="userinput"><code>deleteref 3 5-10 26</code></strong>
</pre><p>This command will delete the references with the ID values 3, 5 through 10, and 26.</p></div></div><div class="refsect2"><a id="app-c-command-dumpref"></a><h3>dumpref</h3><div class="refsect3"><a id="refdbc-dumpref-synopsis"></a><h4>Synopsis</h4><div class="cmdsynopsis"><p><code class="command">dumpref</code> [<code class="option">-b</code> <em class="replaceable"><code>listname</code></em>] [<code class="option">-d</code> <em class="replaceable"><code>database</code></em>] [<code class="option">-h</code>] [[<code class="option">-c</code> <em class="replaceable"><code>command</code></em>] | [<code class="option">-o</code> <em class="replaceable"><code>outfile</code></em>] | [<code class="option">-O</code> <em class="replaceable"><code>outfile</code></em>]] {[
<em class="replaceable"><code>ID</code></em>
...] | [<code class="option">-f</code> <em class="replaceable"><code>file</code></em>]...}</p></div></div><div class="refsect3"><a id="refdbc-dumpref-description"></a><h4>Description</h4><p>Removes references from the specified personal reference list in the current database. If no personal reference list is specified, the default list (carrying the same name as your database username) will be used instead.</p></div><div class="refsect3"><a id="refdbc-dumpref-options"></a><h4>Options</h4><div class="variablelist"><dl class="variablelist"><dt><span class="term"><code class="option">-b</code> <em class="replaceable"><code>listname</code></em></span></dt><dd><p>Use the personal reference list named <em class="replaceable"><code>listname</code></em>.</p></dd><dt><span class="term"><code class="option">-c</code> <em class="replaceable"><code>command</code></em></span></dt><dd><p>Pipe the output through <em class="replaceable"><code>command</code></em>.</p></dd><dt><span class="term"><code class="option">-d</code> <em class="replaceable"><code>database</code></em></span></dt><dd><p>Specify the database.</p></dd><dt><span class="term"><code class="option">-f</code> <em class="replaceable"><code>infile</code></em></span></dt><dd><p>Read a list of ID values in the RIS format from <em class="replaceable"><code>infile</code></em>. This list may be the result of a previous <a class="link" href="re11.html#app-c-command-getref" title="getref">getref</a> command.</p></dd><dt><span class="term"><code class="option">-h</code></span></dt><dd><p>Display a help message explaining the command.</p></dd><dt><span class="term"><code class="option">-o</code> <em class="replaceable"><code>filename</code></em></span></dt><dd><p>Write the output to <code class="filename">filename</code> instead of to stdout.</p></dd><dt><span class="term"><code class="option">-O</code> <em class="replaceable"><code>filename</code></em></span></dt><dd><p>Append the output to <code class="filename">filename</code> instead of sending it to stdout.</p></dd><dt><span class="term"><em class="replaceable"><code>ID</code></em></span></dt><dd><p>All other arguments are interpreted as a list of ID values. Ranges may be used to specify consecutive IDs. If neither IDs nor an <em class="replaceable"><code>infile</code></em> are provided, refdbc attempts to read the IDs from stdin. You can ask refdbc to read ID values from stdin <span class="emphasis"><em>in addition</em></span> to other IDs by using the <code class="option">-f stdin</code> option.</p></dd></dl></div></div><div class="refsect3"><a id="refdbc-dumpref-example"></a><h4>Example</h4><pre class="screen">
<code class="prompt">refdbc: </code>
<strong class="userinput"><code>dumpref -f foo.ris 3 5-10 26</code></strong>
</pre><p>This command will remove the references 3, 5 through 10, and 26 as well as those listed in the file <code class="filename">foo.ris</code> from your personal reference list.</p></div></div><div class="refsect2"><a id="app-c-command-getau"></a><h3>getau, geted, getas, getax</h3><div class="refsect3"><a id="refdbc-getau-synopsis"></a><h4>Synopsis</h4><div class="cmdsynopsis"><p><code class="command">getau</code> [<code class="option">-d</code> <em class="replaceable"><code>database</code></em>] [<code class="option">-h</code>] [[<code class="option">-c</code> <em class="replaceable"><code>command</code></em>] | [<code class="option">-o</code> <em class="replaceable"><code>outfile</code></em>] | [<code class="option">-O</code> <em class="replaceable"><code>outfile</code></em>]] [<code class="option">-N</code> <em class="replaceable"><code>limit[:offset]</code></em>] [<code class="option">-s</code> <em class="replaceable"><code>format</code></em>] {
<em class="replaceable"><code>unix-regexp</code></em>
}</p></div><div class="cmdsynopsis"><p><code class="command"><a id="app-c-command-geted"></a>geted</code> [<code class="option">-d</code> <em class="replaceable"><code>database</code></em>] [<code class="option">-h</code>] [[<code class="option">-c</code> <em class="replaceable"><code>command</code></em>] | [<code class="option">-o</code> <em class="replaceable"><code>outfile</code></em>] | [<code class="option">-O</code> <em class="replaceable"><code>outfile</code></em>]] [<code class="option">-N</code> <em class="replaceable"><code>limit[:offset]</code></em>] [<code class="option">-s</code> <em class="replaceable"><code>format</code></em>] {
<em class="replaceable"><code>unix-regexp</code></em>
}</p></div><div class="cmdsynopsis"><p><code class="command"><a id="app-c-command-getas"></a>getas</code> [<code class="option">-d</code> <em class="replaceable"><code>database</code></em>] [<code class="option">-h</code>] [[<code class="option">-c</code> <em class="replaceable"><code>command</code></em>] | [<code class="option">-o</code> <em class="replaceable"><code>outfile</code></em>] | [<code class="option">-O</code> <em class="replaceable"><code>outfile</code></em>]] [<code class="option">-N</code> <em class="replaceable"><code>limit[:offset]</code></em>] [<code class="option">-s</code> <em class="replaceable"><code>format</code></em>] {
<em class="replaceable"><code>regexp</code></em>
}</p></div><div class="cmdsynopsis"><p><code class="command"><a id="app-c-command-getax"></a>getas</code> [<code class="option">-d</code> <em class="replaceable"><code>database</code></em>] [<code class="option">-h</code>] [[<code class="option">-c</code> <em class="replaceable"><code>command</code></em>] | [<code class="option">-o</code> <em class="replaceable"><code>outfile</code></em>] | [<code class="option">-O</code> <em class="replaceable"><code>outfile</code></em>]] [<code class="option">-N</code> <em class="replaceable"><code>limit[:offset]</code></em>] [<code class="option">-s</code> <em class="replaceable"><code>format</code></em>] {
<em class="replaceable"><code>regexp</code></em>
}</p></div></div><div class="refsect3"><a id="refdbc-getau-description"></a><h4>Description</h4><p>Retrieve all author names that match the regular expression <em class="replaceable"><code>regexp</code></em> in the current database. If no regexp argument is given, <span class="emphasis"><em>all</em></span> author names will be listed, which may or may not be what you want. <span class="command"><strong>getau</strong></span> retrieves the <span class="emphasis"><em>primary</em></span> authors which is the most common case if you want to locate a publication. <span class="command"><strong>geted</strong></span> and <span class="command"><strong>getas</strong></span> retrieve book or periodical editors and series authors, respectively. <span class="command"><strong>getax</strong></span> retrieves authors from any level.</p></div><div class="refsect3"><a id="refdbc-getau-options"></a><h4>Options</h4><div class="variablelist"><dl class="variablelist"><dt><span class="term"><code class="option">-c</code> <em class="replaceable"><code>command</code></em></span></dt><dd><p>Pipe the output through <em class="replaceable"><code>command</code></em>.</p></dd><dt><span class="term"><code class="option">-d</code> <em class="replaceable"><code>database</code></em></span></dt><dd><p>Specify the database.</p></dd><dt><span class="term"><code class="option">-h</code></span></dt><dd><p>Display a help message explaining the command.</p></dd><dt><span class="term"><code class="option">-N</code> <em class="replaceable"><code>limit[:offset]</code></em></span></dt><dd><p>Limit the number of returned datasets. If <em class="replaceable"><code>limit</code></em> is used all by itself, the first <em class="replaceable"><code>limit</code></em> author names are returned. If the optional <em class="replaceable"><code>offset</code></em> argument is used as well, the first <em class="replaceable"><code>offset</code></em> author names will be skipped, and the next <em class="replaceable"><code>limit</code></em> author names will be returned.</p></dd><dt><span class="term"><code class="option">-o</code> <em class="replaceable"><code>filename</code></em></span></dt><dd><p>Write the output to <code class="filename">filename</code> instead of to stdout.</p></dd><dt><span class="term"><code class="option">-O</code> <em class="replaceable"><code>filename</code></em></span></dt><dd><p>Append the output to <code class="filename">filename</code> instead of sending it to stdout.</p></dd><dt><span class="term"><code class="option">-s</code> <em class="replaceable"><code>format</code></em></span></dt><dd><p>Request additional frequency information. "freq" provides the absolute number of references that contain the given author. "relfreq" reports a relative frequency indicator as an integer between 0 and 10.</p></dd><dt><span class="term"><em class="replaceable"><code>regexp</code></em></span></dt><dd><p>All other arguments are interpreted as a unix regular expression which limits the results to matching author names.</p><div class="note" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title">Note</h3><p>Some database engines, like SQLite, do not support Unix-style regular expressions. Use SQL regular expressions instead.</p></div></dd></dl></div></div><div class="refsect3"><a id="refdbc-getau-example"></a><h4>Example</h4><pre class="screen">
<code class="prompt">refdbc: </code>
<strong class="userinput"><code>getau -o authors.txt '^Simpson'</code></strong>
</pre><p>This command will write a list of all authors starting with <span class="quote">“<span class="quote">Simpson</span>”</span> to the file <code class="filename">authors.txt</code>.</p><pre class="screen">
<code class="prompt">refdbc: </code>
<strong class="userinput"><code>getau -N 5:10</code></strong>
</pre><p>This command prints the author names 11 through 15.</p></div></div><div class="refsect2"><a id="app-c-command-getjo"></a><h3>getjo, getjf, getj1, getj2</h3><div class="refsect3"><a id="refdbc-getjo-synopsis"></a><h4>Synopsis</h4><div class="cmdsynopsis"><p><code class="command">getjo</code> [<code class="option">-a</code>] [<code class="option">-d</code> <em class="replaceable"><code>database</code></em>] [<code class="option">-h</code>] [[<code class="option">-c</code> <em class="replaceable"><code>command</code></em>] | [<code class="option">-o</code> <em class="replaceable"><code>outfile</code></em>] | [<code class="option">-O</code> <em class="replaceable"><code>outfile</code></em>]] [<code class="option">-N</code> <em class="replaceable"><code>limit[:offset]</code></em>] [<code class="option">-s</code> <em class="replaceable"><code>format</code></em>] {
<em class="replaceable"><code>regexp</code></em>
}</p></div><div class="cmdsynopsis"><p><code class="command"><a id="app-c-command-getjf"></a>getjf</code> [<code class="option">-a</code>] [<code class="option">-d</code> <em class="replaceable"><code>database</code></em>] [<code class="option">-h</code>] [[<code class="option">-c</code> <em class="replaceable"><code>command</code></em>] | [<code class="option">-o</code> <em class="replaceable"><code>outfile</code></em>] | [<code class="option">-O</code> <em class="replaceable"><code>outfile</code></em>]] [<code class="option">-N</code> <em class="replaceable"><code>limit[:offset]</code></em>] [<code class="option">-s</code> <em class="replaceable"><code>format</code></em>] {
<em class="replaceable"><code>regexp</code></em>
}</p></div><div class="cmdsynopsis"><p><code class="command"><a id="app-c-command-getj1"></a>getj1</code> [<code class="option">-a</code>] [<code class="option">-d</code> <em class="replaceable"><code>database</code></em>] [<code class="option">-h</code>] [[<code class="option">-c</code> <em class="replaceable"><code>command</code></em>] | [<code class="option">-o</code> <em class="replaceable"><code>outfile</code></em>] | [<code class="option">-O</code> <em class="replaceable"><code>outfile</code></em>]] [<code class="option">-N</code> <em class="replaceable"><code>limit[:offset]</code></em>] [<code class="option">-s</code> <em class="replaceable"><code>format</code></em>] {
<em class="replaceable"><code>regexp</code></em>
}</p></div><div class="cmdsynopsis"><p><code class="command"><a id="app-c-command-getj2"></a>getj2</code> [<code class="option">-a</code>] [<code class="option">-d</code> <em class="replaceable"><code>database</code></em>] [<code class="option">-h</code>] [[<code class="option">-c</code> <em class="replaceable"><code>command</code></em>] | [<code class="option">-o</code> <em class="replaceable"><code>outfile</code></em>] | [<code class="option">-O</code> <em class="replaceable"><code>outfile</code></em>]] [<code class="option">-N</code> <em class="replaceable"><code>limit[:offset]</code></em>] [<code class="option">-s</code> <em class="replaceable"><code>format</code></em>] {
<em class="replaceable"><code>regexp</code></em>
}</p></div></div><div class="refsect3"><a id="refdbc-getjo-description"></a><h4>Description</h4><p>Retrieve all journal names that match the regular expression <em class="replaceable"><code>regexp</code></em> in the current database. The <em class="replaceable"><code>regexp</code></em> will be matched to the journal abbreviation, the full name, the custom abbreviation 1, and the custom abbreviation 2, respectively. If no regexp argument is given, <span class="emphasis"><em>all</em></span> available journal names will be listed.</p></div><div class="refsect3"><a id="refdbc-getjo-options"></a><h4>Options</h4><div class="variablelist"><dl class="variablelist"><dt><span class="term"><code class="option">-a</code></span></dt><dd><p>Return all synonymous journal names, i.e. full name, abbreviation, custom abbreviation 1, and custom abbreviation 2. If the option is absent, only the name that you search for will be returned, e.g. only the full name in the case of <span class="command"><strong>getjf</strong></span>.
</p></dd><dt><span class="term"><code class="option">-c</code> <em class="replaceable"><code>command</code></em></span></dt><dd><p>Pipe the output through <em class="replaceable"><code>command</code></em>.</p></dd><dt><span class="term"><code class="option">-d</code> <em class="replaceable"><code>database</code></em></span></dt><dd><p>Specify the database.</p></dd><dt><span class="term"><code class="option">-h</code></span></dt><dd><p>Display a help message explaining the command.</p></dd><dt><span class="term"><code class="option">-N</code> <em class="replaceable"><code>limit[:offset]</code></em></span></dt><dd><p>Limit the number of returned datasets. If <em class="replaceable"><code>limit</code></em> is used all by itself, the first <em class="replaceable"><code>limit</code></em> journal names are returned. If the optional <em class="replaceable"><code>offset</code></em> argument is used as well, the first <em class="replaceable"><code>offset</code></em> journal names will be skipped, and the next <em class="replaceable"><code>limit</code></em> journal names will be returned.</p></dd><dt><span class="term"><code class="option">-o</code> <em class="replaceable"><code>filename</code></em></span></dt><dd><p>Write the output to <code class="filename">filename</code> instead of to stdout.</p></dd><dt><span class="term"><code class="option">-O</code> <em class="replaceable"><code>filename</code></em></span></dt><dd><p>Append the output to <code class="filename">filename</code> instead of sending it to stdout.</p></dd><dt><span class="term"><code class="option">-s</code> <em class="replaceable"><code>format</code></em></span></dt><dd><p>Request additional frequency information. "freq" provides the absolute number of references that contain the given journal name. "relfreq" reports a relative frequency indicator as an integer between 0 and 10.</p></dd><dt><span class="term"><em class="replaceable"><code>regexp</code></em></span></dt><dd><p>All other arguments are interpreted as a unix regular expression which limits the results to matching journal names.</p><div class="note" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title">Note</h3><p>Some database engines, like SQLite, do not support Unix-style regular expressions. Use SQL regular expressions instead.</p></div></dd></dl></div></div><div class="refsect3"><a id="refdbc-getjo-example"></a><h4>Example</h4><pre class="screen">
<code class="prompt">refdbc: </code>
<strong class="userinput"><code>getjo -a -o journals.txt '^J'</code></strong>
</pre><p>This command will list all synonyms of the journals whose abbreviations start with a capital J. The output will be redirected into the file <code class="filename">journals.txt</code>.</p></div></div><div class="refsect2"><a id="app-c-command-getkw"></a><h3>getkw</h3><div class="refsect3"><a id="refdbc-getkw-synopsis"></a><h4>Synopsis</h4><div class="cmdsynopsis"><p><code class="command">getkw</code> [<code class="option">-d</code> <em class="replaceable"><code>database</code></em>] [<code class="option">-h</code>] [[<code class="option">-c</code> <em class="replaceable"><code>command</code></em>] | [<code class="option">-o</code> <em class="replaceable"><code>outfile</code></em>] | [<code class="option">-O</code> <em class="replaceable"><code>outfile</code></em>]] [<code class="option">-N</code> <em class="replaceable"><code>limit[:offset]</code></em>] [<code class="option">-s</code> <em class="replaceable"><code>format</code></em>] {
<em class="replaceable"><code>regexp</code></em>
}</p></div></div><div class="refsect3"><a id="refdbc-getkw-description"></a><h4>Description</h4><p>Retrieve all keywords that match the regular expression <em class="replaceable"><code>regexp</code></em> in the current database. If no regexp argument is specified, all keywords in the database will be listed.</p></div><div class="refsect3"><a id="refdbc-getkw-options"></a><h4>Options</h4><div class="variablelist"><dl class="variablelist"><dt><span class="term"><code class="option">-c</code> <em class="replaceable"><code>command</code></em></span></dt><dd><p>Pipe the output through <em class="replaceable"><code>command</code></em>.</p></dd><dt><span class="term"><code class="option">-d</code> <em class="replaceable"><code>database</code></em></span></dt><dd><p>Specify the database.</p></dd><dt><span class="term"><code class="option">-h</code></span></dt><dd><p>Display a help message explaining the command.</p></dd><dt><span class="term"><code class="option">-N</code> <em class="replaceable"><code>limit[:offset]</code></em></span></dt><dd><p>Limit the number of returned datasets. If <em class="replaceable"><code>limit</code></em> is used all by itself, the first <em class="replaceable"><code>limit</code></em> keywords are returned. If the optional <em class="replaceable"><code>offset</code></em> argument is used as well, the first <em class="replaceable"><code>offset</code></em> keywords will be skipped, and the next <em class="replaceable"><code>limit</code></em> keywords will be returned.</p></dd><dt><span class="term"><code class="option">-o</code> <em class="replaceable"><code>filename</code></em></span></dt><dd><p>Write the output to <code class="filename">filename</code> instead of to stdout.</p></dd><dt><span class="term"><code class="option">-O</code> <em class="replaceable"><code>filename</code></em></span></dt><dd><p>Append the output to <code class="filename">filename</code> instead of sending it to stdout.</p></dd><dt><span class="term"><code class="option">-s</code> <em class="replaceable"><code>format</code></em></span></dt><dd><p>Request additional frequency information. "freq" provides the absolute number of references that contain the given keyword. "relfreq" reports a relative frequency indicator as an integer between 0 and 10.</p></dd><dt><span class="term"><em class="replaceable"><code>regexp</code></em></span></dt><dd><p>All other arguments are interpreted as a unix regular expression which limits the results to matching keywords.</p><div class="note" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title">Note</h3><p>Some database engines, like SQLite, do not support Unix-style regular expressions. Use SQL regular expressions instead.</p></div></dd></dl></div></div><div class="refsect3"><a id="refdbc-getkw-example"></a><h4>Examples</h4><pre class="screen">
<code class="prompt">refdbc: </code>
<strong class="userinput"><code>getkw -o keywords.txt '^An.*l$'</code></strong>
</pre><p>This command will request a list of all keywords that start with <span class="quote">“<span class="quote">An</span>”</span> and end with the letter <span class="quote">“<span class="quote">l</span>”</span>, like <span class="quote">“<span class="quote">Animal</span>”</span>, and write the result to the file <code class="filename">keywords.txt</code>.</p><pre class="screen">
<code class="prompt">~# </code>
<strong class="userinput"><code>refdbc -C getkw -s freq -c "sort -r|cut -d ':' -f 2"|less</code></strong>
</pre><p>Here we run the <span class="command"><strong>getkw</strong></span> command from the shell. The result list contains the frequency of each returned keyword. The data are sorted in descending order according to the frequency, and the frequency information itself is stripped off. Of course there is more than one way to arrive here. E.g. you could use the <code class="option">-c</code> option to send the data to <em class="replaceable"><code>stdout</code></em> and pipe them through the argument of the <code class="option">-c</code> option in the example shown above.</p></div></div><div class="refsect2"><a id="app-c-command-getnote"></a><h3>getnote</h3><div class="refsect3"><a id="refdbc-getnote-synopsis"></a><h4>Synopsis</h4><div class="cmdsynopsis"><p><code class="command">getnote</code> [<code class="option">-d</code> <em class="replaceable"><code>database</code></em>] [<code class="option">-E</code> <em class="replaceable"><code>encoding</code></em>] [<code class="option">-h</code>] [[<code class="option">-c</code> <em class="replaceable"><code>command</code></em>] | [<code class="option">-o</code> <em class="replaceable"><code>outfile</code></em>] | [<code class="option">-O</code> <em class="replaceable"><code>outfile</code></em>]] [<code class="option">-N</code> <em class="replaceable"><code>limit[:offset]</code></em>] [<code class="option">-P</code>] [<code class="option">-S</code> <em class="replaceable"><code>sort-string</code></em>] [<code class="option">-t</code> <em class="replaceable"><code>output-type</code></em>] {[
<em class="replaceable"><code>search-string</code></em>
] | [<code class="option">-f</code> <em class="replaceable"><code>file</code></em>]}</p></div></div><div class="refsect3"><a id="refdbc-getnote-description"></a><h4>Description</h4><p>Displays all extended notes which match the <em class="replaceable"><code>search-string</code></em> in the current database. Refer to the section <a class="link" href="ch14s04.html" title="The query language">The query language</a> for a description of the syntax of a search string.</p></div><div class="refsect3"><a id="refdbc-getnote-options"></a><h4>Options</h4><div class="variablelist"><dl class="variablelist"><dt><span class="term"><code class="option">-c</code> <em class="replaceable"><code>command</code></em></span></dt><dd><p>Pipe the output through <em class="replaceable"><code>command</code></em>.</p></dd><dt><span class="term"><code class="option">-d</code> <em class="replaceable"><code>database</code></em></span></dt><dd><p>Specify the database.</p></dd><dt><span class="term"><code class="option">-E</code> <em class="replaceable"><code>encoding</code></em></span></dt><dd><p>Select the character encoding for the output data if it is different from the database encoding. You can request any encoding that your local libiconv supports (see <span class="command"><strong>man iconv_open</strong></span> for a list of available encodings).</p></dd><dt><span class="term"><code class="option">-f</code> <em class="replaceable"><code>infile</code></em></span></dt><dd><p>Read the search string from <em class="replaceable"><code>infile</code></em>. This is a simple way to re-run saved queries.</p></dd><dt><span class="term"><code class="option">-h</code></span></dt><dd><p>Display a help message explaining the command.</p></dd><dt><span class="term"><code class="option">-N</code> <em class="replaceable"><code>limit[:offset]</code></em></span></dt><dd><p>Limit the number of returned datasets. If <em class="replaceable"><code>limit</code></em> is used all by itself, the first <em class="replaceable"><code>limit</code></em> extended notes are returned. If the optional <em class="replaceable"><code>offset</code></em> argument is used as well, the first <em class="replaceable"><code>offset</code></em> notes will be skipped, and the next <em class="replaceable"><code>limit</code></em> notes will be returned.</p></dd><dt><span class="term"><code class="option">-o</code> <em class="replaceable"><code>filename</code></em></span></dt><dd><p>Write the output to <code class="filename">filename</code> instead of to stdout.</p></dd><dt><span class="term"><code class="option">-O</code> <em class="replaceable"><code>filename</code></em></span></dt><dd><p>Append the output to <code class="filename">filename</code> instead of sending it to stdout.</p></dd><dt><span class="term"><code class="option">-P</code></span></dt><dd><p>Limit the search to the notes which were added by the current user. If this switch is absent, the whole database will be searched.</p></dd><dt><span class="term"><code class="option">-S</code> <em class="replaceable"><code>sort-string</code></em></span></dt><dd><p>Sort the output. Currently you can sort only by <em class="wordasword">ID</em> (the default) or by <em class="wordasword">PY</em> (publication year).</p></dd><dt><span class="term"><code class="option">-t</code> <em class="replaceable"><code>output-type</code></em></span></dt><dd><p>Select the type of output. Available are "scrn", "html", "xhtml", and "xnote" for a compact format suitable for terminal browsing, HTML, XHTML, or the native XML format, respectively.</p></dd><dt><span class="term"><em class="replaceable"><code>search-string</code></em></span></dt><dd><p>The remainder of the arguments is interpreted as a search string. The syntax of the queries is described in the section <a class="link" href="ch14s04.html" title="The query language">query language</a>.</p></dd></dl></div></div><div class="refsect3"><a id="refdbc-getnote-example"></a><h4>Example</h4><pre class="screen" width="60">
<code class="prompt">refdbc: </code>
<strong class="userinput"><code>getnote -t xnote :CK:=Miller1999</code></strong>
</pre><p>This command retrieves notes which are attached to the reference with the citation key "Miller1999" and displays them in the xnote format.</p></div></div><div class="refsect2"><a id="app-c-command-getref"></a><h3>getref</h3><div class="refsect3"><a id="refdbc-getref-synopsis"></a><h4>Synopsis</h4><div class="cmdsynopsis"><p><code class="command">getref</code> [<code class="option">-b</code> <em class="replaceable"><code>listname</code></em>] [<code class="option">-d</code> <em class="replaceable"><code>database</code></em>] [<code class="option">-E</code> <em class="replaceable"><code>encoding</code></em>] [<code class="option">-h</code>] [[<code class="option">-c</code> <em class="replaceable"><code>command</code></em>] | [<code class="option">-o</code> <em class="replaceable"><code>outfile</code></em>] | [<code class="option">-O</code> <em class="replaceable"><code>outfile</code></em>]] [<code class="option">-N</code> <em class="replaceable"><code>limit[:offset]</code></em>] [<code class="option">-s</code> <em class="replaceable"><code>format-string</code></em>] [<code class="option">-S</code> <em class="replaceable"><code>sort-string</code></em>] [<code class="option">-t</code> <em class="replaceable"><code>output-format</code></em>] {[
<em class="replaceable"><code>search-string</code></em>
] | [<code class="option">-f</code> <em class="replaceable"><code>file</code></em>]}</p></div></div><div class="refsect3"><a id="refdbc-getref-description"></a><h4>Description</h4><p>Displays all datasets which match the <em class="replaceable"><code>search-string</code></em> in the current database. Refer to the section <a class="link" href="ch14s04.html" title="The query language">The query language</a> for a description of the syntax of a search string. See the <a class="link" href="re11.html#app-c-command-countref" title="countref">countref</a> command if you want to know how many references match your current query without actually retrieving a possibly large amount of reference data.</p></div><div class="refsect3"><a id="refdbc-getref-options"></a><h4>Options</h4><div class="variablelist"><dl class="variablelist"><dt><span class="term"><code class="option">-b</code> <em class="replaceable"><code>listname</code></em></span></dt><dd><p>Limit the search to the personal reference list named <em class="replaceable"><code>listname</code></em>.</p></dd><dt><span class="term"><code class="option">-c</code> <em class="replaceable"><code>command</code></em></span></dt><dd><p>Pipe the output through <em class="replaceable"><code>command</code></em>.</p></dd><dt><span class="term"><code class="option">-d</code> <em class="replaceable"><code>database</code></em></span></dt><dd><p>Specify the database.</p></dd><dt><span class="term"><code class="option">-E</code> <em class="replaceable"><code>encoding</code></em></span></dt><dd><p>Select the character encoding for the output data if it is different from the database encoding. You can request any encoding that your local libiconv supports (see <span class="command"><strong>man iconv_open</strong></span> for a list of available encodings).</p></dd><dt><span class="term"><code class="option">-f</code> <em class="replaceable"><code>infile</code></em></span></dt><dd><p>Read the search string from <em class="replaceable"><code>infile</code></em>. This is a simple way to re-run saved queries.</p></dd><dt><span class="term"><code class="option">-h</code></span></dt><dd><p>Display a help message explaining the command.</p></dd><dt><span class="term"><code class="option">-N</code> <em class="replaceable"><code>limit[:offset]</code></em></span></dt><dd><p>Limit the number of returned datasets. If <em class="replaceable"><code>limit</code></em> is used all by itself, the first <em class="replaceable"><code>limit</code></em> matching references are returned. If the optional <em class="replaceable"><code>offset</code></em> argument is used as well, the first <em class="replaceable"><code>offset</code></em> matching references will be skipped, and the next <em class="replaceable"><code>limit</code></em> matching references will be returned.</p></dd><dt><span class="term"><code class="option">-o</code> <em class="replaceable"><code>filename</code></em></span></dt><dd><p>Write the output to <code class="filename">filename</code> instead of to stdout.</p></dd><dt><span class="term"><code class="option">-O</code> <em class="replaceable"><code>filename</code></em></span></dt><dd><p>Append the output to <code class="filename">filename</code> instead of sending it to stdout.</p></dd><dt><span class="term"><code class="option">-s</code> <em class="replaceable"><code>format-string</code></em></span></dt><dd><p>Specify additional fields and pseudo-fields (N1, N2/AB, NX, RP, SN, AD, CY, PB, LX, U1 through U5, M1 through M3) that are not displayed by default, except for the RIS and risx output formats. Use "ALL" as an argument to display all available fields. If several fields are specified, the argument has to be enclosed by single quotation marks. If applied to RIS output, you can specify <em class="wordasword">ID</em> as <em class="replaceable"><code>format-string</code></em> to get only a list of ID values in RIS format for all references that match the search. This is a convenient way to generate ID lists for later operations like <a class="link" href="re11.html#app-c-command-deleteref" title="deleteref"><span class="command"><strong>deleteref</strong></span></a>.</p></dd><dt><span class="term"><code class="option">-S</code> <em class="replaceable"><code>sort-string</code></em></span></dt><dd><p>Sort the output. Currently you can sort only by <em class="wordasword">ID</em> (the default) or by <em class="wordasword">PY</em> (publication year).</p></dd><dt><span class="term"><code class="option">-t</code> <em class="replaceable"><code>output-type</code></em></span></dt><dd><p>Select the type of output. Available are "scrn", "ris", "risx", "html", "xhtml", "db31", "db31x", "db50x, "teix", "tei5x", "mods", and "bibtex" for a compact format suitable for terminal browsing, the native RIS and risx (XML) formats, HTML, XHTML, DocBook SGML, DocBook XML (DTD-based), DocBook XML (schema-based), TEI P4 XML, TEI P5 XML, MODS, or BibTeX format, respectively.</p></dd><dt><span class="term"><em class="replaceable"><code>search-string</code></em></span></dt><dd><p>The remainder of the arguments is interpreted as a search string. The syntax of the queries is described in the section <a class="link" href="ch14s04.html" title="The query language">query language</a>.</p></dd></dl></div></div><div class="refsect3"><a id="refdbc-getref-example"></a><h4>Example</h4><pre class="screen" width="60">
<code class="prompt">refdbc: </code>
<strong class="userinput"><code>getref -t ris -o temp.sgml -E ISO-8859-15 ":AU:='& ^Doe ^Jones' AND :KW:=circular\ dichroism"</code></strong>
</pre><p>This command retrieves articles with both an author starting with <span class="quote">“<span class="quote">Doe</span>”</span> and an author starting with <span class="quote">“<span class="quote">Jones</span>”</span> that have the keyword <span class="quote">“<span class="quote">circular dichroism</span>”</span>. The output will be saved in RIS format to the file <code class="filename">temp.sgml</code> using the character encoding ISO-8859-15.</p></div></div><div class="refsect2"><a id="app-c-command-help"></a><h3>help, ?</h3><div class="refsect3"><a id="refdbc-help-synopsis"></a><h4>Synopsis</h4><div class="cmdsynopsis"><p><code class="command">help</code> </p></div><div class="cmdsynopsis"><p><code class="command">?</code> </p></div></div><div class="refsect3"><a id="refdbc-help-description"></a><h4>Description</h4><p>Displays a brief summary of the available commands.</p><div class="note" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title">Note</h3><p>This command is not available in the batch mode (use the <code class="option">-h</code> option instead to review the command line usage).</p></div></div><div class="refsect3"><a id="refdbc-help-example"></a><h4>Example</h4><pre class="screen">
<code class="prompt">refdbc: </code>
<strong class="userinput"><code>help</code></strong>
</pre><p>This will list the available commands.</p></div></div><div class="refsect2"><a id="app-c-command-listdb"></a><h3>listdb</h3><div class="refsect3"><a id="refdbc-listdb-synopsis"></a><h4>Synopsis</h4><div class="cmdsynopsis"><p><code class="command">listdb</code> [<code class="option">-h</code>] [<em class="replaceable"><code>database-regexp</code></em>]</p></div></div><div class="refsect3"><a id="refdbc-listdb-description"></a><h4>Description</h4><p>Lists all available databases if no argument is specified. If <em class="replaceable"><code>database-regexp</code></em> is specified, only the databases matching this expression will be listed.</p></div><div class="refsect3"><a id="refdbc-listdb-options"></a><h4>Options</h4><div class="variablelist"><dl class="variablelist"><dt><span class="term"><code class="option">-h</code></span></dt><dd><p>Displays a help message explaining the <span class="command"><strong>listdb</strong></span> command.</p></dd><dt><span class="term"><em class="replaceable"><code>database-regexp</code></em></span></dt><dd><p>A valid <a class="link" href="ch14s05.html#sect2-regular-expressions-sql" title="SQL regular expressions">SQL regular expression which limits the output to matching database names.</a>
</p></dd></dl></div></div><div class="refsect3"><a id="refdbc-listdb-example"></a><h4>Example</h4><pre class="screen">
<code class="prompt">refdbc: </code>
<strong class="userinput"><code>listdb db%</code></strong>
</pre><p>This command will list all available databases that start with <span class="quote">“<span class="quote">db</span>”</span>.</p></div></div><div class="refsect2"><a id="app-c-command-liststyle"></a><h3>liststyle</h3><div class="refsect3"><a id="refdbc-liststyle-synopsis"></a><h4>Synopsis</h4><div class="cmdsynopsis"><p><code class="command">liststyle</code> {
<em class="replaceable"><code>style-regexp</code></em>
}</p></div></div><div class="refsect3"><a id="refdbc-liststyle-description"></a><h4>Description</h4><p>Lists all available bibliography styles that match <em class="replaceable"><code>style-regexp</code></em>.If no argument is specified, all available styles will be listed.</p></div><div class="refsect3"><a id="refdbc-liststyle-options"></a><h4>Options</h4><div class="variablelist"><dl class="variablelist"><dt><span class="term"><code class="option">-h</code></span></dt><dd><p>Displays a help message explaining the <span class="command"><strong>listdb</strong></span> command.</p></dd><dt><span class="term"><em class="replaceable"><code>style-regexp</code></em></span></dt><dd><p>A valid <a class="link" href="ch14s05.html#sect2-regular-expressions-unix" title="Unix-style regular expressions">Unix regular expression</a> which limits the output to matching style names.</p><div class="note" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title">Note</h3><p>Some database engines, like SQLite, do not support <a class="link" href="ch14s05.html#sect2-regular-expressions-unix" title="Unix-style regular expressions">Unix-style regular expressions</a>. Use <a class="link" href="ch14s05.html#sect2-regular-expressions-sql" title="SQL regular expressions">SQL regular expressions</a> instead.</p></div></dd></dl></div></div><div class="refsect3"><a id="refdbc-liststyle-example"></a><h4>Example</h4><pre class="screen">
<code class="prompt">refdbc: </code>
<strong class="userinput"><code>liststyle <em class="replaceable"><code>^J.*</code></em></code></strong>
</pre><p>This will list all bibliography styles that start with a capital <span class="quote">“<span class="quote">J</span>”</span>.</p></div></div><div class="refsect2"><a id="app-c-command-pickref"></a><h3>pickref</h3><div class="refsect3"><a id="refdbc-pickref-synopsis"></a><h4>Synopsis</h4><div class="cmdsynopsis"><p><code class="command">pickref</code> [<code class="option">-b</code> <em class="replaceable"><code>listname</code></em>] [<code class="option">-d</code> <em class="replaceable"><code>database</code></em>] [<code class="option">-h</code>] [[<code class="option">-c</code> <em class="replaceable"><code>command</code></em>] | [<code class="option">-o</code> <em class="replaceable"><code>outfile</code></em>] | [<code class="option">-O</code> <em class="replaceable"><code>outfile</code></em>]] {[<em class="replaceable"><code>ID</code></em>...] | [<code class="option">-f</code> <em class="replaceable"><code>file</code></em>]}</p></div></div><div class="refsect3"><a id="refdbc-pickref-description"></a><h4>Description</h4><p>Adds references to the specified personal reference list in the current database. If no personal reference list is specified, the default list (carrying the same name as your database username) will be used instead.</p></div><div class="refsect3"><a id="refdbc-pickref-options"></a><h4>Options</h4><div class="variablelist"><dl class="variablelist"><dt><span class="term"><code class="option">-b</code> <em class="replaceable"><code>listname</code></em></span></dt><dd><p>Use the personal reference list named <em class="replaceable"><code>listname</code></em>.</p></dd><dt><span class="term"><code class="option">-c</code> <em class="replaceable"><code>command</code></em></span></dt><dd><p>Pipe the output through <em class="replaceable"><code>command</code></em>.</p></dd><dt><span class="term"><code class="option">-d</code> <em class="replaceable"><code>database</code></em></span></dt><dd><p>Specify the database.</p></dd><dt><span class="term"><code class="option">-f</code> <em class="replaceable"><code>infile</code></em></span></dt><dd><p>Read a list of ID values in the RIS format from <em class="replaceable"><code>infile</code></em>. This list may be the result of a previous <a class="link" href="re11.html#app-c-command-getref" title="getref">getref</a> command.</p></dd><dt><span class="term"><code class="option">-h</code></span></dt><dd><p>Display a help message explaining the command.</p></dd><dt><span class="term"><code class="option">-o</code> <em class="replaceable"><code>filename</code></em></span></dt><dd><p>Write the output to <code class="filename">filename</code> instead of to stdout.</p></dd><dt><span class="term"><code class="option">-O</code> <em class="replaceable"><code>filename</code></em></span></dt><dd><p>Append the output to <code class="filename">filename</code> instead of sending it to stdout.</p></dd><dt><span class="term"><em class="replaceable"><code>ID</code></em></span></dt><dd><p>All other arguments are interpreted as a list of ID values. Ranges may be used to specify consecutive IDs. If neither IDs nor an <em class="replaceable"><code>infile</code></em> are provided, refdbc attempts to read the IDs from stdin. You can ask refdbc to read ID values from stdin <span class="emphasis"><em>in addition</em></span> to other IDs by using the <code class="option">-f stdin</code> option.</p></dd></dl></div></div><div class="refsect3"><a id="refdbc-pickref-example"></a><h4>Example</h4><pre class="screen">
<code class="prompt">refdbc: </code>
<strong class="userinput"><code>pickref -f foo.ris 3 5-10 26</code></strong>
</pre><p>This command will add the references 3, 5 through 10, and 26 as well as those listed in the file <code class="filename">foo.ris</code> to your personal reference list.</p></div></div><div class="refsect2"><a id="app-c-command-countnote"></a><h3>countnote</h3><div class="refsect3"><a id="refdbc-countnote-synopsis"></a><h4>Synopsis</h4><div class="cmdsynopsis"><p><code class="command">countnote</code> [<code class="option">-b</code> <em class="replaceable"><code>listname</code></em>] [<code class="option">-c</code> <em class="replaceable"><code>command</code></em>] [<code class="option">-d</code> <em class="replaceable"><code>database</code></em>] [<code class="option">-h</code>] [<code class="option">-N</code> <em class="replaceable"><code>limit[:offset]</code></em>] {[
<em class="replaceable"><code>search-string</code></em>
] | [<code class="option">-f</code> <em class="replaceable"><code>file</code></em>]}</p></div></div><div class="refsect3"><a id="refdbc-countnote-description"></a><h4>Description</h4><p>Counts all extended notes which match the <em class="replaceable"><code>search-string</code></em> in the current database. Refer to the section <a class="link" href="ch14s04.html" title="The query language">The query language</a> for a description of the syntax of a search string. This command is equivalent to the <a class="link" href="re11.html#app-c-command-getnote" title="getnote">getnote</a> command except that it does not return the matching notes. It just counts them.</p></div><div class="refsect3"><a id="refdbc-countnote-options"></a><h4>Options</h4><div class="variablelist"><dl class="variablelist"><dt><span class="term"><code class="option">-b</code> <em class="replaceable"><code>listname</code></em></span></dt><dd><p>Limit the search to the personal reference list named <em class="replaceable"><code>listname</code></em>.</p></dd><dt><span class="term"><code class="option">-c</code> <em class="replaceable"><code>command</code></em></span></dt><dd><p>Pipe the output through <em class="replaceable"><code>command</code></em>.</p></dd><dt><span class="term"><code class="option">-d</code> <em class="replaceable"><code>database</code></em></span></dt><dd><p>Specify the database.</p></dd><dt><span class="term"><code class="option">-f</code> <em class="replaceable"><code>infile</code></em></span></dt><dd><p>Read the search string from <em class="replaceable"><code>infile</code></em>. This is a simple way to re-run saved queries.</p></dd><dt><span class="term"><code class="option">-h</code></span></dt><dd><p>Display a help message explaining the command.</p></dd><dt><span class="term"><code class="option">-N</code> <em class="replaceable"><code>limit[:offset]</code></em></span></dt><dd><p>Limit the number of returned datasets. If <em class="replaceable"><code>limit</code></em> is used all by itself, the first <em class="replaceable"><code>limit</code></em> matching references are returned. If the optional <em class="replaceable"><code>offset</code></em> argument is used as well, the first <em class="replaceable"><code>offset</code></em> matching references will be skipped, and the next <em class="replaceable"><code>limit</code></em> matching references will be returned.</p></dd><dt><span class="term"><em class="replaceable"><code>search-string</code></em></span></dt><dd><p>The remainder of the arguments is interpreted as a search string. The syntax of the queries is described in the section <a class="link" href="ch14s04.html" title="The query language">query language</a>.</p></dd></dl></div></div><div class="refsect3"><a id="refdbc-countnote-example"></a><h4>Example</h4><pre class="screen" width="60">
<code class="prompt">refdbc: </code>
<strong class="userinput"><code>countnote :KW:~[rR]eview</code></strong>
</pre><p>This command looks for extended notes that are linked to references which contain keywords like "review" or "Review". The command will return the number of matching notes in the result summary.</p></div></div><div class="refsect2"><a id="app-c-command-countref"></a><h3>countref</h3><div class="refsect3"><a id="refdbc-countref-synopsis"></a><h4>Synopsis</h4><div class="cmdsynopsis"><p><code class="command">countref</code> [<code class="option">-b</code> <em class="replaceable"><code>listname</code></em>] [<code class="option">-c</code> <em class="replaceable"><code>command</code></em>] [<code class="option">-d</code> <em class="replaceable"><code>database</code></em>] [<code class="option">-h</code>] [<code class="option">-N</code> <em class="replaceable"><code>limit[:offset]</code></em>] {[
<em class="replaceable"><code>search-string</code></em>
] | [<code class="option">-f</code> <em class="replaceable"><code>file</code></em>]}</p></div></div><div class="refsect3"><a id="refdbc-countref-description"></a><h4>Description</h4><p>Counts all datasets which match the <em class="replaceable"><code>search-string</code></em> in the current database. Refer to the section <a class="link" href="ch14s04.html" title="The query language">The query language</a> for a description of the syntax of a search string. This command is equivalent to the <a class="link" href="re11.html#app-c-command-getref" title="getref">getref</a> command except that it does not return the matching references. It just counts them.</p></div><div class="refsect3"><a id="refdbc-countref-options"></a><h4>Options</h4><div class="variablelist"><dl class="variablelist"><dt><span class="term"><code class="option">-b</code> <em class="replaceable"><code>listname</code></em></span></dt><dd><p>Limit the search to the personal reference list named <em class="replaceable"><code>listname</code></em>.</p></dd><dt><span class="term"><code class="option">-c</code> <em class="replaceable"><code>command</code></em></span></dt><dd><p>Pipe the output through <em class="replaceable"><code>command</code></em>.</p></dd><dt><span class="term"><code class="option">-d</code> <em class="replaceable"><code>database</code></em></span></dt><dd><p>Specify the database.</p></dd><dt><span class="term"><code class="option">-f</code> <em class="replaceable"><code>infile</code></em></span></dt><dd><p>Read the search string from <em class="replaceable"><code>infile</code></em>. This is a simple way to re-run saved queries.</p></dd><dt><span class="term"><code class="option">-h</code></span></dt><dd><p>Display a help message explaining the command.</p></dd><dt><span class="term"><code class="option">-N</code> <em class="replaceable"><code>limit[:offset]</code></em></span></dt><dd><p>Limit the number of returned datasets. If <em class="replaceable"><code>limit</code></em> is used all by itself, the first <em class="replaceable"><code>limit</code></em> matching references are returned. If the optional <em class="replaceable"><code>offset</code></em> argument is used as well, the first <em class="replaceable"><code>offset</code></em> matching references will be skipped, and the next <em class="replaceable"><code>limit</code></em> matching references will be returned.</p></dd><dt><span class="term"><em class="replaceable"><code>search-string</code></em></span></dt><dd><p>The remainder of the arguments is interpreted as a search string. The syntax of the queries is described in the section <a class="link" href="ch14s04.html" title="The query language">query language</a>.</p></dd></dl></div></div><div class="refsect3"><a id="refdbc-countref-example"></a><h4>Example</h4><pre class="screen" width="60">
<code class="prompt">refdbc: </code>
<strong class="userinput"><code>countref ":AU:='& ^Doe ^Jones' AND :KW:=circular\ dichroism"</code></strong>
</pre><p>This command looks for articles with both an author starting with <span class="quote">“<span class="quote">Doe</span>”</span> and an author starting with <span class="quote">“<span class="quote">Jones</span>”</span> that have the keyword <span class="quote">“<span class="quote">circular dichroism</span>”</span>. The command will return the number of matching references in the result summary.</p></div></div><div class="refsect2"><a id="app-c-command-selectdb"></a><h3>selectdb</h3><div class="refsect3"><a id="refdbc-selectdb-synopsis"></a><h4>Synopsis</h4><div class="cmdsynopsis"><p><code class="command">selectdb</code> [<code class="option">-h</code>] {
<em class="replaceable"><code>database</code></em>
}</p></div></div><div class="refsect3"><a id="refdbc-selectdb-description"></a><h4>Description</h4><p>Select <em class="replaceable"><code>database</code></em> as the current database. This current database will be used in all queries unless you specify a different database with the <code class="option">-d</code> option of the query commands.</p><div class="note" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title">Note</h3><p>This command is not available in the batch mode. Use the <code class="option">-d</code> command line option instead.</p></div></div><div class="refsect3"><a id="refdbc-selectdb-options"></a><h4>Options</h4><div class="variablelist"><dl class="variablelist"><dt><span class="term"><code class="option">-h</code></span></dt><dd><p>Display a help message explaining the command.</p></dd><dt><span class="term"><em class="replaceable"><code>database</code></em></span></dt><dd><p>The name of the database to be selected.</p></dd></dl></div></div><div class="refsect3"><a id="refdbc-selectdb-example"></a><h4>Example</h4><pre class="screen">
<code class="prompt">refdbc: </code>
<strong class="userinput"><code>selectdb db1</code></strong>
</pre><p>This command will make the database <code class="filename">db1</code> the active database. All further queries and operations will affect this database.</p></div></div><div class="refsect2"><a id="app-c-command-set"></a><h3>set</h3><div class="refsect3"><a id="refdbc-set-synopsis"></a><h4>Synopsis</h4><div class="cmdsynopsis"><p><code class="command">set</code> [<code class="option">-h</code>] [<em class="replaceable"><code>varname</code></em>] [<em class="replaceable"><code>varvalue</code></em>]</p></div></div><div class="refsect3"><a id="refdbc-set-description"></a><h4>Description</h4><p>The <span class="command"><strong>set</strong></span> command displays or modifies the values of configuration variables.</p><p>If you call <span class="command"><strong>set</strong></span> without any arguments, it will display a list of all configuration variables with their current values.</p><p>If you call <span class="command"><strong>set</strong></span> with one argument, it will display the value of this particular variable.</p><p>If you call <span class="command"><strong>set</strong></span> with two arguments, it will set the variable (first argument) to the new value (second argument). To specify an empty value, use two quotation marks like this:"".</p><div class="note" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title">Note</h3><p>For obvious reasons, <span class="command"><strong>set</strong></span> will never display the current password although you can certainly change the password with this command. To make sure no one else sees the new password that you enter, run the command <span class="command"><strong>set passwd *</strong></span>. You will then be asked to enter a password which will not be echoed on the screen.</p><p>This command is not available in batch mode, use the command line switches instead. In the interactive mode, the changes to the configuration variables are limited to the current session. If you want to change the values permanently, you should rather edit one of the configuration files.</p></div></div><div class="refsect3"><a id="refdbc-set-options"></a><h4>Options</h4><div class="variablelist"><dl class="variablelist"><dt><span class="term"><code class="option">-h</code></span></dt><dd><p>Displays a help message explaining the <span class="command"><strong>set</strong></span> command.</p></dd><dt><span class="term"><em class="replaceable"><code>varname</code></em></span></dt><dd><p>The name of the variable whose value should be displayed or set.</p></dd><dt><span class="term"><em class="replaceable"><code>varvalue</code></em></span></dt><dd><p>The new value of the variable to be set.</p></dd></dl></div></div><div class="refsect3"><a id="refdbc-set-example"></a><h4>Example</h4><pre class="screen">
<code class="prompt">refdbc: </code>
<strong class="userinput"><code>set timeout 90</code></strong>
</pre><p>This command will set the timeout to 90 seconds for the current session.</p></div></div><div class="refsect2"><a id="app-c-command-updatejo"></a><h3>updatejo</h3><div class="refsect3"><a id="refdbc-updatejo-synopsis"></a><h4>Synopsis</h4><div class="cmdsynopsis"><p><code class="command">updatejo</code> [<code class="option">-d</code> <em class="replaceable"><code>database</code></em>] [<code class="option">-h</code>] [[<code class="option">-c</code> <em class="replaceable"><code>command</code></em>] | [<code class="option">-o</code> <em class="replaceable"><code>outfile</code></em>] | [<code class="option">-O</code> <em class="replaceable"><code>outfile</code></em>]] {:XY:=<em class="replaceable"><code>name</code></em>} {:XY:=<em class="replaceable"><code>name</code></em>...}</p></div></div><div class="refsect3"><a id="refdbc-updatejo-description"></a><h4>Description</h4><p>Updates the list of synonyms of a particular periodical.</p><p>Each periodical can have up to four synonymous names. The full name and an official abbreviation (e.g. according to the Index Medicus for biomedical publications) should always be supplied if available. In addition, refdb can store up to two user-defined abbreviations which may serve as shorthands when adding datasets.</p></div><div class="refsect3"><a id="refdbc-updatejo-options"></a><h4>Options</h4><div class="variablelist"><dl class="variablelist"><dt><span class="term"><code class="option">-c</code> <em class="replaceable"><code>command</code></em></span></dt><dd><p>Pipe the output through <em class="replaceable"><code>command</code></em>.</p></dd><dt><span class="term"><code class="option">-d</code> <em class="replaceable"><code>database</code></em></span></dt><dd><p>Specify the database.</p></dd><dt><span class="term"><code class="option">-h</code></span></dt><dd><p>Display a help message explaining the command.</p></dd><dt><span class="term"><code class="option">-o</code> <em class="replaceable"><code>filename</code></em></span></dt><dd><p>Write the output to <code class="filename">filename</code> instead of to stdout.</p></dd><dt><span class="term"><code class="option">-O</code> <em class="replaceable"><code>filename</code></em></span></dt><dd><p>Append the output to <code class="filename">filename</code> instead of sending it to stdout.</p></dd><dt><span class="term"><em class="replaceable"><code>:XY:=</code></em><em class="replaceable"><code>name</code></em></span></dt><dd><p>XY stands for one of JF, JO, J1, or J2 which denote the full name, the abbreviated name, and the user abbreviations 1 and 2, respectively. You have to supply at least two of these items. The first one selects the periodical by one of its existing names in the database. All other items update or add the names as provided.</p></dd></dl></div></div><div class="refsect3"><a id="refdbc-updatejo-example"></a><h4>Example</h4><pre class="screen">
<code class="prompt">refdbc: </code>
<strong class="userinput"><code>updatejo :JO:="J.Biol.Chem." :JF:="The Journal of Biological Chemistry"</code></strong>
</pre><p>Adds (or changes) the full name of the periodical known by its official abbreviation as "J.Biol.Chem." to read "The Journal of Biological Chemistry".</p></div></div><div class="refsect2"><a id="app-c-command-updatenote"></a><h3>updatenote</h3><div class="refsect3"><a id="refdbc-updatenote-synopsis"></a><h4>Synopsis</h4><div class="cmdsynopsis"><p><code class="command">updatenote</code> [<code class="option">-d</code> <em class="replaceable"><code>database</code></em>] [<code class="option">-E</code> <em class="replaceable"><code>encoding</code></em>] [<code class="option">-h</code>] [[<code class="option">-c</code> <em class="replaceable"><code>command</code></em>] | [<code class="option">-o</code> <em class="replaceable"><code>outfile</code></em>] | [<code class="option">-O</code> <em class="replaceable"><code>outfile</code></em>]] [<em class="replaceable"><code>file</code></em>...]</p></div></div><div class="refsect3"><a id="refdbc-updatenote-description"></a><h4>Description</h4><p>Updates the extended notes in <em class="replaceable"><code>file</code></em> in the current database.</p><p>This command is essentially the same as <a class="link" href="re11.html#app-c-command-addnote" title="addnote">addnote</a>, but it uses the <code class="sgmltag-attribute">citekey</code> or <code class="sgmltag-attribute">id</code> attributes (in this order) to update an existing note in the database. If the specified note does not exist in the database, a new one will be created.</p></div><div class="refsect3"><a id="refdbc-updatenote-options"></a><h4>Options</h4><div class="variablelist"><dl class="variablelist"><dt><span class="term"><code class="option">-c</code> <em class="replaceable"><code>command</code></em></span></dt><dd><p>Pipe the output through <em class="replaceable"><code>command</code></em>.</p></dd><dt><span class="term"><code class="option">-d</code> <em class="replaceable"><code>database</code></em></span></dt><dd><p>Specify the database.</p></dd><dt><span class="term"><code class="option">-E</code> <em class="replaceable"><code>encoding</code></em></span></dt><dd><p>Select the character encoding for the input data if it is different from the default UTF-8.</p></dd><dt><span class="term"><code class="option">-h</code></span></dt><dd><p>Display a help message explaining the command.</p></dd><dt><span class="term"><code class="option">-o</code> <em class="replaceable"><code>filename</code></em></span></dt><dd><p>Write the output to <code class="filename">filename</code> instead of to stdout.</p></dd><dt><span class="term"><code class="option">-O</code> <em class="replaceable"><code>filename</code></em></span></dt><dd><p>Append the output to <code class="filename">filename</code> instead of sending it to stdout.</p></dd></dl></div></div><div class="refsect3"><a id="refdbc-updatenote-example"></a><h4>Example</h4><pre class="screen">
<code class="prompt">refdbc: </code>
<strong class="userinput"><code>updatenote foo.xml</code></strong>
</pre><p>This command will update the extended notes in <code class="filename">foo.ris</code> in the currently selected database. If the notes do not specify a date, refdbd will insert a timestamp automatically.</p></div></div><div class="refsect2"><a id="app-c-command-updateref"></a><h3>updateref</h3><div class="refsect3"><a id="refdbc-updateref-synopsis"></a><h4>Synopsis</h4><div class="cmdsynopsis"><p><code class="command">updateref</code> [<code class="option">-d</code> <em class="replaceable"><code>database</code></em>] [<code class="option">-E</code> <em class="replaceable"><code>encoding</code></em>] [<code class="option">-h</code>] [[<code class="option">-c</code> <em class="replaceable"><code>command</code></em>] | [<code class="option">-o</code> <em class="replaceable"><code>outfile</code></em>] | [<code class="option">-O</code> <em class="replaceable"><code>outfile</code></em>]] [<code class="option">-t</code> <em class="replaceable"><code>type</code></em>] [<code class="option">-P</code>] [<code class="option">-U</code> <em class="replaceable"><code>username</code></em>] [<em class="replaceable"><code>file</code></em>]</p></div></div><div class="refsect3"><a id="refdbc-updateref-description"></a><h4>Description</h4><p>Updates the references in RIS format in <em class="replaceable"><code>file</code></em> in the current database.</p><p>This command is essentially the same as <a class="link" href="re11.html#app-c-command-addref" title="addref">addref</a>, but it uses the <em class="wordasword">ID</em> fields in the input data to update existing references with the same ID. If the ID of a reference is not existent in the database, a new entry is created, ignoring the ID specified in the RIS or risx file. Currently refdb does not check whether the new dataset has any similarity with the old one having the same ID. If you tell refdb to update a reference, it uses whatever you send to this end.</p></div><div class="refsect3"><a id="refdbc-updateref-options"></a><h4>Options</h4><div class="variablelist"><dl class="variablelist"><dt><span class="term"><code class="option">-c</code> <em class="replaceable"><code>command</code></em></span></dt><dd><p>Pipe the output through <em class="replaceable"><code>command</code></em>.</p></dd><dt><span class="term"><code class="option">-d</code> <em class="replaceable"><code>database</code></em></span></dt><dd><p>Specify the database.</p></dd><dt><span class="term"><code class="option">-E</code> <em class="replaceable"><code>encoding</code></em></span></dt><dd><p>Select the character encoding for the input data if it is different from the default setting. RIS datasets can use any encoding that your local libiconv supports (see <span class="command"><strong>man iconv_open</strong></span> for a list of available encodings), except UTF-16 and UTF-32. RISX datasets carry the encoding in the processing instructions, therefore this option is not needed and ignored.</p></dd><dt><span class="term"><code class="option">-h</code></span></dt><dd><p>Display a help message explaining the command.</p></dd><dt><span class="term"><code class="option">-o</code> <em class="replaceable"><code>filename</code></em></span></dt><dd><p>Write the output to <code class="filename">filename</code> instead of to stdout.</p></dd><dt><span class="term"><code class="option">-O</code> <em class="replaceable"><code>filename</code></em></span></dt><dd><p>Append the output to <code class="filename">filename</code> instead of sending it to stdout.</p></dd><dt><span class="term"><code class="option">-t</code> <em class="replaceable"><code>type</code></em></span></dt><dd><p>Select the input data type. Possible values are "ris" (default) and "risx". Other data types have to be converted to one of these types before adding them to the database.</p></dd><dt><span class="term"><code class="option">-P</code></span></dt><dd><p>Update only the personal information for this reference, i.e. the N1 (notes), RP (reprint status), and AV (availability) fields. This will automatically add the reference to your personal reference list. All other fields will be ignored. Combine this option with the <code class="option">-g</code> option e.g. to quickly change the reprint status of existing references to <span class="quote">“<span class="quote">IN FILE</span>”</span> from <span class="quote">“<span class="quote">NOT IN FILE</span>”</span> or from <span class="quote">“<span class="quote">ON REQUEST</span>”</span>.</p></dd><dt><span class="term"><code class="option">-U</code> <em class="replaceable"><code>username</code></em></span></dt><dd><p>Provide a different username than that of the current user, so e.g. some technician or administrative staff can add references in behalf of a researcher.</p></dd><dt><span class="term"><em class="replaceable"><code>file</code></em></span></dt><dd><p>All other command-line arguments will be interpreted as filenames to read references from. If no filenames are specified, the data will be read from stdin.</p></dd></dl></div></div><div class="refsect3"><a id="refdbc-updateref-example"></a><h4>Example</h4><pre class="screen">
<code class="prompt">refdbc: </code>
<strong class="userinput"><code>updateref -P foo.ris</code></strong>
</pre><p>This command will update the references in <code class="filename">foo.ris</code> in the previously selected active database. Only the personal information (AV, N1, RP) will be added or modified for the current user.</p></div></div><div class="refsect2"><a id="app-c-command-verbose"></a><h3>verbose</h3><div class="refsect3"><a id="refdbc-verbose-synopsis"></a><h4>Synopsis</h4><div class="cmdsynopsis"><p><code class="command">verbose</code> [<code class="option">-h</code>]</p></div></div><div class="refsect3"><a id="refdbc-verbose-description"></a><h4>Description</h4><p>Toggles the verbose mode on or off. If the verbose mode is on, the error messages and warnings may be some more comprehensible.</p></div><div class="refsect3"><a id="refdbc-verbose-options"></a><h4>Options</h4><div class="variablelist"><dl class="variablelist"><dt><span class="term"><code class="option">-h</code></span></dt><dd><p>Displays a help message explaining the <span class="command"><strong>verbose</strong></span> command.</p></dd></dl></div></div><div class="refsect3"><a id="refdbc-verbose-example"></a><h4>Example</h4><pre class="screen">
<code class="prompt">refdbc: </code>
<strong class="userinput"><code>verbose</code></strong>
</pre><p>Depending on the previous value, this command will either turn the verbose mode on or off.</p></div></div><div class="refsect2"><a id="app-c-command-whichdb"></a><h3>whichdb</h3><div class="refsect3"><a id="refdbc-whichdb-synopsis"></a><h4>Synopsis</h4><div class="cmdsynopsis"><p><code class="command">whichdb</code> [<code class="option">-h</code>]</p></div></div><div class="refsect3"><a id="refdbc-whichdb-description"></a><h4>Description</h4><p>Displays a plethora of information about the currently selected database.</p></div><div class="refsect3"><a id="refdbc-whichdb-options"></a><h4>Options</h4><div class="variablelist"><dl class="variablelist"><dt><span class="term"><code class="option">-h</code></span></dt><dd><p>Displays a help message explaining the <span class="command"><strong>whichdb</strong></span> command.</p></dd></dl></div></div><div class="refsect3"><a id="refdbc-whichdb-example"></a><h4>Example</h4><pre class="screen">
<code class="prompt">refdbc: </code>
<strong class="userinput"><code>whichdb</code></strong>
</pre><p>This will print the information about the active database. Refer to the <a class="link" href="re11.html#app-c-command-selectdb" title="selectdb"><span class="command"><strong>selectdb</strong></span></a> command for information how to change the active database. The <span class="command"><strong>whichdb</strong></span> output looks like this:</p><pre class="programlisting">Current database: alltypes
Number of references: 45
Highest reference ID: 45
Number of notes: 2
Highest note ID: 2
Encoding: ISO-8859-1
Database type: risx
Server type: pgsql
Created: 2003-12-24 22:27:43 UTC
Using refdb version: 0.9.4-pre2
Last modified: 2003-12-24 22:29:05 UTC
</pre></div></div></div><div class="refsect1"><a id="refdbc-files"></a><h2>Files</h2><div class="variablelist"><dl class="variablelist"><dt><span class="term"><code class="filename">PREFIX/etc/refdb/refdbcrc</code></span></dt><dd><p>The global configuration file of refdbc.</p></dd><dt><span class="term"><code class="filename">$HOME/.refdbcrc</code></span></dt><dd><p>The user configuration file of refdbc.</p></dd></dl></div></div><div class="refsect1"><a id="refdbc-see_also"></a><h2>See also</h2><p><span class="emphasis"><em>RefDB</em></span> (7),
<span class="emphasis"><em><a class="link" href="re02.html" title="refdbd">refdbd</a></em></span> (1),
<span class="emphasis"><em><a class="link" href="re06.html" title="refdba">refdba</a></em></span> (1).</p><p><span class="emphasis"><em>RefDB manual (local copy) </em></span> PREFIX/share/doc/refdb-<version>/refdb-manual/index.html</p><p><span class="emphasis"><em>RefDB manual (web) </em></span> <<a class="ulink" href="http://refdb.sourceforge.net/manual/index.html" target="_top">http://refdb.sourceforge.net/manual/index.html</a>></p><p><span class="emphasis"><em>RefDB on the web </em></span> <<a class="ulink" href="http://refdb.sourceforge.net/" target="_top">http://refdb.sourceforge.net/</a>></p></div><div class="refsect1"><a id="refdbc-author"></a><h2>Author</h2><p>refdbc was written by Markus Hoenicka <markus@mhoenicka.de>.</p></div></div><div class="navfooter"><hr /><table width="100%" summary="Navigation footer"><tr><td width="40%" align="left"><a accesskey="p" href="ch14.html">Prev</a> </td><td width="20%" align="center"><a accesskey="u" href="ch14.html#idp66539984">Up</a></td><td width="40%" align="right"> <a accesskey="n" href="re12.html">Next</a></td></tr><tr><td width="40%" align="left" valign="top">Chapter 14. Tools for reference and notes management </td><td width="20%" align="center"><a accesskey="h" href="index.html">Home</a></td><td width="40%" align="right" valign="top"> bib2ris</td></tr></table></div></body></html>
|