git.tinc-vpn.org Git - tinc/blob - doc/tincctl.8.in

   1 .Dd 2007-07-20
   2 .Dt TINCCTL 8
   3 .\" Manual page created by:
   4 .\" Scott Lamb
   5 .Sh NAME
   6 .Nm tincctl
   7 .Nd tinc VPN control
   8 .Sh SYNOPSIS
   9 .Nm
  10 .Op Fl cn
  11 .Op Fl -config Ns = Ns Ar DIR
  12 .Op Fl -net Ns = Ns Ar NETNAME
  13 .Op Fl -controlsocket Ns = Ns Ar FILENAME
  14 .Op Fl -help
  15 .Op Fl -version
  16 .Ar COMMAND
  17 .Sh DESCRIPTION
  18 This is the control program of tinc, a secure virtual private network (VPN)
  19 project.
  20 .Nm
  21 communicates with
  22 .Xr tincd 8
  23 to alter and inspect the running VPN's state.
  24 .Sh OPTIONS
  25 .Bl -tag -width indent
  26 .It Fl n, -net Ns = Ns Ar NETNAME
  27 Communicate with tincd(8) connected with
  28 .Ar NETNAME .
  29 .It Fl -controlsocket Ns = Ns Ar FILENAME
  30 Open control socket at
  31 .Ar FILENAME .
  32 If unspecified, the default is
  33 .Pa @localstatedir@/run/tinc. Ns Ar NETNAME Ns Pa .control.
  34 .It Fl -help
  35 Display short list of options.
  36 .It Fl -version
  37 Output version information and exit.
  38 .El
  39 .Sh COMMANDS
  40 .zZ
  41 .Bl -tag -width indent
  42 .It start
  43 Start
  44 .Xr tincd 8 .
  45 .It stop
  46 Stop
  47 .Xr tincd 8 .
  48 .It restart
  49 Restart
  50 .Xr tincd 8 .
  51 .It reload
  52 Partially rereads configuration files. Connections to hosts whose host
  53 config files are removed are closed. New outgoing connections specified
  54 in
  55 .Xr tinc.conf 5
  56 will be made.
  57 .It pid
  58 Shows the PID of the currently running
  59 .Xr tincd 8 .
  60 .It generate-keys Op bits
  61 Generate public/private RSA keypair and exit.
  62 If
  63 .Ar bits
  64 is omitted, the default length will be 1024 bits.
  65 When saving keys to existing files, tinc will not delete the old keys;
  66 you have to remove them manually.
  67 .It dump nodes
  68 Dump a list of all known nodes in the VPN.
  69 .It dump edges
  70 Dump a list of all known connections in the VPN.
  71 .It dump subnets
  72 Dump a list of all known subnets in the VPN.
  73 .It dump connections
  74 Dump a list of all meta connections with ourself.
  75 .It dump graph
  76 Dump a graph of the VPN in
  77 .Xr dotty 1
  78 format.
  79 .It purge
  80 Purges all information remembered about unreachable nodes.
  81 .It debug Ar N
  82 Sets debug level to
  83 .Ar N .
  84 .It retry
  85 Forces
  86 .Xr tincd 8
  87 to try to connect to all uplinks immediately.
  88 Usually
  89 .Xr tincd 8
  90 attempts to do this itself,
  91 but increases the time it waits between the attempts each time it failed,
  92 and if
  93 .Xr tincd 8
  94 didn't succeed to connect to an uplink the first time after it started,
  95 it defaults to the maximum time of 15 minutes.
  96 .It reload
  97 Partially rereads configuration files.
  98 Connections to hosts whose host config files are removed are closed.
  99 New outgoing connections specified in
 100 .Pa tinc.conf
 101 will be made.
 102 .El
 103 .Sh BUGS
 104 The "start" and "restart" commands are not yet implemented.
 105 .Pp
 106 If you find any bugs, report them to tinc@tinc-vpn.org.
 107 .Sh SEE ALSO
 108 .Xr tincd 8 ,
 109 .Xr tinc.conf 5 ,
 110 .Xr dotty 1 ,
 111 .Pa http://www.tinc-vpn.org/ ,
 112 .Pa http://www.cabal.org/ .
 113 .Pp
 114 The full documentation for tinc is maintained as a Texinfo manual.
 115 If the info and tinc programs are properly installed at your site,
 116 the command
 117 .Ic info tinc
 118 should give you access to the complete manual.
 119 .Pp
 120 tinc comes with ABSOLUTELY NO WARRANTY.
 121 This is free software, and you are welcome to redistribute it under certain conditions;
 122 see the file COPYING for details.
 123 .Sh AUTHORS
 124 .An "Ivo Timmermans"
 125 .An "Guus Sliepen" Aq guus@tinc-vpn.org
 126 .Pp
 127 And thanks to many others for their contributions to tinc!