--name="Skytools" --html --no-private -v
HTMLS = README.html INSTALL.html \
- londiste.ref.html TODO.html pgq-sql.html pgqadm.html pgq-nodupes.html \
+ londiste.ref.html TODO.html pgq-sql.html pgq-nodupes.html \
$(SCRIPT_HTMLS) faq.html set.notes.html skytools3.html devnotes.html
SCRIPT_TXTS = walmgr.txt queue_mover.txt queue_splitter.txt qadmin.txt \
- scriptmgr.txt skytools_upgrade.txt londiste.txt pgqadm.txt
+ scriptmgr.txt skytools_upgrade.txt londiste.txt
SCRIPT_HTMLS = $(SCRIPT_TXTS:.txt=.html)
MAN5 =
-MAN1_SFX = londiste.1 pgqadm.1 scriptmgr.1 skytools_upgrade.1 walmgr.1 \
+MAN1_SFX = londiste.1 scriptmgr.1 skytools_upgrade.1 walmgr.1 \
queue_splitter.1 queue_mover.1
MAN1 = qadmin.1 pgqd.1
FQMAN5 = $(addprefix man/, $(MAN5))
FQMAN = $(FQMAN1) $(FQMAN1_SFX) $(FQMAN5)
-COMMON = common.switches.txt common.config.txt common.logutriga.txt
+COMMON = common.switches.txt common.config.txt
GETATTRS = python ../misc/getattrs.py
FIXMAN = python ../misc/fixman.py
--- /dev/null
+
+=== Common configuration parameters ===
+
+ job_name::
+ Name for particulat job the script does. Script will log under this name
+ to logdb/logserver. The name is also used as default for PgQ consumer name.
+ It should be unique.
+
+ pidfile::
+ Location for pid file. If not given, script is disallowed to daemonize.
+
+ logfile::
+ Location for log file.
+
+ loop_delay::
+ If continuisly running process, how long to sleep after each work loop,
+ in seconds. Default: 1.
+
+ connection_lifetime::
+ Close and reconnect older database connections.
+
+ use_skylog::
+ foo.
+
+ifdef::pgq[]
+
+=== Common PgQ consumer parameters ===
+
+ pgq_queue_name::
+ Queue name to attach to.
+ No default.
+
+ pgq_consumer_id::
+ Consumers ID to use when registering.
+ Default: %(job_name)s
+
+endif::pgq[]
+
--- /dev/null
+
+Following switches are common to all skytools.DBScript-based
+Python programs.
+
+ -h, --help::
+ show help message and exit
+
+ -q, --quiet::
+ make program silent
+
+ -v, --verbose::
+ make program more verbose
+
+ -d, --daemon::
+ make program go background
+
+Following switches are used to control already running process.
+The pidfile is read from config then signal is sent to process
+id specified there.
+
+ -r, --reload::
+ reload config (send SIGHUP)
+
+ -s, --stop::
+ stop program safely (send SIGINT)
+
+ -k, --kill::
+ kill program immidiately (send SIGTERM)
+