gl/version-etc.h

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