blob: e6d42452313266a11eff0bbe7ed4cf5554b2a89c [file] [log] [blame]
Patrick Williamsc124f4f2015-09-15 14:41:29 -05001<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN"
2"http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd"
3[<!ENTITY % poky SYSTEM "../poky.ent"> %poky; ] >
4
5<book id='toaster-manual' lang='en'
6 xmlns:xi="http://www.w3.org/2003/XInclude"
7 xmlns="http://docbook.org/ns/docbook"
8 >
9 <bookinfo>
10
11 <mediaobject>
12 <imageobject>
13 <imagedata fileref='figures/toaster-title.png'
14 format='SVG'
15 align='left' scalefit='1' width='100%'/>
16 </imageobject>
17 </mediaobject>
18
19 <title>
20 Toaster User Manual
21 </title>
22
23 <authorgroup>
24 <author>
Patrick Williamsc124f4f2015-09-15 14:41:29 -050025 <affiliation>
Andrew Geissler82c905d2020-04-13 13:39:40 -050026 <orgname>&ORGNAME;</orgname>
Patrick Williamsc124f4f2015-09-15 14:41:29 -050027 </affiliation>
Andrew Geissler82c905d2020-04-13 13:39:40 -050028 <email>&ORGEMAIL;</email>
Patrick Williamsc124f4f2015-09-15 14:41:29 -050029 </author>
30 </authorgroup>
31
32 <revhistory>
33 <revision>
34 <revnumber>1.8</revnumber>
35 <date>April 2015</date>
Andrew Geissler82c905d2020-04-13 13:39:40 -050036 <revremark>The initial document released with the Yocto Project 1.8 Release.</revremark>
Patrick Williamsc124f4f2015-09-15 14:41:29 -050037 </revision>
38 <revision>
Patrick Williamsf1e5d692016-03-30 15:21:19 -050039 <revnumber>2.0</revnumber>
Patrick Williamsc124f4f2015-09-15 14:41:29 -050040 <date>October 2015</date>
Patrick Williamsf1e5d692016-03-30 15:21:19 -050041 <revremark>Released with the Yocto Project 2.0 Release.</revremark>
Patrick Williamsc124f4f2015-09-15 14:41:29 -050042 </revision>
Patrick Williamsd8c66bc2016-06-20 12:57:21 -050043 <revision>
44 <revnumber>2.1</revnumber>
45 <date>April 2016</date>
46 <revremark>Released with the Yocto Project 2.1 Release.</revremark>
47 </revision>
Patrick Williamsc0f7c042017-02-23 20:41:17 -060048 <revision>
49 <revnumber>2.2</revnumber>
50 <date>October 2016</date>
51 <revremark>Released with the Yocto Project 2.2 Release.</revremark>
52 </revision>
Brad Bishop37a0e4d2017-12-04 01:01:44 -050053 <revision>
Brad Bishop6e60e8b2018-02-01 10:27:11 -050054 <revnumber>2.3</revnumber>
55 <date>May 2017</date>
56 <revremark>Released with the Yocto Project 2.3 Release.</revremark>
Brad Bishop37a0e4d2017-12-04 01:01:44 -050057 </revision>
58 <revision>
Brad Bishopd7bf8c12018-02-25 22:55:05 -050059 <revnumber>2.4</revnumber>
60 <date>October 2017</date>
61 <revremark>Released with the Yocto Project 2.4 Release.</revremark>
Brad Bishop6e60e8b2018-02-01 10:27:11 -050062 </revision>
63 <revision>
Brad Bishop316dfdd2018-06-25 12:45:53 -040064 <revnumber>2.5</revnumber>
65 <date>May 2018</date>
66 <revremark>Released with the Yocto Project 2.5 Release.</revremark>
Brad Bishop37a0e4d2017-12-04 01:01:44 -050067 </revision>
Brad Bishopd5ae7d92018-06-14 09:52:03 -070068 <revision>
Brad Bishop1a4b7ee2018-12-16 17:11:34 -080069 <revnumber>2.6</revnumber>
70 <date>November 2018</date>
71 <revremark>Released with the Yocto Project 2.6 Release.</revremark>
Brad Bishopd5ae7d92018-06-14 09:52:03 -070072 </revision>
Brad Bishopf86d0552018-12-04 14:18:15 -080073 <revision>
Brad Bishop19323692019-04-05 15:28:33 -040074 <revnumber>2.7</revnumber>
Brad Bishopc342db32019-05-15 21:57:59 -040075 <date>May 2019</date>
Brad Bishop19323692019-04-05 15:28:33 -040076 <revremark>Released with the Yocto Project 2.7 Release.</revremark>
Brad Bishopf86d0552018-12-04 14:18:15 -080077 </revision>
Brad Bishopc342db32019-05-15 21:57:59 -040078 <revision>
Brad Bishop64c979e2019-11-04 13:55:29 -050079 <revnumber>3.0</revnumber>
Andrew Geissler82c905d2020-04-13 13:39:40 -050080 <date>October 2019</date>
Brad Bishop64c979e2019-11-04 13:55:29 -050081 <revremark>Released with the Yocto Project 3.0 Release.</revremark>
Brad Bishopc342db32019-05-15 21:57:59 -040082 </revision>
Andrew Geissler82c905d2020-04-13 13:39:40 -050083 <revision>
84 <revnumber>3.1</revnumber>
85 <date>&REL_MONTH_YEAR;</date>
86 <revremark>Released with the Yocto Project 3.1 Release.</revremark>
87 </revision>
Patrick Williamsc124f4f2015-09-15 14:41:29 -050088 </revhistory>
89
90 <copyright>
91 <year>&COPYRIGHT_YEAR;</year>
92 <holder>Linux Foundation</holder>
93 </copyright>
94
95 <legalnotice>
96 <para>
97 Permission is granted to copy, distribute and/or modify this document under
98 the terms of the <ulink type="http" url="http://creativecommons.org/licenses/by-sa/2.0/uk/">Creative Commons Attribution-Share Alike 2.0 UK: England &amp; Wales</ulink> as published by Creative Commons.
99 </para>
Brad Bishop6e60e8b2018-02-01 10:27:11 -0500100 <note><title>Manual Notes</title>
101 <itemizedlist>
102 <listitem><para>
Brad Bishopd7bf8c12018-02-25 22:55:05 -0500103 This version of the
104 <emphasis>Toaster User Manual</emphasis>
105 is for the &YOCTO_DOC_VERSION; release of the
106 Yocto Project.
107 To be sure you have the latest version of the manual
Brad Bishop316dfdd2018-06-25 12:45:53 -0400108 for this release, go to the
Andrew Geissler82c905d2020-04-13 13:39:40 -0500109 <ulink url='&YOCTO_DOCS_URL;'>Yocto Project documentation page</ulink>
Brad Bishop316dfdd2018-06-25 12:45:53 -0400110 and select the manual from that site.
111 Manuals from the site are more up-to-date than manuals
112 derived from the Yocto Project released TAR files.
Brad Bishop6e60e8b2018-02-01 10:27:11 -0500113 </para></listitem>
114 <listitem><para>
Brad Bishop316dfdd2018-06-25 12:45:53 -0400115 If you located this manual through a web search, the
116 version of the manual might not be the one you want
117 (e.g. the search might have returned a manual much
118 older than the Yocto Project version with which you
119 are working).
120 You can see all Yocto Project major releases by
121 visiting the
122 <ulink url='&YOCTO_WIKI_URL;/wiki/Releases'>Releases</ulink>
123 page.
124 If you need a version of this manual for a different
125 Yocto Project release, visit the
Andrew Geissler82c905d2020-04-13 13:39:40 -0500126 <ulink url='&YOCTO_DOCS_URL;'>Yocto Project documentation page</ulink>
Brad Bishop316dfdd2018-06-25 12:45:53 -0400127 and select the manual set by using the
128 "ACTIVE RELEASES DOCUMENTATION" or "DOCUMENTS ARCHIVE"
129 pull-down menus.
130 </para></listitem>
Andrew Geissler82c905d2020-04-13 13:39:40 -0500131 <listitem>
132 <para>
Brad Bishop316dfdd2018-06-25 12:45:53 -0400133 To report any inaccuracies or problems with this
Andrew Geissler82c905d2020-04-13 13:39:40 -0500134 (or any other Yocto Project) manual, send an email to
135 the Yocto Project documentation mailing list at
136 <filename>docs@lists.yoctoproject.org</filename> or
137 log into the freenode <filename>#yocto</filename> channel.
138 </para>
139 </listitem>
Brad Bishop6e60e8b2018-02-01 10:27:11 -0500140 </itemizedlist>
141 </note>
Patrick Williamsc124f4f2015-09-15 14:41:29 -0500142
143 </legalnotice>
144
145 </bookinfo>
146
147 <xi:include href="toaster-manual-intro.xml"/>
148
149 <xi:include href="toaster-manual-start.xml"/>
150
151 <xi:include href="toaster-manual-setup-and-use.xml"/>
152
153 <xi:include href="toaster-manual-reference.xml"/>
154
155</book>
156<!--
157vim: expandtab tw=80 ts=4
158-->