<!doctype refentry PUBLIC "-//OASIS//DTD DocBook V4.1//EN" [

<!-- Process this file with docbook-to-man to generate an nroff manual
     page: `docbook-to-man manpage.sgml > manpage.1'.  You may view
     the manual page with: `docbook-to-man manpage.sgml | nroff -man |
     less'.  A typical entry in a Makefile or Makefile.am is:

manpage.1: manpage.sgml
	docbook-to-man $< > $@

    
	The docbook-to-man binary is found in the docbook-to-man package.
	Please remember that if you create the nroff version in one of the
	debian/rules file targets (such as build), you will need to include
	docbook-to-man in your Build-Depends control field.

  -->

  <!-- Fill in your name for FIRSTNAME and SURNAME. -->
  <!ENTITY dhfirstname "<firstname>David</firstname>">
  <!ENTITY dhsurname   "<surname>Nusinow</surname>">
  <!-- Please adjust the date whenever revising the manpage. -->
  <!ENTITY dhdate      "<date>January 31, 2005</date>">
  <!-- SECTION should be 1-8, maybe w/ subsection other parameters are
       allowed: see man(7), man(1). -->
  <!ENTITY dhsection   "<manvolnum>1</manvolnum>">
  <!ENTITY dhemail     "<email>dnusinow@debian.org</email>">
  <!ENTITY dhusername  "David Nusinow">
  <!ENTITY dhucpackage "<refentrytitle>BIORUBY</refentrytitle>">
  <!ENTITY dhpackage   "br_pmfetch">

  <!ENTITY debian      "<productname>Debian</productname>">
  <!ENTITY gnu         "<acronym>GNU</acronym>">
  <!ENTITY gpl         "&gnu; <acronym>GPL</acronym>">
]>

<refentry>
  <refentryinfo>
    <address>
      &dhemail;
    </address>
    <author>
      &dhfirstname;
      &dhsurname;
    </author>
    <copyright>
      <year>2005</year>
      <holder>&dhusername;</holder>
    </copyright>
    &dhdate;
  </refentryinfo>
  <refmeta>
    &dhucpackage;

    &dhsection;
  </refmeta>
  <refnamediv>
    <refname>&dhpackage;</refname>

    <refpurpose>PubMed Client</refpurpose>
  </refnamediv>
  <refsynopsisdiv>
    <cmdsynopsis>
      <command>&dhpackage;</command>
      <arg><option><replaceable>options...</replaceable></option></arg>
      <arg>"query string"</arg>
    </cmdsynopsis>
    <cmdsynopsis>
      <command>&dhpackage;</command>
      <arg><option>--query<replaceable>"query string"</replaceable></option></arg>
      <arg><option><replaceable>other options...</replaceable></option></arg>
    </cmdsynopsis>
  </refsynopsisdiv>
  <refsect1>
    <title>DESCRIPTION</title>

    <para>This manual page documents briefly the
      <command>&dhpackage;</command>.</para>

    <para><command>&dhpackage;</command> is a command line program to query
	PubMed. It can take a variety of options (documented below) to restrict
	your search query, which is specified by the query string.</para>

  </refsect1>
  <refsect1>
    <title>OPTIONS</title>

    <variablelist>
      <varlistentry>
        <term><option>-q</option>
          <option>--query</option>
        </term>
        <listitem>
          <para>Query string for PubMed search.</para>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term><option>-t</option>
          <option>--title</option>
        </term>
        <listitem>
          <para>Title of the article to search.</para>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term><option>-j</option>
          <option>--journal</option>
        </term>
        <listitem>
          <para>Journal title to search.</para>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term><option>-v</option>
          <option>--volume</option>
        </term>
        <listitem>
          <para>Journal volume to search.</para>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term><option>-i</option>
          <option>--issue</option>
        </term>
        <listitem>
          <para>Journal issue to search.</para>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term><option>-p</option>
          <option>--page</option>
        </term>
        <listitem>
          <para>First page number of the article to search.</para>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term><option>-a</option>
          <option>--author</option>
        </term>
        <listitem>
          <para>Author name to search.</para>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term><option>-m</option>
          <option>--mesh</option>
        </term>
        <listitem>
          <para>MeSH term to search.</para>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term><option>-f</option>
          <option>--format</option>
        </term>
        <listitem>
		  <para>Summary output format. Options are endnote, medline, bibitem,
		  bibtex, report, abstract nature, science, genome_res, genome_biol,
		  nar, current, trends, cell.</para>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term>
          <option>--pmidlist</option>
        </term>
        <listitem>
          <para>Output only a list of PudMed IDs.</para>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term><option>-n</option>
          <option>--retmax</option>
        </term>
        <listitem>
          <para>Number of articles to retrieve at the maximum.</para>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term><option>-N</option>
          <option>--retstart</option>
        </term>
        <listitem>
          <para>Starting number of articles to retrieve.</para>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term><option>-s</option>
          <option>--sort</option>
        </term>
        <listitem>
		  <para>Sort method for the summary output. Options are author,
		  journal, pub+date.</para>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term>
          <option>--reldate</option>
        </term>
        <listitem>
          <para>Search articles published within recent # of days.</para>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term>
          <option>--mindate</option>
        </term>
        <listitem>
          <para>Search articles published after the date YYYY/MM/DD.</para>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term>
          <option>--maxdate</option>
        </term>
        <listitem>
          <para>Search articles published before the date YYYY/MM/DD.</para>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term>
          <option>--help</option>
        </term>
        <listitem>
          <para>Output help and then exit.</para>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term>
          <option>--examples</option>
        </term>
        <listitem>
          <para>Output example usages and then exit.</para>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term>
          <option>--version</option>
        </term>
        <listitem>
          <para>Output version number and then exit.</para>
        </listitem>
      </varlistentry>
    </variablelist>
  </refsect1>
  <refsect1>
    <title>SEE ALSO</title>

    <para> The following pages have information on the PubMed search
	options: http://www.ncbi.nlm.nih.gov/entrez/query/static/help/pmhelp.html 
	  http://www.ncbi.nlm.nih.gov/entrez/query/static/esearch_help.html</para>

  </refsect1>
  <refsect1>
    <title>AUTHOR</title>

    <para>This manual page was written by &dhusername; &dhemail; for
      the &debian; system (but may be used by others).  Permission is
      granted to copy, distribute and/or modify this document under
      the terms of the &gnu; General Public License, Version 2 any 
	  later version published by the Free Software Foundation.
    </para>
	<para>
	  On Debian systems, the complete text of the GNU General Public
	  License can be found in /usr/share/common-licenses/GPL.
	</para>

  </refsect1>
</refentry>

<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
sgml-omittag:t
sgml-shorttag:t
sgml-minimize-attributes:nil
sgml-always-quote-attributes:t
sgml-indent-step:2
sgml-indent-data:t
sgml-parent-document:nil
sgml-default-dtd-file:nil
sgml-exposed-tags:nil
sgml-local-catalogs:nil
sgml-local-ecat-files:nil
End:
-->


