David E. Wheeler > PGXN-API-v0.16.2 > pgxn_api_sync

Download:
PGXN-API-v0.16.2.tar.gz

Annotate this POD

Website

View/Report Bugs
Source   Latest Release: PGXN-API-v0.16.3

Name ^

pgxn_api_sync - Sync the PGXN API server to a PGXN mirror

Usage ^

  pgxn_api_sync --root /path/to/api/doc/root \
                --rsync /path/to/rsync \
                rsync://master.pgxn.org/pgxn/

Description ^

This program syncs the PGXN API server to a PGXN mirror, unpacking all of the synced distributions and indexing them for the API. It's meant to be run on a cron job, so that the API server can be regularly updated with the most recent additions to the network. For example, to run it hourly at 42 minutes past the hour, put this in your crontab:

  * * * * 42 pgxn_api_sync rsync://master.pgxn.org/pgxn/

Options ^

  -r --rsync          Location of rsync if it's not in your path.
  -d --root           Directory to use for the API doc root.
  -V --verbose        Incremental verbosity to STDOUT.
  -h --help           Print a usage statement and exit.
  -m --man            Print the complete documentation and exit.
  -v --version        Print the version number and exit.

Author ^

David E. Wheeler <david.wheeler@pgexperts.com>

Copyright and License ^

Copyright (c) 2011 David E. Wheeler.

This module is free software; you can redistribute it and/or modify it under the PostgreSQL License.

Permission to use, copy, modify, and distribute this software and its documentation for any purpose, without fee, and without a written agreement is hereby granted, provided that the above copyright notice and this paragraph and the following two paragraphs appear in all copies.

In no event shall David E. Wheeler be liable to any party for direct, indirect, special, incidental, or consequential damages, including lost profits, arising out of the use of this software and its documentation, even if David E. Wheeler has been advised of the possibility of such damage.

David E. Wheeler specifically disclaims any warranties, including, but not limited to, the implied warranties of merchantability and fitness for a particular purpose. The software provided hereunder is on an "as is" basis, and David E. Wheeler has no obligations to provide maintenance, support, updates, enhancements, or modifications.

syntax highlighting: