File: pgagent.xml

package info (click to toggle)
pgagent 4.2.3-4
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid
  • size: 476 kB
  • sloc: cpp: 1,913; sql: 1,739; xml: 100; ansic: 58; makefile: 31; sh: 18
file content (128 lines) | stat: -rw-r--r-- 3,773 bytes parent folder | download | duplicates (12)
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
<?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">&lt;connect string&gt;</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>Full documentation of pgAgent is available in pgAdmin III'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 (&gt;=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>&lt;connect string&gt;</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 manual page was mostly ripped from documentation 
    written by the pgAdmin development team. It was built by Raphaƫl Enrici 
    &lt;blacknoz@club-internet.fr&gt; for the Debian project (but may be used
    by others).</para>
  </refsect1>
</refentry>