Differences
This shows you the differences between two versions of the page.
| Both sides previous revision Previous revision Next revision | Previous revision | ||
|
cmd:console [2015/09/11 10:36] mcb30 |
cmd:console [2021/02/18 01:26] (current) mcb30 |
||
|---|---|---|---|
| Line 1: | Line 1: | ||
| - | ====== Configure console ====== | + | ====== Configure graphical console ====== |
| ===== Synopsis ===== | ===== Synopsis ===== | ||
| Line 31: | Line 31: | ||
| Configure the console with the specified width, height, margins, colour depth, and background picture. All distances are specified in pixels. The width, height, and colour depth are specified as minimum requirements; the actual values used may be higher than specified. If a background picture is used then the width and height may be omitted; the console size will then be chosen based on the size of the background picture. | Configure the console with the specified width, height, margins, colour depth, and background picture. All distances are specified in pixels. The width, height, and colour depth are specified as minimum requirements; the actual values used may be higher than specified. If a background picture is used then the width and height may be omitted; the console size will then be chosen based on the size of the background picture. | ||
| - | The background picture will be discarded after configuring the console unless the ''--keep'' option is specified. | + | The background picture will be discarded after configuring the console unless the ''%%--keep%%'' option is specified. |
| Any non-zero margins are treated as being relative to the specified minimum width and height. | Any non-zero margins are treated as being relative to the specified minimum width and height. | ||
| Line 53: | Line 53: | ||
| This command is available only when the build option ''[[:buildcfg:CONSOLE_CMD]]'' is enabled. | This command is available only when the build option ''[[:buildcfg:CONSOLE_CMD]]'' is enabled. | ||
| - | Support for graphical consoles is available only when the relevant build options (e.g. ''[[:buildcfg:CONSOLE_VESAFB]]'' for the VESA framebuffer console) are enabled. | + | Support for graphical consoles is available only when the relevant build options (e.g. ''[[:buildcfg:CONSOLE_FRAMEBUFFER]]'' for the graphical framebuffer console) are enabled. |
| Support for background pictures is available only when the relevant build options (e.g. ''[[:buildcfg:IMAGE_PNG]]'' for PNG images) are enabled. | Support for background pictures is available only when the relevant build options (e.g. ''[[:buildcfg:IMAGE_PNG]]'' for PNG images) are enabled. | ||
| Line 61: | Line 61: | ||
| You can use the ''console'' command (with no options) to reset the console and clear the screen. | You can use the ''console'' command (with no options) to reset the console and clear the screen. | ||
| - | To select the VESA framebuffer console you must either specify a width and height, or specify a background picture. | + | To select the graphical framebuffer console you must either specify a width and height, or specify a background picture. |
| You can use the margins to define a text area within a background picture. For example, you could place your company logo in the top right corner, and specify a top margin to ensure that iPXE's text does not overwrite your logo. | You can use the margins to define a text area within a background picture. For example, you could place your company logo in the top right corner, and specify a top margin to ensure that iPXE's text does not overwrite your logo. | ||
