syntax
[oweals/gnunet.git] / doc / man / gnunet-config.1
1 .Dd July 15, 2012
2 .Dt GNUNET-CONFIG 1
3 .Os
4 .Sh NAME
5 .Nm gnunet-config
6 .Nd
7 manipulate GNUnet configuration files
8 .Sh SYNOPSIS
9 .Nm
10 .Op Fl c Ar FILENAME | Fl \-config= Ns Ar FILENAME
11 .Op Fl f | \-filename
12 .Op Fl h | \-help
13 .Op Fl L Ar LOGLEVEL | Fl \-loglevel= Ns Ar LOGLEVEL
14 .Op Fl o Ar OPTION | Fl \-option= Ns Ar OPTION
15 .Op Fl S |\-list-sections
16 .Op Fl s Ar SECTION | Fl \-section= Ns Ar SECTION
17 .Op Fl V Ar VALUE | Fl \-value Ar VALUE
18 .Op Fl v | \-version
19 .Op Fl W | \-rewrite
20 .Sh DESCRIPTION
21 .Nm
22 can be used to read or modify GNUnet configuration files.
23 .Bl -tag -width Ds
24 .It Fl c Ar FILENAME | Fl \-config= Ns Ar FILENAME
25 Use the configuration file FILENAME.
26 .It Fl f | \-filename
27 Try to perform expansions as if the option values represent filenames (will also be applied even if the option is not really a filename).
28 .It Fl h | \-help
29 Print short help on options.
30 .It Fl L Ar LOGLEVEL | Fl \-loglevel= Ns Ar LOGLEVEL
31 Use LOGLEVEL for logging.
32 Valid values are DEBUG, INFO, WARNING and ERROR.
33 .It Fl o Ar OPTION | Fl \-option= Ns Ar OPTION
34 Which configuration option should be accessed or edited.
35 Required to set a value.
36 If not given, all values of a given section will be printed in the format "OPTION = VALUE".
37 .It Fl S |\-list-sections
38 List available configuration sections for use with \-\-section.
39 .It Fl s Ar SECTION | Fl \-section= Ns Ar SECTION
40 Which configuration section should be accessed or edited.
41 Required option.
42 .It Fl V Ar VALUE | Fl \-value Ar VALUE
43 Configuration value to store in the given section under the given option.
44 Must only be given together with \-s and \-o options.
45 .It Fl v | \-version
46 Print GNUnet version number.
47 .It Fl W | \-rewrite
48 Consider differences to defaults only.
49 .El
50 .Sh SEE ALSO
51 The full documentation for gnunet is maintained as a Texinfo manual.
52 If the
53 .Xr info 1
54 and gnunet programs are properly installed at your site, the command
55 .Pp
56 .Dl info gnunet
57 .Pp
58 should give you access to the complete handbook,
59 .Pp
60 .Dl info gnunet-c-tutorial
61 .Pp
62 will give you access to a tutorial for developers.
63 .sp
64 Depending on your installation, this information is also available in
65 .Xr gnunet 7 and
66 .Xr gnunet-c-tutorial 7 .
67 .\".Sh HISTORY
68 .\".Sh AUTHORS
69 .Sh BUGS
70 Report bugs by using
71 .Lk https://bugs.gnunet.org
72 or by sending electronic mail to
73 .Aq Mt gnunet-developers@gnu.org .