Skip to content

Commit e1fac8a

Browse files
committed
Move the Commands section above Options section
For executables which take a verb, we should list the verbs first, and then options which modify those verbs second. The general layout of the man page is from general description to specific details, usually Overview, Commands, Options, Return Value, Examples, References.
1 parent 69d0eb4 commit e1fac8a

File tree

23 files changed

+2784
-2778
lines changed

23 files changed

+2784
-2778
lines changed

man/bootctl.xml

Lines changed: 57 additions & 57 deletions
Original file line numberDiff line numberDiff line change
@@ -37,63 +37,6 @@
3737
current system.</para>
3838
</refsect1>
3939

40-
<refsect1>
41-
<title>Options</title>
42-
<para>The following options are understood:</para>
43-
44-
<variablelist>
45-
<varlistentry>
46-
<term><option>--esp-path=</option></term>
47-
<listitem><para>Path to the EFI System Partition (ESP). If not specified, <filename>/efi/</filename>,
48-
<filename>/boot/</filename>, and <filename>/boot/efi/</filename> are checked in turn. It is
49-
recommended to mount the ESP to <filename>/efi/</filename>, if possible.</para></listitem>
50-
</varlistentry>
51-
52-
<varlistentry>
53-
<term><option>--boot-path=</option></term>
54-
<listitem><para>Path to the Extended Boot Loader partition, as defined in the <ulink
55-
url="https://systemd.io/BOOT_LOADER_SPECIFICATION">Boot Loader Specification</ulink>. If not
56-
specified, <filename>/boot/</filename> is checked. It is recommended to mount the Extended Boot
57-
Loader partition to <filename>/boot/</filename>, if possible.</para></listitem>
58-
</varlistentry>
59-
60-
<varlistentry>
61-
<term><option>-p</option></term>
62-
<term><option>--print-esp-path</option></term>
63-
<listitem><para>This option modifies the behaviour of <command>status</command>. Only prints the path
64-
to the EFI System Partition (ESP) to standard output and exits.</para></listitem>
65-
</varlistentry>
66-
67-
<varlistentry>
68-
<term><option>-x</option></term>
69-
<term><option>--print-boot-path</option></term>
70-
<listitem><para>This option modifies the behaviour of <command>status</command>. Only prints the path
71-
to the Extended Boot Loader partition if it exists, and the path to the ESP otherwise to standard
72-
output and exit. This command is useful to determine where to place boot loader entries, as they are
73-
preferably placed in the Extended Boot Loader partition if it exists and in the ESP otherwise.</para>
74-
75-
<para>Boot Loader Specification Type #1 entries should generally be placed in the directory
76-
<literal>$(bootctl -x)/loader/entries/</literal>. Existence of that directory may also be used as
77-
indication that boot loader entry support is available on the system. Similarly, Boot Loader
78-
Specification Type #2 entries should be placed in the directory <literal>$(bootctl
79-
-x)/EFI/Linux/</literal>.</para>
80-
81-
<para>Note that this option (similar to the <option>--print-booth-path</option> option mentioned
82-
above), is available independently from the boot loader used, i.e. also without
83-
<command>systemd-boot</command> being installed.</para></listitem>
84-
</varlistentry>
85-
86-
<varlistentry>
87-
<term><option>--no-variables</option></term>
88-
<listitem><para>Do not touch the firmware's boot loader list stored in EFI variables.</para></listitem>
89-
</varlistentry>
90-
91-
<xi:include href="standard-options.xml" xpointer="no-pager"/>
92-
<xi:include href="standard-options.xml" xpointer="help"/>
93-
<xi:include href="standard-options.xml" xpointer="version"/>
94-
</variablelist>
95-
</refsect1>
96-
9740
<refsect1>
9841
<title>Commands</title>
9942
<variablelist>
@@ -189,6 +132,63 @@
189132
</variablelist>
190133
</refsect1>
191134

135+
<refsect1>
136+
<title>Options</title>
137+
<para>The following options are understood:</para>
138+
139+
<variablelist>
140+
<varlistentry>
141+
<term><option>--esp-path=</option></term>
142+
<listitem><para>Path to the EFI System Partition (ESP). If not specified, <filename>/efi/</filename>,
143+
<filename>/boot/</filename>, and <filename>/boot/efi/</filename> are checked in turn. It is
144+
recommended to mount the ESP to <filename>/efi/</filename>, if possible.</para></listitem>
145+
</varlistentry>
146+
147+
<varlistentry>
148+
<term><option>--boot-path=</option></term>
149+
<listitem><para>Path to the Extended Boot Loader partition, as defined in the <ulink
150+
url="https://systemd.io/BOOT_LOADER_SPECIFICATION">Boot Loader Specification</ulink>. If not
151+
specified, <filename>/boot/</filename> is checked. It is recommended to mount the Extended Boot
152+
Loader partition to <filename>/boot/</filename>, if possible.</para></listitem>
153+
</varlistentry>
154+
155+
<varlistentry>
156+
<term><option>-p</option></term>
157+
<term><option>--print-esp-path</option></term>
158+
<listitem><para>This option modifies the behaviour of <command>status</command>. Only prints the path
159+
to the EFI System Partition (ESP) to standard output and exits.</para></listitem>
160+
</varlistentry>
161+
162+
<varlistentry>
163+
<term><option>-x</option></term>
164+
<term><option>--print-boot-path</option></term>
165+
<listitem><para>This option modifies the behaviour of <command>status</command>. Only prints the path
166+
to the Extended Boot Loader partition if it exists, and the path to the ESP otherwise to standard
167+
output and exit. This command is useful to determine where to place boot loader entries, as they are
168+
preferably placed in the Extended Boot Loader partition if it exists and in the ESP otherwise.</para>
169+
170+
<para>Boot Loader Specification Type #1 entries should generally be placed in the directory
171+
<literal>$(bootctl -x)/loader/entries/</literal>. Existence of that directory may also be used as
172+
indication that boot loader entry support is available on the system. Similarly, Boot Loader
173+
Specification Type #2 entries should be placed in the directory <literal>$(bootctl
174+
-x)/EFI/Linux/</literal>.</para>
175+
176+
<para>Note that this option (similar to the <option>--print-booth-path</option> option mentioned
177+
above), is available independently from the boot loader used, i.e. also without
178+
<command>systemd-boot</command> being installed.</para></listitem>
179+
</varlistentry>
180+
181+
<varlistentry>
182+
<term><option>--no-variables</option></term>
183+
<listitem><para>Do not touch the firmware's boot loader list stored in EFI variables.</para></listitem>
184+
</varlistentry>
185+
186+
<xi:include href="standard-options.xml" xpointer="no-pager"/>
187+
<xi:include href="standard-options.xml" xpointer="help"/>
188+
<xi:include href="standard-options.xml" xpointer="version"/>
189+
</variablelist>
190+
</refsect1>
191+
192192
<refsect1>
193193
<title>Exit status</title>
194194
<para>On success, 0 is returned, a non-zero failure code otherwise.</para>

0 commit comments

Comments
 (0)