| Patrick Williams | c124f4f | 2015-09-15 14:41:29 -0500 | [diff] [blame] | 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 |
| 19 | BitBake \- simple tool for the execution of tasks |
| 20 | .SH SYNOPSIS |
| 21 | .B bitbake |
| 22 | .RI [ options ] " packagenames" |
| 23 | .br |
| 24 | .SH DESCRIPTION |
| 25 | This manual page documents briefly the |
| 26 | .B bitbake |
| 27 | command. |
| 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') |
| 33 | for a given set of BitBake files. |
| 34 | .br |
| 35 | It expects that BBFILES is defined, which is a space separated list of files to |
| 36 | be executed. BBFILES does support wildcards. |
| 37 | .br |
| 38 | Default BBFILES are the .bb files in the current directory. |
| 39 | .SH OPTIONS |
| 40 | This program follow the usual GNU command line syntax, with long |
| 41 | options starting with two dashes (`-'). |
| 42 | .TP |
| 43 | .B \-h, \-\-help |
| 44 | Show summary of options. |
| 45 | .TP |
| 46 | .B \-\-version |
| 47 | Show version of program. |
| 48 | .TP |
| 49 | .B \-bBUILDFILE, \-\-buildfile=BUILDFILE |
| 50 | execute the task against this .bb file, rather than a package from BBFILES. |
| 51 | .TP |
| 52 | .B \-k, \-\-continue |
| 53 | continue as much as possible after an error. While the target that failed, and |
| 54 | those that depend on it, cannot be remade, the other dependencies of these |
| 55 | targets can be processed all the same. |
| 56 | .TP |
| 57 | .B \-a, \-\-tryaltconfigs |
| 58 | continue with builds by trying to use alternative providers where possible. |
| 59 | .TP |
| 60 | .B \-f, \-\-force |
| 61 | force run of specified cmd, regardless of stamp status |
| 62 | .TP |
| 63 | .B \-i, \-\-interactive |
| 64 | drop into the interactive mode also called the BitBake shell. |
| 65 | .TP |
| 66 | .B \-cCMD, \-\-cmd=CMD |
| 67 | Specify task to execute. Note that this only executes the specified task for |
| 68 | the providee and the packages it depends on, i.e. 'compile' does not implicitly |
| 69 | call stage for the dependencies (IOW: use only if you know what you are doing). |
| 70 | Depending on the base.bbclass a listtasks task is defined and will show |
| 71 | available tasks. |
| 72 | .TP |
| 73 | .B \-rFILE, \-\-read=FILE |
| 74 | read the specified file before bitbake.conf |
| 75 | .TP |
| 76 | .B \-v, \-\-verbose |
| 77 | output more chit-chat to the terminal |
| 78 | .TP |
| 79 | .B \-D, \-\-debug |
| 80 | Increase the debug level. You can specify this more than once. |
| 81 | .TP |
| 82 | .B \-n, \-\-dry-run |
| 83 | don't execute, just go through the motions |
| 84 | .TP |
| 85 | .B \-p, \-\-parse-only |
| 86 | quit after parsing the BB files (developers only) |
| 87 | .TP |
| 88 | .B \-s, \-\-show-versions |
| 89 | show current and preferred versions of all packages |
| 90 | .TP |
| 91 | .B \-e, \-\-environment |
| 92 | show the global or per-recipe environment (this is what used to be bbread) |
| 93 | .TP |
| 94 | .B \-g, \-\-graphviz |
| 95 | emit the dependency trees of the specified packages in the dot syntax |
| 96 | .TP |
| 97 | .B \-IIGNORED\_DOT\_DEPS, \-\-ignore-deps=IGNORED_DOT_DEPS |
| 98 | Stop processing at the given list of dependencies when generating dependency |
| 99 | graphs. This can help to make the graph more appealing |
| 100 | .TP |
| 101 | .B \-lDEBUG_DOMAINS, \-\-log-domains=DEBUG_DOMAINS |
| 102 | Show debug logging for the specified logging domains |
| 103 | .TP |
| 104 | .B \-P, \-\-profile |
| 105 | profile the command and print a report |
| 106 | .TP |
| 107 | .B \-uUI, \-\-ui=UI |
| 108 | User interface to use. Currently, hob, depexp, goggle or ncurses can be specified as UI. |
| 109 | .TP |
| 110 | .B \-tSERVERTYPE, \-\-servertype=SERVERTYPE |
| 111 | Choose which server to use, none, process or xmlrpc. |
| 112 | .TP |
| 113 | .B \-\-revisions-changed |
| 114 | Set the exit code depending on whether upstream floating revisions have changed or not. |
| 115 | .TP |
| 116 | .B \-\-server-only |
| 117 | Run bitbake without UI, the frontend can connect with bitbake server itself. |
| 118 | .TP |
| 119 | .B \-BBIND, \-\-bind=BIND |
| 120 | The name/address for the bitbake server to bind to. |
| 121 | .TP |
| 122 | .B \-\-no\-setscene |
| 123 | Do not run any setscene tasks, forces builds. |
| 124 | |
| 125 | .SH ENVIRONMENT VARIABLES |
| 126 | bitbake uses the following environment variables to control its |
| 127 | operation: |
| 128 | .TP |
| 129 | .B BITBAKE_UI |
| 130 | The bitbake user interface; overridden by the \fB-u\fP commandline option. |
| 131 | |
| 132 | .SH AUTHORS |
| 133 | BitBake was written by |
| 134 | Phil Blundell, |
| 135 | Holger Freyther, |
| 136 | Chris Larson, |
| 137 | Mickey Lauer, |
| 138 | Richard Purdie, |
| 139 | Holger Schurig |
| 140 | .PP |
| 141 | This manual page was written by Marcin Juszkiewicz <marcin@hrw.one.pl> |
| 142 | for the Debian project (but may be used by others). |