Browse Source

Add blank line after ALL section headers.

master
Svend Sorensen 20 years ago
parent
commit
b4130b849b
1 changed files with 33 additions and 0 deletions
  1. +33
    -0
      docs/formats

+ 33
- 0
docs/formats View File

@@ -34,6 +34,7 @@ Keywords


REM REM
~~~ ~~~

All lines beginning with ``REM`` are considered comments. ``REM`` is All lines beginning with ``REM`` are considered comments. ``REM`` is
considered a keyword, and lines beginning with this keyword are ignored. considered a keyword, and lines beginning with this keyword are ignored.


@@ -42,6 +43,7 @@ considered a keyword, and lines beginning with this keyword are ignored.


CATALOG CATALOG
~~~~~~~ ~~~~~~~

Sets the catalog number of the CD. The ``catalog_number`` must be exactly 13 Sets the catalog number of the CD. The ``catalog_number`` must be exactly 13
digits. digits.


@@ -50,6 +52,7 @@ digits.


FILE FILE
~~~~ ~~~~

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, AIFF, WAVE, section. Allowable ``file_format`` entries are BINARY, MOTOROLA, AIFF, WAVE,
or MP3. or MP3.
@@ -59,6 +62,7 @@ or MP3.


TRACK TRACK
~~~~~ ~~~~~

Starts a new track. ``track_number`` must be a positive integer. Allowable Starts a new track. ``track_number`` must be a positive integer. Allowable
``track_mode`` entries are MODE1/2048, MODE1/2352, MODE2/2336, MODE2/2048, ``track_mode`` entries are MODE1/2048, MODE1/2352, MODE2/2336, MODE2/2048,
MODE2/2324, MODE2/2336, or MODE2/2352. MODE2/2324, MODE2/2336, or MODE2/2352.
@@ -68,6 +72,7 @@ MODE2/2324, MODE2/2336, or MODE2/2352.


FLAGS FLAGS
~~~~~ ~~~~~

Sets track flags. Allowable ``flag`` entries are PRE, DCP, 4CH, and SCMS. Sets track flags. Allowable ``flag`` entries are PRE, DCP, 4CH, and SCMS.


:Section(s): track :Section(s): track
@@ -75,6 +80,7 @@ Sets track flags. Allowable ``flag`` entries are PRE, DCP, 4CH, and SCMS.


ISRC ISRC
~~~~ ~~~~

Sets track ISRC number. ``ISRC_number`` must be of the format CCOOOOYYSSSSS. Sets track ISRC number. ``ISRC_number`` must be of the format CCOOOOYYSSSSS.


:Section(s): track :Section(s): track
@@ -82,6 +88,7 @@ Sets track ISRC number. ``ISRC_number`` must be of the format CCOOOOYYSSSSS.


PREGAP PREGAP
~~~~~~ ~~~~~~

Sets track pregap. ``pregap`` must be in MSF format. Sets track pregap. ``pregap`` must be in MSF format.


:Section(s): track :Section(s): track
@@ -89,6 +96,7 @@ Sets track pregap. ``pregap`` must be in MSF format.


INDEX INDEX
~~~~~ ~~~~~

Sets a track index. ``index_number`` must be a non-negative integer. Sets a track index. ``index_number`` must be a non-negative integer.
``index`` must be in MSF format. ``index`` must be in MSF format.


@@ -97,6 +105,7 @@ Sets a track index. ``index_number`` must be a non-negative integer.


(CD-TEXT keywords) (CD-TEXT keywords)
~~~~~~~~~~~~~~~~~~ ~~~~~~~~~~~~~~~~~~

See `CD-TEXT`_ section. See `CD-TEXT`_ section.


Section(s): any Section(s): any
@@ -119,6 +128,7 @@ Keywords


CATALOG CATALOG
~~~~~~~ ~~~~~~~

Sets the catalog number of the CD. ``catalog_number`` must be exactly 13 Sets the catalog number of the CD. ``catalog_number`` must be exactly 13
digits. digits.


@@ -127,6 +137,7 @@ digits.


CD_DA CD_DA
~~~~~ ~~~~~

Sets the CD format to audio. Sets the CD format to audio.


:Section(s): global :Section(s): global
@@ -134,6 +145,7 @@ Sets the CD format to audio.


CD_ROM CD_ROM
~~~~~~ ~~~~~~

Sets the CD format to data. Sets the CD format to data.


:Section(s): global :Section(s): global
@@ -141,6 +153,7 @@ Sets the CD format to data.


CD_ROM_XA CD_ROM_XA
~~~~~~~~~ ~~~~~~~~~

Sets the CD format to mixed. Sets the CD format to mixed.


:Section(s): global :Section(s): global
@@ -149,11 +162,13 @@ Sets the CD format to mixed.
TRACK TRACK
~~~~~ ~~~~~



:Section(s): track :Section(s): track
:Format: TRACK <track_mode> [sub_channel_mode] :Format: TRACK <track_mode> [sub_channel_mode]


NO NO
~~ ~~

Negates (clears) track flags. Allowable flags are ``COPY`` and Negates (clears) track flags. Allowable flags are ``COPY`` and
``PRE_EMPHASIS``. ``PRE_EMPHASIS``.


@@ -162,6 +177,7 @@ Negates (clears) track flags. Allowable flags are ``COPY`` and


COPY COPY
~~~~ ~~~~

Sets the copy permitted flag. Sets the copy permitted flag.


:Section(s): track :Section(s): track
@@ -169,6 +185,7 @@ Sets the copy permitted flag.


PRE_EMPHASIS PRE_EMPHASIS
~~~~~~~~~~~~ ~~~~~~~~~~~~

Sets the pre-emphasis flag. Sets the pre-emphasis flag.


:Section(s): track :Section(s): track
@@ -176,6 +193,7 @@ Sets the pre-emphasis flag.


TWO_CHANNEL_AUDIO TWO_CHANNEL_AUDIO
~~~~~~~~~~~~~~~~~ ~~~~~~~~~~~~~~~~~

Sets the two channel audio flag. Sets the two channel audio flag.


:Section(s): track :Section(s): track
@@ -183,6 +201,7 @@ Sets the two channel audio flag.


FOUR_CHANNEL_AUDIO FOUR_CHANNEL_AUDIO
~~~~~~~~~~~~~~~~~~ ~~~~~~~~~~~~~~~~~~

Sets the four channel audio flag. Sets the four channel audio flag.


:Section(s): track :Section(s): track
@@ -190,6 +209,7 @@ Sets the four channel audio flag.


ISRC ISRC
~~~~ ~~~~

Sets track ISRC number. ``ISRC_number`` must be of the format CCOOOOYYSSSSS. Sets track ISRC number. ``ISRC_number`` must be of the format CCOOOOYYSSSSS.


:Section(s): track :Section(s): track
@@ -197,18 +217,21 @@ Sets track ISRC number. ``ISRC_number`` must be of the format CCOOOOYYSSSSS.


SILENCE SILENCE
~~~~~~~ ~~~~~~~

*TODO* *TODO*


:Section(s): track :Section(s): track


ZERO ZERO
~~~~ ~~~~

*TODO* *TODO*


:Section(s): track :Section(s): track


FILE FILE
~~~~ ~~~~

Add file to current track. ``start`` and ``length`` must be in MSF format. Add file to current track. ``start`` and ``length`` must be in MSF format.


:Section(s): track :Section(s): track
@@ -216,6 +239,7 @@ Add file to current track. ``start`` and ``length`` must be in MSF format.


AUDIOFILE AUDIOFILE
~~~~~~~~~ ~~~~~~~~~

Add file to current track. ``start`` and ``length`` must be in MSF format. Add file to current track. ``start`` and ``length`` must be in MSF format.


:Section(s): track :Section(s): track
@@ -223,12 +247,14 @@ Add file to current track. ``start`` and ``length`` must be in MSF format.


DATAFILE DATAFILE
~~~~~~~~ ~~~~~~~~

TODO TODO


:Section(s): track :Section(s): track


FIFO FIFO
~~~~ ~~~~

TODO TODO


:Section(s): track :Section(s): track
@@ -236,11 +262,13 @@ TODO
START START
~~~~~ ~~~~~



:Section(s): track :Section(s): track
:Format: ``START <start>`` :Format: ``START <start>``


PREGAP PREGAP
~~~~~~ ~~~~~~

Sets track pregap. ``pregap`` must be in MSF format. Sets track pregap. ``pregap`` must be in MSF format.


Section(s): track Section(s): track
@@ -248,6 +276,7 @@ Format: ``PREGAP <pregap>``


INDEX INDEX
~~~~~ ~~~~~

Sets a track index. ``index_number`` must be a non-negative integer. Sets a track index. ``index_number`` must be a non-negative integer.
``index_time`` must be in MSF format. ``index_time`` must be in MSF format.


@@ -256,6 +285,7 @@ Sets a track index. ``index_number`` must be a non-negative integer.


CD_TEXT CD_TEXT
~~~~~~~ ~~~~~~~

Begins a CD-TEXT block. Begins a CD-TEXT block.


:Section(s): any :Section(s): any
@@ -263,6 +293,7 @@ Begins a CD-TEXT block.


LANGUAGE_MAP LANGUAGE_MAP
~~~~~~~~~~~~ ~~~~~~~~~~~~

Begins a language map block. Begins a language map block.


Section(s): global Section(s): global
@@ -271,6 +302,7 @@ Format: ``LANGUAGE_MAP {}``


LANGUAGE LANGUAGE
~~~~~~~~ ~~~~~~~~

Begins a language block. Begins a language block.


:Section(s): track :Section(s): track
@@ -279,6 +311,7 @@ Begins a language block.


(CD-TEXT keywords) (CD-TEXT keywords)
~~~~~~~~~~~~~~~~~~ ~~~~~~~~~~~~~~~~~~

See `CD-TEXT`_ section. See `CD-TEXT`_ section.


:Section(s): any :Section(s): any


Loading…
Cancel
Save