/usr/share/doc/refdb/refdb-manual/ch06.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 | <?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>Chapter 6. Overview of the RefDB command-line clients</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="pt03.html" title="Part III. User manual" /><link rel="prev" href="pt03.html" title="Part III. User manual" /><link rel="next" href="ch06s02.html" title="The interactive mode of refdba and refdbc" /></head><body><div class="navheader"><table width="100%" summary="Navigation header"><tr><th colspan="3" align="center">Chapter 6. Overview of the RefDB command-line clients</th></tr><tr><td width="20%" align="left"><a accesskey="p" href="pt03.html">Prev</a> </td><th width="60%" align="center">Part III. User manual</th><td width="20%" align="right"> <a accesskey="n" href="ch06s02.html">Next</a></td></tr></table><hr /></div><div class="chapter"><div class="titlepage"><div><div><h2 class="title"><a id="chapter-overview-clients"></a>Chapter 6. Overview of the RefDB command-line clients</h2></div></div></div><div class="toc"><p><strong>Table of Contents</strong></p><dl class="toc"><dt><span class="sect1"><a href="ch06.html#idp63992880">Quickstart guide</a></span></dt><dt><span class="sect1"><a href="ch06s02.html">The interactive mode of refdba and refdbc</a></span></dt><dt><span class="sect1"><a href="ch06s03.html">The non-interactive mode of refdba and refdbc</a></span></dt><dt><span class="sect1"><a href="ch06s04.html">The non-interactive mode of refdbib</a></span></dt><dt><span class="sect1"><a href="ch06s05.html">Common command-line options for all clients</a></span></dt></dl></div><p>There are several client applications, each one performing a self-contained subset of tasks. This chapter provides a short overview over common features of the clients. Please refer to the reference chapters about <a class="link" href="ch13.html" title="Chapter 13. Administration tools">refdba</a>, <a class="link" href="ch14.html" title="Chapter 14. Tools for reference and notes management">refdbc</a>, and <a class="link" href="ch15.html" title="Chapter 15. Tools for bibliographies">refdbib</a> for the nitty gritty details.</p><div class="note" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title">Note</h3><p>This manual covers only the clients shipped with RefDB. Please visit the <a class="ulink" href="http://refdb.sourceforge.net" target="_top">RefDB website</a> for other options. Currently there are tools for both Emacs and Vim which turn these editors into integrated authoring tools with bibliography support.</p></div><p>The clients serve the following purposes:</p><div class="variablelist"><dl class="variablelist"><dt><span class="term">refdba</span></dt><dd><p>The system administrator's tool to create or delete databases, set access rights, and view all kinds of statistics.</p></dd><dt><span class="term">refdbc</span></dt><dd><p>The client for adding, editing, deleting, and searching reference entries.</p></dd><dt><span class="term">refdbib</span></dt><dd><p>The tool to create bibliographies.</p></dd></dl></div><p>refdbc and refdba can be run in an interactive mode where they provide their own command line, similar to a command-line FTP client for example. They use the GNU readline library with its powerful and convenient editing and history capabilities. In a nutshell, you can edit commands on this built-in command line as you can do in your <span class="application">bash</span> or in the <span class="application">Emacs</span> minibuffer. You can scroll through the history of your previous commands with the <span class="keycap"><strong>arrow</strong></span> keys, you can use the <span class="keycap"><strong>tab</strong></span> key to complete command names and filenames, and you can use <span class="keycap"><strong>Ctrl</strong></span>+<span class="keycap"><strong>r</strong></span> to search the history with a regular expression. For further information you should consult the readline manual.</p><p>refdba and refdbc can also be run in batch mode. You can specify one of the built-in commands as an argument to the <code class="option">-C</code> option and pipe or redirect data into stdin. This is very useful if you want to automatize tasks using shell scripts.</p><p>refdbib does not have an interactive mode and can be run only in batch mode. The result will be written to stdout. However, you'll hardly ever run refdbib directly, as RefDB ships with convenient scripts and Makefiles for this purpose.</p><div class="sect1"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="idp63992880"></a>Quickstart guide</h2></div></div></div><p>These are the essential steps to get up and running as a RefDB user:</p><div class="procedure"><ol class="procedure" type="1"><li class="step"><p>Ask your RefDB administrator to grant access to an existing reference database or have him create one for you.</p></li><li class="step"><p>If the application server refdbd is not installed to run as a daemon, start it now: <span class="command"><strong>refdbd -s &</strong></span> (see <a class="link" href="re02.html" title="refdbd">Starting refdbd</a> for more options).</p></li><li class="step"><p><a class="link" href="re11.html#refdbc-synopsis" title="Synopsis">Start the refdbc command line client</a> to manage and retrieve references.</p></li><li class="step"><p><a class="link" href="re11.html#app-c-command-addref" title="addref">Add</a> references to the database.</p></li><li class="step"><p><a class="link" href="re11.html#app-c-command-getref" title="getref">Retrieve</a> references according to your search criteria.</p></li><li class="step"><p><a class="link" href="ch10.html" title="Chapter 10. Bibliographies">Create</a> bibliographies with the references in your database.</p></li></ol></div><div class="note" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title">Note</h3><p>There is a tutorial for first-time users available at the <a class="ulink" href="http://refdb.sourceforge.net/doc.html" target="_top">RefDB documentation page</a>.</p></div></div></div><div class="navfooter"><hr /><table width="100%" summary="Navigation footer"><tr><td width="40%" align="left"><a accesskey="p" href="pt03.html">Prev</a> </td><td width="20%" align="center"><a accesskey="u" href="pt03.html">Up</a></td><td width="40%" align="right"> <a accesskey="n" href="ch06s02.html">Next</a></td></tr><tr><td width="40%" align="left" valign="top">Part III. User manual </td><td width="20%" align="center"><a accesskey="h" href="index.html">Home</a></td><td width="40%" align="right" valign="top"> The interactive mode of refdba and refdbc</td></tr></table></div></body></html>
|