Changeset 35833 in project


Ignore:
Timestamp:
07/10/18 01:01:42 (6 weeks ago)
Author:
evhan
Message:

man/5: Indent egg property tags so they're boxed and highlighted

File:
1 edited

Legend:

Unmodified
Added
Removed
  • wiki/man/5/Egg specification format

    r35832 r35833  
    1717==== version
    1818
    19 [egg property] (version STRING)
     19 [egg property] (version STRING)
    2020
    2121Specifies version string for this egg. {{STRING}} should have
     
    3030==== synopsis
    3131
    32 [egg property] (synopsis STRING)
     32 [egg property] (synopsis STRING)
    3333
    3434Gives a short description of this egg.
     
    3636==== author
    3737
    38 [egg property] (author STRING)
     38 [egg property] (author STRING)
    3939
    4040Names the author or authors of the contained code.
     
    4242==== maintainer
    4343
    44 [egg property] (maintainer STRING)
     44 [egg property] (maintainer STRING)
    4545
    4646Names the maintainer of this code, if different from author(s).
     
    4848==== category
    4949
    50 [egg property] (category NAME)
     50 [egg property] (category NAME)
    5151
    5252Gives the category under which this egg should be contained.
     
    5656==== license
    5757
    58 [egg property] (license STRING)
     58 [egg property] (license STRING)
    5959
    6060Names the license under which this code is available.
     
    6262==== dependencies
    6363
    64 [egg property] (dependencies EGG ...)
     64 [egg property] (dependencies EGG ...)
    6565
    6666Lists eggs that this egg depends on, and which should be
     
    7373==== test-dependencies
    7474
    75 [egg property] (test-dependencies EGG ...)
     75 [egg property] (test-dependencies EGG ...)
    7676
    7777Lists eggs that are required for this egg to run the tests
     
    8181==== build-dependencies
    8282
    83 [egg property] (build-dependencies EGG ...)
     83 [egg property] (build-dependencies EGG ...)
    8484
    8585Lists eggs that are build-time dependencies for this egg,
     
    8989==== foreign-dependencies
    9090
    91 [egg property] (foreign-dependencies NAME ...)
     91 [egg property] (foreign-dependencies NAME ...)
    9292
    9393Lists external dependencies like native code libraries
     
    9797==== platform
    9898
    99 [egg property] (platform PLATFORM)
     99 [egg property] (platform PLATFORM)
    100100
    101101Specifies for which platform this egg is intended. {{PLATFORM}}
     
    108108==== components
    109109
    110 [egg property] (components COMPONENT ...)
     110 [egg property] (components COMPONENT ...)
    111111
    112112Lists components (extensions, programs, include- or data files)
     
    116116==== host
    117117
    118 [egg property] (host PROP ...)
     118 [egg property] (host PROP ...)
    119119
    120120Recursively process {{PROP ...}}, but only for the host (build)
     
    124124==== target
    125125
    126 [egg property] (target PROP ...)
     126 [egg property] (target PROP ...)
    127127
    128128Recursively process {{PROP ...}}, but only for the target
     
    134134==== extension
    135135
    136 [egg property] (extension NAME PROP ...)
     136 [egg property] (extension NAME PROP ...)
    137137
    138138Specifies an extension library component. The properties
     
    142142==== data
    143143
    144 [egg property] (data NAME PROP ...)
     144 [egg property] (data NAME PROP ...)
    145145
    146146Specifies one or more arbitrary data files.
     
    148148==== generated-source-file
    149149
    150 [egg property] (generated-source-file NAME PROP ...)
     150 [egg property] (generated-source-file NAME PROP ...)
    151151
    152152Specifies a file that is generated during the process of building
     
    155155==== c-include
    156156
    157 [egg property] (c-include NAME PROP ...)
     157 [egg property] (c-include NAME PROP ...)
    158158
    159159Specifies one or more C include files.
     
    161161==== scheme-include
    162162
    163 [egg property] (scheme-include NAME PROP ...)
     163 [egg property] (scheme-include NAME PROP ...)
    164164
    165165Specifies one or more Scheme include files.
     
    167167==== program
    168168
    169 [egg property] (program NAME PROP ...)
     169 [egg property] (program NAME PROP ...)
    170170
    171171Specifies an executable program.
     
    175175==== host
    176176
    177 [egg property] (host PROP ...)
     177 [egg property] (host PROP ...)
    178178
    179179Process {{PROP ...}} recursively for the current component, but
     
    183183==== target
    184184
    185 [egg property] (target PROP ...)
     185 [egg property] (target PROP ...)
    186186
    187187Process {{PROP ...}} recursively for the current component, but
     
    191191==== linkage
    192192
    193 [egg property] (linkage LINKAGE)
     193 [egg property] (linkage LINKAGE)
    194194
    195195Define whether the component should be linked dynamically or
     
    199199==== types-file
    200200
    201 [egg property] (types-file [NAME])
     201 [egg property] (types-file [NAME])
    202202
    203203Specifies that a "type-database" file should be generated and
     
    212212==== inline-file
    213213
    214 [egg property] (inline-file [NAME])
     214 [egg property] (inline-file [NAME])
    215215
    216216Specifies that an "inline" file should be generated and installed
     
    221221==== custom-build
    222222
    223 [egg property] (custom-build STRING)
     223 [egg property] (custom-build STRING)
    224224
    225225Specifies a custom build operation that should be executed instead of
     
    246246==== csc-options
    247247
    248 [egg property] (csc-options OPTION ...)
     248 [egg property] (csc-options OPTION ...)
    249249
    250250Specifies additional compiler options for {{csc}} that should be
     
    261261==== link-options
    262262
    263 [egg property] (link-options OPTION ...)
     263 [egg property] (link-options OPTION ...)
    264264
    265265Specifies additional link options for {{csc}} that should be
     
    273273==== source
    274274
    275 [egg property] (source NAME)
     275 [egg property] (source NAME)
    276276
    277277Specifies an alternative source file, in case it has a name
     
    282282==== install-name
    283283
    284 [egg property] (install-name NAME)
     284 [egg property] (install-name NAME)
    285285
    286286Specifies an alternative installation name of the component,
     
    292292==== component-dependencies
    293293
    294 [egg property] (component-dependencies NAME ...)
     294 [egg property] (component-dependencies NAME ...)
    295295
    296296Specifies dependencies to other components. {{NAME ...}} must
     
    300300==== source-dependencies
    301301
    302 [egg property] (source-dependencies NAME ...)
     302 [egg property] (source-dependencies NAME ...)
    303303
    304304Specifies dependencies to additional source files. {{NAME ...}} must
     
    309309==== destination
    310310
    311 [egg property] (destination NAME)
     311 [egg property] (destination NAME)
    312312
    313313Specifies an alternative installation destination for the
     
    326326==== files
    327327
    328 [egg property] (files NAME ...)
     328 [egg property] (files NAME ...)
    329329
    330330Specifies source files for this component and only applies
     
    333333==== modules
    334334
    335 [egg property] (modules NAME ...)
     335 [egg property] (modules NAME ...)
    336336
    337337Specifies modules that the component (usually an extension) contains.
Note: See TracChangeset for help on using the changeset viewer.