X-Git-Url: http://git.tuebingen.mpg.de/?p=paraslash.git;a=blobdiff_plain;f=recv_common.c;h=2d6aa74a55063da799f35d1b9abbe07b33aa59b4;hp=7d7d2b059cd4765dab811d3ace2ea144d4d8f7c8;hb=4a55942a597fc7c828a30557e6621debe5c37481;hpb=bd533f99665cab3c9d64c14c242a8f80bdce71c5 diff --git a/recv_common.c b/recv_common.c index 7d7d2b05..2d6aa74a 100644 --- a/recv_common.c +++ b/recv_common.c @@ -1,5 +1,5 @@ /* - * Copyright (C) 2006-2012 Andre Noll + * Copyright (C) 2006-2014 Andre Noll * * Licensed under the GPL v2. For licencing details see COPYING. */ @@ -12,11 +12,9 @@ #include "list.h" #include "sched.h" #include "ggo.h" +#include "buffer_tree.h" #include "recv.h" #include "string.h" -#include "buffer_tree.h" - -DEFINE_RECEIVER_ARRAY; /** * Call the init function of each paraslash receiver. @@ -52,19 +50,19 @@ static void *parse_receiver_args(int receiver_num, char *options) } /** - * check if given string is a valid command line for any receiver + * Check if the given string is a valid receiver specifier. * * \param \ra string of the form receiver_name:options * \param receiver_num contains the number of the receiver upon success * * This function checks whether \a ra starts with the name of a supported * paraslash receiver, optinally followed by a colon and any options for that - * receiver. If a valid receiver name was found and further are present, the - * remaining part of \a ra is passed to that receiver's config parser. + * receiver. If a valid receiver name was found the remaining part of \a ra is + * passed to the receiver's config parser. * - * \return On success, a pointer to the gengetopt args info struct is returned - * and \a receiver_num contains the number of the receiver. Otherwise this function - * returns \p NULL. + * \return On success, a pointer to the receiver-specific gengetopt args info + * struct is returned and \a receiver_num contains the number of the receiver. + * On errors, the function returns \p NULL. */ void *check_receiver_arg(char *ra, int *receiver_num) { @@ -94,22 +92,23 @@ void *check_receiver_arg(char *ra, int *receiver_num) /** * Print out the help texts to all receivers. * - * \param detailed Whether the detailed help should be printed. + * \param flags Passed to \ref ggo_print_help(). */ -void print_receiver_helps(int detailed) +void print_receiver_helps(unsigned flags) { int i; - printf_or_die("\nAvailable receivers: \n\t"); + printf_or_die("\nAvailable receivers: "); FOR_EACH_RECEIVER(i) printf_or_die("%s%s", i? " " : "", receivers[i].name); - printf_or_die("\n\n"); + printf_or_die("\n"); FOR_EACH_RECEIVER(i) { struct receiver *r = receivers + i; if (!r->help.short_help) continue; - printf_or_die("Options for %s:\n", r->name); - ggo_print_help(&r->help, detailed); + printf_or_die("\n%s: %s", r->name, + r->help.purpose); + ggo_print_help(&r->help, flags); } }