Difference between revisions of "Funtoo Profiles"

From Funtoo
Jump to navigation Jump to search
m (Reverted edits by Nuc1eon (talk) to last revision by Drobbins)
(Marked this version for translation)
 
(63 intermediate revisions by 13 users not shown)
Line 1: Line 1:
== What is a profile? ==
{{#widget:AddThis}}
<languages/>
<translate>This page covers the Funtoo Linux profile system -- how it works, what profiles are available, and how to use [[#Using epro|{{c|epro}}]] to set and change profile settings.
== Profile Types == <!--T:1-->


In Gentoo and Funtoo Linux, profiles are used to define base system settings, and have historically had a lot of untapped potential. In Funtoo Linux, I wanted to take advantage of some of this potential to allow Funtoo Linux users to easily tailor their system for various types of roles. Enter the new Funtoo profile system.
<!--T:2-->
Historically, users have had to add a large number of settings to [[Make.conf|{{c|/etc/make.conf}}]] to customize their Gentoo or Funtoo Linux system, which made setup of the operating system more difficult than it should be. In Gentoo Linux, it is possible to only define one ''system profile''. Think of a system profile as the default settings that Portage uses for building everything on your system. Rather than a single profile, Funtoo Linux uses multiple sub-profiles, and moves many types of settings that are normally stored in {{c|/etc/make.conf}} into the profile system. The following profile types are available in Funtoo Linux:


== What It Is ==
<!--T:3-->
{{TableStart}}
{{2ColHead|Sub-Profile Type|Description}}
{{2Col|{{c|arch}}|Typically {{c|x86-32bit}} or {{c|x86-64bit}}, this defines the processor type and support of your system. This is defined when your stage was built and should not be changed.}}
{{2Col|{{c|build}}|Defines whether your system is a {{c|current}}, {{c|stable}}, {{c|experimental}} or {{c|next}} build. {{c|current}} systems will have newer packages unmasked than {{c|stable}} systems. This is defined when your stage is built and is typically not changed.}}
{{2Col|{{c|subarch}}|Defines CPU optimizations for your system. The subarch is set at the time the stage3 is built, but can be changed later to better settings if necessary. Be sure to pick a [[Subarches|setting that is compatible with your CPU]].}}
{{2Col|{{c|flavor}}|Defines the general type of system, such as {{c|server}} or {{c|desktop}}, and will set default USE flags appropriate for your needs.}}
{{2Col|{{c|mix-ins}}|Defines various optional settings that you may be interested in enabling.}}
{{TableEnd}}


Historically, users have had to add a ton of settings to <tt>/etc/make.conf</tt> to customize their Gentoo or Funtoo Linux system, which made setup of the operating system more difficult than it should be.
<!--T:4-->
{{Note|Flavors can (and often do) inherit settings from other flavors and mix-ins. Mix-ins can also inherit settings from other mix-ins. For example, {{c|X}} is inherited by {{c|gnome}}. The {{c|epro}} tool will show both as being enabled so there are no surprises.}}


In Gentoo Linux, it is possible to only define one ''system profile''. Think of a system profile as the default settings that Portage uses for building everything on your system.
=== The Purpose === <!--T:35-->


In Funtoo Linux, multiple profiles can be enabled at the same time. These include:
<!--T:36-->
The purpose of this new system is to:


* '''arch''' - one arch profile is enabled, at build time, and is not changed. This defines CPU architecture-specific settings.
<!--T:37-->
* '''build''' - one build profile is enabled, at build time, and is generally not changed. It defines the type of build, such as 'current' or 'stable', and associated settings.
# '''Help developers to organize and curate optimal settings for the community.''' We use these settings, such as our {{c|gnome}} mix-in, to build official GNOME stages. So we want them to work, and work well.
* '''flavor''' - one flavor is enabled per system, and can be changed by the user. This defines the general use of the system, such as 'minimal', 'core', 'desktop', 'workstation'
# Allow our users to use the {{c|epro}} tool (also known as its long form: {{c|ego profile}} to manage {{c|USE}} settings in bulk. '''We want our mix-ins to be useful for enabling a logical set of {{c|USE}} flags by name''', such as {{c|mediaformat-audio-extra}} rather than listing a long list of {{c|USE}} flags.
* '''mix-in''' - zero or more mix-ins can be enabled that enable settings specific to a particular subset of features, such as 'gnome', 'kde', 'media', 'mate', 'X', 'hardened'


{{Fancynote|1=
<!--T:38-->
See [[Flavors and Mix-ins]] for a complete list of all flavors and mix-ins available in Funtoo Linux, along with descriptions of what each one does.}}
Really, we consider the selection and maintenance of optimal {{c|USE}} settings to be a ''community task'', rather than an ''individual task''. This is a fundamental cultural difference of Funtoo as compared to Gentoo.


=== Origins and Benefits ===
<!--T:39-->
See the [[Wolf Pack Philosophy]] for more information on these cultural differences which have a practical impact on how we do our work.


This new system is really a completion of the original cascading profile design that was designed by Daniel Robbins and implemented by Seemant Kulleen as part of Portage. Funtoo Profiles designed to leverage the existing cascading profile system and provide something much more useable and maintainable for users and developers alike. Here are some of its benefits:
=== Using epro === <!--T:5-->


* Fewer settings in /etc/make.conf. <tt>CHOST</tt> and <tt>ARCH</tt> no longer set in <tt>/etc/make.conf</tt>.
<!--T:6-->
* Separation of concerns -- arch, build, and flavor-related settings are organized together.
{{c|epro show}} will display the current profile settings on your system:
* User flexibility - any number of mix-ins can be enabled to tweak masks or USE settings as needed.
</translate>
{{console|body=
# ##i##epro show
 
=== ##g##Enabled Profiles##!g##: ===
 
        arch: ##c## x86-64bit
      build: ##c## current
    subarch: ##c## intel64-haswell
      flavor: ##c## desktop
    mix-ins: ##c## gnome
 
 
=== ##g##All inherited flavors from desktop flavor##!g##: ===
 
                    ##c##workstation##!c## (from desktop flavor)
                            ##c##core##!c## (from workstation flavor)
                        ##c##minimal##!c## (from core flavor)
 
=== ##g##All inherited mix-ins from desktop flavor##!g##: ===
 
                              ##c##X##!c## (from workstation flavor)
                          ##c##audio##!c## (from workstation flavor)
                            ##c##dvd##!c## (from workstation flavor)
                          ##c##media##!c## (from workstation flavor)
      ##c##mediadevice-audio-consumer##!c## (from media mix-in)
                ##c##mediadevice-base##!c## (from mediadevice-audio-consumer mix-in)
      ##c##mediadevice-video-consumer##!c## (from media mix-in)
                ##c##mediadevice-base##!c## (from mediadevice-video-consumer mix-in)
        ##c##mediaformat-audio-common##!c## (from media mix-in)
          ##c##mediaformat-gfx-common##!c## (from media mix-in)
        ##c##mediaformat-video-common##!c## (from media mix-in)
                  ##c##console-extras##!c## (from workstation flavor)
                          ##c##print##!c## (from desktop flavor)
}}
<translate><!--T:7-->
To view all available sub-profile settings, use {{c|epro list}}:
{{console|body=# ##i##epro list}}
Enabled profiles will be highlighted in cyan. Directly enabled profiles will be in bold and have an asterisk {{c|*}} appended. Sub-profiles enabled via inheritance will be highlighted.


{{fancynote|See [[Custom Profiles]] for information on how to extend the profile system.}}
==== Usage Examples ==== <!--T:8-->


== What It Looks Like ==
<!--T:9-->
Here's a what a list of profiles looks like:
{{TableStart}}
<console>
{{2Col|Add the mix-ins {{c|gnome}} and {{c|kde}}|{{c|epro mix-ins +gnome +kde}}}}
###i## eselect profile list
{{2Col|Remove a mix-in, for example {{c|gnome}}|{{c|epro mix-ins -gnome}}}}
Currently available arch profiles:
{{2Col|Change the profile arch to x86-64bit|{{c|epro arch x86-64bit}}}}
  [1]  funtoo/1.0/linux-gnu/arch/x86-32bit
{{2Col|Change the subarch to {{c|generic_64}}|{{c|epro subarch generic_64}}}}
  [2]  funtoo/1.0/linux-gnu/arch/x86-64bit
{{2Col|Change the system flavor|{{c|epro flavor desktop}}}}
Currently available build profiles:
{{2Col|Get JSON output of profile settings|{{c|epro show-json}}}}
  [3]  funtoo/1.0/linux-gnu/build/stable
{{2Col|Get current sub-profile setting in text form|{{c|epro get [profiletype]}}}}
  [4]  funtoo/1.0/linux-gnu/build/current
{{TableEnd}}
  [5]  funtoo/1.0/linux-gnu/build/experimental
Currently available flavor profiles:
  [6]  funtoo/1.0/linux-gnu/flavor/minimal
  [7]  funtoo/1.0/linux-gnu/flavor/core
  [8]  funtoo/1.0/linux-gnu/flavor/desktop
  [9]  funtoo/1.0/linux-gnu/flavor/workstation
Currently available mix-ins profiles:
  [10]  funtoo/1.0/linux-gnu/mix-ins/audio
  [11]  funtoo/1.0/linux-gnu/mix-ins/console-extras
  [12]  funtoo/1.0/linux-gnu/mix-ins/dvd
  [13]  funtoo/1.0/linux-gnu/mix-ins/gnome
  [14]  funtoo/1.0/linux-gnu/mix-ins/kde
  [15]  funtoo/1.0/linux-gnu/mix-ins/media
  [16]  funtoo/1.0/linux-gnu/mix-ins/print
  [17]  funtoo/1.0/linux-gnu/mix-ins/python3-only
  [18]  funtoo/1.0/linux-gnu/mix-ins/rhel5-compat
  [19]  funtoo/1.0/linux-gnu/mix-ins/server-db
  [20]  funtoo/1.0/linux-gnu/mix-ins/server-mail
  [21]  funtoo/1.0/linux-gnu/mix-ins/server-web
  [22]  funtoo/1.0/linux-gnu/mix-ins/X
  [23] funtoo/1.0/linux-gnu/mix-ins/xfce
</console>
As you can see, there are multiple types of profiles to choose from.
Let's move on to how to start using it.


== Switch to the Funtoo 1.0 Profile ==
=== Wrapping Up === <!--T:40-->
After you set your desired profile, sync and update.
{{console|body=# ##i## ego sync}}
{{console|body=# ##i## emerge -auDN @world}}


=== Using eselect ===
== Flavors == <!--T:10-->
The preferred method of adding and removing profiles is to use [[eselect|eselect profile]]. This ensures that profiles are added correctly and in the proper order. The order is very important for things to work right.
For a list of options, run:
<console>
###i## eselect profile help
</console>


As stated by the previous command output, let's see the list of what profiles currently defined the option '''list''':
<!--T:11-->
A system can have only one flavor profile enabled at a time. The following flavors are available:


<console>
<!--T:12-->
###i## eselect profile list
{{TableStart}}
Currently available arch profiles:
{{2ColHead|Flavor|Description}}
  [1]  funtoo/1.0/linux-gnu/arch/x86-64bit *
<tr><td>{{c|minimal}}</td><td>This contains the bare minimum settings for all Funtoo Linux flavors.</td></tr>
Currently available build profiles:
<tr><td>{{c|core}}</td><td>The core flavor includes the minimal flavor, plus reasonable settings, and is used for the [[Funtoo_Linux_Installation#Installing_the_Stage_3_tarball|official stage3 downloads]].</td></tr>
  [2]  funtoo/1.0/linux-gnu/build/stable
<tr><td>{{c|server}}</td><td>In the future, the server flavor will include the core flavor, plus specific settings designed for servers. At the moment, it is equivalent to the core flavor.</td></tr>
  [3]  funtoo/1.0/linux-gnu/build/current *
<tr><td>{{c|workstation}}</td><td>The workstation flavor is a minimal desktop system. It includes the core flavor, plus these mix-ins: {{c|X}}, {{c|audio}}, {{c|dvd}}, {{c|media}} and {{c|console-extras}}.</td></tr>
  [4]  funtoo/1.0/linux-gnu/build/experimental
<tr><td>{{c|desktop}}</td><td>The desktop flavor includes the common settings for any full-featured desktop system. It includes the {{c|workstation}} flavor plus {{c|printing}} support. The user is expected to further customize their system with a desktop environment of choice, such as KDE, GNOME, or XFCE, possibly by using a mix-in.</td></tr>
Currently available flavor profiles:
{{TableEnd}}
  [5]  funtoo/1.0/linux-gnu/flavor/minimal
  [6]  funtoo/1.0/linux-gnu/flavor/core
  [7]  funtoo/1.0/linux-gnu/flavor/desktop *
Currently available mix-ins profiles:
  [8]  funtoo/1.0/linux-gnu/mix-ins/dvd
  [9]   funtoo/1.0/linux-gnu/mix-ins/gnome
  [10] funtoo/1.0/linux-gnu/mix-ins/kde
  [11]  funtoo/1.0/linux-gnu/mix-ins/media
  [12]  funtoo/1.0/linux-gnu/mix-ins/rhel5-compat
  [13]  funtoo/1.0/linux-gnu/mix-ins/server-db
  [14]  funtoo/1.0/linux-gnu/mix-ins/server-mail
  [15]  funtoo/1.0/linux-gnu/mix-ins/server-web
  [16]  funtoo/1.0/linux-gnu/mix-ins/workstation
  [17]  funtoo/1.0/linux-gnu/mix-ins/workstation-minimal
</console>


As in several other Funtoo utilities, a star on the right indicates an active item (your case may differ from the example above). To add, say, the mix-ins '''dvd''', '''kde''' and '''media''' you have to enter:
== Mix-ins == <!--T:13-->


<console>
<!--T:14-->
###i## eselect profile add 8
A system can have any number of mix-ins enabled at a time. The following mix-ins are available:
###i## eselect profile add 10
###i## eselect profile add 11
</console>


Or, in a one-shot:
<!--T:15-->
{{TableStart}}
{{2ColHead|Mix-in|Description}}
{{2Col|{{c|audio}}|Enables core audio-related settings, currently related to ALSA.}}
{{2Col|{{c|console-extras}}|Enables things that are nice to have for console-only systems. Currently enabling gpm in USE.}}
{{2Col|{{c|dvd}}|USE settings related to optical drives -- CDR/DVD-ROM/RW use.}}
{{2Col|{{c|gnome}}|USE and package.use settings required to merge GNOME. Designed to be used with {{c|desktop}} or {{c|workstation}} flavor.}}
{{2Col|{{c|hardened}}|Enables hardened support.}}
{{2Col|{{c|kde}}|USE and package.use settings required to merge KDE Plasma 4. Designed to be used with {{c|desktop}} or {{c|workstation}} flavor.}}
{{2Col|{{c|kde-plasma-5}}|USE and package.use settings required to merge KDE Plasma 5. Designed to be used with {{c|desktop}} or {{c|workstation}} flavor.}}
{{2Col|{{c|media}}|USE settings related to audio/video media encoding. Can be for desktops or servers.}}
{{2Col|{{c|print}}|Enables printing capability.}}
{{2Col|{{c|vmware-guest}}|Settings related to using Funtoo Linux as a VMware virtual machine guest.}}
{{2Col|{{c|X}}|Settings related to the X Window System and hardware support.}}
{{2Col|{{c|xfce}}|USE settings required for merging XFCE.}}
{{TableEnd}}


<console>
<!--T:41-->
###i## eselect profile add 8 10 11
{{SectionNeedsUpdates}}
</console>


Verification:
=== Media Device Mix-ins === <!--T:16-->


<console>
<!--T:17-->
###i## eselect profile list 
Media device mix-ins have been created to support media devices, including external and portable devices, and associated low-level hardware support and hardware-focused codecs. Media devices have been categorized into audio and video categories, and consumer and professional categories. "Consumer" devices are those devices that regular desktop users might typically use, while "professional" devices are those that professionals, hobbyists or enthusiasts would typically use. Here are the new mix-ins for media devices:
Currently available arch profiles:
  [1]  funtoo/1.0/linux-gnu/arch/x86-64bit *
Currently available build profiles:
  [2]  funtoo/1.0/linux-gnu/build/stable
  [3]  funtoo/1.0/linux-gnu/build/current *
  [4]  funtoo/1.0/linux-gnu/build/experimental
Currently available flavor profiles:
  [5]  funtoo/1.0/linux-gnu/flavor/minimal
  [6]  funtoo/1.0/linux-gnu/flavor/core
  [7]  funtoo/1.0/linux-gnu/flavor/desktop *
Currently available mix-ins profiles:
  [8]  funtoo/1.0/linux-gnu/mix-ins/dvd *
  [9]  funtoo/1.0/linux-gnu/mix-ins/gnome
  [10]  funtoo/1.0/linux-gnu/mix-ins/kde *
  [11]  funtoo/1.0/linux-gnu/mix-ins/media *
  [12]  funtoo/1.0/linux-gnu/mix-ins/rhel5-compat
  [13]  funtoo/1.0/linux-gnu/mix-ins/server-db
  [14]  funtoo/1.0/linux-gnu/mix-ins/server-mail
  [15]  funtoo/1.0/linux-gnu/mix-ins/server-web
  [16]  funtoo/1.0/linux-gnu/mix-ins/workstation
  [17]  funtoo/1.0/linux-gnu/mix-ins/workstation-minimal
</console>


{{Fancynote| You must use the numbers to reference the profiles bits you want.}}
<!--T:18-->
{{TableStart}}
{{2ColHead|Media Device Mix-in|Description}}
<tr><td>{{c|mediadevice-base}}</td><td>Common, universally-supported media devices, like IEEE-1394 (Firewire), CDDA, CDIO. Other mediadevice mix-ins have this as a parent.</td></tr>
<tr><td>{{c|mediadevice-audio-consumer}}</td><td>Consumer audio devices, such as personal portable media players (iOS, iPod, etc.)</td></tr>
<tr><td>{{c|mediadevice-audio-pro}}</td><td>Pro audio support, such as JACK.</td></tr>
<tr><td>{{c|mediadevice-video-consumer}}</td><td>Consumer video support, such as DVD, Blu Ray, V4L</td></tr>
<tr><td>{{c|mediadevice-video-pro}}</td><td>Pro video support, such as dv, dc1394.</td></tr>
{{TableEnd}}


No magic here, what you add is put by portage in the <tt>/etc/portage/make.profile/parent</tt> file. In the present case this file contains:
=== Media Format Mix-ins === <!--T:19-->


<console>
<!--T:20-->
###i## cat /etc/portage/make.profile/parent
Media format mix-ins have been created to support media formats for reading, writing, encoding and decoding images, audio and video. They have been organized into a "common" collection, for popular formats, and an "extra" collection, which is intended to include "everything else". Let's look at the new mix-ins:
gentoo:funtoo/1.0/linux-gnu/arch/x86-64bit
gentoo:funtoo/1.0/linux-gnu/build/current
gentoo:funtoo/1.0/linux-gnu/flavor/desktop
gentoo:funtoo/1.0/linux-gnu/mix-ins/dvd
gentoo:funtoo/1.0/linux-gnu/mix-ins/gnome
gentoo:funtoo/1.0/linux-gnu/mix-ins/kde
gentoo:funtoo/1.0/linux-gnu/mix-ins/media
</console>


== For Developers ==
<!--T:21-->
{{TableStart}}
{{2ColHead|Media Format Mix-in|Description}}
<tr><td>{{c|mediaformat-video-common}}</td><td>Common (ie. popular) video formats.</td></tr>
<tr><td>{{c|mediaformat-video-extra}}</td><td>More esoteric video formats.</td></tr>
<tr><td>{{c|mediaformat-audio-common}}</td><td>Common (ie. popular) audio formats.</td></tr>
<tr><td>{{c|mediaformat-audio-extra}}</td><td>More esoteric audio formats.</td></tr>
<tr><td>{{c|mediaformat-gfx-common}}</td><td>Common (ie. popular) graphics formats.</td></tr>
<tr><td>{{c|mediaformat-gfx-extra}}</td><td>More esoteric graphics formats.</td></tr>
{{TableEnd}}


=== Define the profile sub-sets you will use ===
=== How to Use Media Mix-Ins === <!--T:22-->


So far in Funtoo we have used the exact same profiles as Gentoo thus Funtoo/2008.0 was strictly the same thing as Gentoo/2008.0 or the barely the same 10.0. This (monolithic) profile was set though a symbolic link named '''/etc/make.profile''' pointing on a complex directory architecture located somewhere under '''/usr/portage/profiles'''. This is no longer valid with the Funtoo 1.0 profiles as they are split in several smaller bricks which are then glued together via the '''/etc/portage/make.profile/parent''' file (You do not need to include everything, just use the "bricks" you need). Those bricks belongs to several categories:
<!--T:23-->
Our existing {{c|media}} mix-in still exists, and is still pulled in by the {{c|desktop}} and {{c|workstation}} flavors automatically. It now includes the following parent mix-ins:


1. MANDATORY -- An "arch" profile which defines settings for a particular architecture. You'll want to set this to whatever arch your system is and leave it alone. '''Setting it to a different arch than your system could severely break it.'''
<!--T:24-->
* {{c|mediadevice-audio-consumer}}
* {{c|mediadevice-video-consumer}}
* {{c|mediaformat-audio-common}}
* {{c|mediaformat-gfx-common}}
* {{c|mediaformat-video-common}}


2. MANDATORY -- A "build" profile which should match the tree you wish to use. '''Stable''', '''Current''' (~arch), or '''Experimental''' (use it if you are brave enough and find '''current''' too stable).
<!--T:25-->
In addition, there is a new {{c|media-pro}} mix-in which needs to be enabled manually, which pulls in the following mix-ins:


3. MANDATORY -- A "flavor" profile (what was previously known as ''profiles'' is still known as such in Gentoo) which describes the kind of system you want.
<!--T:26-->
* minimal - Be warned, minimal is exactly what it says, the minimal profile stuff you need for a usable system, nothing else. This is really for people who know what they're doing.
* {{c|mediadevice-audio-pro}}
* core - This is the core profile. This is for stuff that affects both desktops and servers.
* {{c|mediadevice-video-pro}}
* desktop - Exactly what it says. If you're using a desktop, you should set this as your flavor.
* server - If you're running a server, you should set this as your flavor.


4. OPTIONAL -- One or more "mix-ins" profiles which describe optional add-ons. 'mix-ins' are the heart of the Funtoo 1.0 profiles. Unlike the monolithic profiles which sets a massive amount of use flags and options for you, we've split them into logical add-on profiles. For instance if you want support for gnome, you would add the gnome mix-in to your current profiles. That mix-in sets all the proper use flags and such for gnome. Same with others. Want dvd support? Add that one in. Using a rhel5 kernel which requires special versions of packages such as udev? There's a mix-in for that too. Run a mail server? web server? There's mix-ins for those also. Expect this category to grow in the future as new mix-ins are created.
<!--T:27-->
So typically, you would enable the {{c|desktop}} or {{c|workstation}} flavor, and if you need professional hardware support, you'd also enable the {{c|media-pro}} mix-in. If you needed any additional media formats support, you could enable one or more of the {{c|mediaformat-*-extra}} mix-ins to add the formats you needed. Of course, it's possible to enable only the specific mix-ins you need, and also complement these mix-ins with specific USE variable settings you might require.


The contents of '''/etc/portage/make.profile/parent''' for a basic setup might look like this:
=== How Profile Settings are Stored === <!--T:28-->


<pre>
<!--T:29-->
Funtoo Linux stores its profile settings in the {{f|/etc/portage/make.profile/parent}} file. Typically, users don't need to modify this file, instead using {{c|ego}} and {{c|epro}} to make changes, but it can be handy to take a look at what the contents of the file look like. A simple server might have profile settings as follows:
</translate>
{{file|name=/etc/portage/make.profile/parent|body=
gentoo:funtoo/1.0/linux-gnu/arch/x86-64bit
gentoo:funtoo/1.0/linux-gnu/arch/x86-64bit
gentoo:funtoo/1.0/linux-gnu/build/current
gentoo:funtoo/1.0/linux-gnu/build/current
gentoo:funtoo/1.0/linux-gnu/flavor/core
gentoo:funtoo/1.0/linux-gnu/flavor/core
</pre>
}}
 
<translate>
A more rounded setup for a desktop might look like this:
<!--T:30-->
 
Profile settings for a desktop might look like this:
<pre>
</translate>
{{file|name=/etc/portage/make.profile/parent|body=
gentoo:funtoo/1.0/linux-gnu/arch/x86-64bit
gentoo:funtoo/1.0/linux-gnu/arch/x86-64bit
gentoo:funtoo/1.0/linux-gnu/build/current
gentoo:funtoo/1.0/linux-gnu/build/current
Line 190: Line 211:
gentoo:funtoo/1.0/linux-gnu/mix-ins/dvd
gentoo:funtoo/1.0/linux-gnu/mix-ins/dvd
gentoo:funtoo/1.0/linux-gnu/mix-ins/media
gentoo:funtoo/1.0/linux-gnu/mix-ins/media
</pre>
}}
<translate>


== Related ==
== History and Origins == <!--T:31-->
* [[Flavors and Mix-ins]]
 
<!--T:32-->
This new system is really a completion of the original cascading profile design that was co-designed by Daniel Robbins and Seemant Kulleen and implemented by Seemant Kulleen as part of Portage. Funtoo Profiles designed to leverage the existing cascading profile system and provide something much more useable and maintainable for users and developers alike. Here are some of its benefits:
 
<!--T:33-->
* Fewer settings in <code>/etc/make.conf</code>. <code>CHOST</code> and <code>ARCH</code> no longer set in <code>/etc/make.conf</code>.
* Separation of concerns -- arch, build, and flavor-related settings are organized together.
* User flexibility - any number of mix-ins can be enabled to tweak masks or USE settings as needed.


<!--T:34-->
{{note|See [[Custom Profiles]] for information on how to extend the profile system.}}
</translate>
[[Category:Funtoo features]]
[[Category:Funtoo features]]
[[Category:Portage]]
[[Category:Portage]]
[[Category:Labs]]
[[Category:HOWTO]]
[[Category:HOWTO]]
[[Category:Official Documentation]]
[[Category:Official Documentation{{#translation:}}]]

Latest revision as of 19:39, January 26, 2023

Other languages:
English • ‎Türkçe • ‎español • ‎português do Brasil • ‎slovenčina • ‎русский • ‎中文(中国大陆)‎ • ‎日本語

This page covers the Funtoo Linux profile system -- how it works, what profiles are available, and how to use epro to set and change profile settings.

Profile Types

Historically, users have had to add a large number of settings to /etc/make.conf to customize their Gentoo or Funtoo Linux system, which made setup of the operating system more difficult than it should be. In Gentoo Linux, it is possible to only define one system profile. Think of a system profile as the default settings that Portage uses for building everything on your system. Rather than a single profile, Funtoo Linux uses multiple sub-profiles, and moves many types of settings that are normally stored in /etc/make.conf into the profile system. The following profile types are available in Funtoo Linux:

Sub-Profile TypeDescription
archTypically x86-32bit or x86-64bit, this defines the processor type and support of your system. This is defined when your stage was built and should not be changed.
buildDefines whether your system is a current, stable, experimental or next build. current systems will have newer packages unmasked than stable systems. This is defined when your stage is built and is typically not changed.
subarchDefines CPU optimizations for your system. The subarch is set at the time the stage3 is built, but can be changed later to better settings if necessary. Be sure to pick a setting that is compatible with your CPU.
flavorDefines the general type of system, such as server or desktop, and will set default USE flags appropriate for your needs.
mix-insDefines various optional settings that you may be interested in enabling.
   Note

Flavors can (and often do) inherit settings from other flavors and mix-ins. Mix-ins can also inherit settings from other mix-ins. For example, X is inherited by gnome. The epro tool will show both as being enabled so there are no surprises.

The Purpose

The purpose of this new system is to:

  1. Help developers to organize and curate optimal settings for the community. We use these settings, such as our gnome mix-in, to build official GNOME stages. So we want them to work, and work well.
  2. Allow our users to use the epro tool (also known as its long form: ego profile to manage USE settings in bulk. We want our mix-ins to be useful for enabling a logical set of USE flags by name, such as mediaformat-audio-extra rather than listing a long list of USE flags.

Really, we consider the selection and maintenance of optimal USE settings to be a community task, rather than an individual task. This is a fundamental cultural difference of Funtoo as compared to Gentoo.

See the Wolf Pack Philosophy for more information on these cultural differences which have a practical impact on how we do our work.

Using epro

epro show will display the current profile settings on your system:

root # epro show

=== Enabled Profiles: ===

        arch:  x86-64bit
       build:  current
     subarch:  intel64-haswell
      flavor:  desktop
     mix-ins:  gnome


=== All inherited flavors from desktop flavor: ===

                     workstation (from desktop flavor)
                            core (from workstation flavor)
                         minimal (from core flavor)

=== All inherited mix-ins from desktop flavor: ===

                               X (from workstation flavor)
                           audio (from workstation flavor)
                             dvd (from workstation flavor)
                           media (from workstation flavor)
      mediadevice-audio-consumer (from media mix-in)
                mediadevice-base (from mediadevice-audio-consumer mix-in)
      mediadevice-video-consumer (from media mix-in)
                mediadevice-base (from mediadevice-video-consumer mix-in)
        mediaformat-audio-common (from media mix-in)
          mediaformat-gfx-common (from media mix-in)
        mediaformat-video-common (from media mix-in)
                  console-extras (from workstation flavor)
                           print (from desktop flavor)

To view all available sub-profile settings, use epro list:

root # epro list

Enabled profiles will be highlighted in cyan. Directly enabled profiles will be in bold and have an asterisk * appended. Sub-profiles enabled via inheritance will be highlighted.

Usage Examples

Add the mix-ins gnome and kdeepro mix-ins +gnome +kde
Remove a mix-in, for example gnomeepro mix-ins -gnome
Change the profile arch to x86-64bitepro arch x86-64bit
Change the subarch to generic_64epro subarch generic_64
Change the system flavorepro flavor desktop
Get JSON output of profile settingsepro show-json
Get current sub-profile setting in text formepro get [profiletype]

Wrapping Up

After you set your desired profile, sync and update.

root #  ego sync
root #  emerge -auDN @world

Flavors

A system can have only one flavor profile enabled at a time. The following flavors are available:

FlavorDescription
minimalThis contains the bare minimum settings for all Funtoo Linux flavors.
coreThe core flavor includes the minimal flavor, plus reasonable settings, and is used for the official stage3 downloads.
serverIn the future, the server flavor will include the core flavor, plus specific settings designed for servers. At the moment, it is equivalent to the core flavor.
workstationThe workstation flavor is a minimal desktop system. It includes the core flavor, plus these mix-ins: X, audio, dvd, media and console-extras.
desktopThe desktop flavor includes the common settings for any full-featured desktop system. It includes the workstation flavor plus printing support. The user is expected to further customize their system with a desktop environment of choice, such as KDE, GNOME, or XFCE, possibly by using a mix-in.

Mix-ins

A system can have any number of mix-ins enabled at a time. The following mix-ins are available:

Mix-inDescription
audioEnables core audio-related settings, currently related to ALSA.
console-extrasEnables things that are nice to have for console-only systems. Currently enabling gpm in USE.
dvdUSE settings related to optical drives -- CDR/DVD-ROM/RW use.
gnomeUSE and package.use settings required to merge GNOME. Designed to be used with desktop or workstation flavor.
hardenedEnables hardened support.
kdeUSE and package.use settings required to merge KDE Plasma 4. Designed to be used with desktop or workstation flavor.
kde-plasma-5USE and package.use settings required to merge KDE Plasma 5. Designed to be used with desktop or workstation flavor.
mediaUSE settings related to audio/video media encoding. Can be for desktops or servers.
printEnables printing capability.
vmware-guestSettings related to using Funtoo Linux as a VMware virtual machine guest.
XSettings related to the X Window System and hardware support.
xfceUSE settings required for merging XFCE.


   Important

This section is in need of updates.


Media Device Mix-ins

Media device mix-ins have been created to support media devices, including external and portable devices, and associated low-level hardware support and hardware-focused codecs. Media devices have been categorized into audio and video categories, and consumer and professional categories. "Consumer" devices are those devices that regular desktop users might typically use, while "professional" devices are those that professionals, hobbyists or enthusiasts would typically use. Here are the new mix-ins for media devices:

Media Device Mix-inDescription
mediadevice-baseCommon, universally-supported media devices, like IEEE-1394 (Firewire), CDDA, CDIO. Other mediadevice mix-ins have this as a parent.
mediadevice-audio-consumerConsumer audio devices, such as personal portable media players (iOS, iPod, etc.)
mediadevice-audio-proPro audio support, such as JACK.
mediadevice-video-consumerConsumer video support, such as DVD, Blu Ray, V4L
mediadevice-video-proPro video support, such as dv, dc1394.

Media Format Mix-ins

Media format mix-ins have been created to support media formats for reading, writing, encoding and decoding images, audio and video. They have been organized into a "common" collection, for popular formats, and an "extra" collection, which is intended to include "everything else". Let's look at the new mix-ins:

Media Format Mix-inDescription
mediaformat-video-commonCommon (ie. popular) video formats.
mediaformat-video-extraMore esoteric video formats.
mediaformat-audio-commonCommon (ie. popular) audio formats.
mediaformat-audio-extraMore esoteric audio formats.
mediaformat-gfx-commonCommon (ie. popular) graphics formats.
mediaformat-gfx-extraMore esoteric graphics formats.

How to Use Media Mix-Ins

Our existing media mix-in still exists, and is still pulled in by the desktop and workstation flavors automatically. It now includes the following parent mix-ins:

  • mediadevice-audio-consumer
  • mediadevice-video-consumer
  • mediaformat-audio-common
  • mediaformat-gfx-common
  • mediaformat-video-common

In addition, there is a new media-pro mix-in which needs to be enabled manually, which pulls in the following mix-ins:

  • mediadevice-audio-pro
  • mediadevice-video-pro

So typically, you would enable the desktop or workstation flavor, and if you need professional hardware support, you'd also enable the media-pro mix-in. If you needed any additional media formats support, you could enable one or more of the mediaformat-*-extra mix-ins to add the formats you needed. Of course, it's possible to enable only the specific mix-ins you need, and also complement these mix-ins with specific USE variable settings you might require.

How Profile Settings are Stored

Funtoo Linux stores its profile settings in the /etc/portage/make.profile/parent file. Typically, users don't need to modify this file, instead using ego and epro to make changes, but it can be handy to take a look at what the contents of the file look like. A simple server might have profile settings as follows:

   /etc/portage/make.profile/parent
gentoo:funtoo/1.0/linux-gnu/arch/x86-64bit
gentoo:funtoo/1.0/linux-gnu/build/current
gentoo:funtoo/1.0/linux-gnu/flavor/core

Profile settings for a desktop might look like this:

   /etc/portage/make.profile/parent
gentoo:funtoo/1.0/linux-gnu/arch/x86-64bit
gentoo:funtoo/1.0/linux-gnu/build/current
gentoo:funtoo/1.0/linux-gnu/flavor/desktop
gentoo:funtoo/1.0/linux-gnu/mix-ins/dvd
gentoo:funtoo/1.0/linux-gnu/mix-ins/media

History and Origins

This new system is really a completion of the original cascading profile design that was co-designed by Daniel Robbins and Seemant Kulleen and implemented by Seemant Kulleen as part of Portage. Funtoo Profiles designed to leverage the existing cascading profile system and provide something much more useable and maintainable for users and developers alike. Here are some of its benefits:

  • Fewer settings in /etc/make.conf. CHOST and ARCH no longer set in /etc/make.conf.
  • Separation of concerns -- arch, build, and flavor-related settings are organized together.
  • User flexibility - any number of mix-ins can be enabled to tweak masks or USE settings as needed.
   Note

See Custom Profiles for information on how to extend the profile system.