aboutsummaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
Diffstat (limited to 'doc')
-rw-r--r--doc/man/gnunet-config.125
1 files changed, 18 insertions, 7 deletions
diff --git a/doc/man/gnunet-config.1 b/doc/man/gnunet-config.1
index 03f180c29..c749c03b5 100644
--- a/doc/man/gnunet-config.1
+++ b/doc/man/gnunet-config.1
@@ -26,33 +26,44 @@
26.Os 26.Os
27.Sh NAME 27.Sh NAME
28.Nm gnunet-config 28.Nm gnunet-config
29.Nd manipulate GNUnet configuration files 29.Nd manipulate GNUnet configuration files and provide informations on how GNUnet was built
30.Sh SYNOPSIS 30.Sh SYNOPSIS
31.Nm 31.Nm
32.Op Fl b Ar BACKEND | Fl -supported-backend= Ns Ar BACKEND 32.Op Fl b Ar BACKEND | Fl -supported-backend= Ns Ar BACKEND
33.Op Fl C | -cflags
33.Op Fl c Ar FILENAME | Fl -config= Ns Ar FILENAME 34.Op Fl c Ar FILENAME | Fl -config= Ns Ar FILENAME
35.Op Fl F | -full
34.Op Fl f | -filename 36.Op Fl f | -filename
35.Op Fl h | -help 37.Op Fl h | -help
38.Op Fl j | -libs
36.Op Fl L Ar LOGLEVEL | Fl -loglevel= Ns Ar LOGLEVEL 39.Op Fl L Ar LOGLEVEL | Fl -loglevel= Ns Ar LOGLEVEL
37.Op Fl o Ar OPTION | Fl -option= Ns Ar OPTION 40.Op Fl o Ar OPTION | Fl -option= Ns Ar OPTION
41.Op Fl p | -prefix
42.Op Fl r | -rewrite
38.Op Fl S |-list-sections 43.Op Fl S |-list-sections
39.Op Fl s Ar SECTION | Fl -section= Ns Ar SECTION 44.Op Fl s Ar SECTION | Fl -section= Ns Ar SECTION
40.Op Fl V Ar VALUE | Fl -value Ar VALUE 45.Op Fl V Ar VALUE | Fl -value Ar VALUE
41.Op Fl v | -version 46.Op Fl v | -version
42.Op Fl r | -rewrite
43.Op Fl F | -full
44.Sh DESCRIPTION 47.Sh DESCRIPTION
45.Nm 48.Nm
46can be used to read or modify GNUnet configuration files. 49can be used to read or modify GNUnet configuration files.
50It can also provide informations to properly build applications on top of
51GNUnet, like appropriate values for CFLAGS or the installation prefix.
47.Bl -tag -width indent 52.Bl -tag -width indent
48.It Fl b Ar BACKEND | Fl -supported-backend= Ns Ar BACKEND 53.It Fl b Ar BACKEND | Fl -supported-backend= Ns Ar BACKEND
49Tests whether the specified BACKEND is supported by the current installation. The backend must match the name of a plugin, e.g. "namestore_postgres" for the Postgres database backend of the "NAMESTORE" service. If the BACKEND is supported, gnunet-config will return a status code of 0 (success), otherwise 77 (unsupported). When this option is specified, no other options may be specified. Specifying this option together with other options will cause gnunet-config to return a status code of 1 (error). 54Tests whether the specified BACKEND is supported by the current installation. The backend must match the name of a plugin, e.g. "namestore_postgres" for the Postgres database backend of the "NAMESTORE" service. If the BACKEND is supported, gnunet-config will return a status code of 0 (success), otherwise 77 (unsupported). When this option is specified, no other options may be specified. Specifying this option together with other options will cause gnunet-config to return a status code of 1 (error).
55.It Fl C | -cflags
56Print an appropriate value for CFLAGS to compile applications on top of GNUnet.
50.It Fl c Ar FILENAME | Fl -config= Ns Ar FILENAME 57.It Fl c Ar FILENAME | Fl -config= Ns Ar FILENAME
51Use the configuration file FILENAME. 58Use the configuration file FILENAME.
59.It Fl F | -full
60Write the full configuration, not just the deltas to the defaults.
52.It Fl f | -filename 61.It Fl f | -filename
53Try to perform expansions as if the option values represent filenames (will also be applied even if the option is not really a filename). 62Try to perform expansions as if the option values represent filenames (will also be applied even if the option is not really a filename).
54.It Fl h | -help 63.It Fl h | -help
55Print short help on options. 64Print short help on options.
65.It Fl j | -libs
66Print an appropriate value for LIBS to compile applications on top of GNUnet.
56.It Fl L Ar LOGLEVEL | Fl -loglevel= Ns Ar LOGLEVEL 67.It Fl L Ar LOGLEVEL | Fl -loglevel= Ns Ar LOGLEVEL
57Use LOGLEVEL for logging. 68Use LOGLEVEL for logging.
58Valid values are DEBUG, INFO, WARNING and ERROR. 69Valid values are DEBUG, INFO, WARNING and ERROR.
@@ -60,6 +71,10 @@ Valid values are DEBUG, INFO, WARNING and ERROR.
60Which configuration option should be accessed or edited. 71Which configuration option should be accessed or edited.
61Required to set a value. 72Required to set a value.
62If not given, all values of a given section will be printed in the format "OPTION = VALUE". 73If not given, all values of a given section will be printed in the format "OPTION = VALUE".
74.It Fl p | -prefix
75Print GNUnet's installation prefix (for example /usr/local.)
76.It Fl r | -rewrite
77Write the configuration to file, even if it did not change.
63.It Fl S |-list-sections 78.It Fl S |-list-sections
64List available configuration sections for use with --section. 79List available configuration sections for use with --section.
65.It Fl s Ar SECTION | Fl -section= Ns Ar SECTION 80.It Fl s Ar SECTION | Fl -section= Ns Ar SECTION
@@ -70,10 +85,6 @@ Configuration value to store in the given section under the given option.
70Must only be given together with -s and -o options. 85Must only be given together with -s and -o options.
71.It Fl v | -version 86.It Fl v | -version
72Print GNUnet version number. 87Print GNUnet version number.
73.It Fl r | -rewrite
74Write the configuration to file, even if it did not change.
75.It Fl F | -full
76Write the full configuration, not just the deltas to the defaults.
77.El 88.El
78.Sh SEE ALSO 89.Sh SEE ALSO
79The full documentation for gnunet is maintained as a Texinfo manual. 90The full documentation for gnunet is maintained as a Texinfo manual.