pidfile and cleanup mgmt for startup/shutdown scripts
[vde.git] / vdetelweb / vdetelweb.1
blob0d021713bc24cd3308d3bf942a4149a675a1f72f
1 .\" Copyright (c) 2004 Renzo Davoli
2 .\"
3 .\" This is free documentation; you can redistribute it and/or
4 .\" modify it under the terms of the GNU General Public License as
5 .\" published by the Free Software Foundation; either version 2 of
6 .\" the License, or (at your option) any later version.
7 .\"
8 .\" The GNU General Public License's references to "object code"
9 .\" and "executables" are to be interpreted as the output of any
10 .\" document formatting or typesetting system, including
11 .\" intermediate and printed output.
12 .\"
13 .\" This manual is distributed in the hope that it will be useful,
14 .\" but WITHOUT ANY WARRANTY; without even the implied warranty of
15 .\" MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
16 .\" GNU General Public License for more details.
17 .\"
18 .\" You should have received a copy of the GNU General Public
19 .\" License along with this manual; if not, write to the Free
20 .\" Software Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139,
21 .\" USA.
23 .TH VDETELWEB 1 "October 10, 2005" "Virtual Distributed Ethernet"
24 .SH NAME
25 vdetelweb \- Virtual Distributed Ethernet Telnet and/or Web management module
26 .SH SYNOPSIS
27 .B vdetelweb 
28
29 .BI \-web  
30
31
32 .BI \-telnet 
33 ]  
34
35 .BI \-nodename
36 .I nodename
37
39 .BI \-daemon 
41 .I mgmt_socket
42 .br
43 .SH DESCRIPTION
45 \fBvdetelweb\fP 
46 implements a tiny telnet server and/or a tiny web server for the remote management
47 of a VDE2 switch.
48 .br
49 .SH OPTIONS
50 .TP
51 .B \-web, 
52 starts the web server.
53 .TP
54 .B \-telnet, 
55 starts the telnet server. At least one option \-web or \-telnet must be set
56 .TP
57 .B \-nodename "\fInodename\fP"
58 Specify the nodename as seen from remote connections (e.g. in the command prompt or
59 in the web page title). uname nodename is used when this option is not specified.
60 .TP
61 .B \-daemon
62 Run as a daemon. Use syslog for logging.
63 .TP
64 .B \-f \fIrcfile\fP
65 rc file to set the initial switch configuration. 
66 When not specified, vdetelweb searches for /etc/vde/vdetelwebrc and
67 ~/etc/vde/vdetelwebrc. One rc file must be accessible.
68 .TP
69 .B \-h 
70 help. please use it for a more complete list of options.
71 .TP
72 .B \fImgmt_socket\fP
73 is the managemnt socket used to communicate with the vde_switch. 
74 (This option must match the path used in the -M option for the vde_switch).
75 .SH SEE ALSO
76 .BR vde_switch (1),
77 .BR vde_plug (1),
78 .BR vdeq (1).
79 .BR dpipe (1).
80 .BR unixterm (1).
81 .br
82 .SH AUTHOR
83 VDE is a project by Renzo Davoli <renzo@cs.unibo.it>