Sync usage with man page.
[netbsd-mini2440.git] / gnu / dist / gettext / gettext-tools / lib / error-progname.h
blobc70d1d54e11b47d13de5cf4cccfd1ab2406edb59
1 /* Use of program name in error-reporting functions.
2 Copyright (C) 2001-2003 Free Software Foundation, Inc.
3 Written by Bruno Haible <haible@clisp.cons.org>, 2001.
5 This program is free software; you can redistribute it and/or modify
6 it under the terms of the GNU General Public License as published by
7 the Free Software Foundation; either version 2, or (at your option)
8 any later version.
10 This program is distributed in the hope that it will be useful,
11 but WITHOUT ANY WARRANTY; without even the implied warranty of
12 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13 GNU General Public License for more details.
15 You should have received a copy of the GNU General Public License
16 along with this program; if not, write to the Free Software Foundation,
17 Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA. */
19 #ifndef _ERROR_PROGNAME_H
20 #define _ERROR_PROGNAME_H
22 #include <stdbool.h>
24 /* This file supports selectively prefixing or nor prefixing error messages
25 with the program name.
27 Programs using this file should do the following in main():
28 error_print_progname = maybe_print_progname;
32 #ifdef __cplusplus
33 extern "C" {
34 #endif
37 /* Indicates whether errors and warnings get prefixed with program_name.
38 Default is true.
39 A reason to omit the prefix is for better interoperability with Emacs'
40 compile.el. */
41 extern DLL_VARIABLE bool error_with_progname;
43 /* Print program_name prefix on stderr if and only if error_with_progname
44 is true. */
45 extern void maybe_print_progname (void);
48 #ifdef __cplusplus
50 #endif
53 #endif /* _ERROR_PROGNAME_H */