Difference between pages "UEFI Install Guide" and "ConsoleOutput MediaWiki Extension"

(Difference between pages)
 
 
Line 1: Line 1:
This tutorial will show you how to install Funtoo on a UEFI system. UEFI, also known as the [[Wikipedia:Unified Extensible Firmware Interface|Unified Extensible Firmware Interface]], is a new firmware interface that is used on some newer computers as a replacement for the traditional PC BIOS. It has an integrated boot loader, so setting up booting is different. The recommended approach is to follow the [[ Efi Stub guide ]]. Many have reported that they are now unable to boot their system using the other, older method.
+
The ConsoleOutput MediaWiki extension was created by Daniel Robbins to provide highlighting of user input for interactive terminal session blocks. To use it, surround user input with  <tt>&lt;console&gt;</tt> opening and closing tags, and put a <tt>##i##</tt> input code immediately before user input on each line. This will cause all text from the <tt>##i##</tt> point to the end of the line to be in a darker color. The rest of the text will be in a lighter grey, allowing it to be distinguished more easily from user input. Here are other sequences that can be used:
  
This tutorial is meant to be an "overlay" over the Regular Funtoo Installation. Follow the normal installation and only follow steps in this tutorial when dealing with partitioning and configuring the boot loader (GRUB). All steps are otherwise identical to the regular installation process.
+
* <tt>##b##</tt> - highlight the rest of the line in bold.
 +
* <tt>##b## text here ##!b##</tt> - highlight the text between both markers in bold.
 +
* <tt>##i## text here ##!i##</tt> - highlight the text between both markers in a darker color.
  
== What Are We Doing? ==
+
This extension can be further extended to add color support, as desired, and some of the CSS for color support can already be found in the code below.
  
This guide will show you how to set up your UEFI system to load the GRUB boot loader, which will then load your Funtoo Linux kernel and initramfs. This is the "UEFI + GRUB" method as described on the [[Boot Methods]] page.
+
Here are a few examples of the ConsoleOutput extension. First this is how you might typically display {{c|ls}} output, with a particular directory highlighted:
 
+
== First Steps ==
+
 
+
To install Funtoo Linux on a UEFI system, first you need to boot SysRescueCD in UEFI mode. To do this, enable UEFI in your BIOS, and if necessary disable legacy booting. After some fiddling, you should be able to boot SysRescueCD and get a black and white text menu instead of the traditional aqua/cyan-colored menu. The black and white menu indicates that you booted SysRescueCD in UEFI mode. Once you've accomplished this, you're ready to continue with your Funtoo Linux installation and partition your drive. See below for details.
+
 
+
{{fancynote|If the <tt>/sys/firmware/efi</tt> directory exists, then you have successfully booted in EFI mode and will be able to configure your Funtoo system to boot in EFI mode. If the directory doesn't exist, fix this first. It is a requirement for setting up EFI booting.}}
+
 
+
== Partitioning ==
+
 
+
To set up your partitions for UEFI booting, you will create a ~500MB FAT32 partition on <tt>/dev/sda1</tt>, and set it to type <tt>EF00</tt> using <tt>gdisk</tt>.
+
  
 
<console>
 
<console>
Command: ##i##n ↵
+
www@www-smw ~/public_html $ ##i##ls
Partition Number: ##i##1 ↵
+
COPYING  LocalSettings.php    api.php  ##b##extensions##!b##   index.php  maintenance          redirect.php    skins              thumb_handler.php5
First sector: ##i##
+
CREDITS  README                api.php5  images        index.php5  mw-config            redirect.php5  tests              wiki.phtml
Last sector: ##i##+500M ↵
+
FAQ      RELEASE-NOTES-1.19    bin      img_auth.php  languages  opensearch_desc.php  redirect.phtml  thumb.php
Hex Code: ##i##EF00
+
HISTORY  StartProfiler.sample  cache    img_auth.php5  load.php    opensearch_desc.php5  resources      thumb.php5
 +
INSTALL  UPGRADE              docs      includes      load.php5  profileinfo.php      serialized      thumb_handler.php
 +
www@www-smw ~/public_html $ ##i##cd extensions/
 
</console>
 
</console>
  
This partition will serve as your Funtoo <tt>/boot</tt> filesystem as well as the partition that the UEFI firmware can read to load GRUB. Then you will set up swap on <tt>/dev/sda2</tt> and your root filesystem on <tt>/dev/sda3</tt>. To create the FAT32 filesystem, type:
+
And here is how you might display a more detailed example of console output, using colors:
  
<console>
+
{{console|body=
# ##i##mkfs.vfat -F 32 /dev/sda1
+
# ##i##bluetoothctl
</console>
+
[##g##NEW##!g##] Controller 00:02:72:C9:62:65 antec [default]
 
+
##bl##[bluetooth]##!bl### ##i##power on
Your <tt>/etc/fstab</tt> entry for this filesystem will also differ, and will look like this:
+
Changing power on succeeded
 
+
##bl##[bluetooth]##!bl### ##i##agent on
<pre>
+
Agent registered
/dev/sda1 /boot vfat noatime 1 2
+
##bl##[bluetooth]##!bl### ##i##scan on
</pre>
+
Discovery started
 
+
##bl##[bluetooth]##!bl### ##i##devices
== Kernel ==
+
Device 00:1F:20:3D:1E:75 Logitech K760
 
+
##bl##[bluetooth]##!bl### ##i##pair 00:1F:20:3D:1E:75
=== VFAT ===
+
Attempting to pair with 00:1F:20:3D:1E:75
 
+
[##y##CHG##!y##] Device 00:1F:20:3D:1E:75 Connected: yes
Make sure you add VFAT support to your kernel if you are building it manually.
+
##r##[agent]##!r## Passkey: 454358
 
+
##r##[agent]##!r## Passkey: ##i##4##!i##54358
=== EFI Framebuffer ===
+
##r##[agent]##!r## Passkey: ##i##45##!i##4358
 
+
##r##[agent]##!r## Passkey: ##i##454##!i##358
If you have the following option enabled in your kernel, then uvesafb and efifb will not be able to detect the framebuffer:
+
##r##[agent]##!r## Passkey: ##i##4543##!i##58
 
+
##r##[agent]##!r## Passkey: ##i##45435##!i##8
{{kernelop|title=Bus options (PCI etc.)|desc=
+
##r##[agent]##!r## Passkey: ##i##454358##!i##
    [*] Mark VGA/VBE/EFI FB as generic system framebuffer (NEW)
+
[##y##CHG##!y##] Device 00:1F:20:3D:1E:75 Paired: yes
 +
Pairing successful
 +
[##y##CHG##!y##] Device 00:1F:20:3D:1E:75 Connected: no
 +
##bl##[bluetooth]##!bl### ##i##connect 00:1F:20:3D:1E:75
 +
Attempting to connect to 00:1F:20:3D:1E:75
 +
[##y##CHG##!y##] Device 00:1F:20:3D:1E:75 Connected: yes
 +
Connection successful
 +
##bl##[bluetooth]##!bl### ##i##quit
 +
[##r##DEL##!r##] Controller 00:02:72:C9:62:65 antec [default]
 +
#
 
}}
 
}}
  
If you have that option enabled, ''you must also enable'':
+
To install, make the following modifications to your skin:
  
{{kernelop|title=Device Drivers,Graphics support,Frame buffer Devices|desc=
+
<syntaxhighlight lang="css">
    [*]  Simple framebuffer support
+
--- mediawiki-1.19.1/skins/vector/screen.css    2012-06-13 18:22:39.000000000 +0000
}}
+
+++ public_html/skins/vector/screen.css 2012-08-27 04:34:47.507912892 +0000
 +
@@ -683,10 +683,47 @@
 +
        list-style-image: url(images/bullet-icon.png);
 +
}
 +
 +
-pre {
 +
-      line-height: 1.3em;
 +
+/* ConsoleOutput.php start */
 +
+
 +
+.shell, pre, code, tt, div.mw-geshi {
 +
+        font-size: 12px;
 +
+        font-family: Consolas, 'andale mono','lucida console', monospace;
 +
+}
 +
+
 +
+.shell, pre, div.mw-geshi {
 +
+        background-color: #F8F8FF;
 +
+        line-height: 15px;
 +
+        padding: 10px;
 +
+        border: none;
 +
+        border-top: 2px solid #C6C9E0;
 +
+        border-bottom: 2px solid #C6C9E0;
 +
+        margin: 0;
 +
+        overflow-x: auto;
 +
+        overflow-y: hidden;
 +
+}
 +
+
 +
+.code {
 +
+        color: #666;
 +
+}
 +
+
 +
+.code_input {
 +
+        color: #000;
 +
}
 +
 +
+.code_red {
 +
+        color: #f00;
 +
+}
 +
+
 +
+.code_blue {
 +
+        color: #00f;
 +
+}
 +
+
 +
+.shell_green {
 +
+        color: #080;
 +
+}
 +
+
 +
+/* ConsoleOutput.php end */
 +
+
 +
/* Site Notice (includes notices from CentralNotice extension) */
 +
#siteNotice {
 +
        font-size: 0.8em;
 +
</syntaxhighlight>
  
This is the preferred method of using the EFI framebuffer, the efifb and uvesafb drivers will be used as a fallback if the above is not compatible.
+
Then install the following code in your <tt>extensions</tt> directory and include it with a <tt>require_once( "$IP/extensions/ConsoleOutput.php" );</tt> in <tt>LocalSettings.php</tt>:
=== Grub method ===
+
  
==== Unmask Grub 2.02_beta2 ====
+
<syntaxhighlight lang="php">
 +
<?php
 +
$wgExtensionCredits['validextensionclass'][] = array(
 +
    'name' => 'ConsoleOutput',
 +
    'author' => 'Daniel Robbins',
 +
    'url' => 'https://github.com/danielrobbins/mediawiki-consoleoutput',
 +
    'description' => 'This extension allows you to display colorized console output in mediawiki'
 +
);
  
Unmask the latest version of GRUB by placing this in your <code>/etc/portage/package.unmask</code>:
+
if ( defined( 'MW_SUPPORTS_PARSERFIRSTCALLINIT' ) ) {
 
+
        $wgHooks['ParserFirstCallInit'][] = 'consoleOutputSetup';
<pre>
+
} else {
sys-boot/grub
+
         $wgExtensionFunctions[] = 'consoleOutputSetup';
</pre>
+
 
+
The 2.00 version of GRUB has known issues with UEFI booting. Using 2.02 is essential for having this boot method work reliably.
+
 
+
==== Emerging GRUB ====
+
 
+
You will still use GRUB as a boot loader, but before emerging grub, you will need to enable EFI booting. To do this,
+
add the following line to <tt>/etc/portage/make.conf</tt>:
+
 
+
<pre>
+
GRUB_PLATFORMS="efi-64"
+
</pre>
+
 
+
Then, <tt>emerge grub</tt>. You will notice <tt>efibootmgr</tt> getting pulled in as a dependency. This is expected and good.
+
 
+
==== Installing GRUB ====
+
 
+
Now, for the magic of getting everything in place for booting. You should copy your kernel and initramfs (if you have one -- you will if you are following the default install) to <tt>/boot</tt>. GRUB will boot those. But how do we get UEFI to boot GRUB? Well, we need to run the following command:
+
 
+
<console>
+
# ##i##grub-install --target=x86_64-efi --efi-directory=/boot --bootloader-id="Funtoo Linux [GRUB]" --recheck /dev/sda
+
</console>
+
This command will simply install all the stuff to <tt>/boot/EFI</tt> and <tt>/boot/grub</tt> that your system needs to boot. In particular, the <tt>/boot/EFI/grub/grubx64.efi</tt> file will be created. This is the GRUB boot image that UEFI will load and start.
+
 
+
A more detailed explanation of the flags used in the above command:
+
* <code>--target=x86_64-efi</code>: Tells GRUB that we want to install it in a way that allows it to boot in UEFI
+
* <code>--efi-directory=/boot</code>: All GRUB UEFI files will be installed in ''/boot''
+
* <code>--bootloader-id="Funtoo Linux [GRUB]"</code>: This flag is not necessary for GRUB to boot. However, it allows you to change the text of the boot option in the UEFI BIOS. The stuff in the quotes can be set to anything that you would like.
+
* <code>--recheck</code>: If a device map already exists on the disk or partition that GRUB is being installed on, it will be removed.
+
* <code>/dev/sda</code>:The device that we are installing GRUB on.
+
 
+
==== Configuring GRUB ====
+
 
+
OK, now UEFI has the GRUB image it needs to boot. But we still need to configure GRUB itself so it finds and boots your kernel and initramfs. This is done by performing the following steps. Since boot-update doesn't yet support UEFI, we will use boot-update, but then edit our <code>/boot/grub/grub.cfg</code> to support UEFI booting.
+
 
+
First, you will need to edit <code>/etc/boot.conf</code>. Format this as you would if you were booting without UEFI. If you are not sure how this should look, below is an example of what it could look like if you are booting from an unencrypted ext4 partition:
+
 
+
{{file|name=/etc/boot.conf|desc=|body=
+
boot {
+
         generate grub
+
        default "Funtoo Linux"
+
        timeout 3
+
 
}
 
}
  
"Funtoo Linux" {
+
function consoleOutputSetup( $data )
        kernel vmlinuz[-v]
+
{
        params += rootfstype=ext4 root=/dev/sda2
+
    global $wgParser;
 +
    $wgParser->setHook('console', 'consoleRender');
 +
    return true;
 
}
 
}
}}
 
  
After you have edited your <code>/etc/boot.conf</code> file, run <code>boot-update</code>. If you check your <code>/boot/grub/grub.cfg</code> now, you should see something like this:
+
function consoleRender($input, $args, $parser)
 +
{
 +
    if (count($args))
 +
    {
 +
        return "<strong class='error'>" .
 +
              "ConsoleOutput: arguments not supported" .
 +
              "</strong>";
 +
    }
  
{{file|name=/boot/grub/grub.cfg|desc=|body=
+
    # Display < and > as literals, so escape them:
set timeout=3
+
  
  insmod part_gpt
+
    $input = preg_replace('/>/','&gt;', $input);
  insmod fat
+
    $input = preg_replace('/</','&lt;', $input);
  set root=(hostdisk//dev/sda,gpt1)
+
  search --no-floppy --fs-uuid --set 3CFD-6884
+
if loadfont /grub/unifont.pf2; then
+
  set gfxmode=text
+
  insmod gfxterm
+
  insmod vbe
+
  terminal_output gfxterm
+
fi
+
  
set menu_color_normal=cyan/blue
+
    # http://www.perlmonks.org/?node_id=518444
set menu_color_highlight=blue/cyan
+
    # See "Matching a pattern that doesn't include another pattern:
  
menuentry "Funtoo Linux - vmlinuz-3.16.3" {
+
    $input = preg_replace('/##i##((?:(?!##!i##).)*)##!i##/','<span class="code_input">$1</span>', $input);
  insmod part_gpt
+
    $input = preg_replace('/##i##(.*)/','<span class="code_input">$1</span>', $input);
  insmod fat
+
    $input = preg_replace('/##b##((?:(?!##!b##).)*)##!b##/','<b>$1</b>', $input);
  set root=(hostdisk//dev/sda,gpt1)
+
    $input = preg_replace('/##b##(.*)/','<b>$1</b>', $input);
  search --no-floppy --fs-uuid --set 3CFD-6884
+
    return "<pre class=\"code\">" . $input . "&lt;/pre>";
  linux /vmlinuz-3.16.3 video=uvesafb:1920x1080-32,mtrr:3,ywrap rootfstype=ext4 root=/dev/sda2
+
  set gfxpayload=text
+
 
}
 
}
set default=0
+
?>
}}
+
</syntaxhighlight>
 
+
To get your <code>/boot/grub/grub.cfg</code> to support booting with UEFI, make your <code>/boot/grub/grub.cfg</code> look like this:
+
{{file|name=/boot/grub/grub.cfg|desc=|body=
+
set timeout=3
+
 
+
  insmod part_gpt
+
  insmod fat
+
  insmod efi_gop
+
  insmod efi_uga
+
  set root=(hostdisk//dev/sda,gpt1)
+
  search --no-floppy --fs-uuid --set 3CFD-6884
+
if loadfont /grub/unifont.pf2; then
+
  set gfxmode=auto
+
  insmod gfxterm
+
  insmod vbe
+
  terminal_output gfxterm
+
fi
+
 
+
set menu_color_normal=cyan/blue
+
set menu_color_highlight=blue/cyan
+
 
+
menuentry "Funtoo Linux - vmlinuz-3.16.3" {
+
  insmod part_gpt
+
  insmod fat
+
  set root=(hostdisk//dev/sda,gpt1)
+
  search --no-floppy --fs-uuid --set 3CFD-6884
+
  linux /vmlinuz-3.16.3 video=uvesafb:1920x1080-32,mtrr:3,ywrap rootfstype=ext4 root=/dev/sda2
+
  set gfxpayload=keep
+
}
+
set default=0
+
}}
+
 
+
The lines that we have added and altered do the following:
+
* <code>insmod efi_gop</code> and <code>insmod efi_uga</code>: Both of these involve adding support for the UEFI framebuffer to GRUB.
+
* <code>set gfxmode=auto</code>: Instead of having the GRUB boot option screen being displayed at the smallest resolution possible, changing this to auto will make it fit the resolution of your display.
+
 
+
== Known Issues ==
+
*With pure UEFI boot mode, with legacy mode disabled, following error expected:
+
** video driver not supported, boot hangs, hard reboot required.
+
*Choose UEFI first, next legacy driver. It depends on motherboard vendor and efi bios version.
+
**In UEFI bios choose grub option, if your succeeded with above guide, additional menu should appear in Boot Menu, otherwise it boots into EFI shell: <code>grub:NAME of you hard drive</code>
+
* On some systems, installing the packages that are required for UEFI booting with any gcc later than a 4.x.x release may lead to a black screen after the GRUB screen. To fix this, before you begin installing any packages on your system, emerge =gcc-4.6.4-r2 and proceed with the installation as usual. Remember to switch your compiler back to the version of gcc that came with your system after you have finished installing. To do this, use <code>gcc-config 2</code>.
+
 
+
=== Done! ===
+
 
+
Remember to follow all other steps in the regular Funtoo Install Guide. Assuming you did everything correctly, your system should now boot via UEFI! We will be adding UEFI support to boot-update soon to make this process easier.
+
  
[[Category:HOWTO]]
+
[[Category:MediaWiki Hacks]]

Revision as of 01:05, January 12, 2015

The ConsoleOutput MediaWiki extension was created by Daniel Robbins to provide highlighting of user input for interactive terminal session blocks. To use it, surround user input with <console> opening and closing tags, and put a ##i## input code immediately before user input on each line. This will cause all text from the ##i## point to the end of the line to be in a darker color. The rest of the text will be in a lighter grey, allowing it to be distinguished more easily from user input. Here are other sequences that can be used:

  • ##b## - highlight the rest of the line in bold.
  • ##b## text here ##!b## - highlight the text between both markers in bold.
  • ##i## text here ##!i## - highlight the text between both markers in a darker color.

This extension can be further extended to add color support, as desired, and some of the CSS for color support can already be found in the code below.

Here are a few examples of the ConsoleOutput extension. First this is how you might typically display ls output, with a particular directory highlighted:

www@www-smw ~/public_html $ ls
COPYING  LocalSettings.php     api.php   extensions   index.php   maintenance           redirect.php    skins              thumb_handler.php5
CREDITS  README                api.php5  images         index.php5  mw-config             redirect.php5   tests              wiki.phtml
FAQ      RELEASE-NOTES-1.19    bin       img_auth.php   languages   opensearch_desc.php   redirect.phtml  thumb.php
HISTORY  StartProfiler.sample  cache     img_auth.php5  load.php    opensearch_desc.php5  resources       thumb.php5
INSTALL  UPGRADE               docs      includes       load.php5   profileinfo.php       serialized      thumb_handler.php
www@www-smw ~/public_html $ cd extensions/

And here is how you might display a more detailed example of console output, using colors:

# bluetoothctl 
[NEW] Controller 00:02:72:C9:62:65 antec [default]
[bluetooth]# power on
Changing power on succeeded
[bluetooth]# agent on
Agent registered
[bluetooth]# scan on
Discovery started
[bluetooth]# devices
Device 00:1F:20:3D:1E:75 Logitech K760
[bluetooth]# pair 00:1F:20:3D:1E:75
Attempting to pair with 00:1F:20:3D:1E:75
[CHG] Device 00:1F:20:3D:1E:75 Connected: yes
[agent] Passkey: 454358
[agent] Passkey: 454358
[agent] Passkey: 454358
[agent] Passkey: 454358
[agent] Passkey: 454358
[agent] Passkey: 454358
[agent] Passkey: 454358
[CHG] Device 00:1F:20:3D:1E:75 Paired: yes
Pairing successful
[CHG] Device 00:1F:20:3D:1E:75 Connected: no
[bluetooth]# connect 00:1F:20:3D:1E:75
Attempting to connect to 00:1F:20:3D:1E:75
[CHG] Device 00:1F:20:3D:1E:75 Connected: yes
Connection successful
[bluetooth]# quit
[DEL] Controller 00:02:72:C9:62:65 antec [default]
#


To install, make the following modifications to your skin:

--- mediawiki-1.19.1/skins/vector/screen.css    2012-06-13 18:22:39.000000000 +0000
+++ public_html/skins/vector/screen.css 2012-08-27 04:34:47.507912892 +0000
@@ -683,10 +683,47 @@
        list-style-image: url(images/bullet-icon.png);
 }
 
-pre {
-       line-height: 1.3em;
+/* ConsoleOutput.php start */
+
+.shell, pre, code, tt, div.mw-geshi {
+        font-size: 12px;
+        font-family: Consolas, 'andale mono','lucida console', monospace;
+}
+
+.shell, pre, div.mw-geshi {
+        background-color: #F8F8FF;
+        line-height: 15px;
+        padding: 10px;
+        border: none;
+        border-top: 2px solid #C6C9E0;
+        border-bottom: 2px solid #C6C9E0;
+        margin: 0;
+        overflow-x: auto;
+        overflow-y: hidden;
+}
+
+.code {
+        color: #666;
+}
+
+.code_input {
+        color: #000;
 }
 
+.code_red {
+        color: #f00;
+}
+
+.code_blue {
+        color: #00f;
+}
+
+.shell_green {
+        color: #080;
+}
+
+/* ConsoleOutput.php end */
+
 /* Site Notice (includes notices from CentralNotice extension) */
 #siteNotice {
        font-size: 0.8em;

Then install the following code in your extensions directory and include it with a require_once( "$IP/extensions/ConsoleOutput.php" ); in LocalSettings.php:

<?php
$wgExtensionCredits['validextensionclass'][] = array(
    'name' => 'ConsoleOutput',
    'author' => 'Daniel Robbins',
    'url' => 'https://github.com/danielrobbins/mediawiki-consoleoutput',
    'description' => 'This extension allows you to display colorized console output in mediawiki'
);
 
if ( defined( 'MW_SUPPORTS_PARSERFIRSTCALLINIT' ) ) {
        $wgHooks['ParserFirstCallInit'][] = 'consoleOutputSetup';
} else {
        $wgExtensionFunctions[] = 'consoleOutputSetup';
}
 
function consoleOutputSetup( $data )
{
    global $wgParser;
    $wgParser->setHook('console', 'consoleRender');
    return true;
}
 
function consoleRender($input, $args, $parser)
{
    if (count($args))
    {
        return "<strong class='error'>" .
               "ConsoleOutput: arguments not supported" .
               "</strong>";
    }
 
    # Display < and > as literals, so escape them:

    $input = preg_replace('/>/','&gt;', $input);
    $input = preg_replace('/</','&lt;', $input);
 
    # http://www.perlmonks.org/?node_id=518444
    # See "Matching a pattern that doesn't include another pattern:

    $input = preg_replace('/##i##((?:(?!##!i##).)*)##!i##/','<span class="code_input">$1</span>', $input);
    $input = preg_replace('/##i##(.*)/','<span class="code_input">$1</span>', $input);
    $input = preg_replace('/##b##((?:(?!##!b##).)*)##!b##/','<b>$1</b>', $input);
    $input = preg_replace('/##b##(.*)/','<b>$1</b>', $input);
    return "<pre class=\"code\">" . $input . "&lt;/pre>";
}
?>