HaikuPorts
  • Login
  • Preferences
  • Help/Guide
  • Wiki
  • Timeline
  • Roadmap
  • View Tickets
  • Search
  • Port Log
  • Blog
wiki:BepFile

Context Navigation

  • ← Previous Version
  • View Latest Version
  • Next Version →


Version 4 (modified by brecht, 8 years ago) (diff)

--

Introduction

A .bep file is a recipe that BePorter? uses to fetch, patch, build and install a software package. It is an ASCII file that contains a list of keys with corresponding (lists of) values.

Syntax

Key types

There are three types of keys in a BepFile: single-value, list-of-values and shell-commands.

The key label is subject to the following rules:

  • the key label must be in all capitals and consist only of letters (A-Z) and underscores
  • there may be no whitespace in front of the key label
  • there may be whitespace around the '=', but it is not required

A key with a single value

KEY = "value"

The syntax is subject to the following rules:

  • the value should be enclosed within double quotes
  • there may be whitespace after the closing quote

A key with a list of values

KEY = "value1
       value2
       value3"

The syntax is subject to the rules listed above for a single value key, plus the following:

  • one value is entered per line, with the first on the line of the key label
  • every value but the first is indented by whitespace (tabs or spaces)
  • only one set of double quotes encloses the list, as is visible from the example above
  • the closing double quote is on the same ling as the last value of the list

A key with a list of shell commands

KEY = {
       command1
       command2
       command3
      }

The syntax is subject to these rules:

  • the line of the key label end with an opening brace '{', with no command following it
  • one command is entered per line
  • every command is indented by whitespace (tabs or spaces)
  • the closing brace '}' is on on a seperate line, preceded by whitespace

List of keys

The following keys are currently supported in BePorter?:

KeyDescriptionTypeSyntaxMandatoryDefault
DESCRIPTIONa (short) description of the software packagesingle, listtextyes-
HOMEPAGEURI pointing to the official homepage of the software packagesingleURIyes-
SRC_URI(a list of) URI(s) pointing to the source code archive of the software packagesingle, listURIyes-
REVISIONindicates the BePort? revisionsingleinteger (1, 2, 3, ...)yes-
WORKINGindicates whether this BePort? is fully workingsingleboolean (yes, no)noyes
DEPEND(list of) BePort(s) this port depends uponsingle, listcategory/portname >= portversionno-
BUILDlist of shell commands to execute in order to build the portshellshell commandsno-
INSTALLlist of shell commands to execute in order to install the portshellshell commandsno-

When a key is not listed in the BepFile, BePorter? assumes the default value, or an empty string/list (if no default value is specified above).

Note: It is possible that the names and/or the use of these keys may change as BePorter? evolves. Keys may also be added and removed. When BePorter? gets a release, the key set shall be frozen.

It is possible to insert comments in the BepFile.

  • the comment should be on a line of it's own
  • the comment should be preceded with a hash (#)
  • there may be whitespace preceding the '#'

Download in other formats:

  • Plain Text

Trac Powered

Powered by Trac 0.13dev-r10686
By Edgewall Software.

Visit the Trac open source project at
http://trac.edgewall.org/