blob: 136b4df964ac033c80a0cd0c26982ae00004acc8 [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; ] >
Andrew Geisslerd25ed322020-06-27 00:28:28 -05004<!--SPDX-License-Identifier: CC-BY-2.0-UK-->
Patrick Williamsc124f4f2015-09-15 14:41:29 -05005
6<book id='toaster-manual' lang='en'
7 xmlns:xi="http://www.w3.org/2003/XInclude"
8 xmlns="http://docbook.org/ns/docbook"
9 >
10 <bookinfo>
11
12 <mediaobject>
13 <imageobject>
14 <imagedata fileref='figures/toaster-title.png'
15 format='SVG'
16 align='left' scalefit='1' width='100%'/>
17 </imageobject>
18 </mediaobject>
19
20 <title>
21 Toaster User Manual
22 </title>
23
24 <authorgroup>
25 <author>
Patrick Williamsc124f4f2015-09-15 14:41:29 -050026 <affiliation>
Andrew Geissler82c905d2020-04-13 13:39:40 -050027 <orgname>&ORGNAME;</orgname>
Patrick Williamsc124f4f2015-09-15 14:41:29 -050028 </affiliation>
Andrew Geissler82c905d2020-04-13 13:39:40 -050029 <email>&ORGEMAIL;</email>
Patrick Williamsc124f4f2015-09-15 14:41:29 -050030 </author>
31 </authorgroup>
32
33 <revhistory>
34 <revision>
35 <revnumber>1.8</revnumber>
36 <date>April 2015</date>
Andrew Geissler82c905d2020-04-13 13:39:40 -050037 <revremark>The initial document released with the Yocto Project 1.8 Release.</revremark>
Patrick Williamsc124f4f2015-09-15 14:41:29 -050038 </revision>
39 <revision>
Patrick Williamsf1e5d692016-03-30 15:21:19 -050040 <revnumber>2.0</revnumber>
Patrick Williamsc124f4f2015-09-15 14:41:29 -050041 <date>October 2015</date>
Patrick Williamsf1e5d692016-03-30 15:21:19 -050042 <revremark>Released with the Yocto Project 2.0 Release.</revremark>
Patrick Williamsc124f4f2015-09-15 14:41:29 -050043 </revision>
Patrick Williamsd8c66bc2016-06-20 12:57:21 -050044 <revision>
45 <revnumber>2.1</revnumber>
46 <date>April 2016</date>
47 <revremark>Released with the Yocto Project 2.1 Release.</revremark>
48 </revision>
Patrick Williamsc0f7c042017-02-23 20:41:17 -060049 <revision>
50 <revnumber>2.2</revnumber>
51 <date>October 2016</date>
52 <revremark>Released with the Yocto Project 2.2 Release.</revremark>
53 </revision>
Brad Bishop37a0e4d2017-12-04 01:01:44 -050054 <revision>
Brad Bishop6e60e8b2018-02-01 10:27:11 -050055 <revnumber>2.3</revnumber>
56 <date>May 2017</date>
57 <revremark>Released with the Yocto Project 2.3 Release.</revremark>
Brad Bishop37a0e4d2017-12-04 01:01:44 -050058 </revision>
59 <revision>
Brad Bishopd7bf8c12018-02-25 22:55:05 -050060 <revnumber>2.4</revnumber>
61 <date>October 2017</date>
62 <revremark>Released with the Yocto Project 2.4 Release.</revremark>
Brad Bishop6e60e8b2018-02-01 10:27:11 -050063 </revision>
64 <revision>
Brad Bishop316dfdd2018-06-25 12:45:53 -040065 <revnumber>2.5</revnumber>
66 <date>May 2018</date>
67 <revremark>Released with the Yocto Project 2.5 Release.</revremark>
Brad Bishop37a0e4d2017-12-04 01:01:44 -050068 </revision>
Brad Bishopd5ae7d92018-06-14 09:52:03 -070069 <revision>
Brad Bishop1a4b7ee2018-12-16 17:11:34 -080070 <revnumber>2.6</revnumber>
71 <date>November 2018</date>
72 <revremark>Released with the Yocto Project 2.6 Release.</revremark>
Brad Bishopd5ae7d92018-06-14 09:52:03 -070073 </revision>
Brad Bishopf86d0552018-12-04 14:18:15 -080074 <revision>
Brad Bishop19323692019-04-05 15:28:33 -040075 <revnumber>2.7</revnumber>
Brad Bishopc342db32019-05-15 21:57:59 -040076 <date>May 2019</date>
Brad Bishop19323692019-04-05 15:28:33 -040077 <revremark>Released with the Yocto Project 2.7 Release.</revremark>
Brad Bishopf86d0552018-12-04 14:18:15 -080078 </revision>
Brad Bishopc342db32019-05-15 21:57:59 -040079 <revision>
Brad Bishop64c979e2019-11-04 13:55:29 -050080 <revnumber>3.0</revnumber>
Andrew Geissler82c905d2020-04-13 13:39:40 -050081 <date>October 2019</date>
Brad Bishop64c979e2019-11-04 13:55:29 -050082 <revremark>Released with the Yocto Project 3.0 Release.</revremark>
Brad Bishopc342db32019-05-15 21:57:59 -040083 </revision>
Andrew Geissler82c905d2020-04-13 13:39:40 -050084 <revision>
85 <revnumber>3.1</revnumber>
86 <date>&REL_MONTH_YEAR;</date>
87 <revremark>Released with the Yocto Project 3.1 Release.</revremark>
88 </revision>
Patrick Williamsc124f4f2015-09-15 14:41:29 -050089 </revhistory>
90
91 <copyright>
92 <year>&COPYRIGHT_YEAR;</year>
93 <holder>Linux Foundation</holder>
94 </copyright>
95
96 <legalnotice>
97 <para>
98 Permission is granted to copy, distribute and/or modify this document under
99 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.
100 </para>
Brad Bishop6e60e8b2018-02-01 10:27:11 -0500101 <note><title>Manual Notes</title>
102 <itemizedlist>
103 <listitem><para>
Brad Bishopd7bf8c12018-02-25 22:55:05 -0500104 This version of the
105 <emphasis>Toaster User Manual</emphasis>
106 is for the &YOCTO_DOC_VERSION; release of the
107 Yocto Project.
108 To be sure you have the latest version of the manual
Brad Bishop316dfdd2018-06-25 12:45:53 -0400109 for this release, go to the
Andrew Geissler82c905d2020-04-13 13:39:40 -0500110 <ulink url='&YOCTO_DOCS_URL;'>Yocto Project documentation page</ulink>
Brad Bishop316dfdd2018-06-25 12:45:53 -0400111 and select the manual from that site.
112 Manuals from the site are more up-to-date than manuals
113 derived from the Yocto Project released TAR files.
Brad Bishop6e60e8b2018-02-01 10:27:11 -0500114 </para></listitem>
115 <listitem><para>
Brad Bishop316dfdd2018-06-25 12:45:53 -0400116 If you located this manual through a web search, the
117 version of the manual might not be the one you want
118 (e.g. the search might have returned a manual much
119 older than the Yocto Project version with which you
120 are working).
121 You can see all Yocto Project major releases by
122 visiting the
123 <ulink url='&YOCTO_WIKI_URL;/wiki/Releases'>Releases</ulink>
124 page.
125 If you need a version of this manual for a different
126 Yocto Project release, visit the
Andrew Geissler82c905d2020-04-13 13:39:40 -0500127 <ulink url='&YOCTO_DOCS_URL;'>Yocto Project documentation page</ulink>
Brad Bishop316dfdd2018-06-25 12:45:53 -0400128 and select the manual set by using the
129 "ACTIVE RELEASES DOCUMENTATION" or "DOCUMENTS ARCHIVE"
130 pull-down menus.
131 </para></listitem>
Andrew Geissler82c905d2020-04-13 13:39:40 -0500132 <listitem>
133 <para>
Brad Bishop316dfdd2018-06-25 12:45:53 -0400134 To report any inaccuracies or problems with this
Andrew Geissler82c905d2020-04-13 13:39:40 -0500135 (or any other Yocto Project) manual, send an email to
136 the Yocto Project documentation mailing list at
137 <filename>docs@lists.yoctoproject.org</filename> or
138 log into the freenode <filename>#yocto</filename> channel.
139 </para>
140 </listitem>
Brad Bishop6e60e8b2018-02-01 10:27:11 -0500141 </itemizedlist>
142 </note>
Patrick Williamsc124f4f2015-09-15 14:41:29 -0500143
144 </legalnotice>
145
146 </bookinfo>
147
148 <xi:include href="toaster-manual-intro.xml"/>
149
150 <xi:include href="toaster-manual-start.xml"/>
151
152 <xi:include href="toaster-manual-setup-and-use.xml"/>
153
154 <xi:include href="toaster-manual-reference.xml"/>
155
156</book>
157<!--
158vim: expandtab tw=80 ts=4
159-->