Difference between pages "Help:Funtoo Editing Guidelines" and "Wim42gnu's-setup"

From Funtoo
(Difference between pages)
Jump to navigation Jump to search
(The {{console}} template is now preferred over <console> (better maintainability))
 
 
Line 1: Line 1:
'''Thanks for your interest in contributing to the the Funtoo wiki!'''
=WIM42GNU's Funtoo Setup=
__NOTOC__
=== Types of Edits ===


Before we get started, let's review what changes are okay to make, and what changes are not okay:
This is for everybody who might have seen my funtoo setup and liked it!
This is also for myself to keep track on my system. I have used most of the Linux distributions out there and I am currently most happy with funtoo.
My reasons are:
# Gentoo/Funtoo is a rolling release distribution, meaning you only have to install it once and update it frequently.
# Gentoo/Funtoo is only what you make out of it, no unnesecary rubish like in Ubuntu, OpenSuse or Fedora will be installed by default. In the mean time being aware that Gentoo/Funtoo is for advanced users not careing that much about GUIs for Settings or Configs.
# Gentoo/Funtoo runs fast due to multiple reasons. (Compiling your own software,USE-Flags,...)
# Philosophy, one would think that Slackware would suite me most (KISS,Unix) but the fact is that these distributions require you more energy and time to work with. I want to get my jobs done, not careing to much about the system. It is okay to have tools that do things for you as long they are designed well - like in funtoo.


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


{{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.}}
==1. Install Funtoo (not complete yet - I will update this part when I install funtoo the next time)==


=== Basics ===
''Follow the install instructions and setup a minimal system.''http://www.funtoo.org/Funtoo_Linux_Installation


Here is a list of basic wiki information that you will need to know to get started:
Notice you will need to create/edit some configs in the installation prozess. Here are some of mine customizations:


* First, to perform edits on the wiki, you must {{CreateAccount}} and log in.
a) <code>/etc/portage/make.conf</code>:
* 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.
  CFLAGS="-O2 -march=native -pipe -fomit-frame-pointer"
* 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.
  CXXFLAGS="${CFLAGS}"
* 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.
  CPU_FLAGS_X86="aes avx fma4 mmx mmxext popcnt sse sse2 sse3 sse4_1 sse4_2 sse4a ssse3 xop"


{{tip|The following sections document how to use wikitext and Funtoo templates on the Funtoo wiki.}}
''for the CPU Flags checkout:'' http://www.funtoo.org/News:CPU_FLAGS_X86


=== Paragraphs ===
  USE="qt3support theora libkms xa cdr dvd dvdr alsa ffmpeg -gnome gtk -qt4 -kde lm_sensors mp3 mp4 mozilla multilib png python sound udev usb unicode static-libs hddtemp -bluetooth  nvidia X pulseaudio udisks"


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.
  EMERGE_DEFAULT_OPTS="--keep-going"
  FEATURES="-collision-protect ccache"
  CCACHE_SIZE="1G"
  PORTAGE_NICENESS=20
  PORTAGE_IONICE_COMMAND="ionice -c 3 -p \${PID}"
  #EMERGE_DEFAULT_OPTS="--jobs=12"
  MAKEOPTS="-j12" ''<--- Number of CPU cores *2 in my case works best.''


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:
  LANG="de_DE.UTF-8"
  LINGUAS="de" 
  ACCEPT_LICENSE="* -@EULA"
  INPUT_DEVICES="evdev"
  VIDEO_CARDS="nvidia"


foobar


This can rear its ugly head when specifying template parameters, so you will get this:
b) <code>/etc/fstab</code>


{{note| ugh!}}
  # /etc/fstab: static file system information.
  #
  # The root filesystem should have a pass number of either 0 or 1.
  # All other filesystems should have a pass number of 0 or greater than 1.
  #
  # NOTE: If your BOOT partition is ReiserFS, add the notail option to opts.
  #
  # See the manpage fstab(5) for more information.
  #
  # <fs> <mountpoint> <type> <opts> <dump/pass>


...instead of this:
  /dev/sda1 /boot ext2 noauto,noatime 1 2
  #/dev/cdrom /mnt/cdrom auto noauto,ro 0 0
  /dev/mapper/vg-swap    none          swap      sw                              0 0
  /dev/mapper/vg-root    /            ext4      noatime,nodiratime,defaults    0 1
  /dev/sr0                /mnt/cdrom    auto      noauto,ro                      0 0
  /dev/mapper/vg-home    /home        ext4      noatime,nodiratime              0 0
''' tmpfs /var/tmp/portage tmpfs uid=portage,gid=portage,mode=0775,size=16048M,noatime 0 0'''


{{note|This looks much better!}}
for tmpfs see: http://www.funtoo.org/Funtoo_Filesystem_Guide,_Part_3


=== Page and Section Capitalization ===
c) Since I have an encrypted LVM, one needs an initramfs. I prefer the genkernel method.
    genkernel --kernel-config=/path/to/your/custom-kernel-config --no-mrproper --makeopts=-j5 --install --lvm --luks all
more here: http://www.funtoo.org/Rootfs_over_encrypted_lvm or use better-initramfs: http://www.funtoo.org/Initramfs


In general, capitalize all words in page names and section heading except:
d) My Funtoo Profiles:
* Articles: a, an, the
  eselect profile show
* Coordinating Conjunctions: and, but, or, for, nor, etc.
 
* Prepositions (fewer than five letters): on, at, to, from, by, etc.
  Currently set profiles:
    arch: gentoo:funtoo/1.0/linux-gnu/arch/x86-64bit
    build: gentoo:funtoo/1.0/linux-gnu/build/current
  flavor: gentoo:funtoo/1.0/linux-gnu/flavor/desktop
  mix-ins: gentoo:funtoo/1.0/linux-gnu/mix-ins/audio
  mix-ins: gentoo:funtoo/1.0/linux-gnu/mix-ins/console-extras
  mix-ins: gentoo:funtoo/1.0/linux-gnu/mix-ins/dvd
  mix-ins: gentoo:funtoo/1.0/linux-gnu/mix-ins/media
  mix-ins: gentoo:funtoo/1.0/linux-gnu/mix-ins/X
  Automatically enabled profiles:
  mix-ins: gentoo:funtoo/1.0/linux-gnu/mix-ins/print
  mix-ins: gentoo:funtoo/1.0/linux-gnu/mix-ins/X
  mix-ins: gentoo:funtoo/1.0/linux-gnu/mix-ins/audio
  mix-ins: gentoo:funtoo/1.0/linux-gnu/mix-ins/dvd
  mix-ins: gentoo:funtoo/1.0/linux-gnu/mix-ins/media
  mix-ins: gentoo:funtoo/1.0/linux-gnu/mix-ins/console-extras


=== 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:
==2. Install your WindowManager or DesktopEnviroment==


<pre>= Page Title =
''My favourite Window Manager at the time is i3 followed by xfce and openbox.''
''Details about i3 & funtoo → http://www.funtoo.org/Package:I3_(Window_Manager) ''
'''i3 setup:'''


== Chapter Title ==
1) install these packages:
<console> emerge --ask i3 i3status dmenu lxappeareance
</console>
'' If you want to know what these packages are research them. I use lxappeareance to install and select gtk-themes.''


=== Section Title ===
Config files:


==== SubSection Title ====
==='''1.''' xinitrc at <code>~/.xinitrc </code>===
  exec ck-launch-session i3
''You only need --force-xinerama if you do have a nvidia grafics card that do not work without it. For more <code>startx</code> magic → https://wiki.archlinux.org/index.php/xinitrc''


</pre>
==='''2.'''  <code>~/.i3/config</code>===


{{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.}}
''specify window colors at the top of the file:''
  # class                border  backgr. text    indicator
  client.focused          #333333 #000000 #ffffff #000000
  client.focused_inactive #333333 #5f676a #ffffff #484e50
  client.unfocused        #333333 #222222 #888888 #292d2e
  client.urgent          #333333 #900000 #ffffff #900000


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.
''specify the bar/workspace colors at the bottom of the file:''
 
  bar {
          status_command i3status
          # Bar color settings
          colors{
                  #background #000000
                  #statusline #ffffff
                  #separator  #666666
                  # Type            border  background font
                  focused_workspace  #008fff #007fff #ffffff
                  active_workspace  #333333 #5f676a #ffffff
                  inactive_workspace #333333 #222222 #888888
                  urgent_workspace  #aa0000 #990000 #ffffff
          }
  }


=== 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>.
Do not forget the keymap setting at <code>/etc/X11/xorg.conf</code> otherwise you need to use <code>setxkbmap</code>
  Section "InputClass"
    Identifier        "keyboard-all"
    Driver            "evdev"
    MatchIsKeyboard    "on"
  ''' Option        "XkbLayout" "de"'''
  EndSection


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.
==='''3. '''Display Power Management Signaling===


=== Lists ===
a) You can either use XScreenSaver(https://wiki.archlinux.org/index.php/XScreenSaver):
  emerge -a xscreensaver


MediaWiki supports a number of list formats:
and add <code>/usr/bin/xscreensaver -no-splash &</code> to your <code>~/.xinitrc</code> file:
 
  xscreensaver -no-splash &        # starts screensaver daemon
  exec ck-launch-session i3 --force-xinerama


* Unordered List
or b) modifi your Xorg server (https://wiki.archlinux.org/index.php/Display_Power_Management_Signaling).
* Unordered Item 2
** Unordered sub-item


# Ordered List
==='''4. '''Note: ===
# Ordered Item 2
## Ordered sub-item


;Term: This is called a "definition list". It is used when defining various terms.
I login without a login manager using <code>startx</code> to start my Window Manager, you can end/exit your i3 wm via <code>alt or windows key + shift + e</code>


If you need to quote a portion of text from another site, use <tt><nowiki><blockquote></nowiki></tt> as follows:
==='''5.''' Background Image Viewer===


<blockquote>
a) Feh
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> emerge -a feh</console>
</blockquote>
<code>~/.xinitrc</code>:
  feh --bg-center <path>/<image>.png


=== Literal Text and HTML Symbols ===
''more options → https://wiki.archlinux.org/index.php/Feh#As_a_desktop_wallpaper_manager ''


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!)
b) Nitrogen(GUI Programm)
<console> emerge -a nitrogen</console>
<code>~/.xinitrc</code>:
  exec --no-startup-id nitrogen --restore
==3. Additional Software:==


<pre>
===1) File Manager:===
* Unordered List
<console> emerge --ask thunar </console>
* Unordered Item 2
''thunar - filemanager that supports automounting''
** Unordered sub-item
''Make sure you create this rule: <code> /etc/polkit-1/rules.d/10-drives.rules</code>
  polkit.addRule(function(action, subject) {
  if (action.id.indexOf("org.freedesktop.udisks2.") == 0){
  return polkit.Result.YES;
  }
  }
  );


# Ordered List
''Also you should have <code>udisk</code> installed''
# Ordered Item 2
## Ordered sub-item


;Term: This is called a "definition list". It is used when defining various terms.
===2) '''media-video/smplayer:'''===


If you need to quote a portion of text from another site, use <tt><nowiki><blockquote></nowiki></tt> as follows:
''allow smplayer always to floate, just add''
  for_window [class="smplayer" instance="smplayer"] floating enable
''to your <code>~/.i3/config</code>''


<blockquote>
===3)''' Internet Browser '''===
Wikipedia (ˌwɪkɨˈpiːdiə/ or wɪkiˈpiːdiə/ wik-i-pee-dee-ə) is a collaboratively edited, multilingual, free-access,
''I recommend <code>
free content Internet encyclopedia that is supported and hosted by the non-profit Wikimedia Foundation. Volunteers
www-client/chromium</code> or <code>www-client/google-chrome</code>
worldwide collaboratively write Wikipedia's 30 million articles in 287 languages, including over 4.5 million in the
''see for more info: http://www.funtoo.org/Funtoo_Linux_Web_Browsers''
English Wikipedia. Anyone who can access the site can edit almost any of its articles, which on the Internet
  Addons:
comprise[4] the largest and most popular general reference work.[5][6][7][8][9] In February 2014, The New York
  1) Adblock
Times reported that Wikipedia is ranked fifth globally among all websites stating, "With 18 billion page views
  2) uMatrix
and nearly 500 million unique visitors a month..., Wikipedia trails just Yahoo, Facebook, Microsoft and Google,
  3) StayFocused
the largest with 1.2 billion unique visitors."[10]
  4) WebRTC Block
</blockquote>
</pre>


=== Linking to Packages ===
===n)''' usefull software '''===
app-arch/file-roller
app-editors/bluefish
app-emulation/wine
app-misc/freemind
app-office/libreoffice
app-portage/eix
mail-client/thunderbird
media-gfx/blender
media-gfx/gimp
media-sound/audacity
media-video/kdenlive


To link to a package page, use the <code>Package</code> template:


<pre><nowiki>
media-video/vlc
{{Package|sys-apps/portage}}
net-analyzer/wireshark
</nowiki></pre>
net-ftp/filezilla
 
sys-apps/lm_sensors
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:
virtual/jre
 
app-text/evince
{{Package|sys-apps/portage}}
app-text/calibre
 
app-emulation/virtualbox
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 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
}}
 
The parameters {{c|name}} (filename), {{c|lang}} (language for syntax highlighting) and {{c|desc}} (Description, appearing as a caption) are optional. For a list of supported languages, see [http://www.mediawiki.org/wiki/Extension:SyntaxHighlight_GeSHi#Supported_languages this list].
 
 
{{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.}}
 
=== 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 <nowiki>{{console}}</nowiki> template:
 
For a root console:
<pre>
{{console|body=
###i## run a command as root
}}
</pre>
Produces:
{{console|body=
###i## run a command as root
}}
 
For a non-root console:
<pre>
{{console|body=
$ ##i##run a command as user
}}
</pre>
Produces:
{{console|body=
$ ##i##run a command as user
}}
 
{{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.}}
 
{{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 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.
 
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
 
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.
 
Here is an example of its use:{{console|body=
# ##i##bluetoothctl
[##g##NEW##!g##] Controller 00:02:72:C9:62:65 antec [default]
##bl##[bluetooth]##!bl### ##i##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]
#
}}
 
=== Informational Messages ===
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>
{{note|this is a note}}
 
<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>
{{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>.}}
 
Adding this entry will give you the following output:
{{kernelop|title=foo,bar|desc=
kernel options
}}
 
Here's a more concrete example:
{{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:
* [[Package:AMD Catalyst Video Drivers]]
* [[Package:ACPI Daemon]]
* [[Microcode]]
 
=== 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:
 
<pre>
{{DISQUS}}
</pre>
 
...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 [[:Category:Needs Updates|Needs Updates Category]] so we can identify pages that need updating:
 
<pre>
{{PageNeedsUpdates}}
{{SectionNeedsUpdates}}
</pre>
 
 
Examples of usage:
* [[UEFI Install Guide]]
* [[Package:MediaWiki]]
* [[Clang]]
 
=== Inline Code ===
 
To emphasize commands, and other technical jargon when they appear inline in a paragraph, use the <nowiki>{{c}}</nowiki> template. When referencing files, use the <nowiki>{{f}}</nowiki> template.
 
<pre>
The {{f|/etc/fstab}} file is an important one. Another important file is {{f|/boot/grub/grub.cfg}}. The {{c|emerge}} command is really nifty.
</pre>
 
This example produces the following output:
 
The {{f|/etc/fstab}} file is an important one. Another important file is {{f|/boot/grub/grub.cfg}}. The {{c|emerge}} command is really nifty.
 
{{important|1=
The &#60;tt&#62; tag has been deprecated for the purpose of tagging inline code, to conform with HTML5, and the previous use of the &#60;code&#62; tag is discouraged. It is more maintainable to use the <nowiki>{{c}}</nowiki> template. }}
 
=== 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 20:37, February 16, 2015

WIM42GNU's Funtoo Setup

This is for everybody who might have seen my funtoo setup and liked it! This is also for myself to keep track on my system. I have used most of the Linux distributions out there and I am currently most happy with funtoo. My reasons are:

  1. Gentoo/Funtoo is a rolling release distribution, meaning you only have to install it once and update it frequently.
  2. Gentoo/Funtoo is only what you make out of it, no unnesecary rubish like in Ubuntu, OpenSuse or Fedora will be installed by default. In the mean time being aware that Gentoo/Funtoo is for advanced users not careing that much about GUIs for Settings or Configs.
  3. Gentoo/Funtoo runs fast due to multiple reasons. (Compiling your own software,USE-Flags,...)
  4. Philosophy, one would think that Slackware would suite me most (KISS,Unix) but the fact is that these distributions require you more energy and time to work with. I want to get my jobs done, not careing to much about the system. It is okay to have tools that do things for you as long they are designed well - like in funtoo.


1. Install Funtoo (not complete yet - I will update this part when I install funtoo the next time)

Follow the install instructions and setup a minimal system.http://www.funtoo.org/Funtoo_Linux_Installation

Notice you will need to create/edit some configs in the installation prozess. Here are some of mine customizations:

a) /etc/portage/make.conf: 

 CFLAGS="-O2 -march=native -pipe -fomit-frame-pointer"
 CXXFLAGS="${CFLAGS}"
 CPU_FLAGS_X86="aes avx fma4 mmx mmxext popcnt sse sse2 sse3 sse4_1 sse4_2 sse4a ssse3 xop"

for the CPU Flags checkout: http://www.funtoo.org/News:CPU_FLAGS_X86 

 USE="qt3support theora libkms xa cdr dvd dvdr alsa ffmpeg -gnome gtk -qt4 -kde lm_sensors mp3 mp4 mozilla multilib png python sound udev usb unicode static-libs hddtemp -bluetooth  nvidia X pulseaudio udisks"

 EMERGE_DEFAULT_OPTS="--keep-going"
 FEATURES="-collision-protect ccache"
 CCACHE_SIZE="1G"
 PORTAGE_NICENESS=20
 PORTAGE_IONICE_COMMAND="ionice -c 3 -p \${PID}"
 #EMERGE_DEFAULT_OPTS="--jobs=12" 
 MAKEOPTS="-j12" <--- Number of CPU cores *2 in my case works best.

 LANG="de_DE.UTF-8" 
 LINGUAS="de"  
 ACCEPT_LICENSE="* -@EULA" 
 INPUT_DEVICES="evdev"
 VIDEO_CARDS="nvidia"


b) /etc/fstab 

 # /etc/fstab: static file system information.
 #
 # The root filesystem should have a pass number of either 0 or 1.
 # All other filesystems should have a pass number of 0 or greater than 1.
 #
 # NOTE: If your BOOT partition is ReiserFS, add the notail option to opts.
 #
 # See the manpage fstab(5) for more information.
 #
 # <fs>			<mountpoint>	<type>		<opts>		<dump/pass>

 /dev/sda1		/boot		ext2		noauto,noatime	1 2
 #/dev/cdrom		/mnt/cdrom	auto		noauto,ro	0 0
 /dev/mapper/vg-swap     none          swap      sw                              0 0
 /dev/mapper/vg-root     /             ext4      noatime,nodiratime,defaults     0 1
 /dev/sr0                /mnt/cdrom    auto      noauto,ro                       0 0
 /dev/mapper/vg-home     /home         ext4      noatime,nodiratime              0 0
 tmpfs		/var/tmp/portage	tmpfs	uid=portage,gid=portage,mode=0775,size=16048M,noatime	0 0

for tmpfs see: http://www.funtoo.org/Funtoo_Filesystem_Guide,_Part_3

c) Since I have an encrypted LVM, one needs an initramfs. I prefer the genkernel method. 

   genkernel --kernel-config=/path/to/your/custom-kernel-config --no-mrproper --makeopts=-j5 --install --lvm --luks all

more here: http://www.funtoo.org/Rootfs_over_encrypted_lvm or use better-initramfs: http://www.funtoo.org/Initramfs

d) My Funtoo Profiles: 

 eselect profile show
 
 Currently set profiles:
    arch: gentoo:funtoo/1.0/linux-gnu/arch/x86-64bit
   build: gentoo:funtoo/1.0/linux-gnu/build/current
  flavor: gentoo:funtoo/1.0/linux-gnu/flavor/desktop
 mix-ins: gentoo:funtoo/1.0/linux-gnu/mix-ins/audio
 mix-ins: gentoo:funtoo/1.0/linux-gnu/mix-ins/console-extras
 mix-ins: gentoo:funtoo/1.0/linux-gnu/mix-ins/dvd
 mix-ins: gentoo:funtoo/1.0/linux-gnu/mix-ins/media
 mix-ins: gentoo:funtoo/1.0/linux-gnu/mix-ins/X

 Automatically enabled profiles:
 mix-ins: gentoo:funtoo/1.0/linux-gnu/mix-ins/print
 mix-ins: gentoo:funtoo/1.0/linux-gnu/mix-ins/X
 mix-ins: gentoo:funtoo/1.0/linux-gnu/mix-ins/audio
 mix-ins: gentoo:funtoo/1.0/linux-gnu/mix-ins/dvd
 mix-ins: gentoo:funtoo/1.0/linux-gnu/mix-ins/media
 mix-ins: gentoo:funtoo/1.0/linux-gnu/mix-ins/console-extras


2. Install your WindowManager or DesktopEnviroment

My favourite Window Manager at the time is i3 followed by xfce and openbox. Details about i3 & funtoo → http://www.funtoo.org/Package:I3_(Window_Manager) i3 setup:

1) install these packages: 

 emerge --ask i3 i3status dmenu lxappeareance

If you want to know what these packages are research them. I use lxappeareance to install and select gtk-themes.

Config files:

1. xinitrc at ~/.xinitrc 

 exec ck-launch-session i3

You only need --force-xinerama if you do have a nvidia grafics card that do not work without it. For more startx magic → https://wiki.archlinux.org/index.php/xinitrc

2. ~/.i3/config

specify window colors at the top of the file: 

 # class                 border  backgr. text    indicator
 client.focused          #333333 #000000 #ffffff #000000
 client.focused_inactive #333333 #5f676a #ffffff #484e50
 client.unfocused        #333333 #222222 #888888 #292d2e
 client.urgent           #333333 #900000 #ffffff #900000

specify the bar/workspace colors at the bottom of the file: 

 bar {
         status_command i3status
         # Bar color settings
         colors{
                 #background #000000
                 #statusline #ffffff
                 #separator  #666666
                 # Type             border  background font
                 focused_workspace  #008fff #007fff #ffffff
                 active_workspace   #333333 #5f676a #ffffff
                 inactive_workspace #333333 #222222 #888888
                 urgent_workspace   #aa0000 #990000 #ffffff
         }
 }


Do not forget the keymap setting at /etc/X11/xorg.conf otherwise you need to use setxkbmap 

 Section "InputClass"
   Identifier         "keyboard-all"
   Driver             "evdev"
   MatchIsKeyboard    "on"
   Option         "XkbLayout" "de"
 EndSection

3. Display Power Management Signaling

a) You can either use XScreenSaver(https://wiki.archlinux.org/index.php/XScreenSaver): 

 emerge -a xscreensaver

and add /usr/bin/xscreensaver -no-splash & to your ~/.xinitrc file: 

 xscreensaver -no-splash &         # starts screensaver daemon 
 exec ck-launch-session i3 --force-xinerama

or b) modifi your Xorg server (https://wiki.archlinux.org/index.php/Display_Power_Management_Signaling).

4. Note:

I login without a login manager using startx to start my Window Manager, you can end/exit your i3 wm via alt or windows key + shift + e

5. Background Image Viewer

a) Feh 

 emerge -a feh

~/.xinitrc: 

  feh --bg-center <path>/<image>.png

more options → https://wiki.archlinux.org/index.php/Feh#As_a_desktop_wallpaper_manager

b) Nitrogen(GUI Programm) 

 emerge -a nitrogen

~/.xinitrc: 

  exec --no-startup-id nitrogen --restore

3. Additional Software:

1) File Manager:

 emerge --ask thunar

thunar - filemanager that supports automounting Make sure you create this rule: /etc/polkit-1/rules.d/10-drives.rules 

 polkit.addRule(function(action, subject) {
 if (action.id.indexOf("org.freedesktop.udisks2.") == 0){
 return polkit.Result.YES;
 }
 }
 );

Also you should have udisk installed

2) media-video/smplayer:

allow smplayer always to floate, just add 

 for_window [class="smplayer" instance="smplayer"] floating enable

to your ~/.i3/config

3) Internet Browser

I recommend www-client/chromium or www-client/google-chrome see for more info: http://www.funtoo.org/Funtoo_Linux_Web_Browsers 

  Addons:
  1) Adblock
  2) uMatrix
  3) StayFocused
  4) WebRTC Block

n) usefull software

app-arch/file-roller app-editors/bluefish app-emulation/wine app-misc/freemind app-office/libreoffice app-portage/eix mail-client/thunderbird media-gfx/blender media-gfx/gimp media-sound/audacity media-video/kdenlive


media-video/vlc net-analyzer/wireshark net-ftp/filezilla sys-apps/lm_sensors virtual/jre app-text/evince app-text/calibre app-emulation/virtualbox

Retrieved from "https://www.funtoo.org/index.php?title=Help:Funtoo_Editing_Guidelines&oldid=9056"