summaryrefslogtreecommitdiffstats
path: root/bitbake/doc/bitbake.1
diff options
context:
space:
mode:
Diffstat (limited to 'bitbake/doc/bitbake.1')
-rw-r--r--bitbake/doc/bitbake.1142
1 files changed, 142 insertions, 0 deletions
diff --git a/bitbake/doc/bitbake.1 b/bitbake/doc/bitbake.1
new file mode 100644
index 0000000..15a7f20
--- /dev/null
+++ b/bitbake/doc/bitbake.1
@@ -0,0 +1,142 @@
1.\" Hey, EMACS: -*- nroff -*-
2.\" First parameter, NAME, should be all caps
3.\" Second parameter, SECTION, should be 1-8, maybe w/ subsection
4.\" other parameters are allowed: see man(7), man(1)
5.TH BITBAKE 1 "November 19, 2006"
6.\" Please adjust this date whenever revising the manpage.
7.\"
8.\" Some roff macros, for reference:
9.\" .nh disable hyphenation
10.\" .hy enable hyphenation
11.\" .ad l left justify
12.\" .ad b justify to both left and right margins
13.\" .nf disable filling
14.\" .fi enable filling
15.\" .br insert line break
16.\" .sp <n> insert n+1 empty lines
17.\" for manpage-specific macros, see man(7)
18.SH NAME
19BitBake \- simple tool for the execution of tasks
20.SH SYNOPSIS
21.B bitbake
22.RI [ options ] " packagenames"
23.br
24.SH DESCRIPTION
25This manual page documents briefly the
26.B bitbake
27command.
28.PP
29.\" TeX users may be more comfortable with the \fB<whatever>\fP and
30.\" \fI<whatever>\fP escape sequences to invode bold face and italics,
31.\" respectively.
32\fBbitbake\fP is a program that executes the specified task (default is 'build')
33for a given set of BitBake files.
34.br
35It expects that BBFILES is defined, which is a space separated list of files to
36be executed. BBFILES does support wildcards.
37.br
38Default BBFILES are the .bb files in the current directory.
39.SH OPTIONS
40This program follow the usual GNU command line syntax, with long
41options starting with two dashes (`-').
42.TP
43.B \-h, \-\-help
44Show summary of options.
45.TP
46.B \-\-version
47Show version of program.
48.TP
49.B \-bBUILDFILE, \-\-buildfile=BUILDFILE
50execute the task against this .bb file, rather than a package from BBFILES.
51.TP
52.B \-k, \-\-continue
53continue as much as possible after an error. While the target that failed, and
54those that depend on it, cannot be remade, the other dependencies of these
55targets can be processed all the same.
56.TP
57.B \-a, \-\-tryaltconfigs
58continue with builds by trying to use alternative providers where possible.
59.TP
60.B \-f, \-\-force
61force run of specified cmd, regardless of stamp status
62.TP
63.B \-i, \-\-interactive
64drop into the interactive mode also called the BitBake shell.
65.TP
66.B \-cCMD, \-\-cmd=CMD
67Specify task to execute. Note that this only executes the specified task for
68the providee and the packages it depends on, i.e. 'compile' does not implicitly
69call stage for the dependencies (IOW: use only if you know what you are doing).
70Depending on the base.bbclass a listtasks task is defined and will show
71available tasks.
72.TP
73.B \-rFILE, \-\-read=FILE
74read the specified file before bitbake.conf
75.TP
76.B \-v, \-\-verbose
77output more chit-chat to the terminal
78.TP
79.B \-D, \-\-debug
80Increase the debug level. You can specify this more than once.
81.TP
82.B \-n, \-\-dry-run
83don't execute, just go through the motions
84.TP
85.B \-p, \-\-parse-only
86quit after parsing the BB files (developers only)
87.TP
88.B \-s, \-\-show-versions
89show current and preferred versions of all packages
90.TP
91.B \-e, \-\-environment
92show the global or per-package environment (this is what used to be bbread)
93.TP
94.B \-g, \-\-graphviz
95emit the dependency trees of the specified packages in the dot syntax
96.TP
97.B \-IIGNORED\_DOT\_DEPS, \-\-ignore-deps=IGNORED_DOT_DEPS
98Stop processing at the given list of dependencies when generating dependency
99graphs. This can help to make the graph more appealing
100.TP
101.B \-lDEBUG_DOMAINS, \-\-log-domains=DEBUG_DOMAINS
102Show debug logging for the specified logging domains
103.TP
104.B \-P, \-\-profile
105profile the command and print a report
106.TP
107.B \-uUI, \-\-ui=UI
108User interface to use. Currently, hob, depexp, goggle or ncurses can be specified as UI.
109.TP
110.B \-tSERVERTYPE, \-\-servertype=SERVERTYPE
111Choose which server to use, none, process or xmlrpc.
112.TP
113.B \-\-revisions-changed
114Set the exit code depending on whether upstream floating revisions have changed or not.
115.TP
116.B \-\-server-only
117Run bitbake without UI, the frontend can connect with bitbake server itself.
118.TP
119.B \-BBIND, \-\-bind=BIND
120The name/address for the bitbake server to bind to.
121.TP
122.B \-\-no\-setscene
123Do not run any setscene tasks, forces builds.
124
125.SH ENVIRONMENT VARIABLES
126bitbake uses the following environment variables to control its
127operation:
128.TP
129.B BITBAKE_UI
130The bitbake user interface; overridden by the \fB-u\fP commandline option.
131
132.SH AUTHORS
133BitBake was written by
134Phil Blundell,
135Holger Freyther,
136Chris Larson,
137Mickey Lauer,
138Richard Purdie,
139Holger Schurig
140.PP
141This manual page was written by Marcin Juszkiewicz <marcin@hrw.one.pl>
142for the Debian project (but may be used by others).