Gentoo Wiki:Article Blueprints/Software

The following is a semi-structured, rough software article blueprint users can copy and paste to create new software articles. In general, it follows the Wiki guidelines (review if necessary). Be sure to substitute  below with the category/package being used. Be aware some information provided in the blueprint may not be needed; it is always easier to delete unneeded content than to type out new content.


 * Before copying it is possible to demo the Software article blueprint by going here.

Suggestion for the article's Summary field:

(Introductory paragraph goes here. 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. Separate issues by best describing the error with a new section name. Remove if no issues are known.)

Issue 1
When X happens, Y is how you 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

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