vdetelweb/vdetelweb.1

   1 .\" Copyright (c) 2004-2005 Renzo Davoli, 2008 Ludovico Gardenghi
   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.
  22
  23 .TH VDETELWEB 1 "June 16, 2008" "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 ]
  38 [
  39 .BI \-\-daemon
  40 ]
  41 [
  42 .BI \-\-rcfile
  43 .I rcfile
  44 ]
  45 .I mgmt_socket
  46 .br
  47 .SH DESCRIPTION
  48 \fBvdetelweb\fP
  49 implements a tiny telnet server and/or a tiny web server for the remote management
  50 of a VDE2 switch.
  51 .br
  52 .SH OPTIONS
  53 .TP
  54 .B \-w, \-\-web
  55 start the web server. At least one of \fB\-\-web\fP or \fB\-\-telnet\fP \fImust\fP be set.
  56 .TP
  57 .B \-t, \-\-telnet
  58 start the telnet server. At least one of \fB\-\-web\fP or \fB\-\-telnet\fP \fImust\fP be set.
  59 .TP
  60 .B \-n, \-\-nodename \fInodename\fP
  61 specify the nodename as seen from remote connections (e.g. in the command prompt or
  62 in the web page title). uname nodename is used when this option is not specified.
  63 .TP
  64 .B \-d, \-\-daemon
  65 run as a daemon, using syslog for logging.
  66 .TP
  67 .B \-f, \-\-rcfile \fIrcfile\fP
  68 rc file to set the initial switch configuration.
  69 When not specified, vdetelweb searches for \fI~/.vde/vdetelwebrc\fP and
  70 \fI/etc/vde/vdetelwebrc\fP. At leas one rc file must exist and be readable.
  71 .TP
  72 .B \-h, \-\-help
  73 print help. please use it for a more complete list of options.
  74 .TP
  75 .B \fImgmt_socket\fP
  76 is the managemnt socket used to communicate with the vde_switch.
  77 (This option must match the path used in the -M option for the vde_switch).
  78 .SH NOTICE
  79 Virtual Distributed Ethernet is not related in any way with
  80 www.vde.com ("Verband der Elektrotechnik, Elektronik und Informationstechnik"
  81 i.e. the German "Association for Electrical, Electronic & Information
  82 Technologies").
  83
  84 .SH SEE ALSO
  85 .BR vde_switch (1),
  86 .BR vde_plug (1),
  87 .BR vdeq (1).
  88 .BR dpipe (1).
  89 .BR unixterm (1).
  90 .br
  91 .SH AUTHOR
  92 VDE is a project by Renzo Davoli <renzo@cs.unibo.it>