diff options
Diffstat (limited to 'bitbake/doc/bitbake.1')
| -rw-r--r-- | bitbake/doc/bitbake.1 | 117 |
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 | ||
| 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 seperated 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 \-f, \-\-force | ||
| 58 | force run of specified cmd, regardless of stamp status | ||
| 59 | .TP | ||
| 60 | .B \-i, \-\-interactive | ||
| 61 | drop into the interactive mode also called the BitBake shell. | ||
| 62 | .TP | ||
| 63 | .B \-cCMD, \-\-cmd=CMD | ||
| 64 | Specify task to execute. Note that this only executes the specified task for | ||
| 65 | the providee and the packages it depends on, i.e. 'compile' does not implicitly | ||
| 66 | call stage for the dependencies (IOW: use only if you know what you are doing). | ||
| 67 | Depending on the base.bbclass a listtaks tasks is defined and will show | ||
| 68 | available tasks. | ||
| 69 | .TP | ||
| 70 | .B \-rFILE, \-\-read=FILE | ||
| 71 | read the specified file before bitbake.conf | ||
| 72 | .TP | ||
| 73 | .B \-v, \-\-verbose | ||
| 74 | output more chit-chat to the terminal | ||
| 75 | .TP | ||
| 76 | .B \-D, \-\-debug | ||
| 77 | Increase the debug level. You can specify this more than once. | ||
| 78 | .TP | ||
| 79 | .B \-n, \-\-dry-run | ||
| 80 | don't execute, just go through the motions | ||
| 81 | .TP | ||
| 82 | .B \-p, \-\-parse-only | ||
| 83 | quit after parsing the BB files (developers only) | ||
| 84 | .TP | ||
| 85 | .B \-d, \-\-disable-psyco | ||
| 86 | disable using the psyco just-in-time compiler (not recommended) | ||
| 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-package 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 | .\" | ||
| 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 | ||
| 108 | BitBake was written by | ||
| 109 | Phil Blundell, | ||
| 110 | Holger Freyther, | ||
| 111 | Chris Larson, | ||
| 112 | Mickey Lauer, | ||
| 113 | Richard Purdie, | ||
| 114 | Holger Schurig | ||
| 115 | .PP | ||
| 116 | This manual page was written by Marcin Juszkiewicz <marcin@hrw.one.pl> | ||
| 117 | for the Debian project (but may be used by others). | ||
