CABMAN: add support for optional files (they are listed in the reactos.dff, but may...
[reactos.git] / reactos / tools / cabman / dff.txt
1 Directive File Format for ReactOS Cabinet Manager
2 -------------------------------------------------
3
4 Directives begin with a period ("."), and are followed by a command
5 name, and possibly blank delimited arguments. Commands and variable names are
6 case insensitive.
7
8 Syntax Description
9 -------------------------------------------------------------------------------
10 ; Anything on a line after this is a comment
11 <filename> [destination] [options] File copy command (options: o=optional)
12 .Define variable=[value] Define variable to be equal to value (*)
13 .Delete variable Delete a variable definition (*)
14 .New Disk|Cabinet|Folder Start a new disk, cabinet or folder (* -- new disk will work)
15 .Set variable=[value] Set variable to be equal to value (*)
16 %variable% Substitute value of variable (*)
17 <blank line> Blank lines are ignored
18 -------------------------------------------------------------------------------
19
20
21 Standard variable Description
22 -------------------------------------------------------------------------------
23 Cabinet=ON|OFF Turns cabinet mode on or off (* -- currently always on)
24 CabinetFileCountThreshold=count Threshold count of files per cabinet (*)
25 CabinetNamen=filename Cabinet file name for cabinet number n
26 CabinetNameTemplate=template Cabinet file name template
27 * is replaced by cabinet number
28 Compress=ON|OFF Turns compression on or off (* -- currently always on)
29 CompressionType=NONE|MSZIP Compression engine to use (* -- currently always mszip)
30 DiskLabeln=label Printed disk label name for disk n
31 DiskLabelTemplate=template Printed disk label name template
32 * is replaced by disk number
33 FolderFileCountThreshold=count Threshold count of files per folder (*)
34 FolderSizeThreshold=size Threshold folder size for current folder (*)
35 MaxDiskFileCount=count Maximum count of files per disk (*)
36 MaxDiskSize[n]=size Maximum disk size (for disk n)
37 ReservePerCabinetSize=size Amount of space to reserve in each cabinet (*)
38 ReservePerDataBlockSize=size Amount of space to reserve in each data block (*)
39 ReservePerFolderSize=size Amount of space to reserve in each folder (*)
40 SourceDir=path Default path for source files (*)
41 -------------------------------------------------------------------------------
42 (*) = not implemented
43
44
45 MaxDiskSize
46 -----------
47 0 means disk size is unlimited. Standard sizes available are:
48
49 2.88M
50 1.44M
51 1.25M
52 1.2M
53 720K
54 360K
55 CDROM