Difference between pages "LVM Install Guide" and "Help:Funtoo Editing Guidelines"

(Difference between pages)
m (fix typo)
 
 
Line 1: Line 1:
== Introduction ==
+
'''Thanks for your interest in contributing to the the Funtoo wiki!'''
 +
__NOTOC__
 +
=== Types of Edits ===
  
{{fancynote|This tutorial will show you how to install Funtoo, including the rootfs, on logical volumes. This guide is meant to complement the regular [[Funtoo_Linux_Installation|Funtoo Installation Guide]]. It is recommended that you open it in another tab/window and follow along with it as we will only be documenting the steps that are different or in addition to the regular guide.}}
+
Before we get started, let's review what changes are okay to make, and what changes are not okay:
  
LVM (Logical Volume Management) offers a much more flexible way of managing your storage devices. Not only does it allow you to resize your volumes
+
{{TableStart}}
 +
<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}}
  
== Live CD ==
+
{{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.}}
  
Please read the [[Funtoo Linux Installation#Live CD|Live CD]] section in the regular guide. The only thing you need in addition to the [[Requirements|requirements]] it mentions is the sys-fs/lvm2 package or equivalent. If you use [http://www.sysresccd.org/ System Rescue CD], it includes the lvm2 package.
+
=== Basics ===
  
== Prepare the drives and partitions ==
+
Here is a list of basic wiki information that you will need to know to get started:
  
{{fancynote|For this guide, we are assuming you are using MBR, that you have a /dev/sda1 (a boot drive) and /dev/sdb1 (a system drive), and that you are only using LVM with one drive, even though LVM supports adding multiple hard disks and partitions to a volume group. Please adapt these instructions to suit your needs.}}
+
* First, to perform edits on the wiki, you must {{CreateAccount}} and log in.
 +
* 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.
  
Preparing the hard disk for an LVM install isn't much different from a normal install except that we won't be creating a bunch of partitions as we are going to use logical volumes instead.
+
{{tip|The following sections document how to use wikitext and Funtoo templates on the Funtoo wiki.}}
  
Find the disk:
+
=== Paragraphs ===
  
<console>
+
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.
# fdisk -l
+
</console>
+
  
Verify the disk:
+
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:
  
<console>
+
foobar
# fdisk -l /dev/sdb
+
</console>
+
  
Zap the disk:
+
This can rear its ugly head when specifying template parameters, so you will get this:
  
<console>
+
{{note| ugh!}}
# sgdisk --zap-all /dev/sdb
+
</console>
+
  
Create the partition table:
+
...instead of this:
  
{{fancynote|If you are using MBR, review paritioning [[Funtoo_Linux_Installation#Partitioning_Using_fdisk_.28MBR.29|Partitioning Using fdisk]] and if you are using GPT, review [[Partitioning using gdisk]]. The basic idea is to create what ncessary and then allocate the rest for LVM.}}
+
{{note|This looks much better!}}
  
For MBR, this is the boot partition (if you want it on the system drive), every else goes to LVM like so:
+
=== Page and Section Capitalization= ==
  
<console>
+
In general, capitalize all words in page names and section heading except:
# fdisk /dev/sdb
+
* Articles: a, an, the
</console>
+
* Coordinating Conjunctions: and, but, or, for, nor, etc.
 +
* Prepositions (fewer than five letters): on, at, to, from, by, etc.
  
<pre>
+
=== Document Hierarchy ===
Disk /dev/sdb: 596.2 GiB, 640135028736 bytes, 1250263728 sectors
+
Units: sectors of 1 * 512 = 512 bytes
+
Sector size (logical/physical): 512 bytes / 512 bytes
+
I/O size (minimum/optimal): 512 bytes / 512 bytes
+
Disklabel type: dos
+
Disk identifier: 0xaa6abfe1
+
  
Device    Boot    Start        End    Blocks  Id System
+
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:
/dev/sdb1          2048    264191    131072  83 Linux
+
/dev/sdb2        264192 1250263727 624999768  83 Linux
+
</pre>
+
  
For GPT, this is the  BIOS boot partion and the boot partition (if you want them on the system drive), every else goes to LVM like so:
+
<pre>= Page Title =
  
<console>
+
== Chapter Title ==
# gdisk /dev/sdb
+
</console>
+
  
<pre>
+
=== Section Title ===
Disk /dev/sdb: 596.2 GiB, 640135028736 bytes, 1250263728 sectors
+
 
Units: sectors of 1 * 512 = 512 bytes
+
==== SubSection Title ====
Sector size (logical/physical): 512 bytes / 512 bytes
+
I/O size (minimum/optimal): 512 bytes / 512 bytes
+
Disklabel type: dos
+
Disk identifier: 0x6ba8799c
+
  
Device    Boot    Start        End    Blocks  Id System
 
/dev/sdb1          2048      6143      2048  ef EFI (FAT-12/16/32)
 
/dev/sdb2          6144    268287    131072  83 Linux
 
/dev/sdb3        268288 1250263727 624997720  83 Linux
 
 
</pre>
 
</pre>
  
You'll notice in both cases that a swap partition wasn't created. This is becasue if one is desired, it can be done in LVM.
+
{{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.}}
  
Create the physical volume:
+
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.
  
{{fancynote|As a reminder, for this guide, we are assuming you are using MBR, that you have a /dev/sda1 (a boot drive) and /dev/sdb1 (a system drive), and that you are only using LVM with one drive. Change this to suit your purposes.}}
+
=== Links ===
  
Our first step is to create a physical volume which basically just tells the lvm where to write the data to.
+
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>.
  
<console>
+
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.
# pvcreate -f -f /dev/sdb1
+
</console>
+
  
<pre>
+
=== Lists ===
  Physical volume "/dev/sdb1" successfully created
+
</pre>
+
  
Display the physical volume:
+
MediaWiki supports a number of list formats:
  
<console>
+
* Unordered List
# pvdisplay
+
* Unordered Item 2
</console>
+
** Unordered sub-item
  
<pre>
+
# Ordered List
  "/dev/sdb1" is a new physical volume of "596.17 GiB"
+
# Ordered Item 2
  --- NEW Physical volume ---
+
## Ordered sub-item
  PV Name              /dev/sdb1
+
  VG Name             
+
  PV Size              596.17 GiB
+
  Allocatable          NO
+
  PE Size              0 
+
  Total PE              0
+
  Free PE              0
+
  Allocated PE          0
+
  PV UUID              IDDrWr-t3PD-7t31-fRQ3-pay2-eMGy-1NgrD0
+
</pre>
+
  
Create the volume group:
+
;Term: This is called a "definition list". It is used when defining various terms.
  
Now that we have a place to store our data we need to create a volume group for it. A volume group is simply a named group of at least one physical volume. This allows multiple physical volumes to be used to store data. In our simple example we only have one physical volume so we'll create a volume group and add our physical volume to it in one command. We are going to call our volume group "funtoo" but you can name it anything you want.
+
If you need to quote a portion of text from another site, use <tt><nowiki><blockquote></nowiki></tt> as follows:
  
<console>
+
<blockquote>
# vgcreate funtoo /dev/sdb1
+
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]
</console>
+
</blockquote>
 +
 
 +
=== Literal Text and HTML Symbols ===
 +
 
 +
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!)
  
 
<pre>
 
<pre>
  Volume group "funtoo" successfully created
+
* Unordered List
</pre>
+
* Unordered Item 2
 +
** Unordered sub-item
  
Display the volume group:
+
# Ordered List
 +
# Ordered Item 2
 +
## Ordered sub-item
  
<console>
+
;Term: This is called a "definition list". It is used when defining various terms.
# vgdisplay
+
</console>
+
  
<pre>
+
If you need to quote a portion of text from another site, use <tt><nowiki><blockquote></nowiki></tt> as follows:
  --- Volume group ---
+
 
  VG Name              funtoo
+
<blockquote>
  System ID           
+
Wikipedia (ˌwɪkɨˈpiːdiə/ or wɪkiˈpiːdiə/ wik-i-pee-dee-ə) is a collaboratively edited, multilingual, free-access,
  Format                lvm2
+
free content Internet encyclopedia that is supported and hosted by the non-profit Wikimedia Foundation. Volunteers
  Metadata Areas        1
+
worldwide collaboratively write Wikipedia's 30 million articles in 287 languages, including over 4.5 million in the
  Metadata Sequence No  1
+
English Wikipedia. Anyone who can access the site can edit almost any of its articles, which on the Internet
  VG Access            read/write
+
comprise[4] the largest and most popular general reference work.[5][6][7][8][9] In February 2014, The New York
  VG Status            resizable
+
Times reported that Wikipedia is ranked fifth globally among all websites stating, "With 18 billion page views
  MAX LV                0
+
and nearly 500 million unique visitors a month..., Wikipedia trails just Yahoo, Facebook, Microsoft and Google,
  Cur LV                0
+
the largest with 1.2 billion unique visitors."[10]
  Open LV              0
+
</blockquote>
  Max PV                0
+
  Cur PV                1
+
  Act PV                1
+
  VG Size              596.17 GiB
+
  PE Size              4.00 MiB
+
  Total PE              152619
+
  Alloc PE / Size      0 / 0 
+
  Free  PE / Size      152619 / 596.17 GiB
+
  VG UUID              jFubWA-SGaa-w3C7-Zrst-9Hqo-mWPZ-9JqYZ4
+
 
</pre>
 
</pre>
  
Create the logical volumes:
+
=== Linking to Packages ===
  
We now come to the heart of using LVM, logical volumes. Here we get to create logical volumes to store our data. Remember that the best part of LVM is the ability to resize volumes later on the fly so keep that in mind when deciding how big to make volumes. No need to allocate all your space right away. Also keep in mind when choosing a file system type that it must support resizing in order to take advantage of LVM's resizing features.
+
To link to a package page, use the <code>Package</code> template:
  
For our simple example we are only going to create 4 logical volumes and use them for: (SWAP) /(ROOT), /home/my and /home/my/media.
+
<pre><nowiki>
 +
{{Package|sys-apps/portage}}
 +
</nowiki></pre>
  
<console>
+
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:
# lvcreate -L 32G -n SWAP funtoo
+
</console>
+
  
<pre>
+
{{Package|sys-apps/portage}}
  Logical volume "SWAP" created
+
</pre>
+
  
<console>
+
If you specify a yet-to-be-documented ebuild, it will render like this (which is okay -- it will encourage people to document it):
# lvcreate -L 64G -n ROOT funtoo
+
</console>
+
  
<pre>
+
{{Package|sys-foo/undocumented-ebuild}}
  Logical volume "ROOT" created
+
</pre>
+
  
<console>
+
=== Tables ===
# lvcreate -L 128G -n home_my funtoo
+
 
</console>
+
Instead of using traditional MediaWiki table wikitext, use the following format:
  
 
<pre>
 
<pre>
  Logical volume "home_my" created
+
{{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>
 
</pre>
  
<console>
+
This wil render as follows:
# lvcreate -L 256G -n home_my_media funtoo
+
</console>
+
  
<pre>
+
{{TableStart}}
  Logical volume "home_my_media" created
+
<tr class="info"><th>Header 1</th><th>Header 2</th></tr>
</pre>
+
<tr><td>Value 1</td><td>Value 2</td></tr>
 +
<tr><td>Value 3</td><td>Value 4</td></tr>
 +
{{TableEnd}}
  
Display the logical volumes:
+
{{tip|This table syntax has an added benefit of creating a responsive table that renders properly on mobile devices.}}
  
<console>
+
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:
# lvdisplay
+
 
</console>
+
{{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>
 
<pre>
  --- Logical volume ---
+
<syntaxhighlight lang="python">
  LV Path                /dev/funtoo/SWAP
+
import system
  LV Name                SWAP
+
</syntaxhighlight>
  VG Name                funtoo
+
  LV UUID                VkdEAk-Jshp-qcQ0-jU7m-m7f4-fyG6-1FZJlh
+
  LV Write Access        read/write
+
  LV Creation host, time funtoo, 2014-07-24 04:39:19 -0400
+
  LV Status              available
+
  # open                0
+
  LV Size                32.00 GiB
+
  Current LE            8192
+
  Segments              1
+
  Allocation            inherit
+
  Read ahead sectors    auto
+
  - currently set to    256
+
  Block device          253:1
+
 
+
  --- Logical volume ---
+
  LV Path                /dev/funtoo/ROOT
+
  LV Name                ROOT
+
  VG Name                funtoo
+
  LV UUID                2WE7dL-R5BN-dM78-eMx5-hwS8-SjWJ-mUjzL4
+
  LV Write Access        read/write
+
  LV Creation host, time funtoo, 2014-07-24 04:39:24 -0400
+
  LV Status              available
+
  # open                0
+
  LV Size                64.00 GiB
+
  Current LE            16384
+
  Segments              1
+
  Allocation            inherit
+
  Read ahead sectors    auto
+
  - currently set to    256
+
  Block device          253:2
+
 
+
  --- Logical volume ---
+
  LV Path                /dev/funtoo/home_my
+
  LV Name                home_my
+
  VG Name                funtoo
+
  LV UUID                OJnpYM-399Y-8pa3-iMTY-Nle3-IyK1-keDtng
+
  LV Write Access        read/write
+
  LV Creation host, time funtoo, 2014-07-24 04:40:16 -0400
+
  LV Status              available
+
  # open                0
+
  LV Size                128.00 GiB
+
  Current LE            32768
+
  Segments              1
+
  Allocation            inherit
+
  Read ahead sectors    auto
+
  - currently set to    256
+
  Block device          253:3
+
 
+
  --- Logical volume ---
+
  LV Path                /dev/funtoo/home_my_media
+
  LV Name                home_my_media
+
  VG Name                funtoo
+
  LV UUID                tt7cin-igC4-VD85-fDKV-J692-fV3F-auJYcU
+
  LV Write Access        read/write
+
  LV Creation host, time funtoo, 2014-07-24 04:40:30 -0400
+
  LV Status              available
+
  # open                0
+
  LV Size                256.00 GiB
+
  Current LE            65536
+
  Segments              1
+
  Allocation            inherit
+
  Read ahead sectors    auto
+
  - currently set to    256
+
  Block device          253:4
+
 
</pre>
 
</pre>
  
Activate swap:
+
This will produce the following output:
  
<console>
+
<syntaxhighlight lang="python">
# mkswap /dev/mapper/funtoo-SWAP
+
import system
</console>
+
</syntaxhighlight>
 +
 
 +
Alternatively, if you need a caption, use can use the file template, specifying a <tt>lang=</tt> parameter:
  
 
<pre>
 
<pre>
Setting up swapspace version 1, size = 33554428 KiB
+
{{file|name=foobar|lang=python|desc=foobarosity|body=
no label, UUID=ccc83857-28da-4508-a393-84e974e0eeb1
+
import system
 +
}}
 
</pre>
 
</pre>
  
<console>
+
This will produce:
# swapon /dev/mapper/funtoo-SWAP
+
</console>
+
  
Create the filesystems:
+
{{file|name=foobar|lang=python|desc=foobarosity|body=
 +
import system
 +
}}
  
{{fancynote|Before proceeding you should read through the brief section [[Funtoo Linux Installation#Creating filesystems|Creating filesystems]] in the install guide and decide what type of filesystem you would like to use. Do not actually create any file systems though, we will cover that below.}}
+
{{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.}}
  
<console>
+
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].
# mkfs.ext2      /dev/sda1
+
 
</console>
+
=== 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>
 
<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>
 
</pre>
  
<console>
+
This will produce:
# mkfs.ext4      /dev/mapper/funtoo-ROOT
+
</console>
+
  
<pre>
+
{{file|name=/etc/foo.conf|desc=My foo.conf file|body=
mke2fs 1.42.10 (18-May-2014)
+
# /etc/host.conf:
Creating filesystem with 16777216 4k blocks and 4194304 inodes
+
# $Header: /var/cvsroot/gentoo/src/patchsets/glibc/extra/etc/host.conf,v 1.1 2006/09/29
Filesystem UUID: 0ab8f9ab-e824-4d69-a9c4-201d4ccd99ac
+
}}
Superblock backups stored on blocks:  
+
32768, 98304, 163840, 229376, 294912, 819200, 884736, 1605632, 2654208,  
+
4096000, 7962624, 11239424
+
  
Allocating group tables: done                           
+
=== Console ===
Writing inode tables: done                           
+
To display console output, use the <tt>&#60;console&#62;</tt> tag:
Creating journal (32768 blocks): done
+
Writing superblocks and filesystem accounting information: done 
+
</pre>
+
  
 +
For a root console:
 +
<pre>
 
<console>
 
<console>
# mkfs.ext4      /dev/mapper/funtoo-home_my
+
###i## run a command as root
 
</console>
 
</console>
 
<pre>
 
mke2fs 1.42.10 (18-May-2014)
 
Creating filesystem with 33554432 4k blocks and 8388608 inodes
 
Filesystem UUID: 46e394c1-3635-4f13-ba51-10c537d2b5ed
 
Superblock backups stored on blocks:
 
32768, 98304, 163840, 229376, 294912, 819200, 884736, 1605632, 2654208,
 
4096000, 7962624, 11239424, 20480000, 23887872
 
 
Allocating group tables: done                           
 
Writing inode tables: done                           
 
Creating journal (32768 blocks): done
 
Writing superblocks and filesystem accounting information: done   
 
 
</pre>
 
</pre>
 
+
Produces:
 
<console>
 
<console>
# mkfs.xfs        /dev/mapper/funtoo-home_my_media
+
###i## run a command as root
 
</console>
 
</console>
  
 +
For a non-root console:
 
<pre>
 
<pre>
meta-data=/dev/mapper/funtoo-home_my_media isize=256    agcount=4, agsize=16777216 blks
+
<console>
        =                      sectsz=512  attr=2, projid32bit=0
+
$ ##i##run a command as user
data    =                      bsize=4096  blocks=67108864, imaxpct=25
+
</console>
        =                      sunit=0      swidth=0 blks
+
naming  =version 2              bsize=4096  ascii-ci=0
+
log      =internal log          bsize=4096  blocks=32768, version=2
+
        =                      sectsz=512  sunit=0 blks, lazy-count=1
+
realtime =none                  extsz=4096  blocks=0, rtextents=0
+
 
</pre>
 
</pre>
 
+
Produces:
Label the filesystems:
+
 
+
 
<console>
 
<console>
# e2label /dev/sda1 boot
+
$ ##i##run a command as user
 
</console>
 
</console>
  
== Prepare for chroot ==
+
{{important|1=
 +
Note that we use a <tt>#</tt> prompt for <tt>root</tt> and a <tt>$</tt> prompt to denote a non-root user.}}
  
Activiate the volumes:
+
{{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.}}
  
<console>
+
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.
# vgscan
+
# vgchange -a y
+
</console>
+
  
Mount the filesystems:
+
The following special character sequences are also available:
 +
* <code>##g##</code> - Green
 +
* <code>##y##</code> - Yellow
 +
* <code>##bl##</code> - Blue
 +
* <code>##r##</code> - Red
 +
* <code>##b##</code> - Bold
  
<console>
+
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.
# mkdir -p /mnt/funtoo
+
 
# mount /dev/mapper/funtoo-ROOT /mnt/funtoo
+
Here is an example of its use:<console>
# mkdir -p /mnt/funtoo/boot
+
# ##i##bluetoothctl
# mount /dev/sda1 /mnt/funtoo/boot
+
[##g##NEW##!g##] Controller 00:02:72:C9:62:65 antec [default]
# mkdir -p /mnt/funtoo/home/my
+
##bl##[bluetooth]##!bl###power on
# mount /dev/mapper/funtoo-home_my /mnt/funtoo/home/my
+
Changing power on succeeded
# mkdir -p /mnt/funtoo/home/my/media
+
##bl##[bluetooth]##!bl### ##i##agent on
# mount /dev/mapper/funtoo-home_my_media /mnt/funtoo/home/my/media
+
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>
  
== Resume from Funtoo Linux Installation ==
+
=== Informational Messages ===
 +
Notes, warnings, tips, and important templates can be used for informational messages that need to be offset from the regular text flow:
  
You may safely resume from [http://www.funtoo.org/Funtoo_Linux_Installation#Installing_the_Stage_3_tarball Installing the Stage 3 tarball] with few exceptions:
+
<pre>{{note|this is a note}}</pre>
 +
{{note|this is a note}}
  
=== fstab ===
+
<pre>{{important|this is important}}</pre>
 +
{{important|this is important}}
  
 +
<pre>{{warning|this is a warning}}</pre>
 +
{{warning|this is a warning}}
 +
 +
<pre>{{tip|this is a tip}}</pre>
 +
{{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.
 +
 +
=== Kernelop ===
 +
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>
 
<pre>
# <filesystem>                  <mountpoint>        <type>      <opts>      <dump>      <pass>
+
{{kernelop|title=foo,bar|desc=
/dev/funtoo/SWAP                none                swap        sw          0          0
+
kernel options pasted from "make menuconfig"
/dev/funtoo/ROOT                /                  ext4        noatime    0          1
+
}}
LABEL=boot                      /boot              ext2        noatime    0          0
+
/dev/funtoo/home_my            /home/my            ext4        noatime    0          2
+
/dev/funtoo/home_my_media      /home/my/media      xfs        noatime    0          2
+
 
</pre>
 
</pre>
  
=== kernel ===
+
{{note|Kernelop is colored blue to slightly resemble the blueish background from <tt>make menuconfig</tt>.}}
  
Enable kernel options:
+
Adding this entry will give you the following output:  
{{kernelop
+
{{kernelop|title=foo,bar|desc=
|title=
+
kernel options
|desc=
+
General setup --->
+
      [*] Initial RAM filesystem and RAM disk (initramfs/initrd) support
+
 
}}
 
}}
{{kernelop
+
 
|title=
+
Here's a more concrete example:
|desc=
+
{{kernelop|title=File systems|desc=
Device Drivers --->
+
<M> Second extended fs support         
      Generic Driver Options --->
+
[ ]   Ext2 extended attributes         
      [*] Maintain a devtmpfs filesystem to mount at /dev
+
[ ]  Ext2 execute in place support    
}}
+
<M> Ext3 journalling file system support
{{kernelop
+
|title=
+
|desc=
+
Device Drivers --->
+
      [*] Multiple devices driver support --->
+
      <*>Device Mapper Support
+
 
}}
 
}}
  
Build initramfs (genkernel):
+
Examples of usage:  
 +
* [[Package:AMD Catalyst Video Drivers]]
 +
* [[Package:ACPI Daemon]]
 +
* [[Microcode]]
  
{{fancynote|This builds only an initramfs with lvm support. It does not build the whole kernel so you still have to do that.}}
+
=== Discussion Pages ===
  
<console>
+
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:
# genkernel --lvm initramfs
+
</console>
+
 
+
=== boot-update ===
+
  
 
<pre>
 
<pre>
boot {
+
{{DISQUS}}
  generate grub
+
</pre>
  default "Funtoo Linux"
+
  timeout 3
+
}
+
  
"Funtoo Linux" {
+
...and presto! You will now have DISQUS-powered mini-forums to discuss whatever you want about your wiki page.
  kernel kernel-genkernel-x86_64-3.14.13
+
 
  initrd initramfs-genkernel-x86_64-3.14.13
+
== Marking Pages as Needing Updates ==
  params += dolvm real_root=/dev/mapper/funtoo-ROOT rootfstype=ext4 resume=swap:/dev/mapper/funtoo-SWAP quiet
+
 
}
+
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:
 +
 
 +
<pre>
 +
{{PageNeedsUpdates}}
 +
{{SectionNeedsUpdates}}
 
</pre>
 
</pre>
  
=== software ===
 
  
<console>
+
Examples of usage:
# emerge -va lvm2
+
* [[UEFI Install Guide]]
</console>
+
* [[Package:MediaWiki]]
 +
* [[Clang]]
  
For the most part, LVM "just works" without any additional configuration. This is especially true for versions below 2.02.107. If you are using >=sys-fs/lvm2-2.02.107 with Funtoo, there are two features be desired that are turned off by default:
+
=== Inline Code ===
  
The Metadata Daemon ([https://access.redhat.com/documentation/en-US/Red_Hat_Enterprise_Linux/6/html/Logical_Volume_Manager_Administration/metadatadaemon.html lvmetad])
+
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:
  
Thinly-Provisioned Logical Volumes ([https://access.redhat.com/documentation/en-US/Red_Hat_Enterprise_Linux/6/html/Logical_Volume_Manager_Administration/thinprovisioned_volumes.html Thin Volumes])
+
<pre>
 +
The <code>/etc/fstab</code> file is an important one. Another important file is <code>/boot/grub/grub.cfg</code>.
 +
</pre>
  
Enabling either is simply a matter of enabling their USE flags.
+
This example produces the following output:
  
== Cleaning up ==
+
The <code>/etc/fstab</code> file is an important one. Another important file is <code>/boot/grub/grub.cfg</code>.
  
<console>
+
{{important|1=
# exit
+
The &#60;tt&#62; tag has been deprecated for the purpose of tagging inline code, to conform with HTML5.}}
# cd /
+
# cat /proc/mounts | grep funtoo | awk '{print $2}' | grep "^$MOUNTPOINT" | sort -r | xargs umount
+
# umount /mnt/funtoo
+
# swapoff -v /dev/mapper/funtoo-SWAP
+
# vgchange -a n
+
# init 0
+
</console>
+
  
== Special notes ==
+
=== Slideshow ===
  
=== Resizing ===
+
Any page has the capability of displaying a slideshow. Adding a slideshow to a page involves three steps:
  
{{fancynote|Resizing is filesystem specific. Most can be grown but cannot be shrunk.}}
+
# Upload Images
 +
# Define Slides
 +
# Add Slideshow to page
  
==== Growing /home/my by 8G ====
+
==== Upload Images ====
  
<console>
+
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'''.
# lvextend -L+8G /dev/mapper/funtoo-home_my
+
</console>
+
  
===== ext2/ext3/ext4 =====
+
==== Define Slides ====
  
<console>
+
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:
# resize2fs /mnt/funtoo/home/my
+
</console>
+
  
===== xfs =====
+
<pre><nowiki>
 +
{{#subobject:|slideIndex=0|slideCaption=
 +
== Wikitext Here ==
 +
This is a fantastic slide!
 +
|slideImage=File:Fruit.jpg|slideLink=PageName}}
 +
</nowiki></pre>
  
<console>
+
Here are some important instructions regarding defining slides:
# xfs_growfs /mnt/funtoo/home/my
+
</console>
+
  
==== Shrinking /home/my by 8G ====
+
* <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.
  
{{fancynote|You generally need to umount first.}}
+
==== Add Slideshow to Page ====
  
===== ext2/ext3/ext4 =====
+
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>
<console>
+
{{Slideshow}}
# umount /mnt/funtoo/home/my
+
</pre>
# lvreduce -r -L -8G /dev/mapper/funtoo-home_my
+
</console>
+
  
===== xfs =====
+
=== YouTube Videos (Screencasts, etc.) ===
  
XFS cannot be shrunk.
+
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.
  
== Beyond the basics ==
+
<pre>{{#widget:YouTube16x9|id=5KDei5mBfSg}}</pre>
 +
{{#widget:YouTube16x9|id=5KDei5mBfSg}}
  
The [[LVM Fun]] page may be of interest.
+
{{tip|The sample video above explains how to create your own screencasts under Funtoo Linux.}}
  
As well as these pages from Red Hat: [https://access.redhat.com/documentation/en-US/Red_Hat_Enterprise_Linux/6/html/Logical_Volume_Manager_Administration/snapshot_command.html Creating Snapshot Volumes]
+
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.
[https://access.redhat.com/documentation/en-US/Red_Hat_Enterprise_Linux/6/html/Logical_Volume_Manager_Administration/thinly_provisioned_volume_creation.html Creating Thinly-Provionsed Logical Volumes]
+
{{note|These YouTube widgets have been updated to be mobile-friendly.}}
[https://access.redhat.com/documentation/en-US/Red_Hat_Enterprise_Linux/6/html/Logical_Volume_Manager_Administration/mirror_create.html Creating Mirrored Volumes]
+
  
[[Category:HOWTO]]
+
[[Category:Wiki Development]]
[[Category:Install]]
+
[[Category:Official Documentation]]
+

Revision as of 05:18, January 2, 2015

Thanks for your interest in contributing to the the Funtoo wiki!

Types of Edits

Before we get started, let's review what changes are okay to make, and what changes are not okay:

Type of ChangeOkay?
Grammar/spelling fixesYes
New wiki contentYes
New package informationYes
Adding to existing articleMaybe -- see below
Adding missing/incomplete informationYes
Making correctionsYes
Adding work-arounds to problems experiencedNo - open bug first on bug tracker.
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.

Basics

Here is a list of basic wiki information that you will need to know to get started:

  • First, to perform edits on the wiki, you must Create a Funtoo account and log in.
  • 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 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:

= Page Title =

== Chapter Title ==

=== Section Title ===

==== SubSection Title ====

Note

By default, Table of Contents is disabled on the Funtoo wiki. If you would like to enable the TOC, you can place a __TOC__ on a blank line where you'd like the Table of Contents to appear, or place __FORCETOC__ 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 [[pagename]]. To specify an alternate name for the link, use [[pagename|my link name]].

For external links, use [http://funtoo.org my link] 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
  1. Ordered List
  2. Ordered Item 2
    1. 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 <blockquote> as follows:

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]

Literal Text and HTML Symbols

Here is wikitext for the section above, which I am displaying by placing the literal wikitext between a <pre> and </pre> tag. If you want to disable wikitext processing for an inline span of text, use <nowiki> and </nowiki>. If you want to print out a tag literally, use &#60; and &#62; (In the wikitext, I used &amp;#60; and &amp;#62 to display these!)

* 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><blockquote></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>

Linking to Packages

To link to a package page, use the Package template:

{{Package|sys-apps/portage}}

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:

{{#ask: CatPkg::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):

{{#ask: CatPkg::sys-foo/undocumented-ebuild }}

Tables

Instead of using traditional MediaWiki table wikitext, use the following format:

{{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}}

This wil render as follows:

Header 1Header 2
Value 1Value 2
Value 3Value 4
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 tr (rows) and td/th elements to color them as desired:

Class Name
success
info
warning
active
danger

Displaying Source Code

To display source code, use the <syntaxhighlight> tag, which has the ability to perform syntax highlighting on the source code for easier reading:

<syntaxhighlight lang="python">
import system
</syntaxhighlight>

This will produce the following output:

import system

Alternatively, if you need a caption, use can use the file template, specifying a lang= parameter:

{{file|name=foobar|lang=python|desc=foobarosity|body=
import system
}}

This will produce:

foobar (python source code) - foobarosity
import system
Important

If you need to display the pipe ("|") character within the body of a file template, replace each "|" with {{!}} -- otherwise your file contents will not display properly. This is necessary because {{file}} 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 lang attribute. For a list of supported languages, see 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 <pre> tags, or use the new file template. The file template is used like so:

{{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
}}

This will produce:

/etc/foo.conf - My foo.conf file
# /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 <console> tag:

For a root console:

<console>
###i## run a command as root
</console>

Produces:

# run a command as root

For a non-root console:

<console>
$ ##i##run a command as user
</console>

Produces:

$ run a command as user
Important

Note that we use a # prompt for root and a $ prompt to denote a non-root user.

Important

The ##i## 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 need to end highlighting of user input prior to the end of a line, use ##!i## to mark the end of the highlighted area.

The following special character sequences are also available:

  • ##g## - Green
  • ##y## - Yellow
  • ##bl## - Blue
  • ##r## - Red
  • ##b## - 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 ##!(colorcode)## option to turn color off prior to end of line.

Here is an example of its use:
# 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]
#

Informational Messages

Notes, warnings, tips, and important templates can be used for informational messages that need to be offset from the regular text flow:

{{note|this is a note}}
Note

this is a note

{{important|this is important}}
Important

this is important

{{warning|this is a warning}}
Warning

this is a warning

{{tip|this is a tip}}
Tip

this is a tip

Note that these templates used to be called fancynote, fancytip, etc. The "fancy" names have been deprecated but will still be supported for the forseeable future.

Kernelop

To display kernel configuration options, we encourage you to use the kernelop template. To use the kernelop template, create an entry similar to the following example:

{{kernelop|title=foo,bar|desc=
kernel options pasted from "make menuconfig"
}} 
Note

Kernelop is colored blue to slightly resemble the blueish background from make menuconfig.

Adding this entry will give you the following output: Under foo-->bar:

kernel options

Here's a more concrete example: Under File systems:

<M> Second extended fs support          
[ ]   Ext2 extended attributes          
[ ]   Ext2 execute in place support     
<M> Ext3 journalling file system support

Examples of usage:

Discussion Pages

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:

{{DISQUS}}

...and presto! You will now have DISQUS-powered mini-forums to discuss whatever you want about your wiki page.

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 Needs Updates Category so we can identify pages that need updating:

{{PageNeedsUpdates}}
{{SectionNeedsUpdates}}


Examples of usage:

Inline Code

To emphasize filenames, commands, and other technical jargon when they appear inline in a paragraph, use the <code> element. Follow the example below:

The <code>/etc/fstab</code> file is an important one. Another important file is <code>/boot/grub/grub.cfg</code>.

This example produces the following output:

The /etc/fstab file is an important one. Another important file is /boot/grub/grub.cfg.

Important

The <tt> 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:

  1. Upload Images
  2. Define Slides
  3. 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:

{{#subobject:|slideIndex=0|slideCaption=
== Wikitext Here ==
This is a fantastic slide!
|slideImage=File:Fruit.jpg|slideLink=PageName}}

Here are some important instructions regarding defining slides:

  • slideIndex 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.)
  • slideCaption= can contain wikitext, such as headings and links. The best way to enter slideCaption is as above -- type a literal slideCaption=, 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 slideImage field. Your slideImage will have a name of File:myname.jpg, where myname.jpg is the Destination Filename you used when uploading the image.
  • An optional parameter called slideLink= 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:

{{Slideshow}}

YouTube Videos (Screencasts, etc.)

Screencasting is an easy method to explain complex tasks. Take for instance youtu.be/5KDei5mBfSg and chop off the id and insert it into the following syntax to produce a video example.

{{#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 YouTube16x9 widget. There is also a YouTube4x3 widget for videos with a 4x3 aspect ratio.

Note

These YouTube widgets have been updated to be mobile-friendly.