Orbspec Specification

An orbspec is a specification for an orb package. It's a file containing information that the orb tool needs to be able to build an orb package, e.g. name, version, type, files needed to build the package and so on. This is an example of how an orbspec file can look like:

# orange.orbspec
# name "orange" # inferred from the name of the orbspec
version "1.0.0"
author "Jacob Carlborg"
type :library
files << ["a.d", "b.di"] # an array of source files

The following sections describe exactly how an orbspec file looks like.

Syntax

Types

• integer - 24
• floating point number - 3.0
• string - "example of a string"
• array - [1, 2, 3]
• symbol - :example_of_symbol. Symbols are usually used in places of strings where there is a limited set of valid strings. Usually strings and symbols are interchangeable.

Setting a Field

name "orbit"

Getting a Field

a = name

Comments

# this is a comment

Check Platform

if version.darwin
    # Mac OS X specific configuration
end

Set platform

version.darwin = true

Callbacks

before :install do
    # runs this before installing the package
end

(An orbspec is written in Ruby)

Required Fields

• summary
• version

(These will most likely change)

Fields

(R indicates a read only field)

• author
• build - The tool used to build the package. DSSS, Dake, Make, Shell
• build_dependencies - All the orb packages required to build this orb
• date - The date this orb was created, R
• dependencies - Alias for runtime_dependencies
• description
• dvm - The D version required for this orb
• email
• executables - All executables included in this package
• files - All the required files to build this orb
• homepage
• libraries - All libraries included in this package (both static and dynamic)
• name - The name of the orb package
• orbit_version - The orbit version used to create this orb, R
• orbs - Alias for runtime_dependencies
• platforms - The platforms this package support
• runtime_dependencies - All the orb packages required to run this orb
• specification_version - The orbspec version used to create this orb, R
• type - The type of the package, e.g., library, source, bindings and so on.

Callbacks

The following callbacks are available, both as before and after callbacks:

• build
• install
• uninstall
• upgrade

Versions

The following list contains the predefined versions and on which platforms they are defined:

• darwin - Alias for osx
• freebsd - FreeBSD
• linux - Linux
• osx - Mac OS X
• posix - Mac OS X, Linux and FreeBSD
• windows - Windows
• bit64 - All 64bit platforms
• bit32 - All 32bit platforms