Template:USEflag

Documentation

Note

This page is a template. It contains some standardized, often used text, which can be transcluded inside other pages.

As this page is widely used in our wiki, it is protected. Only staff members can change it. Use the discussion page to propose enhancements, fixes or voice your opinion.

Use this template to show a table for listing USE flags of a package and details about these USE flags.

Parameters

unnamed parameter (up to 30)

Specify in each parameter one USE flag. You can set additional details in the same parameter delimited by a +:

• Default: This column shows, whether this USE flag is enabled by default in this package or by profile. For the articles in the Server & Security category the "default" profile is the default/linux/amd64/13.0 profile, for every other article it is the default/linux/amd64/13.0/desktop profile. Exceptions have to be named and founded.
• Recommended: This column shows, whether the author of the article recommends to enable this USE flag.
• Description: When no description is provided for a USE flag, the default description from use.desc (and where available the package specific description) is automatically displayed. Otherwise, when defining a description, it should be a detailed description of this USE flag and how it affects this package. In some cases it goes beyond Enables PNG support in GIMP. and might contain an explanation like If this USE flag is disabled, this package will have no authentication support at all, as the only supported authentication backend at the moment is LDAP..

package (optional)

Specify the full package name to enable local USE flag descriptions instead of global, if existing.

Note

The implementation is not very efficient, so you should set parameter only, if you know, that there are local USE flag descriptions. To check that:

user $ grep PACKAGE /usr/portage/profiles/use.local.desc

desc (optional)

Add description text.

Usage

See the template's testcases:

Parameter: unnamed
Wiki code	{{USEflag|ldap}}
Main version	→ Information about USE flags USE flag Default Recommended Description ldap No Adds LDAP support (Lightweight Directory Access Protocol)
Sandbox version	USE flags → Information about USE flags Flag Default Recommended Description ldap No Adds LDAP support (Lightweight Directory Access Protocol)

Parameter: unnamed (custom description)
Wiki code	{{USEflag|ldap+++Custom description}}
Main version	→ Information about USE flags USE flag Default Recommended Description ldap No Custom description
Sandbox version	USE flags → Information about USE flags Flag Default Recommended Description ldap No Custom description

Parameter: unnamed (all attributes)
Wiki code	{{USEflag|ldap+yes+no}}
Main version	→ Information about USE flags USE flag Default Recommended Description ldap Yes No Adds LDAP support (Lightweight Directory Access Protocol)
Sandbox version	USE flags → Information about USE flags Flag Default Recommended Description ldap Yes No Adds LDAP support (Lightweight Directory Access Protocol)

Parameter: unnamed (multiple), package
Wiki code	{{USEflag |package=app-editors/nano |debug |justify |minimal++yes |ncurses |nls |slang |spell |unicode }}
Main version	→ Information about USE flags USE flag Default Recommended Description debug No Enable debug messages and assert warnings. Note that these will all be sent straight to stderr rather than some logging facility. justify No Enable justify/unjustify functions for text formatting. minimal No Yes Disable all fancy features, including ones that otherwise have a dedicated USE flag (such as spelling). ncurses No Adds ncurses support (console display library) nls No Adds Native Language Support (using gettext - GNU locale utilities) slang No Adds support for the slang text display library (it's like ncurses, but different) spell No Adds dictionary support unicode No Adds support for Unicode
Sandbox version	USE flags  app-editors/nano → Information about USE flags Flag Default Recommended Description debug No Enable debug messages and assert warnings. Note that these will all be sent straight to stderr rather than some logging facility. justify No Enable justify/unjustify functions for text formatting. minimal No Yes Disable all fancy features, including ones that otherwise have a dedicated USE flag (such as spelling). ncurses No Adds ncurses support (console display library) nls No Adds Native Language Support (using gettext - GNU locale utilities) slang No Adds support for the slang text display library (it's like ncurses, but different) spell No Adds dictionary support unicode No Adds support for Unicode

Parameter: desc
Wiki code	{{USEflag|ldap|desc=A description}}
Main version	A description → Information about USE flags USE flag Default Recommended Description ldap No Adds LDAP support (Lightweight Directory Access Protocol)
Sandbox version	USE flags A description → Information about USE flags Flag Default Recommended Description ldap No Adds LDAP support (Lightweight Directory Access Protocol)

Note

The above documentation is transcluded from Template:USEflag/doc. (edit | history)
Editors can experiment in this template's sandbox (edit) and testcases (edit) pages.
Please add categories and interwikis to the /doc subpage. Subpages of this template.