man: license headers
[oweals/gnunet.git] / doc / man / gnunet-config.1
1 .\" This file is part of GNUnet.
2 .\" Copyright (C) 2001-2019 GNUnet e.V.
3 .\"
4 .\" Permission is granted to copy, distribute and/or modify this document
5 .\" under the terms of the GNU Free Documentation License, Version 1.3 or
6 .\" any later version published by the Free Software Foundation; with no
7 .\" Invariant Sections, no Front-Cover Texts, and no Back-Cover Texts.  A
8 .\" copy of the license is included in the file
9 .\" ``FDL-1.3''.
10 .\"
11 .\" A copy of the license is also available from the Free Software
12 .\" Foundation Web site at @url{http://www.gnu.org/licenses/fdl.html}.
13 .\"
14 .\" Alternately, this document is also available under the General
15 .\" Public License, version 3 or later, as published by the Free Software
16 .\" Foundation.  A copy of the license is included in the file
17 .\" ``GPL3''.
18 .\"
19 .\" A copy of the license is also available from the Free Software
20 .\" Foundation Web site at @url{http://www.gnu.org/licenses/gpl.html}.
21 .\"
22 .\" SPDX-License-Identifier: GPL3.0-or-later OR FDL1.3-or-later
23 .\"
24 .Dd July 15, 2012
25 .Dt GNUNET-CONFIG 1
26 .Os
27 .Sh NAME
28 .Nm gnunet-config
29 .Nd
30 manipulate GNUnet configuration files
31 .Sh SYNOPSIS
32 .Nm
33 .Op Fl c Ar FILENAME | Fl \-config= Ns Ar FILENAME
34 .Op Fl f | \-filename
35 .Op Fl h | \-help
36 .Op Fl L Ar LOGLEVEL | Fl \-loglevel= Ns Ar LOGLEVEL
37 .Op Fl o Ar OPTION | Fl \-option= Ns Ar OPTION
38 .Op Fl S |\-list-sections
39 .Op Fl s Ar SECTION | Fl \-section= Ns Ar SECTION
40 .Op Fl V Ar VALUE | Fl \-value Ar VALUE
41 .Op Fl v | \-version
42 .Op Fl W | \-rewrite
43 .Sh DESCRIPTION
44 .Nm
45 can be used to read or modify GNUnet configuration files.
46 .Bl -tag -width Ds
47 .It Fl c Ar FILENAME | Fl \-config= Ns Ar FILENAME
48 Use the configuration file FILENAME.
49 .It Fl f | \-filename
50 Try to perform expansions as if the option values represent filenames (will also be applied even if the option is not really a filename).
51 .It Fl h | \-help
52 Print short help on options.
53 .It Fl L Ar LOGLEVEL | Fl \-loglevel= Ns Ar LOGLEVEL
54 Use LOGLEVEL for logging.
55 Valid values are DEBUG, INFO, WARNING and ERROR.
56 .It Fl o Ar OPTION | Fl \-option= Ns Ar OPTION
57 Which configuration option should be accessed or edited.
58 Required to set a value.
59 If not given, all values of a given section will be printed in the format "OPTION = VALUE".
60 .It Fl S |\-list-sections
61 List available configuration sections for use with \-\-section.
62 .It Fl s Ar SECTION | Fl \-section= Ns Ar SECTION
63 Which configuration section should be accessed or edited.
64 Required option.
65 .It Fl V Ar VALUE | Fl \-value Ar VALUE
66 Configuration value to store in the given section under the given option.
67 Must only be given together with \-s and \-o options.
68 .It Fl v | \-version
69 Print GNUnet version number.
70 .It Fl W | \-rewrite
71 Consider differences to defaults only.
72 .El
73 .Sh SEE ALSO
74 The full documentation for gnunet is maintained as a Texinfo manual.
75 If the
76 .Xr info 1
77 and gnunet programs are properly installed at your site, the command
78 .Pp
79 .Dl info gnunet
80 .Pp
81 should give you access to the complete handbook,
82 .Pp
83 .Dl info gnunet-c-tutorial
84 .Pp
85 will give you access to a tutorial for developers.
86 .sp
87 Depending on your installation, this information is also available in
88 .Xr gnunet 7 and
89 .Xr gnunet-c-tutorial 7 .
90 .\".Sh HISTORY
91 .\".Sh AUTHORS
92 .Sh BUGS
93 Report bugs by using
94 .Lk https://bugs.gnunet.org
95 or by sending electronic mail to
96 .Aq Mt gnunet-developers@gnu.org .