doc/
[gnupg.git] / tools / gpgconf.h
1 /* gpgconf.h - Global definitions for gpgconf
2  *      Copyright (C) 2003 Free Software Foundation, Inc.
3  *
4  * This file is part of GnuPG.
5  *
6  * GnuPG 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  * GnuPG 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
20 #ifndef GPGCONF_H
21 #define GPGCONF_H
22
23 #include "../common/util.h"
24
25 /* We keep all global options in the structure OPT.  */
26 struct
27 {
28   int verbose;          /* Verbosity level.  */
29   int quiet;            /* Be extra quiet.  */
30   int dry_run;          /* Don't change any persistent data.  */
31   int runtime;          /* Make changes active at runtime.  */
32   char *outfile;        /* Name of output file.  */
33
34   int component;        /* The active component.  */
35 } opt;
36
37
38
39 /*-- gpgconf-comp.c --*/
40 /* Percent-Escape special characters.  The string is valid until the
41    next invocation of the function.  */
42 char *gc_percent_escape (const char *src);
43
44
45 void gc_error (int status, int errnum, const char *fmt, ...);
46
47 /* List all components that are available.  */
48 void gc_component_list_components (FILE *out);
49
50 /* List all programs along with their status.  */
51 void gc_check_programs (FILE *out);
52
53 /* Find the component with the name NAME.  Returns -1 if not
54    found.  */
55 int gc_component_find (const char *name);
56
57 /* Retrieve the currently active options and their defaults from all
58    involved backends for this component.  */
59 void gc_component_retrieve_options (int component);
60
61 /* List all options of the component COMPONENT.  */
62 void gc_component_list_options (int component, FILE *out);
63
64 /* Read the modifications from IN and apply them.  */
65 void gc_component_change_options (int component, FILE *in, FILE *out);
66
67 /* Check the options of a single component.  Returns 0 if everything
68    is OK.  */
69 int gc_component_check_options (int component, FILE *out,
70                                 const char *conf_file);
71
72 /* Process global configuration file.  */
73 int gc_process_gpgconf_conf (const char *fname, int update, int defaults,
74                              FILE *listfp);
75
76
77 #endif /*GPGCONF_H*/