summaryrefslogtreecommitdiff
path: root/doc/man/en/xine.5
diff options
context:
space:
mode:
Diffstat (limited to 'doc/man/en/xine.5')
-rw-r--r--doc/man/en/xine.587
1 files changed, 63 insertions, 24 deletions
diff --git a/doc/man/en/xine.5 b/doc/man/en/xine.5
index 7a9357640..eba55aef5 100644
--- a/doc/man/en/xine.5
+++ b/doc/man/en/xine.5
@@ -32,60 +32,73 @@ to read from. Valid MRLs may be plain file names or one of the following
.TP
\(bu CD and DVD:
.br
-.BI dvd:/[<device_name>][/<title>.<part>]
+.BI dvd:/[ device_name ][/ title [. part ]]
.br
-.BI dvd:/<DVD_image_file_or_directory>[/<title>.<part>]
+.BI dvd:/ DVD_image_file [/ title [. part ]]
.br
-.BI vcd://[<CD_image>|<device_name>][@[letter]<number>]
+.BI dvd:/ DVD_directory [/ title [. part ]]
.br
-.BI vcdo://<track_number>
+ (use the path of the directory which contains VIDEO_TS)
.br
-.BI cdda:/[<device>][/<track-number>]
+.BI vcd://[ CD_image_or_device_name ][@[ letter ] number ]
+.br
+.BI vcdo:// track_number
+.br
+.BI cdda:/[ device ][/ track_number ]
.LP
.TP
\(bu Video devices:
.br
-.BI v4l://[<tuner_device>/<frequency>]
+.BI v4l://[ tuner_device / frequency ]
+.br
+.BI dvb:// channel_number
+.br
+ (nth channel in your channels.conf)
+.br
+.BI dvb:// channel_name
.br
-.BI dvb://<number_or_channel_name>
+.BI dvbc:// channel_name : tuning_parameters
.br
-.BI dvbc://<channel_name>:<tuning_parameters>
+.BI dvbs:// channel_name : tuning_parameters
.br
-.BI dvbs://<channel_name>:<tuning_parameters>
+.BI dvbt:// channel_name : tuning_parameters
.br
-.BI dvbt://<channel_name>:<tuning_parameters>
+.BI dvba:// channel_name : tuning_parameters
.br
-.BI dvba://<channel_name>:<tuning_parameters>
+.BI pvr:/ tmp_files_path ! saved_files_path ! max_page_age
.br
-.BR pvr:/<tmp_files_path>!<saved_files_path>!<max_page_age> " (for WinTV PVR 250 and 350)"
+ (for WinTV PVR 250 and 350)
.LP
.TP
\(bu Network:
.br
-.BI http://<host>...
+.BI http:// host...
.br
-.BR tcp://<host>[:<port>] " (default port is 7658)"
+.BI tcp:// host [: port ]
.br
-.BR udp://<host>[:<port>[?iface=<interface>]] " (default port is 7658)"
+.BI udp:// host [: port [?iface= interface ]]
.br
-.BR rtp://<host>[:<port>[?iface=<interface>]] " (default port is 7658)"
+.BI rtp:// host [: port [?iface= interface ]]
+.br
+ (default port for tcp, udp and rtp is 7658)
.br
.BI smb://...
.br
-.BI mms://<host>...
+.BI mms:// host...
.br
-.BI pnm://<host>...
+.BI pnm:// host...
.br
-.BR rtsp://<host>... " (requires Real codecs)"
+.BI rtsp:// host... "\fR (requires Real codecs)"
.br
.LP
Additional input plugins will provide additional MRL types. The ones listed
above are available with stock libxine.
\fBNOTE:\fP where a file name is required, the \fIfull path must be
-provided\fP - from a shell, you can use \fB"$PWD/file"\fP or
+provided\fP - from a shell, you can normally use \fB"$PWD/file"\fP or
\fB"$(pwd)/file"\fP or \fB"\`pwd\`/file"\fP if the file is in the current
-directory. (Which one depends on your shell; all three work in bash.)
+directory. (Which one depends on your shell; all three work in bash. Also,
+certain characters need to be encoded.)
As of xine-lib 1.1.3, the DVD title number may be 0 (select navigation) and
the chapter number may be 0 (full title).
@@ -256,6 +269,23 @@ audio program ID
.TP 20
.B service-id
service ID (needed for now/next information etc.)
+.PP
+The following keyboard & mouse inputs may be accepted:
+.TP 24
+.B Menu 2
+Start/stop recording
+.TP 24
+.B Menu 3
+Toggle zoom
+.TP 24
+.B Menu 7
+Toggle now/next display
+.TP 24
+.B Previous/Next Chapter
+Previous/next channel
+.TP 24
+.B Mouse wheel & button 1
+Scroll through channel list & select the highlighted channel
.SH SUBTITLE
.B external subtitle files (any mrl)
.br
@@ -263,7 +293,12 @@ Text subtitle files may be appended to the MRL:.
.TP
.BI <mrl>#subtitle:<subtitlefile>
This is the normal way to define the subtitle file to use. The frontend will
-not take any notice of the subtitle file.
+not take any notice of the subtitle file. For example:
+.br
+.I file://home/user/wibble.mpg#subtitle:/home/user/wibble.sub
+.br
+(Note that some front ends can detect subtitles files where the name differs
+as shown in the example.)
.br
.SH STREAM OPTIONS
.br
@@ -290,6 +325,10 @@ Set audio dynamic range compression.
.BI <config\ entry> : <config\ value>
Assign a new value to any config entry.
.TP
+.BI save: <file>
+Save the stream (if allowed) to the named file, relative to the directory
+given by the option "media.capture.save_dir".
+.TP
.B change configuration option 'on the fly':
.br
You can change a configuration option at any time, using the special
@@ -307,8 +346,8 @@ stream.
.br
The programs are documented fully on the xine home page:
-.UR http://xinehq.de/
-.IR "http://xinehq.de/"
+.UR http://www.xine-project.org/
+.IR "http://www.xine-project.org/"
.UE
.SH AUTHOR
This text was extracted from the xine man page by Darren Salt