Subversion Repositories SvarDOS

Rev

Rev 687 | Rev 711 | Go to most recent revision | Show entire file | Ignore whitespace | Details | Blame | Last modification | View Log | RSS feed

Rev 687 Rev 689
Line 9... Line 9...
9
Packages names must follow some basic rules. They shall be max. 8 letters long
9
Packages names must follow some basic rules. They shall be max. 8 letters long
10
(but should not be too short either, since a 1 or 2-letters package name might
10
(but should not be too short either, since a 1 or 2-letters package name might
11
be confusing), and must not be composed of characters other than a-b, 0-9 and
11
be confusing), and must not be composed of characters other than a-b, 0-9 and
12
'_'. This for backward compatibility with short file names (8+3) and ISO 9660
12
'_'. This for backward compatibility with short file names (8+3) and ISO 9660
13
file systems (used on CDROMs). The package filename is always followed by the
13
file systems (used on CDROMs). The package filename is always followed by the
14
.ZIP extension.
14
.SVP ("SvarDOS Package") extension.
15
 
15
 
16
 
16
 
17
%hPackage files
17
%hPackage files
18
 
18
 
19
SvarDOS uses ZIP files as its package file format. This format has been chosen
19
SvarDOS uses ZIP files as its package file format. This format has been chosen
Line 22... Line 22...
22
supported, and in the public domain.
22
supported, and in the public domain.
23
 
23
 
24
Here below is the recommended command line that can be used to create a
24
Here below is the recommended command line that can be used to create a
25
package for a program named EXAMPLE using info-zip:
25
package for a program named EXAMPLE using info-zip:
26
 
26
 
27
  zip -9rkDX EXAMPLE.ZIP subdir1 subdir2 ... subdirN
27
  zip -9rkDX EXAMPLE.SVN subdir1 subdir2 ... subdirN
28
 
28
 
29
If you are using 7za to create your packages, then use this:
29
If you are using 7za to create your packages, then use this:
30
 
30
 
31
  7za a -mm=deflate -mx=9 -tzip EXAMPLE.ZIP subdir1 subdir2 ... subdirN
31
  7za a -mm=deflate -mx=9 -tzip EXAMPLE.SVN subdir1 subdir2 ... subdirN
32
 
32
 
33
 
33
 
34
%hPackage directory structure
34
%hPackage directory structure
35
 
35
 
36
The directory structure of a package depends on the type of packages.
36
The directory structure of a package depends on the type of packages.
Line 39... Line 39...
39
  APPINFO            Put the program's LSM file here
39
  APPINFO            Put the program's LSM file here
40
  BIN                Binaries, such as exe and com files
40
  BIN                Binaries, such as exe and com files
41
  DOC\PKGNAME        Package documentation
41
  DOC\PKGNAME        Package documentation
42
  HELP               Used ONLY by the "help" package
42
  HELP               Used ONLY by the "help" package
43
  NLS\PKGNAME        Localizations (NLS language files) of the package
43
  NLS\PKGNAME        Localizations (NLS language files) of the package
44
  SOURCE\PKGNAME     The source code (optional)
-
 
45
 
44
 
46
Non-core packages use a slightly different directory organization. For
45
Non-core packages use a slightly different directory organization. For
47
example, if we were to consider a package FOO, we might end up with the
46
example, if we were to consider a package FOO, we might end up with the
48
following structure:
47
following structure:
49
 
48
 
50
  APPINFO\FOO.LSM    Package meta file for the FOO program
49
  APPINFO\FOO.LSM    Package meta file for the FOO program
51
  PROGS\FOO\FOO.EXE  The program's executable
50
  PROGS\FOO\FOO.EXE  The program's executable
52
  PROGS\FOO\FOO.TXT  Some documentation
51
  PROGS\FOO\FOO.TXT  Some documentation
53
  PROGS\FOO\FILE.DAT Data file used by the FOO program
52
  PROGS\FOO\FILE.DAT Data file used by the FOO program
54
  SOURCE\FOO\*       here would be stored the foo's source code (optional)
-
 
55
 
53
 
56
Note the PROGS directory above. This is the category to which the package
54
Note the PROGS directory above. This is the category to which the package
57
belongs. The package installer might change this directory at install time,
55
belongs. The package installer might change this directory at install time,
58
depending on the user's preferences. Possible categories are listed below:
56
depending on the user's preferences. Possible categories are listed below:
59
 
57
 
Line 106... Line 104...
106
FDISK 1.54      <- originally packaged version
104
FDISK 1.54      <- originally packaged version
107
FDISK 1.54+1    <- package has been changed, but not the upstream version
105
FDISK 1.54+1    <- package has been changed, but not the upstream version
108
FDISK 1.55      <- upstream version increased, so SvarDOS rev restarts
106
FDISK 1.55      <- upstream version increased, so SvarDOS rev restarts
109
FDISK 1.55+1    <- new version of the package, but still contains FDISK 1.55
107
FDISK 1.55+1    <- new version of the package, but still contains FDISK 1.55
110
FDISK 1.55+2    <- another new version of the package, etc
108
FDISK 1.55+2    <- another new version of the package, etc
-
 
109
 
-
 
110
The entire version string of a package must never exceed 16 characters.
-
 
111
 
-
 
112
 
-
 
113
%hSources
-
 
114
 
-
 
115
When a packaged software has its sources available, then it is recommended to
-
 
116
archive also them. To that effect, put the sources into a ZIP archive that has
-
 
117
the same filename as the package, but a *.ZIP extension (as opposed to the
-
 
118
*.SVP extension of the proper package). The result would be that the packaged
-
 
119
software would be distributed within two files. Example for FDISK:
-
 
120
 
-
 
121
FDISK.SVP       <- binaries (ZIP archive following the SVP structure)
-
 
122
FDISK.ZIP       <- sources (flat, unstructured ZIP archive)
-
 
123
 
-
 
124
The ZIP file must obviously contain the source code that belongs to the exact
-
 
125
same version present in the SVP package.