vdetelweb.1

.\" Copyright (c) 2004-2005 Renzo Davoli, 2008 Ludovico Gardenghi
.\"
.\" This is free documentation; you can redistribute it and/or
.\" modify it under the terms of the GNU General Public License as
.\" published by the Free Software Foundation; either version 2 of
.\" the License, or (at your option) any later version.
.\"
.\" The GNU General Public License's references to "object code"
.\" and "executables" are to be interpreted as the output of any
.\" document formatting or typesetting system, including
.\" intermediate and printed output.
.\"
.\" This manual is distributed in the hope that it will be useful,
.\" but WITHOUT ANY WARRANTY; without even the implied warranty of
.\" MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
.\" GNU General Public License for more details.
.\"
.\" You should have received a copy of the GNU General Public
.\" License along with this manual; if not, write to the Free
.\" Software Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139,
.\" USA.

.TH VDETELWEB 1 "June 16, 2008" "Virtual Distributed Ethernet"
.SH NAME
vdetelweb \- Virtual Distributed Ethernet Telnet and/or Web management module
.SH SYNOPSIS
.B vdetelweb
[ 
.BI \-\-web  
] 
[ 
.BI \-\-https  
] 
[ 
.BI \-\-telnet 
]  
[ 
.BI \-\-ssh 
] 
[
.BI \-\-daemon 
]
[ 
.BI \-\-stack
.I iothstack
]
[
.BI \-\-rcfile
.I rcfile
]
[ 
.BI \-\-nodename
.I nodename
] 
[
.BI \-\-pidfile
.I pidfile
]
.I mgmt_socket
.br
.SH DESCRIPTION
\fBvdetelweb\fP 
implements a tiny telnet server and/or a tiny web server and/or a tiny ssh server
for the remote management of a VDE2 switch.
.br
.SH OPTIONS
.TP

.B \-w, \-\-web
start the web server in http mode. At least one of \fB\-\-web\fP, \fB\-\-telnet\fP or \fB\-\-ssh\fP \fImust\fP be set.
.TP
.B \-S, \-\-https
start the web server in https mode. httpscert and httpskey must be set in the rc file.
.TP
.B \-t, \-\-telnet
start the telnet server. At least one of \fB\-\-web\fP, \fB\-\-telnet\fP or \fB\-\-ssh\fP \fImust\fP be set.
.TP
.B \-s, \-\-ssh
start the ssh server. If this parameter is set, sshcert must be set in the config file (must be a der file).
At least one of \fB\-\-web\fP, \fB\-\-telnet\fP or \fB\-\-ssh\fP \fImust\fP be set.
.TP
.B \-d, \-\-daemon
run as a daemon, using syslog for logging.
.TP
.B \-i, \-\-stack \fIiothstack\fP
specify the iothstack to use. This setting must be specified.
.TP
.B \-n, \-\-nodename \fInodename\fP
specify the nodename as seen from remote connections (e.g. in the command prompt or
in the web page title). uname nodename is used when this option is not specified.
.TP
.B \-f, \-\-rcfile \fIrcfile\fP
rc file to set the initial switch configuration.
When not specified, vdetelweb searches for \fI~/.vde/vdetelwebrc\fP and
\fI/etc/vde/vdetelwebrc\fP. At leas one rc file must exist and be readable.
.TP
.B \-f, \-\-pidfile \fIpidfile\fP
file's path to set the pid of the main process. If the file doesn't exist,
the programm will create it and remove it on close.
.TP
.B \-h, \-\-help
print help. please use it for a more complete list of options.
.TP
.B \fImgmt_socket\fP
is the managemnt socket used to communicate with the vde_switch.
(This option must match the path used in the -M option for the vde_switch).
.SH NOTICE
Virtual Distributed Ethernet is not related in any way with
www.vde.com ("Verband der Elektrotechnik, Elektronik und Informationstechnik"
i.e. the German "Association for Electrical, Electronic & Information
Technologies").

.SH SEE ALSO
.BR vde_switch (1),
.BR vde_plug (1),
.BR vdeq (1).
.BR dpipe (1).
.BR unixterm (1).
.br
.SH AUTHOR
VDE is a project by Renzo Davoli <renzo@cs.unibo.it>