Skip Menu |
 

This queue is for tickets about the Socialtext-Resting CPAN distribution.

Report information
The Basics
Id: 75622
Status: new
Priority: 0/
Queue: Socialtext-Resting

People
Owner: Nobody in particular
Requestors: fschlich [...] zedat.fu-berlin.de
Cc:
AdminCc:

Bug Information
Severity: (no value)
Broken in: (no value)
Fixed in: (no value)



Subject: POD / manpage for st-webhook
Download (untitled) / with headers
text/plain 322b
Hi, the Debian Policy demands that every program be accompanied by an associated manual page. Could you provide some POD for st-webhook, which our packaging tools can automatically turn into a manpage? Attached patch would be a very minimal solution that basically just wraps the existing help output in POD. Florian
Subject: manpage_for_st-webhook.patch
Description: a very simple POD / manpage for st-webhook The Debian Policy demands that every program should be accompanied by an associated manual page. Author: Florian Schlichting <fschlich@zedat.fu-berlin.de> --- a/bin/st-webhook +++ b/bin/st-webhook @@ -90,3 +90,35 @@ } print "\n"; } + +=pod + +=head1 NAME + +st-webhook - tool to create/list/delete webhooks into the Socialtext REST services + +=head1 SYNOPSIS + +st-webhook COMMAND --class=foo --url=foo + +Where COMMAND is one of: + create - create a new webhook + list - list existing webhooks + delete - delete a webhook + +Mandatory `create` arguments: + --class - class of events to hook + --url - URL the hook should GET when it fires + +Mandatory `delete` arguments: + --id - Webhook ID to delete + +Optional Webhook filter arguments: + --account-id=foo + --workspace-id=foo + +=head1 AUTHORS + +This POD was created for the Debian package of Socialtext-Resting +from the help output of st-webhook by +Florian Schlichting <fschlich@zedat.fu-berlin.de>.


This service is sponsored and maintained by Best Practical Solutions and runs on Perl.org infrastructure.

Please report any issues with rt.cpan.org to rt-cpan-admin@bestpractical.com.