diff options
| author | Alyssa Rosenzweig <alyssa@rosenzweig.io> | 2017-03-17 22:24:25 -0700 |
|---|---|---|
| committer | Alyssa Rosenzweig <alyssa@rosenzweig.io> | 2017-03-17 22:24:25 -0700 |
| commit | dbc480fb28a694ad5a587be025eabfded7c7784b (patch) | |
| tree | 16b4251dcbdede274781f7bb8b1f23570853f3bb /docs/grub | |
| parent | 85ec6862e8af0747420ca15fef7100edb5885302 (diff) | |
| download | librebootfr-dbc480fb28a694ad5a587be025eabfded7c7784b.tar.gz librebootfr-dbc480fb28a694ad5a587be025eabfded7c7784b.zip | |
Convert documentation to markdown
Diffstat (limited to 'docs/grub')
| -rw-r--r-- | docs/grub/index.html | 190 | ||||
| -rw-r--r-- | docs/grub/index.md | 164 |
2 files changed, 164 insertions, 190 deletions
diff --git a/docs/grub/index.html b/docs/grub/index.html deleted file mode 100644 index 78beb3e6..00000000 --- a/docs/grub/index.html +++ /dev/null @@ -1,190 +0,0 @@ -<!DOCTYPE html> -<html> -<head> - <meta charset="utf-8"> - <meta name="viewport" content="width=device-width, initial-scale=1"> - - <style type="text/css"> - @import url('../css/main.css'); - </style> - - <title>GRUB payload</title> -</head> - -<body> - - <div class="section"> - <h1 id="pagetop">GRUB payload</h1> - <p> - This section relates to the GRUB payload used in libreboot. - </p> - <p> - Or <a href="../">Back to main index</a>. - </p> - <ul> - <li><a href="#grub_background">Changing the background image in GRUB</a></li> - <li><a href="#grub_font">Setting font in GRUB</a></li> - <li><a href="#grub_keyboard">GRUB keyboard layouts</a> - <ul> - <li><a href="#grub_custom_keyboard">Custom keyboard layout in GRUB</a></li> - <li><a href="#grub_ukdvorak_keyboard">UK Dvorak keyboard layout in GRUB</a></li> - </ul> - </li> - </ul> - </div> - - <div class="section"> - - <h1 id="grub_background">Changing the background image in GRUB</h1> - - <p> - Use cbfstool from libreboot_util, or libreboot_src/coreboot/util/cbfstool/ if you want to build from source. - </p> - <p> - ./cbfstool yourrom.rom remove background.png -n background.png<br/> - ./cbfstool yourrom.rom add -f background.png -n background.png -t raw - </p> - <p> - When you've done this, re-flash your ROM and you should have a new background at boot time. - </p> - - </div> - - <div class="section"> - - <h1 id="grub_font">Setting font in GRUB (for reference)</h1> - - <p>You don't need to do this unless you would like to change the default font yourself. - (this is just for reference. It has already been done for you)</p> - - <p>The old font used was Unifont, and this had some missing characters: for instance, the border showed ??? characters instead of lines.</p> - - <p>I tried DeJavu Sans Mono from this website: - <a href="http://dejavu-fonts.org/wiki/Download">dejavu-fonts.org</a></p> - - <p>Specifically, the version that I chose was the latest at the time of writing (Saturday 21 June 2014): - <a href="http://sourceforge.net/projects/dejavu/files/dejavu/2.34/dejavu-fonts-ttf-2.34.tar.bz2">this one</a></p> - - <p>This is a free font that is also contained in GNU+Linux distributions like Debian, Devuan or Parabola.</p> - - <p><b>$ cd libreboot_src/grub</b><br/> - compile grub (the build scripts info on how to do this)<br/> - come back out into libreboot_src/resources/grub:<br/> - <b>$ cd ../libreboot_src/resources/grub/font</b></p> - - <p>I took Dejavu Sans Mono from dejavu (included in this version of libreboot) and did:<br/> - <b>$ ../../../grub/grub-mkfont -o dejavusansmono.pf2 dejavu-fonts-ttf-2.34/ttf/DejaVuSansMono.ttf</b></p> - - <p>I then added the instructions to 'gen.sh' script in grub-assemble to include resources/grub/dejavusansmono.pf2 - in all of the ROM images, at the root of the GRUB memdisk.<br/> - I then added that instructions to the grub.cfg files (to load the font):<br/> - <b>loadfont (memdisk)/dejavusansmono.pf2</b></p> - - <p><a href="#pagetop">Back to top of page</a></p> - - </div> - - <div class="section"> - - <h1 id="grub_keyboard">GRUB keyboard layouts (for reference)</h1> - - <div class="subsection"> - - <h2 id="grub_custom_keyboard">Custom keyboard layout in GRUB (for reference)</h2> - - <p> - Keymaps are stored in resources/utilities/grub-assemble/keymap/. - </p> - - <p> - Example (French Azerty):<br/> - <b>$ ckbcomp fr > frazerty</b><br/><br/> - Go in grub directory:<br/> - <b>cat frazerty | ./grub/grub-mklayout -o frazerty.gkb</b> - </p> - - <p> - You must make sure that the files are named keymap and keymap.gkb (where 'keymap' can be whatever you want). - </p> - - <p> - Then from the above example, you would put <b>frazerty</b> in <b>resources/utilities/grub-assemble/keymap/original/</b> and - the <b>frazerty.gkb</b> file goes under <b>resources/utilities/grub-assemble/keymap/</b> - </p> - - <p> - The build scripts will automatically see this, and automatically build - ROM images with your custom layout (given the name) and include them under bin. Example: <b>libreboot_frazerty.rom</b>. - </p> - - <p><a href="#pagetop">Back to top of page</a></p> - - </div> - - <div class="subsection"> - - <h2 id="grub_ukdvorak_keyboard">UK Dvorak keyboard layout in GRUB (for reference)</h2> - - <p> - ukdvorak had to be created manually, based on usdvorak. diff them (under resources/utilities/grub-assemble/keymap/original) - to see how ukdvorak file was created - </p> - - <p><b>$ cat ukdvorak | ./grub/grub-mklayout -o ukdvorak.gkb</b></p> - - <p><a href="#pagetop">Back to top of page</a></p> - - </div> - - </div> - - <div class="section"> - - <p> - Copyright © 2014 Leah Rowe <info@minifree.org><br/> - Permission is granted to copy, distribute and/or modify this document - under the terms of the Creative Commons Attribution-ShareAlike 4.0 International license - or any later version published by Creative Commons; - - A copy of the license can be found at <a href="../cc-by-sa-4.0.txt">../cc-by-sa-4.0.txt</a> - </p> - - <p> - Updated versions of the license (when available) can be found at - <a href="https://creativecommons.org/licenses/by-sa/4.0/legalcode">https://creativecommons.org/licenses/by-sa/4.0/legalcode</a> - </p> - - <p> - UNLESS OTHERWISE SEPARATELY UNDERTAKEN BY THE LICENSOR, TO THE - EXTENT POSSIBLE, THE LICENSOR OFFERS THE LICENSED MATERIAL AS-IS - AND AS-AVAILABLE, AND MAKES NO REPRESENTATIONS OR WARRANTIES OF - ANY KIND CONCERNING THE LICENSED MATERIAL, WHETHER EXPRESS, - IMPLIED, STATUTORY, OR OTHER. THIS INCLUDES, WITHOUT LIMITATION, - WARRANTIES OF TITLE, MERCHANTABILITY, FITNESS FOR A PARTICULAR - PURPOSE, NON-INFRINGEMENT, ABSENCE OF LATENT OR OTHER DEFECTS, - ACCURACY, OR THE PRESENCE OR ABSENCE OF ERRORS, WHETHER OR NOT - KNOWN OR DISCOVERABLE. WHERE DISCLAIMERS OF WARRANTIES ARE NOT - ALLOWED IN FULL OR IN PART, THIS DISCLAIMER MAY NOT APPLY TO YOU. - </p> - <p> - TO THE EXTENT POSSIBLE, IN NO EVENT WILL THE LICENSOR BE LIABLE - TO YOU ON ANY LEGAL THEORY (INCLUDING, WITHOUT LIMITATION, - NEGLIGENCE) OR OTHERWISE FOR ANY DIRECT, SPECIAL, INDIRECT, - INCIDENTAL, CONSEQUENTIAL, PUNITIVE, EXEMPLARY, OR OTHER LOSSES, - COSTS, EXPENSES, OR DAMAGES ARISING OUT OF THIS PUBLIC LICENSE OR - USE OF THE LICENSED MATERIAL, EVEN IF THE LICENSOR HAS BEEN - ADVISED OF THE POSSIBILITY OF SUCH LOSSES, COSTS, EXPENSES, OR - DAMAGES. WHERE A LIMITATION OF LIABILITY IS NOT ALLOWED IN FULL OR - IN PART, THIS LIMITATION MAY NOT APPLY TO YOU. - </p> - <p> - The disclaimer of warranties and limitation of liability provided - above shall be interpreted in a manner that, to the extent - possible, most closely approximates an absolute disclaimer and - waiver of all liability. - </p> - - </div> - -</body> -</html> diff --git a/docs/grub/index.md b/docs/grub/index.md new file mode 100644 index 00000000..2ca95bc8 --- /dev/null +++ b/docs/grub/index.md @@ -0,0 +1,164 @@ +<div class="section"> + +GRUB payload {#pagetop} +============ + +This section relates to the GRUB payload used in libreboot. + +Or [Back to main index](../). + +- [Changing the background image in GRUB](#grub_background) +- [Setting font in GRUB](#grub_font) +- [GRUB keyboard layouts](#grub_keyboard) + - [Custom keyboard layout in GRUB](#grub_custom_keyboard) + - [UK Dvorak keyboard layout in GRUB](#grub_ukdvorak_keyboard) + +</div> + +<div class="section"> + +Changing the background image in GRUB {#grub_background} +===================================== + +Use cbfstool from libreboot\_util, or +libreboot\_src/coreboot/util/cbfstool/ if you want to build from source. + +./cbfstool yourrom.rom remove background.png -n background.png\ +./cbfstool yourrom.rom add -f background.png -n background.png -t raw + +When you\'ve done this, re-flash your ROM and you should have a new +background at boot time. + +</div> + +<div class="section"> + +Setting font in GRUB (for reference) {#grub_font} +==================================== + +You don\'t need to do this unless you would like to change the default +font yourself. (this is just for reference. It has already been done for +you) + +The old font used was Unifont, and this had some missing characters: for +instance, the border showed ??? characters instead of lines. + +I tried DeJavu Sans Mono from this website: +[dejavu-fonts.org](http://dejavu-fonts.org/wiki/Download) + +Specifically, the version that I chose was the latest at the time of +writing (Saturday 21 June 2014): [this +one](http://sourceforge.net/projects/dejavu/files/dejavu/2.34/dejavu-fonts-ttf-2.34.tar.bz2) + +This is a free font that is also contained in GNU+Linux distributions +like Debian, Devuan or Parabola. + +**\$ cd libreboot\_src/grub**\ +compile grub (the build scripts info on how to do this)\ +come back out into libreboot\_src/resources/grub:\ +**\$ cd ../libreboot\_src/resources/grub/font** + +I took Dejavu Sans Mono from dejavu (included in this version of +libreboot) and did:\ +**\$ ../../../grub/grub-mkfont -o dejavusansmono.pf2 +dejavu-fonts-ttf-2.34/ttf/DejaVuSansMono.ttf** + +I then added the instructions to \'gen.sh\' script in grub-assemble to +include resources/grub/dejavusansmono.pf2 in all of the ROM images, at +the root of the GRUB memdisk.\ +I then added that instructions to the grub.cfg files (to load the +font):\ +**loadfont (memdisk)/dejavusansmono.pf2** + +[Back to top of page](#pagetop) + +</div> + +<div class="section"> + +GRUB keyboard layouts (for reference) {#grub_keyboard} +===================================== + +<div class="subsection"> + +Custom keyboard layout in GRUB (for reference) {#grub_custom_keyboard} +---------------------------------------------- + +Keymaps are stored in resources/utilities/grub-assemble/keymap/. + +Example (French Azerty):\ +**\$ ckbcomp fr > frazerty**\ +\ +Go in grub directory:\ +**cat frazerty | ./grub/grub-mklayout -o frazerty.gkb** + +You must make sure that the files are named keymap and keymap.gkb (where +\'keymap\' can be whatever you want). + +Then from the above example, you would put **frazerty** in +**resources/utilities/grub-assemble/keymap/original/** and the +**frazerty.gkb** file goes under +**resources/utilities/grub-assemble/keymap/** + +The build scripts will automatically see this, and automatically build +ROM images with your custom layout (given the name) and include them +under bin. Example: **libreboot\_frazerty.rom**. + +[Back to top of page](#pagetop) + +</div> + +<div class="subsection"> + +UK Dvorak keyboard layout in GRUB (for reference) {#grub_ukdvorak_keyboard} +------------------------------------------------- + +ukdvorak had to be created manually, based on usdvorak. diff them (under +resources/utilities/grub-assemble/keymap/original) to see how ukdvorak +file was created + +**\$ cat ukdvorak | ./grub/grub-mklayout -o ukdvorak.gkb** + +[Back to top of page](#pagetop) + +</div> + +</div> + +<div class="section"> + +Copyright © 2014 Leah Rowe <info@minifree.org>\ +Permission is granted to copy, distribute and/or modify this document +under the terms of the Creative Commons Attribution-ShareAlike 4.0 +International license or any later version published by Creative +Commons; A copy of the license can be found at +[../cc-by-sa-4.0.txt](../cc-by-sa-4.0.txt) + +Updated versions of the license (when available) can be found at +<https://creativecommons.org/licenses/by-sa/4.0/legalcode> + +UNLESS OTHERWISE SEPARATELY UNDERTAKEN BY THE LICENSOR, TO THE EXTENT +POSSIBLE, THE LICENSOR OFFERS THE LICENSED MATERIAL AS-IS AND +AS-AVAILABLE, AND MAKES NO REPRESENTATIONS OR WARRANTIES OF ANY KIND +CONCERNING THE LICENSED MATERIAL, WHETHER EXPRESS, IMPLIED, STATUTORY, +OR OTHER. THIS INCLUDES, WITHOUT LIMITATION, WARRANTIES OF TITLE, +MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, NON-INFRINGEMENT, +ABSENCE OF LATENT OR OTHER DEFECTS, ACCURACY, OR THE PRESENCE OR ABSENCE +OF ERRORS, WHETHER OR NOT KNOWN OR DISCOVERABLE. WHERE DISCLAIMERS OF +WARRANTIES ARE NOT ALLOWED IN FULL OR IN PART, THIS DISCLAIMER MAY NOT +APPLY TO YOU. + +TO THE EXTENT POSSIBLE, IN NO EVENT WILL THE LICENSOR BE LIABLE TO YOU +ON ANY LEGAL THEORY (INCLUDING, WITHOUT LIMITATION, NEGLIGENCE) OR +OTHERWISE FOR ANY DIRECT, SPECIAL, INDIRECT, INCIDENTAL, CONSEQUENTIAL, +PUNITIVE, EXEMPLARY, OR OTHER LOSSES, COSTS, EXPENSES, OR DAMAGES +ARISING OUT OF THIS PUBLIC LICENSE OR USE OF THE LICENSED MATERIAL, EVEN +IF THE LICENSOR HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH LOSSES, +COSTS, EXPENSES, OR DAMAGES. WHERE A LIMITATION OF LIABILITY IS NOT +ALLOWED IN FULL OR IN PART, THIS LIMITATION MAY NOT APPLY TO YOU. + +The disclaimer of warranties and limitation of liability provided above +shall be interpreted in a manner that, to the extent possible, most +closely approximates an absolute disclaimer and waiver of all liability. + +</div> |