gnunet-cadet.1 2.3 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485
  1. .TH GNUNET\-CADET 1 "May 3, 2016" "GNUnet"
  2. .SH NAME
  3. gnunet\-cadet \- Create or obtain information about CADET tunnels and peers
  4. .SH SYNOPSIS
  5. .B gnunet\-cadet
  6. .RI [ options ]
  7. .I [ \fIPEER_ID SHARED_SECRET\fR ]
  8. .br
  9. .SH DESCRIPTION
  10. \fBgnunet\-cadet\fP prints information about CADET tunnels and peers.
  11. It can also be used for command-line based CADET tunnels using the
  12. \fI-o SHARED_SECRET\fR option to open a port on a receiving PEER_ID
  13. and using "\fBgnunet\-cadet\fP \fIPEER_ID SHARED_SECRET\fR" to
  14. establish one circuit to that peer from any other peer. The receiving
  15. process will only accept one incoming circuit, but several commands
  16. using the same \fI-o\fR can be issued to satisfy multiple requests.
  17. For one\-to\-many communication \fBgnunet\-social\fP may be better
  18. suited, however.
  19. .SH SPECIFIC OPTIONS
  20. .B
  21. .IP "\-C CONNECTION_ID, \-\-connection=CONNECTION_ID"
  22. Provide information about a particular connection.
  23. .B
  24. .IP "\-d, \-\-dump"
  25. Dump debug information to STDERR.
  26. .B
  27. .IP "\-e, \-\-echo"
  28. Activate echo mode.
  29. .B
  30. .IP "\-o SHARED_SECRET, \-\-open-port=SHARED_SECRET"
  31. Listen for connections using a shared secret among sender and recipient.
  32. .B
  33. .IP "\-p PEER_ID, \-\-peer=PEER_ID"
  34. Provide information about a patricular peer.
  35. .B
  36. .IP "\-P, \-\-peers"
  37. Provide information about all peers.
  38. .B
  39. .IP "\-T, \-\-tunnels"
  40. Provide information about all tunnels.
  41. .SH STANDARD OPTIONS
  42. .B
  43. .IP "\-c FILENAME, \-\-config=FILENAME"
  44. Use the configuration file FILENAME.
  45. .B
  46. .IP "\-h, \-\-help"
  47. Print short help on options.
  48. .B
  49. .IP "\-l LOGFILE, \-\-logfile=LOGFILE"
  50. Configure logging to write logs to LOGFILE.
  51. .B
  52. .IP "\-L LOGLEVEL, \-\-loglevel=LOGLEVEL"
  53. Use LOGLEVEL for logging. Valid values are DEBUG, INFO, WARNING and ERROR.
  54. .B
  55. .IP "\-v, \-\-version"
  56. Print GNUnet version number.
  57. .SH BUGS
  58. Report bugs by using Mantis <https://bugs.gnunet.org/> or by sending
  59. electronic mail to <gnunet\-developers@gnu.org>
  60. .SH SEE ALSO
  61. The full documentation for
  62. .B gnunet
  63. is maintained as a Texinfo manual. If the
  64. .B info
  65. and
  66. .B gnunet
  67. programs are properly installed at your site, the command
  68. .IP
  69. .B info gnunet
  70. .PP
  71. should give you access to the complete handbook,
  72. .IP
  73. .B info gnunet-c-tutorial
  74. .PP
  75. will give you access to a tutorial for developers.
  76. .PP
  77. Depending on your installation, this information is also
  78. available in
  79. \fBgnunet\fP(7) and \fBgnunet-c-tutorial\fP(7).