components/database/pgagent/files/pgagent.1

   1 '\" t
   2 .\"
   3 .\" CDDL HEADER START
   4 .\"
   5 .\" The contents of this file are subject to the terms of the
   6 .\" Common Development and Distribution License (the "License").
   7 .\" You may not use this file except in compliance with the License.
   8 .\"
   9 .\" You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE
  10 .\" or http://www.opensolaris.org/os/licensing.
  11 .\" See the License for the specific language governing permissions
  12 .\" and limitations under the License.
  13 .\"
  14 .\" When distributing Covered Code, include this CDDL HEADER in each
  15 .\" file and include the License file at usr/src/OPENSOLARIS.LICENSE.
  16 .\" If applicable, add the following below this CDDL HEADER, with the
  17 .\" fields enclosed by brackets "[]" replaced with your own identifying
  18 .\" information: Portions Copyright [yyyy] [name of copyright owner]
  19 .\"
  20 .\" CDDL HEADER END
  21 .\"
  22 .\" Copyright 2010 Sun Microsystems, Inc.  All rights reserved.
  23 .\" Use is subject to license terms.
  24 .\"
  25 .\" #ident      "@(#)pgagent.1  1.2     10/03/16 SMI"
  26 .\"
  27 .TH "pgagent" "1" "" "" "User Commands"
  28 .SH NAME
  29 pgAgent \- a job scheduler for PostgreSQL
  30
  31 .SH SYNOPSIS
  32 .sp
  33 \fBpgagent\fR [ \fB\fIoption\fB\fR\fI...\fR ]   [ \fB\fIconnection\fR ]
  34 .SH DESCRIPTION
  35 pgAgent is a job scheduling agent for PostgreSQL, capable of running
  36 multi-step batch/shell and SQL tasks on complex schedules. Jobs may
  37 be easily created using pgAdmin III.
  38
  39 Full documentation of pgAgent is available in pgAdmin III's online
  40 help. Launch pgAdmin III (simply type "pgadmin3" at command prompt) and
  41 select "Help..." from the "Help" menu. Browse through the pgAdmin III
  42 documentation until you find "pgAgent". Both database setup and system
  43 part of the installation are detailed. You will also find instructions
  44 to create jobs and schedules.
  45
  46 However, some of the features can be accessed through command line.
  47
  48 .SH "OPTIONS"
  49 .PP
  50 The following options are supported:
  51 .TP
  52 \fB\fIconnection\fB\fR
  53 Connection string specifies the server to which the connection
  54 has to be established
  55 .TP
  56 \fB-f\fR
  57 Run in the foreground (do not detach from the terminal)
  58 .TP
  59 \fB-t \fIseconds\fB\fR
  60 Poll time interval in seconds (default 10)
  61 .TP
  62 \fB-r \fIseconds\fB\fR
  63 Retry period after connection abort in seconds (>=10, default 30)
  64 .TP
  65 \fB-s \fIfile\fB\fR
  66 Log file (messages are logged to STDOUT if not specified)
  67 .TP
  68 \fB-l \fIvalue\fB\fR
  69 logging verbosity (ERROR=0, WARNING=1, DEBUG=2, default 0)
  70 .PP
  71
  72 .\" Begin Sun update
  73 .SH ATTRIBUTES
  74 See
  75 .BR attributes (5)
  76 for descriptions of the following attributes:
  77 .sp
  78 .TS
  79 box;
  80 cbp-1 | cbp-1
  81 l | l .
  82 ATTRIBUTE TYPE  ATTRIBUTE VALUE
  83 =
  84 Availability    database/postgres/pgadmin
  85 =
  86 Interface Stability     Committed
  87 .TE
  88
  89 .SH NOTES
  90 You may find useful informations in the help menu of pgadmin3.
  91 You may also find Solaris specific PostgreSQL informations in "postgres"
  92 man page. Source for pgAgent is available on http://www.pgadmin.org/.
  93 .\" End Sun update
  94
  95
  96 .SH SEE ALSO
  97 .PP
  98 pgadmin3(1)
  99
 100 .SH REFERENCES
 101 .PP
 102 http://www.pgadmin.org