plerdall - Publish an entire Plerd blog from source
In /path/to/plerd/conf/plerd.conf:
base_uri: http://blog.example.com path: /home/me/Dropbox/plerd title: My Lovely Blog
And then, on the command line, while in the top-level plerd directory:
bin/plerdall
Oh, you don't have a Plerd blog at all yet? Then you can try this first:
bin/plerdall --init=/home/me/Dropbox/plerd
Run in its default mode, this program directs Plerd to completely publish a blog, once, based configuration. If the blog's already been published, then it'll get wholly and freshly republished.
This program can perform other one-off Plerd-related tasks, as well, as directed by command-line options provided to it. See "OPTIONS", below.
For instructions on installing and using Plerd, please see the README file that should have accompanied this distribution. It is also available online at https://github.com/jmacdotorg/plerd#plerd.
bin/plerdall --config=/path/to/plerd.conf
Specify the location of a valid Plerd config file.
If not specified here, then this program will seek a config file in these locations, and in this order:
plerd.conf, in the current working directory
plerd.conf
conf/plerd.conf, in the current working directory
conf/plerd.conf
.plerd, in your home directory
.plerd
Consult the config file generated by plerdall --init to learn more about the config file format.
plerdall --init
bin/plerdall --init bin/plerdall --init=/path/to/new/plerd/directory
This command sets up a new working directory for a Plerd-powered blog. It will contain default templates, workspaces, and config files.
If given a path, it will try to create the directory if one doesn't already exist there. If the path already exists, plerdall will check that it is an empty directory.
If not given a path, plerdall will default to ./plerd, and then proceed as above.
./plerd
This program will print either error text or a welcoming success message with followup suggestions to STDOUT, and then exit. It will not perform any blog publication beyond this initial setup.
All of the following Webmention-related options are experimental.
bin/plerdall --send-webmentions
After publishing all the blog's posts, Plerd will then direct every post to scan itself for hyperlinks and attempt to send webmentions to each one.
bin/plerdall --process-webmentions
Before publishing all the blog's posts, Plerd will check to see if any new webmentions are waiting in its webmention-inbox. If so, it will process those webmentions. Then, if at least one of those received webmentions is valid, Plerd will republish all the blog's posts. If neither of the prior conditions are true, Plerd will not republish the blog.
This flag makes plerdall suitable for use as a scheduled task, via e.g. cron.
bin/plerdall --rebuild-webmentions
Before publishing all the blog's posts, Plerd will re-verify every valid webmention that the blog has received and stored over its history, overwriting its old webmention database with the results. Then it will republish all the blog's posts.
The script rate-limits itself to one verification request per second, so this might take a while.
This is a utility function intended for use if the serialization format for Plerd's webmentions changes. You probably won't need to use it often, if ever.
Plerd
Jason McIntosh <jmac@jmac.org>
To install Plerd, copy and paste the appropriate command in to your terminal.
cpanm
cpanm Plerd
CPAN shell
perl -MCPAN -e shell install Plerd
For more information on module installation, please visit the detailed CPAN module installation guide.