/ 
App-Slackeria-0.12
River stage zero No dependents
/ slackeria

NAME

slackeria - Project status overview

SYNOPSIS

slackeria [-v|--verbose] outfile

VERSION

version 0.12

DESCRIPTION

slackeria outputs a nice (XHTML) overview of all your projects and their status in various distributions, on websites, et cetera. So far it checks two things: First, if the project exists on a given site, and second what version it has there. This output is then put into a table so you can quickly see what's missing or not up-to-date.

OPTIONS

-t, --template file

Read output template from file. See App::Slackeria::Out::XHTML(3pm).

-v, --verbose

Show the names of projects/plugins as they are run.

-V, --version

Print program version

EXIT STATUS

Zero unless something went completely wrong. The exist status does not indicate the status of projects or plugins.

CONFIGURATION

The configuration is stored in ~/.config/slackeria/ (or whatever prefix your XDG_CONFIG_HOME is set to), it is in Config::Tiny(3pm) INI-style format. The list of projects, plugins and their default configuration are read from ~/.config/slackeria/config, for each project ~/.config/slackeria/projectname (if it exists) is also read. Use it to override global plugin options.

slackeria reads its projects from the whitespace-separated value of the "projects" key in the "slackeria" section. Plugins need to be explicitly enabled by creating a section with their name. In this section, you can configure the plugin (see the plugin documentation).

Two options are supported by all plugins:

enable

Set it to 0 to disable the plugin by default. You can set it back to 1 in a project-specific config file

name

Override project name (like App-Slackeria for cpan, but slackeria for freshmeat)

EXAMPLE

# slackeria/config

[slackeria]
projects = dtach irssi perl zsh

[Debian]

[FreeBSD]

[Freshmeat]
token = secretsecret

[OpenPorts]

[OpenSUSE]

[Pkgsrc]

# slackeria/perl

[OpenPorts]
enable = 0

[Pkgsrc]
enable = 0

PLUGINS

This version of slackeria ships the following plugins:

  • App::Slackeria::Plugin::CPAN(3pm)

  • App::Slackeria::Plugin::Debian(3pm)

  • App::Slackeria::Plugin::FreeBSD(3pm)

  • App::Slackeria::Plugin::Freshmeat(3pm)

  • App::Slackeria::Plugin::Gentoo(3pm)

  • App::Slackeria::Plugin::GitHub(3pm)

  • App::Slackeria::Plugin::Git(3pm)

  • App::Slackeria::Plugin::Ikiwiki(3pm)

  • App::Slackeria::Plugin::OpenPorts(3pm)

  • App::Slackeria::Plugin::OpenSUSE(3pm)

  • App::Slackeria::Plugin::Pkgsrc(3pm)

  • App::Slackeria::Plugin::Ubuntu(3pm)

For plugin options and dependencies, see their documentation.

DEPENDENCIES

slackeria itself only depends on Config::Tiny, File::BaseDir and HTML::Template.

BUGS AND LIMITATIONS

Some plugins are based on whohas, which breaks easily.

This is alpha software. The Plugin API and Config format can be considered stable, but other things may still change.

SEE ALSO

Config::Tiny(3pm), App::Slackeria::PluginLoader(3pm).

CREDITS

The name "slackeria" is courtesy of Maximilian Gaß.

AUTHOR

Copyright (C) 2011 by Daniel Friesel <derf@finalrewind.org>

LICENSE

0. You just DO WHAT THE FUCK YOU WANT TO.