mirror of
https://github.com/ibm-s390-linux/s390-tools.git
synced 2026-08-05 02:14:52 +00:00
Signed-off-by: Philipp Rudo <prudo@linux.vnet.ibm.com> Signed-off-by: Michael Holzheu <holzheu@linux.vnet.ibm.com>
59 lines
1.4 KiB
C
59 lines
1.4 KiB
C
/**
|
|
* @defgroup util_prg_h util_prg: Program interface
|
|
* @{
|
|
* @brief Print standard program messages
|
|
*
|
|
* Copyright IBM Corp. 2016, 2017
|
|
*
|
|
* s390-tools is free software; you can redistribute it and/or modify
|
|
* it under the terms of the MIT license. See LICENSE for details.
|
|
*/
|
|
|
|
#ifndef LIB_UTIL_PRG_H
|
|
#define LIB_UTIL_PRG_H
|
|
|
|
#include <err.h>
|
|
#include <limits.h>
|
|
#include <stdio.h>
|
|
#include <stdlib.h>
|
|
#include <string.h>
|
|
|
|
struct util_prg_copyright {
|
|
/** Name of the copyright owner, e.g. IBM */
|
|
const char *owner;
|
|
/** Year of first publishing */
|
|
int pub_first;
|
|
/** Year of last major changes */
|
|
int pub_last;
|
|
};
|
|
|
|
/**
|
|
* @brief Coypright end marker
|
|
*/
|
|
#define UTIL_PRG_COPYRIGHT_END {NULL, 0, 0}
|
|
|
|
/**
|
|
* Program description
|
|
*/
|
|
struct util_prg {
|
|
/** Description for help */
|
|
const char *desc;
|
|
/** Command arguments in front of other options */
|
|
const char *command_args;
|
|
/** Positional arguments */
|
|
const char *args;
|
|
/** Copyright list */
|
|
struct util_prg_copyright copyright_vec[];
|
|
};
|
|
|
|
void util_prg_init(const struct util_prg *prg);
|
|
void util_prg_set_command(const char *command);
|
|
void util_prg_print_parse_error(void);
|
|
void util_prg_print_required_arg(const char *option);
|
|
void util_prg_print_invalid_option(const char *option);
|
|
void util_prg_print_arg_error(const char *arg_name);
|
|
void util_prg_print_version(void);
|
|
void util_prg_print_help(void);
|
|
|
|
#endif /** LIB_UTIL_PRG_H @} */
|