Documentation/Manpages/curvetun.8

   1 =head1 NAME
   2
   3 curvetun - lightweight curve25519-based multiuser IP tunnel
   4
   5 =head1 SYNOPSIS
   6
   7 curvetun [-d|--dev <tun>][-x|--export][-C|--dumpc][-S|--dumps]
   8 [-k|--keygen][-c|--client [<alias>]][-s|--server][-N|--no-logging]
   9 [-p|--port <num>][-t|--stun <server>][-4|--ipv4][-6|--ipv6]
  10 [-v|--version][-h|--help]
  11
  12 =head1 DESCRIPTION
  13
  14 curvetun embeds a client and a server to build and manage multiuser
  15 IP tunnels using Elliptic Curve Cryptography (ECC)
  16
  17 =head1 EXAMPLES
  18
  19 =over
  20
  21 =item curvetun --keygen
  22
  23 Generate public/private keypair. This needs to be done before
  24 to get things started.
  25
  26 =item curvetun --export
  27
  28 Export public data to remote servers
  29
  30 =item curvetun --server -4 -u -N --port 6666 --stun stunserver.org
  31
  32 Start a UDP IPv4 curvetun server on port 6666.
  33 Use stunserver.org as STUN server.
  34
  35 =item curvetun --client=ethz
  36
  37 Start curvetun client using the profile called 'ethz'
  38
  39 =back
  40
  41 =head1 OPTIONS
  42
  43 =over
  44
  45 =item -k|--keygen
  46
  47 Generate public/private keypair.
  48
  49 =item -x|--export
  50
  51 Export your public data for remote servers.
  52
  53 =item -C|--dumpc
  54
  55 Dump parsed clients.
  56
  57 =item -S|--dumps
  58
  59 Dump parsed servers.
  60
  61 =item -D|--nofork
  62
  63 Do not daemonize.
  64
  65 =item -d|--dev <tun>
  66
  67 Networking tunnel device, e.g. tun0.
  68
  69 =item -c|--client [<alias>]
  70
  71 Client mode, server alias optional.
  72
  73 =item -s|--server
  74
  75 Server mode.
  76
  77 =item -N|--no-logging
  78
  79 Disable server logging (for better anonymity).
  80
  81 =item -p|--port <num>
  82
  83 Port number (mandatory).
  84
  85 =item -t|--stun <server>
  86
  87 Show public IP/Port mapping via STUN.
  88
  89 =item -u|--udp
  90
  91 Use UDP as carrier instead of TCP.
  92
  93 =item -4|--ipv4
  94
  95 Tunnel devices are IPv4.
  96
  97 =item -6|--ipv6
  98
  99 Tunnel devices are IPv6.
 100
 101 =item -v|--version
 102
 103 Print version.
 104
 105 =item -h|--help
 106
 107 Print help text and lists all options.
 108
 109 =back
 110
 111 =head1 AUTHOR
 112
 113 Written by Daniel Borkmann <daniel@netsniff-ng.org> and Emmanuel Roullit <emmanuel@netsniff-ng.org>
 114
 115 =head1 DOCUMENTATION
 116
 117 Documentation by Emmanuel Roullit <emmanuel@netsniff-ng.org>
 118
 119 =head1 BUGS
 120
 121 Please report bugs to <bugs@netsniff-ng.org>
 122
 123 =cut