Restructured keyword sections.
Made quotations optional for strings.
This commit is contained in:
75
docs/formats
75
docs/formats
@@ -23,6 +23,9 @@ in the global section or a track section.
|
|||||||
Format Notation
|
Format Notation
|
||||||
---------------
|
---------------
|
||||||
|
|
||||||
|
A string may be enclosed in single or double quotation marks. If the string
|
||||||
|
contains whitespace, it must be enclosed in quotation marks.
|
||||||
|
|
||||||
``<field>``
|
``<field>``
|
||||||
a required field
|
a required field
|
||||||
``[field]``
|
``[field]``
|
||||||
@@ -41,83 +44,109 @@ Keywords
|
|||||||
REM
|
REM
|
||||||
~~~
|
~~~
|
||||||
|
|
||||||
|
Begin a comment line. All lines beginning with ``REM`` are ignored.
|
||||||
|
|
||||||
:Section(s): any
|
:Section(s): any
|
||||||
:Format: ``REM [comments]``
|
:Format: ``REM [comments]``
|
||||||
|
|
||||||
Begin a comment line. All lines beginning with ``REM`` are ignored.
|
|
||||||
|
|
||||||
CATALOG
|
CATALOG
|
||||||
~~~~~~~
|
~~~~~~~
|
||||||
|
|
||||||
|
Sets the catalog number of the CD.
|
||||||
|
|
||||||
:Section(s): global
|
:Section(s): global
|
||||||
:Format: ``CATALOG <catalog_number>``
|
:Format: ``CATALOG <catalog_number>``
|
||||||
|
|
||||||
Sets the catalog number of the CD. The ``catalog_number`` is an integer
|
``catalog_number``
|
||||||
consisting of exactly 13 digits.
|
an integer consisting of exactly 13 digits.
|
||||||
|
|
||||||
FILE
|
FILE
|
||||||
~~~~
|
~~~~
|
||||||
|
|
||||||
:Section(s): track
|
|
||||||
:Format: ``FILE "<filename>" [file_format]``
|
|
||||||
|
|
||||||
Sets a new input file. ``FILE`` line precedes the beginning of the track
|
Sets a new input file. ``FILE`` line precedes the beginning of the track
|
||||||
section. Allowable ``file_format`` entries are ``BINARY``, ``MOTOROLA``,
|
section.
|
||||||
``AIFF``, ``WAVE``, or ``MP3``.
|
|
||||||
|
:Section(s): track
|
||||||
|
:Format: ``FILE <filename> [file_format]``
|
||||||
|
|
||||||
|
``filename``
|
||||||
|
a string.
|
||||||
|
``file_format``
|
||||||
|
one of: ``BINARY``, ``MOTOROLA``, ``AIFF``, ``WAVE``, or ``MP3``.
|
||||||
|
|
||||||
TRACK
|
TRACK
|
||||||
~~~~~
|
~~~~~
|
||||||
|
|
||||||
|
Starts a new track.
|
||||||
|
|
||||||
:Section(s): track
|
:Section(s): track
|
||||||
:Format: ``TRACK <track_number> <track_mode>``
|
:Format: ``TRACK <track_number> <track_mode>``
|
||||||
|
|
||||||
Starts a new track. ``track_number`` must be a positive integer in the range
|
``track_number``
|
||||||
1-99. Allowable ``track_mode`` entries are ``MODE1/2048``, ``MODE1/2352``,
|
a positive integer in the range 1-99.
|
||||||
``MODE2/2336``, ``MODE2/2048``, ``MODE2/2324``, ``MODE2/2336``, or
|
``track_mode``
|
||||||
``MODE2/2352``.
|
one of: ``MODE1/2048``, ``MODE1/2352``, ``MODE2/2336``, ``MODE2/2048``,
|
||||||
|
``MODE2/2324``, ``MODE2/2336``, or ``MODE2/2352``.
|
||||||
|
|
||||||
FLAGS
|
FLAGS
|
||||||
~~~~~
|
~~~~~
|
||||||
|
|
||||||
|
Sets track flags.
|
||||||
|
|
||||||
:Section(s): track
|
:Section(s): track
|
||||||
:Format: ``FLAGS [flag]...``
|
:Format: ``FLAGS [flag]...``
|
||||||
|
|
||||||
Sets track flags. Allowable ``flag`` entries are ``PRE``, ``DCP``, ``4CH``,
|
``flag``
|
||||||
and ``SCMS``.
|
one of: ``PRE``, ``DCP``, ``4CH``, or ``SCMS``.
|
||||||
|
|
||||||
ISRC
|
ISRC
|
||||||
~~~~
|
~~~~
|
||||||
|
|
||||||
|
Sets track ISRC number.
|
||||||
|
|
||||||
:Section(s): track
|
:Section(s): track
|
||||||
:Format: ``ISRC <ISRC_number>``
|
:Format: ``ISRC <ISRC_number>``
|
||||||
|
|
||||||
Sets track ISRC number. ``ISRC_number`` must be of the format CCOOOOYYSSSSS.
|
``ISRC_number``
|
||||||
|
a string with the format CCOOOOYYSSSSS.
|
||||||
|
|
||||||
PREGAP
|
PREGAP
|
||||||
~~~~~~
|
~~~~~~
|
||||||
|
|
||||||
|
Sets track pregap.
|
||||||
|
|
||||||
:Section(s): track
|
:Section(s): track
|
||||||
:Format: ``PREGAP <pregap>``
|
:Format: ``PREGAP <pregap>``
|
||||||
|
|
||||||
Sets track pregap. ``pregap`` must be in MSF format.
|
``pregap``
|
||||||
|
time in MSF format.
|
||||||
|
|
||||||
INDEX
|
INDEX
|
||||||
~~~~~
|
~~~~~
|
||||||
|
|
||||||
|
Sets a track index.
|
||||||
|
|
||||||
:Section(s): track
|
:Section(s): track
|
||||||
:Format: ``INDEX <index_number> <index>``
|
:Format: ``INDEX <index_number> <index>``
|
||||||
|
|
||||||
Sets a track index. ``index_number`` must be a non-negative integer in the
|
``index_number``
|
||||||
range 0-99. ``index`` must be in MSF format.
|
an integer in the range 0-99.
|
||||||
|
``index``
|
||||||
|
time in MSF format.
|
||||||
|
|
||||||
(CD-TEXT keywords)
|
(CD-TEXT keywords)
|
||||||
~~~~~~~~~~~~~~~~~~
|
~~~~~~~~~~~~~~~~~~
|
||||||
|
|
||||||
:Section(s): any
|
Sets CD-TEXT data. The cue format does not have native support for binary
|
||||||
:Format: ``<CDTEXT_keyword> "<CDTEXT_field>"``
|
CD-TEXT.
|
||||||
|
|
||||||
See `CD-TEXT`_ section for a list of CD-TEXT keywords. The cue format cannot
|
:Section(s): any
|
||||||
handle binary CD-TEXT.
|
:Format: ``<CDTEXT_keyword> <CDTEXT_field>``
|
||||||
|
|
||||||
|
``CDTEXT_keyword``
|
||||||
|
(see `CD-TEXT`_ section for a list of CD-TEXT keywords)
|
||||||
|
``CDTEXT_keyword``
|
||||||
|
a string.
|
||||||
|
|
||||||
TOC File Format
|
TOC File Format
|
||||||
===============
|
===============
|
||||||
|
|||||||
Reference in New Issue
Block a user