Difference between pages "Help:Funtoo Editing Guidelines" and "Install/BootLoader"

(Difference between pages)
(Document Hierarchy)
 
(New School (UEFI))
 
Line 1: Line 1:
'''Thanks for your interest in contributing to the the Funtoo wiki!'''
+
<noinclude>
__NOTOC__
+
{{InstallPart|boot loader configuration}}
== Types of Edits ==
+
</noinclude>
 +
=== Installing a Bootloader ===
  
Before we get started, let's review what changes are okay to make, and what changes are not okay:
+
These install instructions show you how to use GRUB to boot using BIOS (old-school) or UEFI (new-school).
  
{{TableStart}}
+
==== Old School (BIOS) ====
<tr class="active"><th>Type of Change</th><th>Okay?</th></tr>
+
<tr><td>Grammar/spelling fixes</td><td>Yes</td></tr>
+
<tr><td>New wiki content</td><td>Yes</td></tr>
+
<tr><td>New package information</td><td>Yes</td></tr>
+
<tr><td>Adding to existing article</td><td>Maybe -- see below</td></tr>
+
<tr><td>Adding missing/incomplete information</td><td>Yes</td></tr>
+
<tr><td>Making corrections</td><td>Yes</td></tr>
+
<tr class="danger"><td>Adding work-arounds to problems experienced</td><td>No - open bug first on [http://bugs.funtoo.org bug tracker].</td></tr>
+
{{TableEnd}}
+
  
{{important|Note that if you experience some problem with Funtoo Linux, during installation or otherwise, the proper course of action is to not add a work-around to our documentation, but to ''open a bug on our bug tracker.'' This is important because the problem you experienced may be a legitimate bug and the solution may be to fix the bug rather than add a work-around to our documentation. We may end up fixing a bug, making a documentation fix, or possibly both.}}
+
If you're using the BIOS to boot, setting up GRUB, the bootloader, is pretty easy.
  
== Basics ==
+
To use this recommended boot method, first emerge <code>boot-update</code>. This will also cause <code>grub-2</code> to be merged, since it is a dependency of <code>boot-update</code>.
  
Here is a list of basic wiki information that you will need to know to get started:
+
<console>
 
+
(chroot) # ##i##emerge boot-update
* First, to perform edits on the wiki, you must {{CreateAccount}} and log in.
+
</console>
* You can create a new page by navigating to http://www.funtoo.org/New_Page_Name. Underscores are the equivalent of spaces. Then select "Create" under the "Actions" menu.
+
* Whether creating a new page or editing an existing page by clicking "Edit", you will be presented with Web-based text editor that allows you to modify the ''wikitext'' of the page. The wikitext is rendered to produce the document you see when you view the page normally.
+
* Another fun thing you can do is click on your name under the "Account" menu once you have logged in. This will bring you to your "User" page. Then click "Create with Form" unde the "Actions" menu and enter your geographic and other information. This will allow you to be displayed on our [[Usermap]] and will also allow your full name to be displayed on [[:Category:Ebuilds|Ebuild pages]] for which you are an author. It's generally a good idea to do this.
+
 
+
{{tip|The following sections document how to use wikitext and Funtoo templates on the Funtoo wiki.}}
+
 
+
== Paragraphs ==
+
 
+
To create a new paragraph, insert a blank line between two lines of text. If a blank line doesn't exist between two lines of wikitext, they will be combined into a single flowing paragraph.
+
 
+
If you leave leading whitespace at the beginning of a line, MediaWiki will render it as pre-formatted text. Beware of this. Here's an example:
+
 
+
foobar
+
 
+
This can rear its ugly head when specifying template parameters, so you will get this:
+
 
+
{{note| ugh!}}
+
 
+
...instead of this:
+
 
+
{{note|This looks much better!}}
+
 
+
== Page and Section Capitalization ==
+
 
+
In general, capitalize all words in page names and section heading except:
+
* Articles: a, an, the
+
* Coordinating Conjunctions: and, but, or, for, nor, etc.
+
* Prepositions (fewer than five letters): on, at, to, from, by, etc.
+
 
+
== Document Hierarchy ==
+
 
+
Use section headings to create a document hierarchy for your page. These will define the table of contents that appears at the top of the wiki page. Create chapters, sections and sub-sections as follows:
+
 
+
<pre>= Page Title =
+
 
+
== Chapter Title ==
+
 
+
=== Section Title ===
+
 
+
==== SubSection Title ====
+
 
+
</pre>
+
 
+
{{Note|By default, Table of Contents is disabled on the Funtoo wiki. If you would like to enable the TOC, you can place a <code><nowiki>__TOC__</nowiki></code> on a blank line where you'd like the Table of Contents to appear, or place <code><nowiki>__FORCETOC__</nowiki></code> on a blank line anywhere in the wikitext to force the TOC to appear at the top of the page.}}
+
 
+
In general, when creating new documents, it's best to use level-3 (three "="'s) Section Titles to break up content. Level-2 Section Titles are best used for major sections of larger documents. Use them infrequently. Level-1 Section Titles generally do not need to be used.
+
 
+
== Links ==
+
 
+
Internal links to other wiki pages can be specified as <tt><nowiki>[[pagename]]</nowiki></tt>. To specify an alternate name for the link, use <tt><nowiki>[[pagename|my link name]]</nowiki></tt>.
+
 
+
For external links, use <tt><nowiki>[http://funtoo.org my link]</nowiki></tt> to specify a URL. If you want the URL to appear in the wikitext, you can specify it without brackets: http://forums.funtoo.org.
+
 
+
== Lists ==
+
 
+
MediaWiki supports a number of list formats:
+
 
+
* Unordered List
+
* Unordered Item 2
+
** Unordered sub-item
+
 
+
# Ordered List
+
# Ordered Item 2
+
## Ordered sub-item
+
 
+
;Term: This is called a "definition list". It is used when defining various terms.
+
 
+
If you need to quote a portion of text from another site, use <tt><nowiki><blockquote></nowiki></tt> as follows:
+
 
+
<blockquote>
+
Wikipedia (ˌwɪkɨˈpiːdiə/ or wɪkiˈpiːdiə/ wik-i-pee-dee-ə) is a collaboratively edited, multilingual, free-access, free content Internet encyclopedia that is supported and hosted by the non-profit Wikimedia Foundation. Volunteers worldwide collaboratively write Wikipedia's 30 million articles in 287 languages, including over 4.5 million in the English Wikipedia. Anyone who can access the site can edit almost any of its articles, which on the Internet comprise[4] the largest and most popular general reference work.[5][6][7][8][9] In February 2014, The New York Times reported that Wikipedia is ranked fifth globally among all websites stating, "With 18 billion page views and nearly 500 million unique visitors a month..., Wikipedia trails just Yahoo, Facebook, Microsoft and Google, the largest with 1.2 billion unique visitors."[10]
+
</blockquote>
+
  
== Literal Text and HTML Symbols ==
+
Then, edit <code>/etc/boot.conf</code> and specify "<code>Funtoo Linux genkernel</code>" as the <code>default</code> setting at the top of the file, replacing <code>"Funtoo Linux"</code>.
  
Here is wikitext for the section above, which I am displaying by placing the literal wikitext between a &#60;pre&#62; and &#60;/pre&#62; tag. If you want to disable wikitext processing for an inline span of text, use &#60;nowiki&#62; and &#60;/nowiki&#62;. If you want to print out a tag literally, use &amp;#60; and &amp;#62; (In the wikitext, I used &amp;amp;#60; and &amp;amp;#62 to display these!)
+
<code>/etc/boot.conf</code> should now look like this:
  
 
<pre>
 
<pre>
* Unordered List
+
boot {
* Unordered Item 2
+
generate grub
** Unordered sub-item
+
default "Funtoo Linux genkernel"
 +
timeout 3
 +
}
  
# Ordered List
+
"Funtoo Linux" {
# Ordered Item 2
+
kernel bzImage[-v]
## Ordered sub-item
+
}
  
;Term: This is called a "definition list". It is used when defining various terms.
+
"Funtoo Linux genkernel" {
 +
kernel kernel[-v]
 +
initrd initramfs[-v]
 +
params += real_root=auto
 +
}
  
If you need to quote a portion of text from another site, use <tt><nowiki><blockquote></nowiki></tt> as follows:
+
"Funtoo Linux better-initramfs" {
 
+
kernel vmlinuz[-v]
<blockquote>
+
initrd /initramfs.cpio.gz
Wikipedia (ˌwɪkɨˈpiːdiə/ or wɪkiˈpiːdiə/ wik-i-pee-dee-ə) is a collaboratively edited, multilingual, free-access,
+
}
free content Internet encyclopedia that is supported and hosted by the non-profit Wikimedia Foundation. Volunteers
+
worldwide collaboratively write Wikipedia's 30 million articles in 287 languages, including over 4.5 million in the
+
English Wikipedia. Anyone who can access the site can edit almost any of its articles, which on the Internet
+
comprise[4] the largest and most popular general reference work.[5][6][7][8][9] In February 2014, The New York
+
Times reported that Wikipedia is ranked fifth globally among all websites stating, "With 18 billion page views
+
and nearly 500 million unique visitors a month..., Wikipedia trails just Yahoo, Facebook, Microsoft and Google,
+
the largest with 1.2 billion unique visitors."[10]
+
</blockquote>
+
 
</pre>
 
</pre>
  
== Linking to Packages ==
+
Please read <code>man boot.conf</code> for further details.
  
To link to a package page, use the <code>Package</code> template:
+
===== Running grub-install and boot-update =====
  
<pre><nowiki>
+
Finally, we will need to actually install the GRUB boot loader to your disk, and also run <code>boot-update</code> which will generate your boot loader configuration file:
{{Package|sys-apps/portage}}
+
</nowiki></pre>
+
  
This template will create a link to the official wiki page for sys-apps/portage, and render using the official "English" page name, as follows:
 
 
{{Package|sys-apps/portage}}
 
 
If you specify a yet-to-be-documented ebuild, it will render like this (which is okay -- it will encourage people to document it):
 
 
{{Package|sys-foo/undocumented-ebuild}}
 
 
== Tables ==
 
 
Instead of using traditional MediaWiki table wikitext, use the following format:
 
 
<pre>
 
{{TableStart}}
 
<tr class="info"><th>Header 1</th><th>Header 2</th></tr>
 
<tr><td>Value 1</td><td>Value 2</td></tr>
 
<tr><td>Value 3</td><td>Value 4</td></tr>
 
{{TableEnd}}
 
</pre>
 
 
This wil render as follows:
 
 
{{TableStart}}
 
<tr class="info"><th>Header 1</th><th>Header 2</th></tr>
 
<tr><td>Value 1</td><td>Value 2</td></tr>
 
<tr><td>Value 3</td><td>Value 4</td></tr>
 
{{TableEnd}}
 
 
{{tip|This table syntax has an added benefit of creating a responsive table that renders properly on mobile devices.}}
 
 
It is possible to use the following CSS classes with <code>tr</code> (rows) and <code>td/th</code> elements to color them as desired:
 
 
{{TableStart}}
 
<tr class="active"><td>Class Name</td></tr>
 
<tr class="success"><td>success</td></tr>
 
<tr class="info"><td>info</td></tr>
 
<tr class="warning"><td>warning</td></tr>
 
<tr class="active"><td>active</td></tr>
 
<tr class="danger"><td>danger</td></tr>
 
{{TableEnd}}
 
 
== Displaying Source Code ==
 
 
To display source code, use the <tt>&#60;syntaxhighlight&#62;</tt> tag, which has the ability to perform syntax highlighting on the source code for easier reading:
 
<pre>
 
<syntaxhighlight lang="python">
 
import system
 
</syntaxhighlight>
 
</pre>
 
 
This will produce the following output:
 
 
<syntaxhighlight lang="python">
 
import system
 
</syntaxhighlight>
 
 
Alternatively, if you need a caption, use can use the file template, specifying a <tt>lang=</tt> parameter:
 
 
<pre>
 
{{file|name=foobar|lang=python|desc=foobarosity|body=
 
import system
 
}}
 
</pre>
 
 
This will produce:
 
 
{{file|name=foobar|lang=python|desc=foobarosity|body=
 
import system
 
}}
 
 
{{important|If you need to display the pipe ("{{!}}") character within the body of a file template, replace each "{{!}}" with <nowiki>{{!}}</nowiki> -- otherwise your file contents will not display properly. This is necessary because <nowiki>{{file}}</nowiki> is a template and the "{{!}}" character is used as a delimiter for arguments to the template.}}
 
 
Note that the language should be specified in the <tt>lang</tt> attribute. For a list of supported languages, see [http://www.mediawiki.org/wiki/Extension:SyntaxHighlight_GeSHi#Supported_languages this list].
 
 
== Displaying Text File Contents ==
 
 
For displaying the contents of non-programming language text files (like config files), you have two options. You can enclose your lines within <tt>&#60;pre&#62;</tt> tags, or use the new [[Template:File|file template]]. The file template is used like so:
 
 
<pre>
 
{{file|name=/etc/foo.conf|desc=My foo.conf file|body=
 
# /etc/host.conf:
 
# $Header: /var/cvsroot/gentoo/src/patchsets/glibc/extra/etc/host.conf,v 1.1 2006/09/29
 
}}
 
</pre>
 
 
This will produce:
 
 
{{file|name=/etc/foo.conf|desc=My foo.conf file|body=
 
# /etc/host.conf:
 
# $Header: /var/cvsroot/gentoo/src/patchsets/glibc/extra/etc/host.conf,v 1.1 2006/09/29
 
}}
 
 
== Console ==
 
To display console output, use the <tt>&#60;console&#62;</tt> tag:
 
 
For a root console:
 
<pre>
 
 
<console>
 
<console>
###i## run a command as root
+
(chroot) # ##i##grub-install --target=i386-pc --no-floppy /dev/sda
</console>
+
(chroot) # ##i##boot-update
</pre>
+
Produces:
+
<console>
+
###i## run a command as root
+
 
</console>
 
</console>
  
For a non-root console:
+
Now you need to update your boot loader configuration file:
<pre>
+
<console>
+
$ ##i##run a command as user
+
</console>
+
</pre>
+
Produces:
+
 
<console>
 
<console>
$ ##i##run a command as user
+
(chroot) # ##i##boot-update
 
</console>
 
</console>
 +
You only need to run <code>grub-install</code> when you first install Funtoo Linux, but you need to re-run <code>boot-update</code> every time you modify your <code>/etc/boot.conf</code> file, so your changes are applied on next boot.
  
{{important|1=
+
==== New School (UEFI) ====
Note that we use a <tt>#</tt> prompt for <tt>root</tt> and a <tt>$</tt> prompt to denote a non-root user.}}
+
  
{{important|The <tt>##i##</tt> text tags the rest of the line as being ''user input'' ("i" is for "input"). It is then highlighted in a noticeable color so it stands out from text that is not typed in by the user.}}
+
If you're using UEFI to boot, setting up the boot loader is a bit more complicated for now, but this process will be improving soon. Perform the following steps.
  
If you need to end highlighting of user input prior to the end of a line, use <code>##!i##</code> to mark the end of the highlighted area.
+
===== Emerging GRUB =====
  
The following special character sequences are also available:
+
First, <code>emerge boot-update</code>. You will notice <code>grub</code> and <code>efibootmgr</code> getting pulled in as dependencies. This is expected and good:
* <code>##g##</code> - Green
+
* <code>##y##</code> - Yellow
+
* <code>##bl##</code> - Blue
+
* <code>##r##</code> - Red
+
* <code>##b##</code> - Bold
+
  
Please use the above coloring options sparingly. It is sometimes nice to use them to get wiki console output to match the colors that are displayed on a Linux console. Also note that for every color above, there is a matching <code>##!(colorcode)##</code> option to turn color off prior to end of line.
+
<console>
 
+
(chroot) # ##i##emerge boot-update
Here is an example of its use:<console>
+
# ##i##bluetoothctl
+
[##g##NEW##!g##] Controller 00:02:72:C9:62:65 antec [default]
+
##bl##[bluetooth]##!bl###power on
+
Changing power on succeeded
+
##bl##[bluetooth]##!bl### ##i##agent on
+
Agent registered
+
##bl##[bluetooth]##!bl### ##i##scan on
+
Discovery started
+
##bl##[bluetooth]##!bl### ##i##devices
+
Device 00:1F:20:3D:1E:75 Logitech K760
+
##bl##[bluetooth]##!bl### ##i##pair 00:1F:20:3D:1E:75
+
Attempting to pair with 00:1F:20:3D:1E:75
+
[##y##CHG##!y##] Device 00:1F:20:3D:1E:75 Connected: yes
+
##r##[agent]##!r## Passkey: 454358
+
##r##[agent]##!r## Passkey: ##i##4##!i##54358
+
##r##[agent]##!r## Passkey: ##i##45##!i##4358
+
##r##[agent]##!r## Passkey: ##i##454##!i##358
+
##r##[agent]##!r## Passkey: ##i##4543##!i##58
+
##r##[agent]##!r## Passkey: ##i##45435##!i##8
+
##r##[agent]##!r## Passkey: ##i##454358##!i##
+
[##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]
+
#
+
 
</console>
 
</console>
  
== Informational Messages ==
+
===== Installing GRUB =====
Notes, warnings, tips, and important templates can be used for informational messages that need to be offset from the regular text flow:
+
  
<pre>{{note|this is a note}}</pre>
+
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:
{{note|this is a note}}
+
  
<pre>{{important|this is important}}</pre>
+
For x86-64bit systems:
{{important|this is important}}
+
  
<pre>{{warning|this is a warning}}</pre>
+
<console>
{{warning|this is a warning}}
+
(chroot) # ##i##grub-install --target=x86_64-efi --efi-directory=/boot --bootloader-id="Funtoo Linux [GRUB]" --recheck /dev/sda
 +
</console>
  
<pre>{{tip|this is a tip}}</pre>
+
For x86-32bit systems:
{{tip|this is a tip}}
+
  
Note that these templates used to be called <code>fancynote</code>, <code>fancytip</code>, etc. The "fancy" names have been deprecated but will still be supported for the forseeable future.
+
<console>
 +
(chroot) # ##i##grub-install --target=i386-efi --efi-directory=/boot --bootloader-id="Funtoo Linux [GRUB]" --recheck /dev/sda
 +
</console>
  
== Kernelop ==
+
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.
To display kernel configuration options, we encourage you to use the <tt>kernelop</tt> template. To use the <tt>kernelop</tt> template, create an entry similar to the following example:
+
<pre>
+
{{kernelop|title=foo,bar|desc=
+
kernel options pasted from "make menuconfig"
+
}}
+
</pre>
+
  
{{note|Kernelop is colored blue to slightly resemble the blueish background from <tt>make menuconfig</tt>.}}
+
A more detailed explanation of the flags used in the above command:
 +
* <code>--target=x86_64-efi</code> or <code>--target=i386-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.
  
Adding this entry will give you the following output:
+
===== Configuring GRUB =====
{{kernelop|title=foo,bar|desc=
+
kernel options
+
}}
+
  
Here's a more concrete example:
+
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.
{{kernelop|title=File systems|desc=
+
<M> Second extended fs support         
+
[ ]  Ext2 extended attributes         
+
[ ]  Ext2 execute in place support   
+
<M> Ext3 journalling file system support
+
}}
+
  
Examples of usage:  
+
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:
* [[Package:AMD Catalyst Video Drivers]]
+
* [[Package:ACPI Daemon]]
+
* [[Microcode]]
+
  
== Discussion Pages ==
+
{{file|name=/etc/boot.conf|desc=|body=
 +
boot {
 +
        generate grub
 +
        default "Funtoo Linux"
 +
        timeout 3
 +
}
  
In MediaWiki, every "regular" wiki page has a corresponding "Talk" or "Discussion" page which has a page name prefixed by "Talk:" -- you can get to this page by going to the "Action" menu, and then choosing the "Discussion" menu item. These talk pages are typically used to discuss the edits that are going on in the "main" wiki page. The problem with talk pages is that they are kind of a pain to use. However, we have a way to fix that. If you want to enable a DISQUS-based mini-forum on a talk page, insert the following wikitext on the Talk page:
+
"Funtoo Linux" {
 +
        kernel vmlinuz[-v]
 +
        params += rootfstype=ext4 root=/dev/sda2
 +
}
 +
}}
  
<pre>
+
After you have edited your <code>/etc/boot.conf</code> file, run <code>boot-update</code>. You should now have a <code>/boot/grub/grub.cfg</code> file, which you can edit using the following command:
{{DISQUS}}
+
</pre>
+
  
...and presto! You will now have DISQUS-powered mini-forums to discuss whatever you want about your wiki page.
+
<console>
 +
# ##i##nano /boot/grub/grub.cfg
 +
</console>
  
== Marking Pages as Needing Updates ==
 
  
If you find outdated wiki content, but you don't have the time or ability to update it, add one of the following templates to the wikitext of the page. This will add the page to the [[:Category:Needs Updates|Needs Updates Category]] so we can identify pages that need updating:
+
To get your <code>/boot/grub/grub.cfg</code> to support booting with UEFI, make the following changes. Below the existing insmod lines, add the following lines.  Both of these involve adding support for the UEFI framebuffer to GRUB.:
  
 
<pre>
 
<pre>
{{PageNeedsUpdates}}
+
  insmod efi_gop
{{SectionNeedsUpdates}}
+
  insmod efi_uga
 
</pre>
 
</pre>
  
 
+
Then, change the <code>set gfxpayload</code> line to read as follows. UEFI does not support text mode, so we will keep video initialized to the current resolution.:
Examples of usage:
+
* [[UEFI Install Guide]]
+
* [[Package:MediaWiki]]
+
* [[Clang]]
+
 
+
== Inline Code ==
+
 
+
To emphasize filenames, commands, and other technical jargon when they appear inline in a paragraph, use the <tt>&#60;code&#62;</tt> element. Follow the example below:
+
  
 
<pre>
 
<pre>
The <code>/etc/fstab</code> file is an important one. Another important file is <code>/boot/grub/grub.cfg</code>.
+
  set gfxpayload=keep
 
</pre>
 
</pre>
  
This example produces the following output:
+
You can now save your changes by pressing <code>Control-X</code> and answering <code>y</code> when asked if you want to save the modified buffer. When prompted for a filename, hit Enter to use the existing filename.
 
+
The <code>/etc/fstab</code> file is an important one. Another important file is <code>/boot/grub/grub.cfg</code>.
+
 
+
{{important|1=
+
The &#60;tt&#62; tag has been deprecated for the purpose of tagging inline code, to conform with HTML5.}}
+
 
+
== Slideshow ==
+
 
+
Any page has the capability of displaying a slideshow. Adding a slideshow to a page involves three steps:
+
 
+
# Upload Images
+
# Define Slides
+
# Add Slideshow to page
+
 
+
=== Upload Images ===
+
 
+
To upload images, head to [[Special:Upload]] and upload a file. It is highly recommended to upload JPEG format images in high resolution -- MediaWiki will handle scaling JPEG automatically, saving bandwidth, but does not do this for PNG. Make sure that all images you upload have the same dimensions. When you upload, make note of the '''Destination Filename''' field -- this is the name that the upload will use when you reference it in your slide. It is recommended that you choose a simple descriptive name ending in ".jpg" for the '''Destination Filename'''.
+
 
+
=== Define Slides ===
+
 
+
Once images have been uploaded, you must define slides. To define slides on a page, you enter special semantic information about the slide on the page that it will be displayed, in the following format:
+
 
+
<pre><nowiki>
+
{{#subobject:|slideIndex=0|slideCaption=
+
== Wikitext Here ==
+
This is a fantastic slide!
+
|slideImage=File:Fruit.jpg|slideLink=PageName}}
+
</nowiki></pre>
+
 
+
Here are some important instructions regarding defining slides:
+
 
+
* <code>slideIndex</code> must be 0 for the first slide, 1 for the second slide, etc. Numbers must be unique and incrementing from zero, and not doing this will result in slideshow display errors (but can be easily fixed by correcting the wikitext.)
+
* <code>slideCaption=</code> can contain wikitext, such as headings and links. The best way to enter <code>slideCaption</code> is as above -- type a literal <code>slideCaption=</code>, followed by enter, then specify your wikitext, and terminate the caption by a single pipe character on the following line. Pipe characters are used to separate arguments from each other.
+
* Specify your image name in the <code>slideImage</code> field. Your slideImage will have a name of <code>File:myname.jpg</code>, where <code>myname.jpg</code> is the '''Destination Filename''' you used when uploading the image.
+
* An optional parameter called <code>slideLink=</code> can be provided to allow the image to be clickable and link to another wiki page. If it is omitted, then the image will not be clickable.
+
 
+
=== Add Slideshow to Page ===
+
 
+
Once the slides have been added to the page, you can add the following text to your page at the point you'd like the slideshow to appear:
+
<pre>
+
{{Slideshow}}
+
</pre>
+
 
+
== YouTube Videos (Screencasts, etc.) ==
+
 
+
Screencasting is an easy method to explain complex tasks. Take for instance <code>youtu.be/5KDei5mBfSg</code> and chop off the id and insert it into the following syntax to produce a video example.
+
 
+
<pre>{{#widget:YouTube16x9|id=5KDei5mBfSg}}</pre>
+
{{#widget:YouTube16x9|id=5KDei5mBfSg}}
+
 
+
{{tip|The sample video above explains how to create your own screencasts under Funtoo Linux.}}
+
 
+
Most YouTube videos are in 16x9 format and should use the <code>YouTube16x9</code> widget. There is also a <code>YouTube4x3</code> widget for videos with a 4x3 aspect ratio.
+
{{note|These YouTube widgets have been updated to be mobile-friendly.}}
+
 
+
[[Category:Wiki Development]]
+

Revision as of 02:31, January 3, 2015


Note

This is a template that is used as part of the Installation instructions which covers: boot loader configuration. Templates are being used to allow multiple variant install guides that use most of the same re-usable parts.


Installing a Bootloader

These install instructions show you how to use GRUB to boot using BIOS (old-school) or UEFI (new-school).

Old School (BIOS)

If you're using the BIOS to boot, setting up GRUB, the bootloader, is pretty easy.

To use this recommended boot method, first emerge boot-update. This will also cause grub-2 to be merged, since it is a dependency of boot-update.

(chroot) # emerge boot-update

Then, edit /etc/boot.conf and specify "Funtoo Linux genkernel" as the default setting at the top of the file, replacing "Funtoo Linux".

/etc/boot.conf should now look like this:

boot {
	generate grub
	default "Funtoo Linux genkernel" 
	timeout 3 
}

"Funtoo Linux" {
	kernel bzImage[-v]
}

"Funtoo Linux genkernel" {
	kernel kernel[-v]
	initrd initramfs[-v]
	params += real_root=auto 
} 

"Funtoo Linux better-initramfs" {
	kernel vmlinuz[-v]
	initrd /initramfs.cpio.gz
}

Please read man boot.conf for further details.

Running grub-install and boot-update

Finally, we will need to actually install the GRUB boot loader to your disk, and also run boot-update which will generate your boot loader configuration file:

(chroot) # grub-install --target=i386-pc --no-floppy /dev/sda
(chroot) # boot-update

Now you need to update your boot loader configuration file:

(chroot) # boot-update

You only need to run grub-install when you first install Funtoo Linux, but you need to re-run boot-update every time you modify your /etc/boot.conf file, so your changes are applied on next boot.

New School (UEFI)

If you're using UEFI to boot, setting up the boot loader is a bit more complicated for now, but this process will be improving soon. Perform the following steps.

Emerging GRUB

First, emerge boot-update. You will notice grub and efibootmgr getting pulled in as dependencies. This is expected and good:

(chroot) # emerge boot-update
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 /boot. GRUB will boot those. But how do we get UEFI to boot GRUB? Well, we need to run the following command:

For x86-64bit systems:

(chroot) # grub-install --target=x86_64-efi --efi-directory=/boot --bootloader-id="Funtoo Linux [GRUB]" --recheck /dev/sda

For x86-32bit systems:

(chroot) # grub-install --target=i386-efi --efi-directory=/boot --bootloader-id="Funtoo Linux [GRUB]" --recheck /dev/sda

This command will simply install all the stuff to /boot/EFI and /boot/grub that your system needs to boot. In particular, the /boot/EFI/grub/grubx64.efi 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:

  • --target=x86_64-efi or --target=i386-efi: Tells GRUB that we want to install it in a way that allows it to boot in UEFI
  • --efi-directory=/boot: All GRUB UEFI files will be installed in /boot
  • --bootloader-id="Funtoo Linux [GRUB]": 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.
  • --recheck: If a device map already exists on the disk or partition that GRUB is being installed on, it will be removed.
  • /dev/sda: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 /boot/grub/grub.cfg to support UEFI booting.

First, you will need to edit /etc/boot.conf. 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:

/etc/boot.conf
boot {
        generate grub
        default "Funtoo Linux"
        timeout 3
}

"Funtoo Linux" {
        kernel vmlinuz[-v]
        params += rootfstype=ext4 root=/dev/sda2
}

After you have edited your /etc/boot.conf file, run boot-update. You should now have a /boot/grub/grub.cfg file, which you can edit using the following command:

# nano /boot/grub/grub.cfg


To get your /boot/grub/grub.cfg to support booting with UEFI, make the following changes. Below the existing insmod lines, add the following lines. Both of these involve adding support for the UEFI framebuffer to GRUB.:

  insmod efi_gop
  insmod efi_uga

Then, change the set gfxpayload line to read as follows. UEFI does not support text mode, so we will keep video initialized to the current resolution.:

  set gfxpayload=keep

You can now save your changes by pressing Control-X and answering y when asked if you want to save the modified buffer. When prompted for a filename, hit Enter to use the existing filename.