summaryrefslogtreecommitdiff
path: root/man/gummiboot.xml
blob: 4b42ce33db5cc37be7dfe2efcdad633cdb7eaef6 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
<?xml version='1.0'?> <!--*-nxml-*-->
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN"
        "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd">

<!--
  Copyright 2013 Kay Sievers

  gummiboot is free software; you can redistribute it and/or modify it
  under the terms of the GNU Lesser General Public License as published by
  the Free Software Foundation; either version 2.1 of the License, or
  (at your option) any later version.

  systemd is distributed in the hope that it will be useful, but
  WITHOUT ANY WARRANTY; without even the implied warranty of
  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
  Lesser General Public License for more details.

  You should have received a copy of the GNU Lesser General Public License
  along with systemd; If not, see <http://www.gnu.org/licenses/>.
-->

<refentry id="gummiboot">
        <refentryinfo>
                <title>gummiboot</title>
                <productname>gummiboot</productname>

                <authorgroup>
                        <author>
                                <contrib>Developer</contrib>
                                <firstname>Kay</firstname>
                                <surname>Sievers</surname>
                                <email>kay@vrfy.org</email>
                        </author>
                </authorgroup>
        </refentryinfo>

        <refmeta>
                <refentrytitle>gummiboot</refentrytitle>
                <manvolnum>8</manvolnum>
        </refmeta>

        <refnamediv>
                <refname>gummiboot</refname>
                <refpurpose>Setup and manage Gummiboot Boot Manager</refpurpose>
        </refnamediv>

        <refsynopsisdiv>
                <cmdsynopsis>
                        <command>gummiboot <arg choice="opt" rep="repeat">OPTIONS</arg>status</command>
                </cmdsynopsis>
                <cmdsynopsis>
                        <command>gummiboot <arg choice="opt" rep="repeat">OPTIONS</arg>update</command>
                </cmdsynopsis>
                <cmdsynopsis>
                        <command>gummiboot <arg choice="opt" rep="repeat">OPTIONS</arg>install</command>
                </cmdsynopsis>
                <cmdsynopsis>
                        <command>gummiboot <arg choice="opt" rep="repeat">OPTIONS</arg>remove</command>
                </cmdsynopsis>
        </refsynopsisdiv>

        <refsect1>
                <title>Description</title>

                <para><command>gummibot</command> checks, updates,
                installs or removes the boot loader from the current
                system.</para>

                <para><command>gummiboot status</command> checks and prints the
                currently installed versions of the boot loader binaries and the
                all current EFI boot variables.</para>

                <para><command>gummiboot update</command> updates all installed
                versions of gummiboot, if the current version is newer than the
                version installed in the EFI system partition. This also includes
                the EFI default/fallback loader at /EFI/Boot/boot*.efi. An
                gummiboot entry in the EFI boot variables is created, if there
                is no current entry. A created entry will be added to the end of
                the boot order list.</para>

                <para><command>gummiboot install</command> installs gummiboot into
                the EFI system partition. A copy of gummiboot will be stored as
                the EFI default/fallback loader at /EFI/Boot/boot*.efi. An gummiboot
                entry in the EFI boot variables is created and added to the top
                of the boot order list.</para>

                <para><command>gummiboot remove</command> removes all installed
                versions of gummiboot from the EFI system partition, and removes
                gummiboot from the EFI boot variables.</para>

                <para>If no command is passed <command>status</command> is
                implied.</para>
        </refsect1>

        <refsect1>
                <title>Options</title>
                <para>The following options are understood:</para>

                <variablelist>
                        <varlistentry>
                                <term><option>-h</option></term>
                                <term><option>--help</option></term>

                                <listitem><para>Prints a short help
                                text and exits.</para></listitem>
                        </varlistentry>

                        <varlistentry>
                                <term><option>--path</option></term>
                                <listitem><para>Path to the EFI system
                                partition. The default is /boot.</para></listitem>
                        </varlistentry>

                        <varlistentry>
                                <term><option>--no-variables</option></term>
                                <listitem><para>Do not touch the EFI boot
                                variables.</para></listitem>
                        </varlistentry>
                </variablelist>
        </refsect1>

        <refsect1>
                <title>Exit status</title>
                <para>On success 0 is returned, a non-zero failure
                code otherwise.</para>
        </refsect1>

        <refsect1>
                <title>See Also</title>
                <para>
                        <ulink url="http://freedesktop.org/wiki/Software/gummiboot">Gummiboot wiki</ulink>
                        <ulink url="http://www.freedesktop.org/wiki/Specifications/BootLoaderSpec">Boot loader specification</ulink>
                        <ulink url="http://www.freedesktop.org/wiki/Software/systemd/BootLoaderInterface">Systemd boot loader interface</ulink>
                        <citerefentry><refentrytitle>bootctl</refentrytitle><manvolnum>1</manvolnum></citerefentry>
                </para>
        </refsect1>
</refentry>