pgAgent manpage - Mailing list pgadmin-hackers

Hi Dave, friends,

santa claus just passed through my house and left this manpage near my
shoes... So, merry christmas!

pgagent.xml is the docbook-xml source for this manpage and pgagent.1 was
compiled with the following command under Debian/Sarge:
docbook2x-man pgagent.xml

I can convert the old pgadmin3.1 that I ship with Debian packages to
docbook-xml if needed. I'd prefer that we all ship these manpages for
next releases instead of releasing them specifically for Debian, what do
you think of adding them to the main install process?

Regards,
Raph
.TH pgagent 1  "December 26, 2005"
.SH NAME
pgAgent \- a job scheduler for PostgreSQL.
.SH SYNOPSIS
\fBpgagent\fR [\-f | \-t \fBseconds\fR | \-r \fBseconds\fR | \-l \fBnumber\fR] {<connect string>}
.SH DESCRIPTION
Introduced in pgAdmin III v1.4, pgAgent is a job scheduling agent
for PostgreSQL, capable of running multi\-step batch/shell and SQL tasks on
complex schedules.
.PP
A full documentation of pgAgent is available in pgadmin3's online
help. Launch pgAdmin III (simply type pgadmin3 at command prompt) and
select "Help..." from the "Help" menu. Browse through the pgAdmin III
documentation until you find "pgAgent". Both database setup and system
part of the installation are detailed. You will also find instructions
to create jobs and schedules.
.SH OPTIONS
.TP
\fB\-f\fR
run in the foreground (do not detach from the
terminal)
.TP
\fB\-t\fR \fIseconds\fR
poll time interval in seconds (default 10)
.TP
\fB\-r\fR \fIseconds\fR
retry period after connection abort in seconds (>=10,
default 30)
.TP
\fB\-l\fR \fIverbosity\fR
logging verbosity (ERROR=0, WARNING=1, DEBUG=2, default
0)
.TP
\fI<connect string>\fR
The connect string required is a standard PostgreSQL libpq
connection string (see the PostgreSQL documentation for further
details). For example, the following command line will run pgAgent
against a server listening on the localhost, using a database called
\&'pgadmin', connecting as the user 'postgres': /usr/bin/pgagent
hostaddr=127.0.0.1 dbname=pgadmin user=postgres
.SH "SEE ALSO"
\fBpgadmin3\fR(1)
.SH AUTHORS
The content of this maniual page was mostly ripped from documentation
written by the pgAdmin development team. It was built by Rapha\(:el Enrici
<blacknoz@club\-internet.fr>, for the Debian project (but may be used
by others).
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN"
"http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd">
<refentry id="pgagent">
  <refmeta>
    <refentrytitle>pgagent</refentrytitle>

    <manvolnum>1</manvolnum>
    <refmiscinfo class='source'>December 26, 2005</refmiscinfo>
  </refmeta>

  <refnamediv>
    <refname>pgAgent</refname>

    <refpurpose>a job scheduler for PostgreSQL.</refpurpose>
  </refnamediv>

  <refsynopsisdiv>
    <cmdsynopsis>
      <command>pgagent</command>

      <group>
        <arg>-f</arg>

        <arg>-t <replaceable>seconds</replaceable></arg>

        <arg>-r <replaceable>seconds</replaceable></arg>

        <arg>-l <replaceable>number</replaceable></arg>
      </group>

      <arg choice="req"><connect string></arg>
    </cmdsynopsis>
  </refsynopsisdiv>

  <refsect1>
    <title>DESCRIPTION</title>

    <para>Introduced in pgAdmin III v1.4, pgAgent is a job scheduling agent
    for PostgreSQL, capable of running multi-step batch/shell and SQL tasks on
    complex schedules.</para>

    <para>A full documentation of pgAgent is available in pgadmin3's online
    help. Launch pgAdmin III (simply type pgadmin3 at command prompt) and
    select "Help..." from the "Help" menu. Browse through the pgAdmin III
    documentation until you find "pgAgent". Both database setup and system
    part of the installation are detailed. You will also find instructions
    to create jobs and schedules.</para>
  </refsect1>

  <refsect1>
    <title>OPTIONS</title>

    <variablelist>
      <varlistentry>
        <term><option>-f</option></term>

        <listitem>
          <para>run in the foreground (do not detach from the
          terminal)</para>
        </listitem>
      </varlistentry>
    </variablelist>

    <variablelist>
      <varlistentry>
        <term><option>-t</option> <replaceable>seconds</replaceable></term>

        <listitem>
          <para>poll time interval in seconds (default 10)</para>
        </listitem>
      </varlistentry>
    </variablelist>

    <variablelist>
      <varlistentry>
        <term><option>-r</option> <replaceable>seconds</replaceable></term>

        <listitem>
          <para>retry period after connection abort in seconds (>=10,
          default 30)</para>
        </listitem>
      </varlistentry>
    </variablelist>

    <variablelist>
      <varlistentry>
        <term><option>-l</option> <replaceable>verbosity</replaceable></term>

        <listitem>
          <para>logging verbosity (ERROR=0, WARNING=1, DEBUG=2, default
          0)</para>
        </listitem>
      </varlistentry>
    </variablelist>

    <variablelist>
      <varlistentry>
        <term><replaceable><connect string></replaceable></term>

        <listitem>
          <para>The connect string required is a standard PostgreSQL libpq
          connection string (see the PostgreSQL documentation for further
          details). For example, the following command line will run pgAgent
          against a server listening on the localhost, using a database called
          'pgadmin', connecting as the user 'postgres': /usr/bin/pgagent
          hostaddr=127.0.0.1 dbname=pgadmin user=postgres</para>
        </listitem>
      </varlistentry>
    </variablelist>
  </refsect1>

  <refsect1>
    <title>SEE ALSO</title>

    <para><emphasis role="bold">pgadmin3</emphasis>(1)</para>
  </refsect1>

  <refsect1>
    <title>AUTHORS</title>

    <para>The content of this maniual page was mostly ripped from documentation
    written by the pgAdmin development team. It was built by Raphaël Enrici
    <blacknoz@club-internet.fr>, for the Debian project (but may be used
    by others).</para>
  </refsect1>
</refentry>