Annotation of multiplexer/en300468ts.1.src, revision 1.1

1.1     ! oskar       1: .\" Man page for en300468ts
        !             2: .\"
        !             3: .\" Copyright (C) GPL 2004..2005, Oskar Schirmer
        !             4: .\"
        !             5: .TH en300468ts 1 "2006-02-01" "1.1.0" "Multiplexer"
        !             6: .SH NAME
        !             7: en300468ts \- SI table generator (EN 300468) for transport streams
        !             8: .SH SYNOPSIS
        !             9: en300468ts [CONFIGURATION...]
        !            10: .SH DESCRIPTION
        !            11: Generates SI tables according to EN 300468 from a set of given tables.
        !            12: The result is sent to \fIstdout\fR.
        !            13: All arguments are treated as filenames,
        !            14: which are supposed to denote configuration files.
        !            15: The special filename \fI-\fR stands for \fIstdin\fR.
        !            16: Each of these files is read line by line, each line refers
        !            17: to one table and must have one of the following two forms:
        !            18: .TP
        !            19: .BI S\  pid\ tableid\ frequency\ file
        !            20: The \fIfile\fR is opened and read, it shall contain the table
        !            21: contents in simple ascii.
        !            22: This table shall be reproduced every \fIfrequency\fR msecs,
        !            23: the tableid is \fItableid\fR, the pid is \fIpid\fR.
        !            24: If a table with this \fItableid\fR and \fIpid\fR existed before,
        !            25: it is purged first.
        !            26: If \fIfrequency\fR is \fB0\fR,
        !            27: the table is output only once and not repeated
        !            28: .TP
        !            29: .BI -\  pid\ tableid
        !            30: The corresponding table will be deleted from the list
        !            31: of tables to generate
        !            32: .P
        !            33: While the primary configuration files are line oriented,
        !            34: the table description files are not. They are composed of
        !            35: a sequence of tokens, which directly depends from the type
        !            36: of the table. See the sections \fBTOKENS\fR and \fBTABLES\fR
        !            37: for details.
        !            38: .SH EXAMPLE
        !            39: The output of \fIen300468ts\fR shall be piped to
        !            40: \fIiso13818ts\fR:
        !            41: .IP
        !            42: $ mkfifo table_pipe
        !            43: .br
        !            44: $ en300468ts en.conf > table-pipe &
        !            45: .br
        !            46: $ iso13818ts -B --ts table-pipe --si = 0x10 0x1F > /dev/xvdb1
        !            47: .br
        !            48: \&...
        !            49: .PP
        !            50: The example refers to the configuration file \fBen.conf\fR:
        !            51: .IP
        !            52: S 0x10 0x40 1000 /tmp/nit
        !            53: .br
        !            54: S 0x13 0x71 1500 /tmp/rst
        !            55: .PP
        !            56: This in turn refers to two table description files (the
        !            57: examples do not show useful values),
        !            58: one is \fBnit\fR:
        !            59: .IP
        !            60: 4711
        !            61: .br
        !            62: 1
        !            63: .br
        !            64:   0x40 "Glotz-NET"
        !            65: .br
        !            66: 1
        !            67: .br
        !            68:   0x0815
        !            69: .br
        !            70:   4710
        !            71: .br
        !            72:   0
        !            73: .PP
        !            74: The other table description file is \fBrst\fR:
        !            75: .IP
        !            76: 2
        !            77: .br
        !            78:   2342 991 1 42 1
        !            79: .br
        !            80:   4711 992 3 56 1
        !            81: .PP
        !            82: The example will produce a \fBnit\fR table once a second
        !            83: and an \fBrst\fR table once in one and a half second.
        !            84: .SH TOKENS
        !            85: The table descriptor files are made up of the following tokens:
        !            86: .TP
        !            87: .B number
        !            88: Whereever numerical values are needed, these are given as numbers,
        !            89: decimal or hexadecimal or octal according to the preference of the
        !            90: user.
        !            91: .TP
        !            92: \fB"string"\fR
        !            93: Whereever character strings are needed, these are given in
        !            94: double quotes, with double quotes escaped by double quotes, so:
        !            95: \fI"this "" is my quote"\fR.
        !            96: .TP
        !            97: .B DESCRIPTORS
        !            98: When a list of descriptors is expected, first the number of
        !            99: descriptors to follow is to be given (not the number of bytes!).
        !           100: Then the descriptors follow one by one, see section \fIDESCRIPTORS\fR
        !           101: for details.
        !           102: .TP
        !           103: .BR LOOP( ... )
        !           104: Parts of a table may be repeated. The number of repeatitions
        !           105: is given first, then the contents of the loop is given as often
        !           106: as it was denoted first.
        !           107: .TP
        !           108: .B YYYY/MM/DD HH:MM:SS
        !           109: When date and time information is needed, this is given
        !           110: in exactly the following form: \fIYYYY/MM/DD HH:MM:SS\fR,
        !           111: 19 characters, the slashes, colons and blank exactly as given here,
        !           112: e.g.: \fI2006/01/31 20:54:56\fR.
        !           113: .SH TABLES
        !           114: The syntax of the single table types is given next, with
        !           115: valid pid and tableid given in parantheses:
        !           116: .TP
        !           117: INCLUDE-TABLE
        !           118: .BR
        !           119: .P
        !           120: Note, that the \fBTDT\fR table is empty and thus may
        !           121: be represented by the empty file \fB/dev/null\fR.
        !           122: .SH DESCRIPTORS
        !           123: Descriptors are made up of tokens like tables are, where an
        !           124: additional descriptor tag is preceeding.
        !           125: .TP
        !           126: INCLUDE-DESCR
        !           127: .BR
        !           128: .P
        !           129: .SH NOTES
        !           130: Someone said, the option \fI--nit\fR might be useful at \fBiso13818ts\fR,
        !           131: when it is about DVB-T.
        !           132: .SH "SEE ALSO"
        !           133: .BR iso13818ts (1),
        !           134: .BR ISO\ 13818-1 ,
        !           135: .BR ETSI\ EN\ 300\ 468 .
        !           136: .SH AUTHOR
        !           137: Oskar Schirmer (schirmer@scara.com).

LinuxTV legacy CVS <linuxtv.org/cvs>