- removed the deprecated HOWTO;

  - INSTALL: clean redundant information with doc;
  - Updated ChangeLog;
  - configure: updated version.
parent 5b5de2ec
......@@ -2,15 +2,20 @@
# ChangeLog for vls #
* New parser using flex/bison
* Added a DVB input
* TS Multiplexer/Demultiplexer
* New libdvbpsi library
* Fixed a minor bug in the manager
* Added a user's documentation
* Improved multicast support
* Cleaned the syntax of the configuration files
* IPv6 support
* New parser using flex/bison.
* Support for files whose size is above 2GB.
* Fixed PS->TS conversion in the Solaris port.
* Added a DVB input.
* TS Multiplexer/Demultiplexer.
* Added libdvbpsi library support.
* Fixed a minor bug in the manager.
* Added a user's documentation.
* Added TTL option to override default multicast TTL of 1.
* Improved multicast support.
* Cleaned the syntax of the configuration files.
* IPv6 support.
Thu, 6 Dec 2001 16:28:42 +0100
HOWTO file for vls, the VideoLAN Server
Note: this HOWTO is deprecated. You should rather build the user's
documentation in the doc directory (see INSTALL to know how to do it)
The VideoLAN Server is composed of "inputs" which provide some
"programs" to be streamed in the TS format through a "channel".
Global and channels configuration is in the "vls.cfg" file. Inputs'
configuration is in some separate files.
The configuration files are divided into sections like this:
BEGIN "<SectionName>"
<SettingName> = "<SettingValue>"
You can add some comments after a '#' which must be outside of the
quotation marks if there are some. Quotation marks are mandatory for
the section's name and the setting's value.
How to configure the vls (vls.cfg) ?
Main settings
The first section is "Vls". You can specify an alternate log file
(default is "vls.cfg") with a "LogFile" setting like this:
LogFile = "<vls-alternate.log>"
The two next sections are used for authentification and permissions.
The are called "Groups" and "Users".
In the first one you can specify which commands are available for
which group. The syntax is :
<GroupName> = "<cmd1>|<cmd2>|..."
List of the commands :
- help
- browse
- start
- resume
- suspend
- stop
- shutdown
- logout
In the second section you can specify users' information. The syntax
is :
<UserName> = "<EncryptedPassword>:<Group>"
Each user belongs to one and only one group.
Administration settings
The two next sections are "Telnet" and "NativeAdmin". For each of them
you can specify a local TCP port to use to accept connections. Telnet's
default port is 9999, NativeAdmin's is 9998. The syntax is :
LocalPort = "<TcpPortToUse>"
How to configure Channels ?
Channels are declared in the vls.cfg section "Channels". The syntax
is :
<ChannelName> = "<ChannelType>"
At the moment the only channel type available is "network".
Channel's settings are defined in a section whose name is the channel's
Network channel
The settings for this kind of channel are :
- "SrcHost" : host used to bind the socket;
- "SrcPort" : TCP port used to bind the socket;
- "DstHost" : host used to connect the socket;
- "DstPort" : TCP port used to connect the socket;
- "Interface" : interface to route the IP packets through.
Hosts could be DNS names or IP addresses.
The "Interface" setting is only supported under Linux. It's mainly
useful when you have multiple interfaces connected to the same network.
You must have super-user permissions to use this option. If not you
won't be able to use the channel.
How to configure Inputs ?
First: Input are declared in the vls.cfg section "Inputs". The syntax
is :
<InputName> = "<InputType>"
At the moment the only input types available are "local" (files/dvd)
and "video" (encoding or DVB card ).
Local input
This kind of input has been designed to read local Mpeg streams (files,
DVDs...) and to broadcast them in the Mpeg2 TS (Transport stream)
To configure a local input you have to specify a path to a
configuration file named "input.cfg" like this :
BEGIN "<InputName>"
ConfigPath = "<Path>"
The config file is "<Path>/input.cfg".
Its syntax is like vls.cfg. The first section is "Input" where you must
set up the "FilesPath" and "PgrmCount" settings. The first one is
the location of files, the second is the number of programs.
BEGIN "Input"
FilesPath = "<PathToFiles>"
ProgramCount = "<N>"
Then you must configure each program in a section whose name is the
program number (from "1" to "PgrmCount"). The syntax is :
BEGIN "<PgrmNumber>"
Name = "Dolby_Game.vob"
<AdditionnalSetting> = "<Value>"
Type = "Mpeg2-PS"
The "Name" setting is the name used to identify the program. The "Type"
setting could be :
- Mpeg1-PS (file) : supported;
- Mpeg2-PS (file) : supported;
- Mpeg2-TS (file) : supported;
- Dvd (device) : supported;
When the program is a file you must add a "FileName" setting. The file
used is "<FilesPath>/<FileName>".
When the program's type is "Dvd" you must add a "Device" setting
("/dev/dvd" for example). The "FilesPath" is _not_ prepended to the
device's name.
The file input.cfg in this tree is a short example.
Video Input
This input has been designed to read Mpeg streams from a Mpeg2 encoder
board, through the Video4Linux device (/dev/video).
At the moment, the only card supported under linux is the Visiontech
encoder based on a Kfir chip. The drivers for linux can be found at:
To configure this input, you have to add the following lines in the
configuration file vls.cfg:
BEGIN "<InputName>"
Device = "<Device>"
Type = "<Type>"
- <Device> is the path of the Video4linux device. If there is no Device
setting, a default path ("/dev/video") is assumed
- <Type> can be "Mpeg2-PS" or "Mpeg2-TS", depending on the encoder board
configuration. The default type is "Mpeg2-PS" (the VideoLAN server
cannot not read TS streams from the Visiontech Kfir board; if you
manage to do that, e-mail us ! ;)
If you do not provide this BEGIN [...] END section, all default values
will be assumed.
Note that the Video Input defines a single program, called "video".
How to use the VideoLAN Server ?
When you connect to the telnet port (9999 is the default) you have to
authentificate yourself (users are configured in vls.cfg). Once done
you can type commands. To have a list of available commands type
"help". "help <command>" gives you details. Be carefull: you may not
have the permission to run some of the commands.
Happy streaming.
......@@ -4,77 +4,13 @@ INSTALL file for vls, the VideoLAN Server
Building the documentation
A user's documentation is available in the doc directory, in the linuxdoc
SGML format.
A user's documentation is available in the doc directory, in the
linuxdoc SGML format.
To build it, you must have the linuxdoc utility (package linuxdox-tools
under Debian). Then go into the doc directory, and type "make html" to
build the documentation. You can also find it on the VideoLAN web site
Configuring the VideoLAN Server
The first step is to create the Makefile thanks to the configure script. For a
basic configuration, juste run:
You can supply several options to configure, to change the installation
directories, for instance. Run ./configure --help to get a list of all options
available. Here is an explanation of vls-specific options:
Specify endianness when cross-compiling. Don't use this option if you
don't know what it means !
Disable debug mode (enabled by default).
Generate extra code to write profile information suitable for the
analysis program gprof.
Disable DVD support (enabled by default). You must supply this option
if you don't have libdvdread installed.
Note: the flag -DBUGGY_VLC changes the behaviour of the server when
the client shutdowns/crashes (like vlc, just a little troll :)
When it's not defined the program is stopped, it goes on otherwise.
Building the VideoLAN Server
Once configured, run `make' to build vls.
Installing and running the VideoLAN Server
run `make install'.
Default files and directories:
- binaries : /usr/local/bin
- plugins : /usr/local/lib/videolan/vls
- configuration file : /usr/local/etc/videolan/vls/vls.cfg
The configuration file is first searched in the current directory or if it
doesn't exist it is searched in /usr/local/etc/videolan/vls.
Edit a vls.cfg file. Read the documentation to know how to configure and
run the server.
Uninstalling the VideoLAN Server
run `make uninstall'.
This documentation tries to be exhaustive. If you find some dark
points in it then don't hesitate to report to the mailing-list.
......@@ -2,7 +2,7 @@
# vls (VideoLAN Server) main Makefile
# (c)1999-2001 VideoLAN
# $Id: Makefile,v 1.89 2002/03/25 01:57:43 asmax Exp $
# $Id: Makefile,v 1.90 2002/04/02 17:26:39 bozo Exp $
......@@ -237,17 +237,17 @@ snapshot:
rm -Rf tmp/vls/tmp
find debian -mindepth 1 -maxdepth 1 -type d | \
while read i ; do rm -Rf tmp/vls/$$i ; done
mkdir -p tmp/vls/doc
# Copy .c .h .in .cpp and files
find src -type f -name '*.[chi]*' | while read i ; \
do cp $$i tmp/vls/$$i ; done
# Copy module Makefiles
find src/modules -type f -name Makefile | while read i ; \
do cp $$i tmp/vls/$$i ; done
# Copy input Makefiles
find src/inputs -type f -name Makefile | while read i ; \
do cp $$i tmp/vls/$$i ; done
# Copy documentation
cp doc/Makefile doc/vls-guide.sgml tmp/vls/doc
# Copy misc files
vls.cfg input.cfg Makefile Makefile.dep Makefile.module \
Makefile.module.dep Makefile.opts.in\
configure configure.in install-sh config.sub config.guess \
......@@ -11,7 +11,8 @@ video streams over any IP network.
Building, Installing and Running VideoLAN
See the INSTALL file for this.
See the INSTALL file to know how to build the documentation and then
read it.
......@@ -59,10 +60,6 @@ The VideoLAN web site at http://www.videolan.org/ is a good start for
information about MPEG and DVD playing. Have a look at the documentation
section, as well as the bookmarks.
You can also try the OpenDVD site at http://www.opendvd.org/ or the
the LiViD project at http://www.linuxvideo.org/. They have lots of
information, too.
The team
......@@ -645,7 +645,7 @@ test "$host_alias" != "$target_alias" &&
......@@ -4,7 +4,7 @@ AC_CONFIG_HEADER(src/core/defs.h)
dnl Main sources default
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment