+++ /dev/null
-.\" Man page for <tool>
-.\"
-.\" (c)2007 emlix GmbH
-.\"
-.TH <tool> 1 "Aug 15, 2008" "2.2"
-
-.SH NAME
-e2.conf - global configuration
-
-.SH DESCRIPTION
-\fBe2.conf\fR is the global configuration file holding tool and server
-configurations.
-
-.SH EXAMPLE
-.nf
-config {
- tools = {
- which = { name="which" },
- curl = { name="curl" },
- ssh = { name="ssh" },
- scp = { name="scp" },
- cvs = { name="cvs", flags="" },
- },
- servers = {
- upstream = {
- url = "ssh://e2data/data/e2data/upstream",
- cachable = true,
- cache = true,
- },
- projects = {
- url = "ssh://e2data/mnt/e2data/projects",
- cachable = false,
- cache = false,
- },
- chroot = {
- url = "ssh://e2data/mnt/e2data/results",
- cachable = true,
- cache = true,
- },
- results = {
- url = "ssh://e2data/data/e2data/results",
- cachable = true,
- cache = true,
- },
- },
-}
-.nf
-
-.SH "SEE ALSO"
-.BR e2config(5)
-.BR e2intro (7)
-
-.SH AUTHORS
-Gordon Hecker, Oskar Schirmer and Felix Winkelmann
-
-.SH COPYRIGHT
-(c)2008 emlix GmbH
--- /dev/null
+.\" Man page for e2.conf
+.\"
+.\" (c)2007 emlix GmbH
+.\"
+.TH e2.conf 5 "Oct 29, 2012" "@VERSION@"
+
+.SH NAME
+e2.conf \- global configuration file of e2factory
+
+.SH DESCRIPTION
+The mandatory and global file \fBe2.conf\fR configures following aspects:
+.PP
+.IP o
+Logging
+.IP o
+Available versions of e2factory
+.IP o
+Configuration of external tools
+.IP o
+Cache directory
+.IP o
+Servers
+
+.PP
+This file is not part of any e2factory project but needs to be on each machine running e2factory.
+It needs to be adopted to that machine and it network environment.
+
+.SH PLACES
+
+This file is searched in the following places. The first match is taken:
+.PP
+.IP 1.
+Argument: \-\-e2\-config=FILE
+.IP 2.
+Environment variable: E2_CONFIG=<FILE>
+.IP 3.
+$HOME/.e2/e2.conf-<MAJOR>.<MINOR>.<PATCHLEVEL>
+.IP 4.
+$HOME/.e2/e2.conf-<MAJOR>.<MINOR>
+.IP 5.
+$HOME/.e2/e2.conf
+.IP 6.
+/etc/.e2/e2.conf-<MAJOR>.<MINOR>.<PATCHLEVEL>
+.IP 7.
+/etc/.e2/e2.conf-<MAJOR>.<MINOR>
+.IP 8.
+/etc/.e2/e2.conf
+
+
+
+.SH STRUCTURE
+The file has following structure:
+.nf
+
+config {
+ log = {
+ logrotate = <integer>;
+ },
+ site = {
+ e2_server = "<string>",
+ e2_location = "<string>",
+ e2_base = "<string>",
+ e2_branch = "<string>",
+ e2_tag = "<string>",
+ default_extensions = {
+ {
+ name = "<string>",
+ ref = "<string>",
+ },
+ ...
+ }
+ },
+ tools = {
+ ["<tool-name>"] = { name="<string>", flags="<string>" },
+ ...
+ },
+ cache = {
+ path = "<string>",
+ },
+ servers = {
+ ["server-name"] = {
+ url = "<string>",
+ cachable = <bool>,
+ cache = <bool>,
+ islocal = <bool>,
+ writeback = <bool>,
+ push_permissions = "<string>",
+ },
+ ...
+ },
+}
+.nf
+
+.SH KEYS
+
+.TP
+.BR log
+Type: Table
+.br
+Logging relevant configurations.
+
+.TP
+.BR logrotate
+Type: Integer
+.br
+Number of old log-files to keep. Others are deleted.
+
+.TP
+.BR site
+Type: Table
+.br
+Access to the e2factory repository.
+
+.TP
+.BR e2_server
+Type: String
+.br
+Name of the server where the e2factory repository is stored.
+
+.TP
+.BR e2_location
+Type: String
+.br
+Path of the e2factory repository on the server.
+
+.TP
+.BR e2_base
+Type: String
+.br
+Path of extensions repositories on the server.
+
+.TP
+.BR e2_branch
+Type: String
+.br
+Name of the git branch of the e2factory version to use, when using \fBe2-create-project\fR(1).
+
+.TP
+.BR e2_tag
+Type: String
+.br
+Name of the git tag of the e2factory version to use, when using \fBe2-create-project\fR(1).
+
+.TP
+.BR default_extensions
+Type: Table
+.br
+List of extension to select, when creating a new project with \fBe2-create-project\fR(1).
+
+.TP
+.BR name
+(on level site, default_extensions)
+Type: String
+.br
+Name of extension.
+
+.TP
+.BR ref
+(on level site, default_extensions)
+Type: String
+.br
+git reference of version of extension.
+
+.TP
+.BR tools
+Type: Table
+.br
+List of tools used with specific arguments.
+
+.TP
+.BR <tool-name>
+Type: String
+.br
+Name of the tool.
+
+.TP
+.BR name
+Type: String
+.br
+Command to call the tool.
+
+.TP
+.BR flags
+Type: String
+.br
+Flags/arguments to be passed to the tool.
+
+.TP
+.BR cache
+Type: Table
+.br
+Caching relevant configurations.
+
+.TP
+.BR path
+Type: String
+.br
+Path of the e2factory cache directory.
+
+.TP
+.BR servers
+Type: Table
+.br
+List of servers that could be used in e2factory projects.
+
+.TP
+.BR <server-name>
+Type: String
+.br
+Name of the server.
+
+.TP
+.BR url
+Type: String
+.br
+URL of the server.
+
+.TP
+.BR cachable
+Type: Boolean (true, false)
+.br
+Defines weather the content of the server could be cached.
+
+.TP
+.BR cache
+(on server level)
+Type: Boolean (true, false)
+.br
+Defines weather the content of the server should be cached.
+
+.TP
+.BR islocal
+Type: Boolean (true, false)
+.br
+True if the server is local.
+
+.TP
+.BR writeback
+Type: Boolean (true, false)
+.br
+True if data should be pushed back to the server.
+
+.TP
+.BR push_permissions
+Type: String
+.br
+Permissions to be set when pushing back to server.
+
+.SH "SEE ALSO"
+.BR e2factory(1)
+
+.SH COPYRIGHT
+(c)2013 emlix GmbH
--- /dev/null
+.\" Man page for e2chroot
+.\"
+.\" (c)2007, 2012 emlix GmbH
+.\"
+.TH e2chroot 5 "Oct 26, 2012" "@VERSION@"
+
+.SH NAME
+proj/chroot \- chroot configuration file of an e2factory project
+
+.SH DESCRIPTION
+The mandatory file \fBproj/chroot\fR defines the chroots that could be configured
+for a build processes.
+
+
+.SH STRUCTURE
+The file has following structure:
+.nf
+
+e2chroot {
+ default_groups = { "<string>", ... },
+ groups = {
+
+ {
+ name = "<string>",
+ server = "<string>",
+ files = {
+ { server = "<string>",
+ location = "<string>",
+ sha1 = "<string>", },
+ ...
+ },
+ },
+ ...
+ }
+
+}
+.fi
+
+.SH KEYS
+
+.TP
+.BR default_groups
+Type: Table of strings.
+.br
+List of chroot groups to be installed in any build process by default.
+
+.TP
+.BR groups
+Type: Table
+.br
+Table of groups.
+
+.TP
+.BR name
+Type: String
+.br
+Name of this chroot group.
+
+.TP
+.BR server
+(on group level)
+.br
+Type: String
+.br
+Default server for this chroot group.
+
+.TP
+.BR files
+Type: Table
+.br
+List of files belonging to the chroot group.
+
+.TP
+.BR server
+(on file level)
+.br
+Type: String
+.br
+Server that stores the file. If not given, server on chroot group level is used.
+
+.TP
+.BR location
+Type: String
+.br
+Path to the file on the server.
+
+.TP
+.BR sha1
+Type: String
+.br
+sha1 check-sum of the file.
+
+.SH COPYRIGHT
+(c)2013 emlix GmbH
\ No newline at end of file
+++ /dev/null
-.\" Man page for e2config
-.\"
-.\" (c)2007 emlix GmbH
-.\"
-.TH e2config 1 "Aug 6, 2007" "0.1"
-
-.SH NAME
-e2config \- e2 configuration file format
-
-.SH DESCRIPTION
-An \fBe2\fR project tree consists of the following files and
-sub-directories:
-
-.nf
-.
-|-- .e2 local part of e2 tool
-|-- in sources from shared repositories
-|-- out will hold build results
-|-- proj project configuration directory
-| |-- env holds project environment (optional)
-| |-- chroot required chroot tarballs
-| |-- default-results main final results of the project
-| |-- init initialization scripts run inside chroot
-| |-- licences list of licences used by sources (optional)
-| |-- name project name
-| |-- result-storage where to store shared build-results
-| o-- servers remote servers for sources and projects
-|
-|-- log contains log files for e2 use and builds
-| |-- debug.log e2 internal log for last operation
-| |-- build.<result>.log build log for specific result
-| :
-|
-|-- res build result descriptions
-| |-- <result> one directory for each result
-| | |-- config result configuration file
-| | |-- build-script build instructions executed in chroot
-| | o-- <local file> project-local files (related to result)
- |-- <subfolder> results can be grouped in subfolders
-| | o-- <result>
-| | | |-- config
-| | | |-- build-script
-| | | o-- <local file>
- | :
-| :
-|
-o-- src source descriptions for each source
- |-- <source> one directory for each source
- | |-- config source configuration
- | o-- <local file> project-local files (related to source)
- |-- <subfolder> sources can be groupd in subfolders
- | o-- <source>
- | | |-- config
- | | o-- <local file>
- | :
- :
-.fi
-
-.SH DEPENDENCY\ CONFIGURATION
-
-The file "proj/default-results" lists the main final results of
-the project, one per line. This is for convenience only, the list
-is used when e2-build is called with no result name.
-
-.SH ENVIRONMENT\ CONFIGURATION
-
-The optional file "proj/env" may define a table of global variables that are
-accessible during the build process. The table should be of the form
-
-.nf
-env {
- <variable1> = "<value1>",
- <variable2> = "<value2>",
- :
-}
-.fi
-
-During execution of a build script for a given result, environment variables
-of the same name will be defined, so in this example a build script could
-access the variables \fB$variable1\fR and \fB$variable2\fR. Variable values
-must be strings or symbols. The environment table is stored in the global
-Lua variable \fBenv\fR and can be referred to from source- and result configuration
-file (using \fBenv.variable1\R, \fBenv.variable2\fR, ...).
-
-Per-result environment variable entries can be defined with the syntax
-
-.nf
-env {
- :
- <resultname> = { <variable1 = "<value1>", ... }
- :
-}
-.fi
-
-In this case the defined variables are only available in the build-script
-for this particular result. Note that \fB<resultname\fR must be a valid
-variable name. If the result has a name containing special characters
-(like "-"), use this syntax:
-
-.nf
-env {
- :
- ["<resultname>"] = { ... }
- :
-}
-.fi
-
-Accessing a result-specific variable must be done using this syntax:
-
-.nf
- env[ "<resultname>" ].<variable>
-.fi
-
-\fBenv\fR may also be invoked with a single string as argument. In
-this case the string should designate a path (relative to the project
-directory) with another environment definition file in the same syntax.
-This file will then be loaded and can add additional definitions to
-the project environment.
-
-.SH CHROOT\ CONFIGURATION
-
-The file "proj/chroot" lists the binaries
-that are copied into the \fBchroot(1)\fR
-environment before the build of a result commences.
-The chroot configuration file should have the following format:
-
-.nf
-e2chroot {
- {
- group = "<groupname>",
- server = "<servername>",
- files = {
- "<path-to-file>",
- ...
- },
- },
- ...
-}
-.fi
-
-The group name is arbitrary and is used
-to select particular sets of chroot binaries in a result configuration.
-
-.SH SERVER\ CONFIGURATION
-
-The file "proj/servers" holds a list of abstract server names. Each
-line should contain two fields, separated by whitespace: the server
-name and the path where the server's resources are stored. A relative
-path is always treated as relative to the projects root directory.
-Empty lines and lines starting with the "#" symbol are ignored.
-
-.SH LICENCES\ CONFIGURATION
-
-The licences file (proj/licences) should have the following format:
-
-.nf
-e2licence {
- <licencename> = {
- server = "<servername>",
- name = "<path-to-directory>"
- }
-}
-.fi
-
-All licences explicitely referenced in source configuration
-shall be listed in this file.
-Each entry refers to a directory, which may contain one or
-more files that make up the licence information.
-
-The licence configuration file must follow \fBlua(1)\fR syntax.
-
-.SH SOURCE\ CONFIGURATION
-
-The "config" file for a source should have the following general
-form:
-
-.nf
-e2source {
- <propertyname> = <value>,
- ...
-}
-.fi
-
-If the source refers to a tarball or fixed set of files, the following
-properties should be set:
-
-.nf
-file = {
- { server = "<servername>",
- location = "<path-to-file>",
- <destiny> = "contents"
- }
-}
-.fi
-
-<destiny> is one of \fBunpack\fR, \fBpatch\fR or \fBcopy\fR.
-The contents depends on the type of destiny.
-For \fBunpack\fR it is the single subdir contained in the tarball to unpack,
-for \fBpatch\fR it is the patch level to apply with, usually \fI1\fR,
-for \fBcopy\fR it is the destination path, relative to the source subdir.
-
-For example:
-
-.nf
-e2source {
- file={
- { server="upstream",
- location="hello/1.0/hello-1.0.tar.gz",
- unpack="hello-1.0"
- }
- }
-}
-.fi
-
-If the source refers to a version control repository
-(\fBgit(7)\fR, \fBsvn(1)\fR, etc.), then
-these properties should be defined:
-
-.nf
-branch = "<branchname>" (usually "master")
-location = "<path-to-repository>"
-server = "<servername>"
-tag = "<tagname>"
-type = "<scmtype>" ("git", "svn" or "cvs")
-working = "<path-to-working-dir>" (defaults to "in/<sourcename>")
-licence = "<licencename>" (as listed in proj/licences)
-.fi
-
-If the source refers to a \fBcvs\fR repository, the following applies,
-in addition to the properties given above:
-
-.nf
-remote must not be configured
-cvsroot = "<path to cvsroot>"
-module = "<module path>"
-.fi
-
-To use cvs pserver mode the server must use "cvspserver://" transport.
-cvs login is not supported. Do cvs login before trying to access the
-cvs server with e2.
-
-Source configuration files must follow \fBlua(1)\fR syntax.
-
-The tag field may provide a list of tags instead of a single tag.
-The last tag in the list is the current one used when building.
-The other tags may be kept for historical purpose, they are used
-to split up the source when preparing it for cargo.
-
-A config file referring to a version control repository may
-contain the field "file", which states the historical basic state
-of the source, which will be used to split up source upon preparation
-for cargo into the old files state and newer tagged patches.
-
-The licence entry value is used as key into the table
-in proj/licences.
-It is optional for a source of type \fIfiles\fR,
-but obligatory otherwise.
-
-Note that all references to a server accept the special server name "."
-(period) which refers to the project directory itself.
-E.g., the following declaration refers to a kernel configuration file
-stored locally in the project:
-
-.nf
-e2source {
- file={
- { server = ".",
- location = "src/linux-config/my_config",
- copy = ".config"
- }
- }
-}
-.fi
-
-Note that during development the \fItagname\fR may be replaced by \fB^\fR
-to denote the head revision of the given branch \fIbranchname\fR.
-
-.SH RESULT\ CONFIGURATION
-
-"config" files for results look similar to source configurations, but
-use the "e2result" configuration command:
-
-.nf
-e2result {
- <propertyname> = <value>,
- ...
-}
-.fi
-
-Value result properties are:
-
-.nf
-sources = { "<sourcename1>", ... } (zero or more sources by name)
-files = { "<resultfilename1>", ... } (i.e. "hello.tar.gz")
-chroot = { "<chroot-group1>", ... } (defaults to all groups)
-depends = { "<dependency1>", ... } (defaults to none)
-.fi
-
-The "sources" property specifies the archives, repositories, files or
-patches referenced by configuration entries in the "src" directory
-which are to be copied into the build environment. Only the sources
-given in this property will be copied/extracted.
-
-It is possible to group sources in subfolders. When a folder for a source does
-NOT contain a config file e2 factory tries to search its subfolders for further
-sources. To name sources in subfolders you have to add the foldername to the source name
-separated with a dot (e.g. xorg.libXau). This occurrs when specify sources in the result config.
-
-The properties may omit the "{ ... }" braces, if only a single entry is
-used. Note that you can specify multiple sources for any single result.
-
-Result configuration files must follow \fBlua(1)\fR syntax.
-
-.SH CONFIGURATION\ FILE\ RESTRICTIONS
-
-Configuration files (specifically source-configurations,
-result-configurations and the project environment) are executed in a
-restricted environment: only the confguration-specific initializer
-functions (\fBe2source\fR, \fBe2result\fR and \fBenv\fR) and the Lua
-standard operations from the \fBstring\fR are available). Adding new
-definitions to the global environment is not allowed. Note that
-re-definitions are still currently possible. Hooks do not run in
-restricted mode and have full access to the e2 internals.
-
-.SH "SEE ALSO"
-.BR e2intro(7)
-.BR e2-ls-project(1)
-.BR e2.conf(5)
-
-.SH AUTHORS
-Gordon Hecker, Oskar Schirmer and Felix Winkelmann
-
-.SH COPYRIGHT
-(c)2007 emlix GmbH
--- /dev/null
+.\" Man page for e2env
+.\"
+.\" (c)2007 emlix GmbH
+.\"
+.TH e2env 5 "Oct 26, 2012" "@VERSION@"
+
+.SH NAME
+proj/env \- optional configuration file for environment variable of build processes
+
+.SH DESCRIPTION
+The optional file \fBproj/env\fR defines tables of global and result-specific
+environment variables that will be available during build processes.
+
+.SH STRUCTURE
+\fBGlobal environment variables:\fR
+
+.nf
+env {
+ <variable1> = "<value1>",
+ <variable2> = "<value2>",
+ :
+}
+.fi
+
+\fBResult specific environment variables:\fR
+
+.nf
+env {
+ :
+ ["<resultname>"] = { <variable1 = "<value1>", ... }
+ :
+}
+.fi
+
+\fBInclude a file:\fR
+
+env("<file>")
+
+<file> needs to be relative from project root. Syntax is the same as above.
+
+
+.SH "SEE ALSO"
+.BR e2factory(1)
+
+.SH COPYRIGHT
+(c)2013 emlix GmbH
\ No newline at end of file
--- /dev/null
+.\" General man page for e2
+.\"
+.\" (c)20012 emlix GmbH
+.\"
+.TH e2factory 1 "2012" "@VERSION@"
+
+.SH NAME
+e2factory \- the emlix embedded build system
+
+.SH DESCRIPTION
+\fBe2factory\fR is a system for automated and reproducible builds of
+software from sources. For details consult the reference documentation.
+It can be found on the website of e2factory \fBwww.e2factory.org\fR.
+
+.SH TOOLS
+e2factory provides the following tools to
+configure a project and run the build process. Each tool has its own man-page.
+Please consult it for further information by typing \fBman <toolname>\fR.
+
+.TP
+.BR e2-create-project(1)
+Create a new project.
+.TP
+.BR e2-fetch-project(1)
+Retrieves a project.
+.TP
+.BR e2-install-e2(1)
+Install the local e2 tools into a project environment.
+.TP
+.BR e2-build(1)
+Build results.
+.TP
+.BR e2-cf(1)
+Create and modify configuration files.
+.TP
+.BR e2-dlist(1)
+Show a list of the dependencies.
+.TP
+.BR e2-dsort(1)
+Show the sorted list of results.
+.TP
+.BR e2-fetch-sources(1)
+Retrieve the sources for the current project.
+.TP
+.BR e2-ls-project(1)
+Display a schematic view of the current project.
+.TP
+.BR e2-new-source(1)
+Create a new source.
+.TP
+.BR e2-playground(1)
+Enter chroot environment.
+.TP
+.BR e2-locate-project-root(1)
+Display the project root.
+
+.SH OPTIONS
+All tools support the following common set of options:
+.TP
+.BR \-\-e2\-config=<file>
+Specify an e2factory configuration file.
+.TP
+.BR \-\-help
+Show usage information.
+.TP
+.BR \-\-version
+Show e2factory version number and exit.
+.TP
+.BR \-\-licence
+Show licence information and exit.
+.TP
+.BR \-\-quiet
+Disable all log levels.
+.TP
+.BR \-\-verbose
+Enable log levels 1-2.
+.TP
+.BR \-\-debug
+Enable log levels 1-3.
+.TP
+.BR \-\-tooldebug
+Enable log levels 1-4.
+.TP
+.BR \-\-vall
+Enable all log levels.
+.TP
+.BR \-\-v1
+Enable log level 1 (minimal).
+.TP
+.BR \-\-v2
+Enable log level 2 (verbose).
+.TP
+.BR \-\-v3
+Enable log level 3 (show user debug information).
+.TP
+.BR \-\-v4
+Enable log level 4 (show tool debug information).
+.TP
+.BR \-\-log-debug
+Enable logging of debugging output.
+.TP
+.BR \-\-Wall
+Enable all warnings
+.TP
+.BR \-\-Wdefault
+Warn when default values are applied.
+.TP
+.BR \-\-Wdeprecated
+Warn if deprecated options are used.
+.TP
+.BR \-\-Wither
+Disable all warnings not mentioned (enabled by default).
+.TP
+.BR \-\-Pols
+Warn when hurting policies.
+.TP
+.BR \-\-Whint
+Enable hints to the user.
+
+.SH FILES
+e2factory reads the following files to
+configure a project and run the build process. Each file has its own man-page.
+Please consult it for further information by typing \fBman <name>\fR.
+.TP
+.BR e2.conf(5)
+Global configuration file of e2factory.
+.br
+Filename: \fBe2.conf\fR
+.TP
+.BR e2rc(5)
+Per user default argument settings.
+.br
+Filename: \fB$HOME/.e2/e2rc\fR
+.TP
+.BR e2project(5)
+Central configuration file for an e2factory project.
+.br
+Filename: \fBproj/config\fR
+.TP
+.BR e2chroot(5)
+chroot configuration file of an e2factory project.
+.br
+Filename: \fBproj/chroot\fR
+.TP
+.BR e2licence(5)
+Licence configuration file of an e2factory project.
+.br
+Filename: \fBproj/licence\fR
+.TP
+.BR e2env(5)
+Optional configuration file for environment variable of build processes.
+.br
+Filename: \fBproj/env\fR
+.TP
+.BR e2source(5)
+Source configuration files of an e2factory project.
+.br
+Filename: \fBsrc/<dir>/config\fR
+.TP
+.BR e2result(5)
+Result configuration files of an e2factory project.
+.br
+Filename: \fBres/<dir>/config\fR
+
+.SH ENVIRONMENT
+All tools evaluate the following environment variables:
+.TP
+.BR COLUMNS
+Number of columns of terminal for formatted output.
+.TP
+.BR EDITOR
+Name of editor to be used.
+.TP
+.BR HOME
+Users home directory.
+.TP
+.BR TERM
+The terminal
+.TP
+.BR TMPDIR
+Temporary directory to be used. Overwritten by \fBE2TMPDIR\fR.
+.TP
+.BR USER
+Name of the user.
+.TP
+.BR E2TMPDIR
+Temporary directory to be used. Overwrites \fBTMPDIR\fR.
+.TP
+.BR E2_CONFIG
+Path to the config file.
+.TP
+.BR E2_SSH
+ssh-tool to be use instead of \fBssh\fR(1).
+
+.SH COPYRIGHT
+(c)2013 emlix GmbH
--- /dev/null
+.\" Man page for e2licence
+.\"
+.\" (c)2007, 2012 emlix GmbH
+.\"
+.TH e2licence 5 "Oct 26, 2012" "@VERSION@"
+
+.SH NAME
+proj/licence \- licence configuration file of an e2factory project
+
+.SH DESCRIPTION
+The mandatory file \fBproj/licence\fR defines the licences that could be used in
+source configurations.
+
+
+.SH STRUCTURE
+The file has following structure:
+.nf
+
+e2licence {
+ ["<licence>"] = {
+ server = "<string>",
+ files = {
+ { server = "<string>",
+ location = "<string>",
+ sha1 = "<string>", },
+ ...
+ },
+ },
+ ...
+}
+.fi
+
+.SH KEYS
+
+.TP
+.BR <licence>
+Type: String
+.br
+Name of the licence.
+
+.TP
+.BR server
+(on licence level)
+.br
+Type: String
+.br
+Name of the server the licence file is stored.
+
+.TP
+.BR files
+Type: Table
+.br
+List of files belonging to the licence.
+
+.TP
+.BR server
+(on file level)
+.br
+Type: String
+.br
+Server that stores the file. If not given, server on licence level is used.
+
+.TP
+.BR location
+Type: String
+.br
+Path to the licence file on server.
+
+.TP
+.BR sha1
+Type: String
+.br
+SHA-1 check-sum of the file.
+
+.SH "SEE ALSO"
+.BR e2factory(1)
+
+.SH COPYRIGHT
+(c)2013 emlix GmbH
--- /dev/null
+.\" Man page for e2project
+.\"
+.\" (c)2007, 2012 emlix GmbH
+.\"
+.TH e2project 1 "Oct 26, 2012" "@VERSION@"
+
+.SH NAME
+proj/config \- central configuration file for an e2factory project
+
+.SH DESCRIPTION
+The mandatory file \fBproj/config\fR sets most imported configuration options for
+an e2factory project.
+
+
+.SH STRUCTURE
+The file has following structure:
+.nf
+
+e2project {
+ name = "<string>",
+ release_id = "<string>",
+ default_results = { "<string>", ...},
+ chroot_arch = "<string>",
+ deploy_results = { "<string>", ...},
+
+}
+.fi
+
+.SH KEYS
+
+.TP
+.BR name
+Type: String
+.br
+Name of the project.
+
+.TP
+.BR release_id
+Type: String
+.br
+Identifier of the current release.
+
+.TP
+.BR default_results
+Type: Table of strings
+.br
+Results to be build if none is given.
+
+.TP
+.BR chroot_arch
+Type: String
+.br
+Architecture of chroot. Use "x86_32".
+
+.TP
+.BR deploy_results
+Type: Table of strings
+.br
+Results to be archived during building in release-mode.
+
+
+.SH "SEE ALSO"
+.BR e2factory(1)
+
+.SH COPYRIGHT
+(c)2013 emlix GmbH
+++ /dev/null
-.\" Man page for e2rc
-.\"
-.\" (c)2007 emlix GmbH
-.\"
-.TH e2rc.5 "Aug 2, 2007" "0.1"
-
-.SH NAME
-e2rc \- per-user default settings for local e2 tools
-
-.SH SYNOPSIS
-e2rc [OPTION/PATH]...
-
-.SH DESCRIPTION
-\fB$HOME/.e2/e2rc\fR has the following format:
-
- e2rc {
- { "option" [, value] },
- ...
- }
-
-where \fBoption\fR must be the name of a valid command line option and value
-can be \fBtrue\fR or \fBfalse\fR for flags or a quoted string for options
-that take an argument.
-Omitting the value is equivalent to specifying \fBtrue\fR.
-Options given on the command line override options specified in
-\fBe2rc\fR.
-
-Example:
-
- e2rc {
- { "debug" }
- }
-
-.SH BUGS
-Doubtless there are many.
-
-.SH "SEE ALSO"
-.BR e2intro (7).
-
-.SH AUTHORS
-Gordon Hecker, Oskar Schirmer and Felix Winkelmann
-
-.SH COPYRIGHT
-(c)2007 emlix GmbH
--- /dev/null
+.\" Man page for e2rc
+.\"
+.\" (c)2007 emlix GmbH
+.\"
+.TH e2rc 5 "Dec 12, 2012" "@VERSION@"
+
+.SH NAME
+e2rc \- per user default argument settings
+
+.SH DESCRIPTION
+The optional file \fB$HOME/.e2/e2rc\fR allows setting of
+command-line arguments to each call of a e2factory tool.
+Arguments given on the command line override arguments specified in
+\fBe2rc\fR.
+
+.SH STRUCTURE
+The file has following structure:
+.nf
+
+ e2rc {
+ { "<argument>", "<value>" },
+ { "<argument>" },
+ ...
+ }
+.fi
+
+.SH KEYS
+
+.TP
+.BR argument
+Type: String
+.br
+Name of the command-line argument to be set in each call to a e2factory command.
+
+.TP
+.BR value
+Type: String
+.br
+Value of the argument, if omitted \fBtrue\fR is assumed.
+
+.SH EXAMPLE
+.nf
+
+ e2rc {
+ { "debug" }
+ }
+.fi
+
+.SH "SEE ALSO"
+.BR e2factory(1)
+
+.SH COPYRIGHT
+(c)2013 emlix GmbH
\ No newline at end of file
--- /dev/null
+.\" Man page for e2result
+.\"
+.\" (c)2007, 2012 emlix GmbH
+.\"
+.TH e2result 5 "Oct 29, 2012" "@VERSION@"
+
+.SH NAME
+res/*/config \- result configuration files of an e2factory project
+
+.SH DESCRIPTION
+The mandatory files \fBres/<dir>/config\fR configure results to be built. The name of
+the directory \fB<dir>\fR defines the result-name.
+In case of sub-directories, all directories below \fBres/\fR do form the
+result-name separated by dots.
+.br
+e.g.:
+\fBres/<name1>/<name2>/config\fR leads to result name: \fB<name1>.<name2>\fR.
+
+.SH STRUCTURE
+The file has following structure:
+.nf
+
+e2result {
+ chroot = {
+ "<string>",
+ ...
+ },
+ depends = {
+ "<string>",
+ ...
+ },
+ env = {
+ ["<variable name>"] = "<variable value>",
+ ...
+ },
+ sources = {
+ "<string>",
+ ...
+ },
+}
+.fi
+
+.SH KEYS
+
+.TP
+.BR chroot
+Type: Table of strings
+.br
+chroot(s) that should be used during build process.
+
+.TP
+.BR depends
+Type: Table of strings
+.br
+Result(s) that should be available during build process.
+
+.TP
+.BR env
+Type: Table
+.br
+List of environment variables and values separated by \fB=\fR. The variables are available during the build process.
+
+.TP
+.BR sources
+Type: Table of strings
+.br
+Source(s) that should be available during build process.
+
+.SH "SEE ALSO"
+.BR e2factory(1)
+
+.SH COPYRIGHT
+(c)2013 emlix GmbH
--- /dev/null
+.\" Man page for e2source
+.\"
+.\" (c)2007, 2012 emlix GmbH
+.\"
+.TH e2source 5 "Oct 29, 2012" "@VERSION@"
+
+.SH NAME
+src/*/config \- source configuration files of an e2factory project
+
+.SH DESCRIPTION
+The mandatory files \fBsrc/<dir>/config\fR configure sources to be used when building results. The name of
+the directory \fB<dir>\fR defines the source-name.
+In case of sub-directories, all directories below \fBsrc/\fR do form the
+source-name separated by dots.
+.br
+e.g.:
+\fBsrc/<name1>/<name2>/config\fR leads to source name: \fB<name1>.<name2>\fR.
+.br
+Sources could either refer to files (including archives), git repositories or subversion repositories.
+
+.SH STRUCTURE (file)
+The files have following structure, if referring to files:
+.nf
+
+e2source {
+ licences = {
+ "<string>",
+ ...
+ },
+ env = {
+ ["<variable name>"] = "<variable value>",
+ ...
+ },
+ type = "file",
+ server = "<string>",
+ file = {
+ { licences = {"<string>", ...},
+ server = "<string>",
+ location = "<string>",
+ sha1 = "<string>",
+ copy = "<string>",
+ patch = "<string>",
+ unpack = "<string>", },
+ ...
+ },
+}
+.fi
+
+.SH KEYS (file)
+
+.TP
+.BR licences
+(on source level)
+.br
+Type: Table of strings
+.br
+Name(s) of the licence(s) that apply to the source.
+
+.TP
+.BR env
+Type: Table
+.br
+List of environment variables and values separated by \fB=\fR. The variables are available during the build process.
+
+.TP
+.BR type
+Type: String
+.br
+Defines the type of the source. In case of file sources always \fBfile\fR, defaults to \fBfile\fR if
+omitted.
+
+.TP
+.BR server
+(on source level)
+.br
+Type: String
+.br
+Name of the server the source file is stored on.
+
+.TP
+.BR file
+Type: Table
+.br
+List of files belonging to the source.
+
+.TP
+.BR licences
+(on file level)
+.br
+Type: Table of strings
+.br
+Name of the licence(s) that apply to this specific file, defaults to
+licences on source level, if omitted.
+
+.TP
+.BR server
+(on file level)
+.br
+Type: String
+.br
+Server that stores the file. If not given, server on source level is used.
+
+.TP
+.BR location
+Type: String
+.br
+Path of the file on server.
+
+.TP
+.BR sha1
+Type: String
+.br
+SHA-1 check-sum of the file.
+
+.TP
+.BR copy
+Type: String
+.br
+The file is copied to directory defined in string during build preparation. Mutual exclusive to
+\fBpatch\fR and \fBunpack\fR.
+
+.TP
+.BR patch
+Type: String
+.br
+The file is applied as a patch. The string is treated as an argument to the "-p"
+argument. Mutual exclusive to \fBcopy\fR and \fBunpack\fR.
+
+.TP
+.BR unpack
+Type: String
+.br
+The file is an archive (tarball) it is unpacked and a link pointing to the directory
+defined in string is created. Name of the link equals source-name. Mutual exclusive
+to \fBcopy\fR and \fBpatch\fR.
+
+
+
+
+.SH STRUCTURE (git)
+The files have following structure if referring to git repositories:
+.nf
+
+e2source {
+ licences = {
+ "<string>",
+ ...
+ },
+ env = {
+ ["<variable name>"] = "<variable value>",
+ ...
+ },
+ type = "git",
+ server = "<string>",
+ location = "<string>",
+ branch = "<string>",
+ tag = "<string>",
+ working = "<string>",
+}
+.fi
+
+.SH KEYS (git)
+
+.TP
+.BR licences
+Type: Table of strings
+.br
+Name of the licence(s) that apply to the source.
+
+.TP
+.BR env
+Type: Table
+.br
+List of environment variables and values separated by \fB=\fR. The variables are available during the build process.
+
+.TP
+.BR type
+Type: String
+.br
+Defines the type of the source in case of git, always "git".
+
+.TP
+.BR server
+.br
+Type: String
+.br
+Name of the server the git repository is stored on.
+
+.TP
+.BR location
+Type: String
+.br
+Path of the git repository on server.
+
+.TP
+.BR branch
+Type: String
+.br
+Name of the git branch.
+
+.TP
+.BR tag
+Type: String
+.br
+Name of the git tag.
+
+.TP
+.BR working
+Type: String
+.br
+Path to the working directory.
+
+
+.SH STRUCTURE (subversion)
+The files have following structure if referring to subversion (svn) repositories:
+.nf
+
+e2source {
+ licences = {
+ "<string>",
+ ...
+ },
+ env = {
+ ["<variable name>"] = "<variable value>",
+ ...
+ },
+ type = "svn",
+ server = "<string>",
+ location = "<string>",
+ branch = "<string>",
+ tag = "<string>",
+ working = "<string>",
+}
+.fi
+
+.SH KEYS (subversion)
+
+.TP
+.BR licences
+Type: Table of strings
+.br
+Name of the licence(s) that apply to the source.
+
+.TP
+.BR env
+Type: Table
+.br
+List of environment variables and values separated by \fB=\fR. The variables are available during the build process.
+
+.TP
+.BR type
+Type: String
+.br
+Defines the type of the source in case of subversion, always "svn".
+
+.TP
+.BR server
+.br
+Type: String
+.br
+Name of the server the subversion repository is stored on.
+
+.TP
+.BR location
+Type: String
+.br
+Path of the subversion repository on server.
+
+.TP
+.BR branch
+Type: String
+.br
+Name of the subversion branch directory.
+
+.TP
+.BR tag
+Type: String
+.br
+Name of the subversion tag directory.
+
+.TP
+.BR working
+Type: String
+.br
+Path to the working directory.
+
+.TP
+.BR workingcopy_subdir
+Type: String
+.br
+Path to the directory to be used in working copy mode.
+
+.SH "SEE ALSO"
+.BR e2factory(1)
+
+.SH COPYRIGHT
+(c)2013 emlix GmbH
projects / e2factory.git / commitdiff