gnunet-config.1 3.8 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798
  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 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 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 manipulate GNUnet configuration files
  30. .Sh SYNOPSIS
  31. .Nm
  32. .Op Fl b Ar BACKEND | Fl -supported-backend= Ns Ar BACKEND
  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 indent
  47. .It Fl b Ar BACKEND | Fl -supported-backend= Ns Ar BACKEND
  48. Tests whether the specified BACKEND is supported by the current installation. The backend must match the name of a plugin, i.e. "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).
  49. .It Fl c Ar FILENAME | Fl -config= Ns Ar FILENAME
  50. Use the configuration file FILENAME.
  51. .It Fl f | -filename
  52. Try to perform expansions as if the option values represent filenames (will also be applied even if the option is not really a filename).
  53. .It Fl h | -help
  54. Print short help on options.
  55. .It Fl L Ar LOGLEVEL | Fl -loglevel= Ns Ar LOGLEVEL
  56. Use LOGLEVEL for logging.
  57. Valid values are DEBUG, INFO, WARNING and ERROR.
  58. .It Fl o Ar OPTION | Fl -option= Ns Ar OPTION
  59. Which configuration option should be accessed or edited.
  60. Required to set a value.
  61. If not given, all values of a given section will be printed in the format "OPTION = VALUE".
  62. .It Fl S |-list-sections
  63. List available configuration sections for use with --section.
  64. .It Fl s Ar SECTION | Fl -section= Ns Ar SECTION
  65. Which configuration section should be accessed or edited.
  66. Required option.
  67. .It Fl V Ar VALUE | Fl -value Ar VALUE
  68. Configuration value to store in the given section under the given option.
  69. Must only be given together with -s and -o options.
  70. .It Fl v | -version
  71. Print GNUnet version number.
  72. .It Fl W | -rewrite
  73. Consider differences to defaults only.
  74. .El
  75. .Sh SEE ALSO
  76. The full documentation for gnunet is maintained as a Texinfo manual.
  77. If the
  78. .Xr info 1
  79. and gnunet programs are properly installed at your site, the command
  80. .Pp
  81. .Dl info gnunet
  82. .Pp
  83. should give you access to the complete handbook,
  84. .Pp
  85. .Dl info gnunet-c-tutorial
  86. .Pp
  87. will give you access to a tutorial for developers.
  88. .sp
  89. Depending on your installation, this information is also available in
  90. .Xr gnunet 7 and
  91. .Xr gnunet-c-tutorial 7 .
  92. .\".Sh HISTORY
  93. .\".Sh AUTHORS
  94. .Sh BUGS
  95. Report bugs by using
  96. .Lk https://bugs.gnunet.org
  97. or by sending electronic mail to
  98. .Aq Mt gnunet-developers@gnu.org .