xref: /illumos-gate/usr/src/man/man5/menu.lst.5 (revision e3ae4b35c024af1196582063ecee3ab79367227d)
1.\"
2.\" This file and its contents are supplied under the terms of the
3.\" Common Development and Distribution License ("CDDL"), version 1.0.
4.\" You may only use this file in accordance with the terms of version
5.\" 1.0 of the CDDL.
6.\"
7.\" A full copy of the text of the CDDL should have accompanied this
8.\" source.  A copy of the CDDL is also available via the Internet at
9.\" http://www.illumos.org/license/CDDL.
10.\"
11.\"
12.\" Copyright 2023 Toomas Soome <tsoome@me.com>
13.\"
14.Dd March 30, 2023
15.Dt MENU.LST 5
16.Os
17.Sh NAME
18.Nm menu.lst
19.Nd List of entries for boot menu
20.Sh SYNOPSIS
21.Pa <pool>/boot/menu.lst
22.Pp
23.Pa /boot/menu.lst
24.Sh DESCRIPTION
25This file contains the list of menu entries for use by boot loader.
26The location is either root dataset of boot zfs pool or
27.Pa /boot
28directory of root file system.
29.Nm
30is created automatically by
31.Xr beadm 8 ,
32and can be managed by
33.Xr bootadm 8 .
34.Pp
35Each menu entry in
36.Nm
37consists of two lines:
38.Pp
39.Dl Sy title Ar name
40.Dl Ar type Ar data
41.Pp
42Where first line will set name for the menu entry and second line
43will declare the type and type specific data for boot menu entry.
44.Pp
45Currently accepted types are:
46.Bl -tag -width Ds
47.It Sy bootfs
48to specify the name or location of the boot file system.
49.It Sy chain
50to specify device or file to be used with
51.Xr loader 7
52.Sy chain
53command.
54.El
55.Pp
56The boot file system name could be either the name of zfs dataset or
57the device name in case of
58.Xr ufs 4fs ,
59.Xr pcfs 4fs ,
60or other currently supported disk based file system.
61.Pp
62Device name for
63.Sy chain
64command must use the form
65.Pp
66.Dl diskN[pX]: or diskN[sXpY]:
67.Dl zfs:pool/dataset:
68.Pp
69See output of loader
70.Cm lsdev Fl v
71command for available device names.
72.Sh FILES
73.Pa <pool>/boot/menu.lst
74.Pp
75.Pa /boot/menu.lst
76.Sh EXAMPLES
77A sample
78.Nm
79file.
80.Bd -literal -offset indent
81title Disk1:
82chain disk1:
83title Disk2_UFS
84bootfs disk2s1a:
85title openindiana-2023:01:03
86bootfs rpool/ROOT/openindiana-2023:01:03
87.Ed
88.Sh SEE ALSO
89.Xr pcfs 4fs ,
90.Xr ufs 4fs ,
91.Xr loader 7 ,
92.Xr beadm 8 ,
93.Xr bootadm 8
94