run.xml 5.56 KB
Newer Older
Clément Stenac's avatar
Clément Stenac committed
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321
<?xml version="1.0" encoding="iso8859-1"?>
<chapter id="run"><title id="trun">
Running VLS


</title>

<sect1><title>Launching VLS</title>

<para>
If you want to use the telnet interface, running
VLS is very easy: just type <command>vls</command> in a shell
console, and that's all. Running <command>vlsd</command> will
start VLS as a daemon and will detach itself from the launching
shell. Remember that VLS will try to load its configuration file
(<filename>vls.cfg</filename>) from the current directory, and if
there is no <filename>vls.cfg</filename> there, it will try to load it
from <filename>SYSCONF_DIR/etc/videolan</filename> (see section <xref linkend="config" endterm="tconfig"/>)


.</para>

<caution><para>
If your log file is <filename>vls.log</filename> as
in the example, VLS will need write access in the current directory, or
you will see something like


:</para>

<screen><computeroutput>
*** Exception *** in copy constructor (0xbffffc98, copy of 0x80e30a8)
Unable to open the log file "vls.log": Error: Could not open file 'vls.log':
Permission denied
</computeroutput></screen>

<para>
Remember also that you must be root when using the
"Interface" option in <filename>vls.cfg</filename>


.</para>

</caution>

<para>

If everything is right, you will see something like


:</para>

<screen><computeroutput>
VideoLAN Server v 0.5.3 (Jun  6 2003) - (c)1999-2003 VideoLAN
2002-03-09 17:24:51 [INFO/Vls]  Module "channel:file" registered
2002-03-09 17:24:51 [INFO/Vls]  Module "channel:network" registered
2002-03-09 17:24:51 [INFO/Vls]  Module "mpegreader:file" registered
2002-03-09 17:24:51 [INFO/Vls]  Module "mpegconverter:ts2ts" registered
[...]
</computeroutput></screen>

<para>
What you can see on the screen (stderr) is exactly
what goes in the log file <filename>vls.log</filename>


.</para>

<para>
When VLS has been successfully started, it doesn't
take any command from its standard input, so you can put it into
background (you can use the <emphasis>screen</emphasis> utility to do
that)


.</para>

<para>
On the other hand, if you want to
use the command line interface, please see the <ulink url="http://www.videolan.org/doc/">VideoLAN HOWTO</ulink>


.</para>

</sect1>

<sect1><title>
Using the telnet interface


</title>

<para>
After VLS has been launched, it opens a telnet
server (on the port 9999 by default). You can connect to this server
with the following command


:</para>

<screen>
<prompt>% </prompt><userinput>telnet localhost 9999</userinput>
</screen>

<para>
You should see something like


:</para>

<screen><computeroutput>
Trying 127.0.0.1...
Connected to vls.
Escape character is '^]'.

Videolan Server Administration System

Login:
</computeroutput></screen>

<para>
Then you must authenticate with a login/password
pair defined in <filename>vls.cfg</filename>. When you have been
successfully authenticated, you should see a prompt like


:</para>


<screen><computeroutput>
admin@vls&gt;
</computeroutput>&gt;</screen>

<para>
Then you can type some commands, which are explained
in the next paragraph. To log out, type <command>logout</command> after
the telnet prompt


.</para>

</sect1>

<sect1><title>
Interface commands


</title>

<simplesect><title>help</title>

<para>
Usage: help [command]


.</para>

<para>
Called with no argument, "help" gives the list of
all the commands (available or not). Called with one argument it gives
details about how to use the specified command


.</para>

</simplesect>

<simplesect><title>browse</title>

<para>
Usage: browse [input]


.</para>

<para>
Called without argument, "browse" gives all programs
of inputs. Called with one argument it only gives the programs of the
specified input. Each program is given with its status


.</para>

</simplesect>

<simplesect><title>start</title>

<para>

Usage: start &lt;program&gt; &lt;channel&gt; &lt;input&gt; [--loop] [--rtp]



</para>

<para>
"start" launches the specified program of the
specified input and broadcasts it through the specified channel. The
option "--loop" makes the program being repeated indefinitely. The
option "--rtp" makes the TS packet to be send through the RTP protocol,
as defined in RFC 1889 and RFC 2250


.</para>

</simplesect>

<simplesect><title>stop</title>
<para>
Usage: stop &lt;channel&gt;


</para>
<para>
"stop" ends the broadcast of the specified channel


.</para>
</simplesect>

<simplesect><title>forward</title>

<para>
Usage: forward &lt;channel&gt; &lt;speed&gt;


</para>

<para>
"forward" forwards the channel with the given speed.
This does not work when reading directly from a device such as an MPEG
encoding card, a DVB card or an acquisition card


.</para>

</simplesect>

<simplesect><title>rewind</title>

<para>
Usage: rewind &lt;channel&gt; &lt;speed&gt;


</para>
<para>
"rewind" rewinds the channel with the given
speed. This does not work when reading directly from a device such as an
MPEG encoding card, a DVB card or an acquisition card


.</para>
</simplesect>

<simplesect><title>suspend</title>

<para>
Usage: suspend &lt;channel&gt;

</para>
<para>
"suspend" suspends the streaming of the specified
channel


.</para>

</simplesect>

<simplesect><title>resume</title>

<para>
Usage: resume &lt;channel&gt;


</para>

<para>
"resume" resumes the streaming of the specified
channel


.</para>

</simplesect>

<simplesect><title>logout</title>

<para>
Usage: logout


</para>

<para>
"logout" closes the current administration session
and the remote connection


.</para>

</simplesect>

<simplesect><title>shutdown</title>

<para>
Usage: shutdown


</para>

<para>
"shutdown" stops all the programs and shutdowns VLS


.</para>

</simplesect>

</sect1>
</chapter>