Gentoo Wiki:Article Blueprints/Software/Example

(Mark article as a stub if it is just starting off with little content.)

(These InfoBox sections are recommended if possible, but remove unavailable sections. No more than 10 sections can fit in an infobox however. This order of InfoBox sections can be used for consistency across the wiki. See [//wiki.gentoo.org/index.php?title=Special:PrefixIndex&prefix=inf&namespace=10] for all available section templates. Remember the "|header=true" parameter in the first section and use http only if https doesn't work.)

(Introductory paragraph goes here. Describe the concept/package/software/tool/utility/etc. here. Put the description sentence in this template: Article description::DESCRIPTION so it can be used on other pages. Make first mention of subject bold.)

Subject is Article description::what it is, what it does, etc. Further information.

Kernel
(Optional section. Remove if not applicable to software being written about.)

USE flags
(Optional section. Remove if not applicable. Some software does not have any USE flags to set.)

Additional software
(Optional section. Explain software that can be paired or used with the main software package described in this article. This could be anything from a small plugin to a complete integration.)

Configuration
(Explain how to configure the package/software/tool/utility/etc. in this section.)

Environment variables

 * VAR1
 * VAR2

Files

 * - Global (system wide) configuration file.
 * - Local (per user) configuration file.

Service
(Optional section. Provide instructions on starting/stopping and enabling/disabling the software's service. This is only really necessary if the software includes a daemon for certain tasks.)

Usage
(Explain how to _use_ the package/software/tool/utility/etc. in this section.)

Invocation
(Optional section. Remove this section if not applicable.)

Troubleshooting
(Optional section. Add troubleshooting steps for common issues in this section. Separate issues by best describing the error with a new section name. Remove if no common troubleshooting issues are known by the author, another contributor may add it back in later.)

Issue 1
When X happens, Y is how to fix it.

Removal
(Explain how to properly remove the software. If this section needs more than an 'emerge -c' command each step should be explained in detail so that no trace of the software remains on the system.)

External resources
(Optional section. Link to external resources (outside the Wiki) using bullet points in this section. It is common to use full sentences that are links here.)


 * Descriptive link name –