summaryrefslogtreecommitdiffstats
path: root/bitbake/doc/bitbake.1
diff options
context:
space:
mode:
authorRichard Purdie <richard@openedhand.com>2007-01-08 23:53:01 +0000
committerRichard Purdie <richard@openedhand.com>2007-01-08 23:53:01 +0000
commitf5665d5bfcfb13d01da9e4c7d5046453e80f7baf (patch)
treeb8908549afaf3006bf3763419711090ac999c2a4 /bitbake/doc/bitbake.1
parentaec95de5f7dca2afa3a4a0bdb0d4d553c13f680d (diff)
downloadpoky-f5665d5bfcfb13d01da9e4c7d5046453e80f7baf.tar.gz
bitbake: Sync with upstream.
* File licence headers were sanitised causing most of the diff. * cooker.py was created from bin/bitbake. * cvs fetcher port option was added * The -f force option was fixed to work correctly * Multiple entries in rrecrdeps are now handled correctly (allows adding do_deploy to image depends) git-svn-id: https://svn.o-hand.com/repos/poky/trunk@1129 311d38ba-8fff-0310-9ca6-ca027cbcb966
Diffstat (limited to 'bitbake/doc/bitbake.1')
-rw-r--r--bitbake/doc/bitbake.1117
1 files changed, 117 insertions, 0 deletions
diff --git a/bitbake/doc/bitbake.1 b/bitbake/doc/bitbake.1
new file mode 100644
index 0000000000..e6cbe7df0e
--- /dev/null
+++ b/bitbake/doc/bitbake.1
@@ -0,0 +1,117 @@
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 seperated 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 \-f, \-\-force
58force run of specified cmd, regardless of stamp status
59.TP
60.B \-i, \-\-interactive
61drop into the interactive mode also called the BitBake shell.
62.TP
63.B \-cCMD, \-\-cmd=CMD
64Specify task to execute. Note that this only executes the specified task for
65the providee and the packages it depends on, i.e. 'compile' does not implicitly
66call stage for the dependencies (IOW: use only if you know what you are doing).
67Depending on the base.bbclass a listtaks tasks is defined and will show
68available tasks.
69.TP
70.B \-rFILE, \-\-read=FILE
71read the specified file before bitbake.conf
72.TP
73.B \-v, \-\-verbose
74output more chit-chat to the terminal
75.TP
76.B \-D, \-\-debug
77Increase the debug level. You can specify this more than once.
78.TP
79.B \-n, \-\-dry-run
80don't execute, just go through the motions
81.TP
82.B \-p, \-\-parse-only
83quit after parsing the BB files (developers only)
84.TP
85.B \-d, \-\-disable-psyco
86disable using the psyco just-in-time compiler (not recommended)
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.\"
101.\" Next option is only in BitBake 1.7.x (trunk)
102.\"
103.\".TP
104.\".B \-lDEBUG_DOMAINS, \-\-log-domains=DEBUG_DOMAINS
105.\"Show debug logging for the specified logging domains
106
107.SH AUTHORS
108BitBake was written by
109Phil Blundell,
110Holger Freyther,
111Chris Larson,
112Mickey Lauer,
113Richard Purdie,
114Holger Schurig
115.PP
116This manual page was written by Marcin Juszkiewicz <marcin@hrw.one.pl>
117for the Debian project (but may be used by others).