source: project/wiki/Metafile reference @ 15382

Last change on this file since 15382 was 15324, checked in by felix winkelmann, 11 years ago

fixes

File size: 3.7 KB
Line 
1== Metafile reference
2
3The {{.meta}} file describes properties of a downloadable extension
4(see [[eggs tutorial]] for an explanation of extensions and meta files).
5
6The following properties are supported:
7
8 (synopsis STRING)
9
10A short description of the extension (required).
11
12 (author STRING)
13
14The author, optionally with an e-mail address, if desired (required).
15
16  (maintainer STRING)
17
18The maintainer, if not identical to the author.
19
20 (files STRING ...)
21
22The names of all files that should be contained in the egg (required).
23
24 (license STRING)
25
26The license under which the code is released. Please make sure you
27use the proper license if you package code written by others (required).  Read [[eggs licencing]] for details on how to format this string!
28
29 (category SYMBOL)
30
31A category under which the egg should be listed on the egg-index
32page at
33[[http://www.call-with-current-continuation.org/eggs/index.html]]
34(required).
35
36Currently the set of categories is fixed, use one of:
37
38    code-generation:  Code generation
39    crypt:            Cryptography
40    data:             Algorithms and data-structures
41    db:               Databases
42    debugging:        Debugging tools
43    doc-tools:        Documentation tools
44    egg-tools:        Egg tools
45    ffi:              Interfacing to other languages
46    graphics:         Graphics
47    io:               Input/Output
48    lang-exts:        Language extensions
49    logic:            Logic programming
50    macros:           Macros and meta-syntax
51    math:             Mathematical libraries
52    misc:             Miscellaneous
53    net:              Networking
54    oop:              Object-oriented programming
55    os:               OS interface
56    parsing:          Data formats and parsing
57    sound:            Sound related stuff
58    testing:          Unit-testing
59    tools:            Command line tools
60    ui:               User interface toolkits
61    web:              Web programming
62    xml:              XML processing
63
64
65 (needs EXTENSION-ID ...)
66
67Any extensions needed to build and use this extension. This should
68normally be the raw extension-identifier, the same that you would use in a
69{{require-extension}} form. Alternatively, {{EXTENSION-ID}} may be an
70arbitrary Scheme expression that is evaluated and should return a list of
71extension-ids. This is intended to test the executing system for particular
72platform- or installation-specific features before computing a set of
73required extensions to be available before the installation of the original
74extension commences.
75
76 (depends EXT ...)
77
78Similar to {{needs}}, but {{EXT}} may also be of the form {{(EXTENSIONNAME VERSION)}}
79to specify a particular version of an extension this extension depends on.
80
81 (test-depends EXT ...)
82
83Specifies dependencies that are required to run the included test-suite.
84
85 (doc-from-wiki)
86
87Marks this extension as having a documentation page in the
88associated CHICKEN wiki at [[http://chicken.wiki.br]].
89
90 (eggdoc FILENAME)
91
92Marks this extension as having a documentation page in
93[[eggdoc]] format. The eggdoc file should exist in the extension directory
94and will be executed when the egg is packaged.
95
96 (hidden)
97
98Marks this extension as being "hidden", that is: it is available
99for download and the documentation page is generated, but it will
100not appear in the official list (mainly intended for preliminary
101eggs and testing).
102
103 (platform ID ...)
104
105Identifies the platforms where this extension can be used. {{ID ...}}
106should be one or more ''feature ID''s, i.e. symbols returned by
107{{build-platform}}, {{software-version}}, {{software-type}},
108{{machine-type}} and {{machine-byte-order}}. If a particular type of
109feature ID is not given, it implies that this egg is portable across
110all platforms that are described by this type.
Note: See TracBrowser for help on using the repository browser.