[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
[gnunet] 02/09: gnunet-config manpage: Document the new flags
From: |
gnunet |
Subject: |
[gnunet] 02/09: gnunet-config manpage: Document the new flags |
Date: |
Fri, 17 Sep 2021 19:03:18 +0200 |
This is an automated email from the git hooks/post-receive script.
alessio-vanni pushed a commit to branch master
in repository gnunet.
commit 9bdfda437e180ee9fe6d1e54b201c538086d2c48
Author: Alessio Vanni <vannilla@firemail.cc>
AuthorDate: Sat Jul 24 16:15:10 2021 +0200
gnunet-config manpage: Document the new flags
---
doc/man/gnunet-config.1 | 25 ++++++++++++++++++-------
1 file 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 @@
.Os
.Sh NAME
.Nm gnunet-config
-.Nd manipulate GNUnet configuration files
+.Nd manipulate GNUnet configuration files and provide informations on how
GNUnet was built
.Sh SYNOPSIS
.Nm
.Op Fl b Ar BACKEND | Fl -supported-backend= Ns Ar BACKEND
+.Op Fl C | -cflags
.Op Fl c Ar FILENAME | Fl -config= Ns Ar FILENAME
+.Op Fl F | -full
.Op Fl f | -filename
.Op Fl h | -help
+.Op Fl j | -libs
.Op Fl L Ar LOGLEVEL | Fl -loglevel= Ns Ar LOGLEVEL
.Op Fl o Ar OPTION | Fl -option= Ns Ar OPTION
+.Op Fl p | -prefix
+.Op Fl r | -rewrite
.Op Fl S |-list-sections
.Op Fl s Ar SECTION | Fl -section= Ns Ar SECTION
.Op Fl V Ar VALUE | Fl -value Ar VALUE
.Op Fl v | -version
-.Op Fl r | -rewrite
-.Op Fl F | -full
.Sh DESCRIPTION
.Nm
can be used to read or modify GNUnet configuration files.
+It can also provide informations to properly build applications on top of
+GNUnet, like appropriate values for CFLAGS or the installation prefix.
.Bl -tag -width indent
.It Fl b Ar BACKEND | Fl -supported-backend= Ns Ar BACKEND
Tests 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 [...]
+.It Fl C | -cflags
+Print an appropriate value for CFLAGS to compile applications on top of GNUnet.
.It Fl c Ar FILENAME | Fl -config= Ns Ar FILENAME
Use the configuration file FILENAME.
+.It Fl F | -full
+Write the full configuration, not just the deltas to the defaults.
.It Fl f | -filename
Try to perform expansions as if the option values represent filenames (will
also be applied even if the option is not really a filename).
.It Fl h | -help
Print short help on options.
+.It Fl j | -libs
+Print an appropriate value for LIBS to compile applications on top of GNUnet.
.It Fl L Ar LOGLEVEL | Fl -loglevel= Ns Ar LOGLEVEL
Use LOGLEVEL for logging.
Valid values are DEBUG, INFO, WARNING and ERROR.
@@ -60,6 +71,10 @@ Valid values are DEBUG, INFO, WARNING and ERROR.
Which configuration option should be accessed or edited.
Required to set a value.
If not given, all values of a given section will be printed in the format
"OPTION = VALUE".
+.It Fl p | -prefix
+Print GNUnet's installation prefix (for example /usr/local.)
+.It Fl r | -rewrite
+Write the configuration to file, even if it did not change.
.It Fl S |-list-sections
List available configuration sections for use with --section.
.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.
Must only be given together with -s and -o options.
.It Fl v | -version
Print GNUnet version number.
-.It Fl r | -rewrite
-Write the configuration to file, even if it did not change.
-.It Fl F | -full
-Write the full configuration, not just the deltas to the defaults.
.El
.Sh SEE ALSO
The full documentation for gnunet is maintained as a Texinfo manual.
--
To stop receiving notification emails like this one, please contact
gnunet@gnunet.org.
- [gnunet] branch master updated (5df20a349 -> ad9c10e6e), gnunet, 2021/09/17
- [gnunet] 07/09: -indentation, gnunet, 2021/09/17
- [gnunet] 03/09: - Do not hardcode values in gnunet-config, gnunet, 2021/09/17
- [gnunet] 04/09: Autoconf macro to detect GNUnet installations, gnunet, 2021/09/17
- [gnunet] 05/09: gnunet.m4: add flag to disable debug messages, gnunet, 2021/09/17
- [gnunet] 01/09: 5708: allow gnunet-config to output build config informations, gnunet, 2021/09/17
- [gnunet] 06/09: -Merge branch 'master' into dev/vanni/build-info, gnunet, 2021/09/17
- [gnunet] 08/09: -set return value following the current API, gnunet, 2021/09/17
- [gnunet] 09/09: Merge branch 'dev/vanni/build-info' into 'master', gnunet, 2021/09/17
- [gnunet] 02/09: gnunet-config manpage: Document the new flags,
gnunet <=