doc: Start writing some in-tree documentation
[petitboot] / doc / func / user_interface.rst
1 User Interface
2 ==============
3
4 There are two UI implementations but in practice the ncurses client `petitboot-nc` is the primary interface.
5
6 The default view includes a list of discovered boot options and links to other sub screens.
7 Common shortcuts include:
8
9 ======== =====================================
10 Shortcut
11 ======== =====================================
12 i        Open the System Information screen
13 e        View/Edit a boot option details
14 g        View the status update log
15 l        Open the Language screen
16 c        Open the System Configuration screen
17 n        Create/Edit a boot option
18 h        Show help text for the current screen
19 x        Exit to the shell
20 Ctrl-L   Refresh/Redraw the display
21 ======== =====================================
22
23 System Information
24 ------------------
25
26 Provides an overview of the system, in particular discovered partitions and network interfaces. Depending on the platform can also include information on firmware versions, BMC information, etc.
27
28 System Configuration
29 --------------------
30
31 The primary method to configure Petitboot. From here the user can configure the :ref:`auto-boot` order, network interface behaviour, :ref:`snapshots` settings, and handle platform-specific options like :ref:`ipmi` overrides and default consoles.
32
33 Boot Option Editor
34 ------------------
35
36 The boot option editor displays the source device and boot resources for a given option. All fields are editable; paths are relative to the source device or full URLs for remote resources.
37
38 Status Log
39 ----------
40
41 The status log keeps a running log of all status updates that normally appear in the bottom line of the interface.
42
43 Plugin Menu
44 -----------
45
46 The plugin menu displays a list of all known :ref:`plugins` and whether they are installed or not. "Enter" installs a plugin, and "e" on an installed interface enters a detailed view of the plugin from which a user can run the plugin.
47
48 Shell
49 -----
50
51 At any time the user may drop to a shell by exiting the UI, depending on how Petitboot has been built. This is usually a relatively feature-ful ``sh`` shell with Busybox utilities but Petitboot doesn't make any particular guarantees about available tools aside from those it uses itself.