Help:Funtoo Editing Guidelines

From Funtoo
Revision as of 08:53, 18 February 2014 by Daniel Robbins (Talk | contribs)

Jump to: navigation, search

This guide is meant to serve as a reference for those who are interested in helping improve the Funtoo wiki.



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

kernel options pasted 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:


To display the contents of a file, use the file template.

| file name | <pre>
contents of the file

This produces:

contents of the file

Examples of usage:

<tt> and <code>

To emphasize filenames, commands, and other technical "jargon," use the <tt> or <code> option. To use these, follow the example below:

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

This example produces the following output (notice the difference between the fonts?):
The /etc/fstab file is an important one. Another important file is /boot/grub/grub.cfg.


To indicate that a user should run commands in a terminal, use <console>:

For a root console:

###i## run a command as root


# run a command as root
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.

Examples of usage:

For a non-root console:

$##i## run a command as user


$ run a command as user

Examples of usage: