git.cworth.org Git - tar/blob - gnu/version-etc.h

   1 /* -*- buffer-read-only: t -*- vi: set ro: */
   2 /* DO NOT EDIT! GENERATED AUTOMATICALLY! */
   3 /* Print --version and bug-reporting information in a consistent format.
   4    Copyright (C) 1999, 2003, 2005, 2009-2010 Free Software Foundation, Inc.
   5
   6    This program is free software: you can redistribute it and/or modify
   7    it under the terms of the GNU General Public License as published by
   8    the Free Software Foundation; either version 3 of the License, or
   9    (at your option) any later version.
  10
  11    This program is distributed in the hope that it will be useful,
  12    but WITHOUT ANY WARRANTY; without even the implied warranty of
  13    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  14    GNU General Public License for more details.
  15
  16    You should have received a copy of the GNU General Public License
  17    along with this program.  If not, see <http://www.gnu.org/licenses/>.  */
  18
  19 /* Written by Jim Meyering. */
  20
  21 #ifndef VERSION_ETC_H
  22 # define VERSION_ETC_H 1
  23
  24 # include <stdarg.h>
  25 # include <stdio.h>
  26
  27 /* The `sentinel' attribute was added in gcc 4.0.  */
  28 #ifndef ATTRIBUTE_SENTINEL
  29 # if 4 <= __GNUC__
  30 #  define ATTRIBUTE_SENTINEL __attribute__ ((__sentinel__))
  31 # else
  32 #  define ATTRIBUTE_SENTINEL /* empty */
  33 # endif
  34 #endif
  35
  36 extern const char version_etc_copyright[];
  37
  38 /* The three functions below display the --version information in the
  39    standard way: command and package names, package version, followed
  40    by a short GPLv3+ notice and a list of up to 10 author names.
  41
  42    If COMMAND_NAME is NULL, the PACKAGE is asumed to be the name of
  43    the program.  The formats are therefore:
  44
  45    PACKAGE VERSION
  46
  47    or
  48
  49    COMMAND_NAME (PACKAGE) VERSION.
  50
  51    The functions differ in the way they are passed author names: */
  52
  53 /* N_AUTHORS names are supplied in array AUTHORS.  */
  54 extern void version_etc_arn (FILE *stream,
  55                              const char *command_name, const char *package,
  56                              const char *version,
  57                              const char * const * authors, size_t n_authors);
  58
  59 /* Names are passed in the NULL-terminated array AUTHORS.  */
  60 extern void version_etc_ar (FILE *stream,
  61                             const char *command_name, const char *package,
  62                             const char *version, const char * const * authors);
  63
  64 /* Names are passed in the NULL-terminated va_list.  */
  65 extern void version_etc_va (FILE *stream,
  66                             const char *command_name, const char *package,
  67                             const char *version, va_list authors);
  68
  69 /* Names are passed as separate arguments, with an additional
  70    NULL argument at the end.  */
  71 extern void version_etc (FILE *stream,
  72                          const char *command_name, const char *package,
  73                          const char *version,
  74                          /* const char *author1, ..., NULL */ ...)
  75   ATTRIBUTE_SENTINEL;
  76
  77 /* Display the usual `Report bugs to' stanza */
  78 extern void emit_bug_reporting_address (void);
  79
  80 #endif /* VERSION_ETC_H */