Gentoo Wiki:Article Blueprints/Software/Example

(Introductory paragraph goes here. Briefly describe the concept/package/software/tool/utility here.)

Kernel
(Optional section. Remove if not applicable.)

USE flags
(Optional section. Remove if not applicable.)

Additional software
(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 in this section.)

Environment variables

 * VAR1
 * VAR2

Files

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

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

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

Invocation
(Remove this section if not applicable.)

Troubleshooting
(Troubleshoot issues in this section. Describe each issue in a separate section. It's often a good idea to use the exact error message a user might see as the section title. Remove if no issues are known.)

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

External resources

 * (Link to external resources [outside the Wiki] using bullet points in this section. It is common for the information in this section to be full sentences that are links.)