Gentoo Wiki:Article Blueprints/Software/Example

From Gentoo Wiki
Jump to: navigation, search
This article is a stub. You can help by expanding it.

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

Installation

Kernel

(Optional section. Remove if not applicable.)

KERNEL Enable support for <Software_title>
Write kernel feature instructions here.

USE flags

(Optional section. Remove if not applicable.)

Cannot load package information. Is the atom category/package correct?

Emerge

root #emerge --ask category/package

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

  • /etc/global_file_example – Global (system wide) configuration file.
  • ~/.local_file_example – 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.)

OpenRC

runit

systemd

Usage

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

Invocation

(Remove this section if not applicable.)

user $cmd --help
This is an example of command invocation output.

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.

Removal

Unmerge

root #emerge --ask --unmerge category/package

See also

  • Article title
  • Article title – (Link to related Gentoo Wiki articles using bullet points for each link in this section; each link should be local to the Wiki. Use a dash to separate the link from a reason why the link was decided upon.)

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.)

References

(Optional section. Remove this section if references are not used. Typically the only content here will be {{reflist}}, especially if you use <ref> tags for footnotes. Otherwise, list any references you used to write the article here.)

(Category links are listed at the bottom of the article. They effectively end up in the last section of the article, whatever that may be. Do not use a section heading like "Categories". While all software articles could appear in Category:Software, you should use one of its subcategories when appropriate.)

Category:Software