gvpe/doc/vped.8

.Dd 2002-03-25
.Dt VPED 8
.\" Manual page created by:
.\" Ivo Timmermans <ivo@o2w.nl>
.\" Guus Sliepen <guus@sliepen.eu.org>
.\" Modified extensively by Marc Lehmann <pcg@goof.com>
.Sh NAME
.Nm vped
.Nd Virtual Private Ethernet Daemon
.Sh SYNOPSIS
.Nm
.Op Fl cdDkKnL
.Op Fl -config Ns = Ns Ar DIR
.Op Fl -no-detach
.Op Fl -debug Ns = Ns Ar [LEVEL]
.Op Fl -kill Ns = Ns Ar [SIGNAL]
.Op Fl -mlock
.Op Fl -help
.Op Fl -version
NODENAME
.Sh DESCRIPTION
This is the manual page for vped, the virtual private ethernet daemon.
When started,
.Nm

will read it's configuration file to determine the network topology, and
other configuration information, assuming the role of node NODENAME. It
will then connect to the tun/tap device and set up a socket for incoming
connections.  Then a script will be executed to further configure the
virtual device.  If that succeeds, it will detach from the controlling
terminal and continue in the background, accepting and setting up
connections to other vped daemons that are part of the virtual private
ethernet.

.Sh OPTIONS
.Bl -tag -width indent
.It Fl c, -config Ns = Ns Ar DIR
Read configuration options from
.Ar DIR .
.It Fl d, -debug Ns Op = Ns Ar LEVEL
Increase debug level or set it to
.Ar LEVEL
(see below).
.It Fl -help
Display short list of options.
.It Fl k, -kill Ns Op = Ns Ar SIGNAL
Attempt to kill a running
.Nm
(optionally with the specified
.Ar SIGNAL
instead of SIGTERM) and exit.
.It Fl D, -no-detach
Don't fork and detach.
.It Fl L, -mlock
Lock vped into main memory.
This will prevent sensitive data like shared private keys to be written to the system swap files/partitions.
.It Fl -version
Output version information and exit.
.El
.Sh SIGNALS
.Bl -tag -width indent
.It HUP
Closes all connections, resets the retry time and will start connecting again
(it will NOT re-read the config file). This is useful e.g. in a /etc/ppp/if-up script.
.El
.Sh FILES
.Bl -tag -width indent
.It Pa /etc/vpe/vped.conf
The configuration file for
.Nm .
.It Pa /etc/vpe/if-up
Script which is executed as soon as the virtual network device has been allocated.
Purpose is to further configure that device.
.It Pa /etc/vpe/node-up
Script which is executed whenever a node connects to this node. This can be used
for example to run nsupdate.
.It Pa /etc/vpe/node-down
Script which is executed whenever a conenction to another node is lost.
for example to run nsupdate.
.It Pa /etc/vpe/pubkey/*
The directory containing the public keys for every node, usually autogenerated
by executing vpectrl --generate-keys.
.It Pa /var/run/vped.pid
The PID of the currently running
.Nm
is stored in this file.
.El
.Sh BUGS
.Sy The cryptography in vped is not well tested yet. Use it at your own risk!
.Pp
If you find any bugs, report them to vpe@plan9.de.
.Sh TODO
A lot.
.Sh SEE ALSO
.Xr vpe.conf 5 ,
.Xr vpectrl 8 ,
.Pp
The full documentation for vpe is maintained as a Texinfo manual.
If the info and tinc programs are properly installed at your site,
the command
.Ic info vpe
should give you access to the complete manual.
.Pp
vpe comes with ABSOLUTELY NO WARRANTY.
This is free software, and you are welcome to redistribute it under certain conditions;
see the file COPYING for details.
.Sh AUTHORS
.An "Marc Lehmann" Aq vpe@plan9.de
.Pp
And thanks to many others for their contributions to vpe, especially the tincd authors
who inspired this program and whose sourcecode I scavanged!
Revision:	1.2
Committed:	Sun Mar 23 14:47:39 2003 UTC (21 years, 2 months ago) by pcg
Branch:	MAIN
Changes since 1.1:	+1 -1 lines
Log Message:	* empty log message *
#	Content
1	.Dd 2002-03-25
2	.Dt VPED 8
3	.\" Manual page created by:
4	.\" Ivo Timmermans <ivo@o2w.nl>
5	.\" Guus Sliepen <guus@sliepen.eu.org>
6	.\" Modified extensively by Marc Lehmann <pcg@goof.com>
7	.Sh NAME
8	.Nm vped
9	.Nd Virtual Private Ethernet Daemon
10	.Sh SYNOPSIS
11	.Nm
12	.Op Fl cdDkKnL
13	.Op Fl -config Ns = Ns Ar DIR
14	.Op Fl -no-detach
15	.Op Fl -debug Ns = Ns Ar [LEVEL]
16	.Op Fl -kill Ns = Ns Ar [SIGNAL]
17	.Op Fl -mlock
18	.Op Fl -help
19	.Op Fl -version
20	NODENAME
21	.Sh DESCRIPTION
22	This is the manual page for vped, the virtual private ethernet daemon.
23	When started,
24	.Nm
25
26	will read it's configuration file to determine the network topology, and
27	other configuration information, assuming the role of node NODENAME. It
28	will then connect to the tun/tap device and set up a socket for incoming
29	connections. Then a script will be executed to further configure the
30	virtual device. If that succeeds, it will detach from the controlling
31	terminal and continue in the background, accepting and setting up
32	connections to other vped daemons that are part of the virtual private
33	ethernet.
34
35	.Sh OPTIONS
36	.Bl -tag -width indent
37	.It Fl c, -config Ns = Ns Ar DIR
38	Read configuration options from
39	.Ar DIR .
40	.It Fl d, -debug Ns Op = Ns Ar LEVEL
41	Increase debug level or set it to
42	.Ar LEVEL
43	(see below).
44	.It Fl -help
45	Display short list of options.
46	.It Fl k, -kill Ns Op = Ns Ar SIGNAL
47	Attempt to kill a running
48	.Nm
49	(optionally with the specified
50	.Ar SIGNAL
51	instead of SIGTERM) and exit.
52	.It Fl D, -no-detach
53	Don't fork and detach.
54	.It Fl L, -mlock
55	Lock vped into main memory.
56	This will prevent sensitive data like shared private keys to be written to the system swap files/partitions.
57	.It Fl -version
58	Output version information and exit.
59	.El
60	.Sh SIGNALS
61	.Bl -tag -width indent
62	.It HUP
63	Closes all connections, resets the retry time and will start connecting again
64	(it will NOT re-read the config file). This is useful e.g. in a /etc/ppp/if-up script.
65	.El
66	.Sh FILES
67	.Bl -tag -width indent
68	.It Pa /etc/vpe/vped.conf
69	The configuration file for
70	.Nm .
71	.It Pa /etc/vpe/if-up
72	Script which is executed as soon as the virtual network device has been allocated.
73	Purpose is to further configure that device.
74	.It Pa /etc/vpe/node-up
75	Script which is executed whenever a node connects to this node. This can be used
76	for example to run nsupdate.
77	.It Pa /etc/vpe/node-down
78	Script which is executed whenever a conenction to another node is lost.
79	for example to run nsupdate.
80	.It Pa /etc/vpe/pubkey/*
81	The directory containing the public keys for every node, usually autogenerated
82	by executing vpectrl --generate-keys.
83	.It Pa /var/run/vped.pid
84	The PID of the currently running
85	.Nm
86	is stored in this file.
87	.El
88	.Sh BUGS
89	.Sy The cryptography in vped is not well tested yet. Use it at your own risk!
90	.Pp
91	If you find any bugs, report them to vpe@plan9.de.
92	.Sh TODO
93	A lot.
94	.Sh SEE ALSO
95	.Xr vpe.conf 5 ,
96	.Xr vpectrl 8 ,
97	.Pp
98	The full documentation for vpe is maintained as a Texinfo manual.
99	If the info and tinc programs are properly installed at your site,
100	the command
101	.Ic info vpe
102	should give you access to the complete manual.
103	.Pp
104	vpe comes with ABSOLUTELY NO WARRANTY.
105	This is free software, and you are welcome to redistribute it under certain conditions;
106	see the file COPYING for details.
107	.Sh AUTHORS
108	.An "Marc Lehmann" Aq vpe@plan9.de
109	.Pp
110	And thanks to many others for their contributions to vpe, especially the tincd authors
111	who inspired this program and whose sourcecode I scavanged!