Project:Documentation/Overview

From Gentoo Wiki
Jump to: navigation, search

Welcome to the Gentoo Documentation Resources. This page will give you a quick overview on various guides and documents in this wiki that we carefully follow up on and edit where needed. The documents are structured through the category within the wiki. Of course, far from all pages in the wiki are linked here, so do try out the search functionality on this site, or browse through the categories themselves.

If you find bugs in our documentation or have proposals, please use the page' Discussion tab.

Important
Documents listed here are not necessarily created by the documentation team - community documents or project documents that are well written and managed will be included in the list as well.

Documentation overview

Core system

A full overview of all documents in this category can be found at Core system.

PageAbstract
ACCEPT KEYWORDSThe ACCEPT_KEYWORDS variable informs the package manager which ebuilds' KEYWORDS values it is allowed to accept.
AMD64/FAQThis is the Gentoo Linux/AMD64 Frequently Asked Questions
Alpha/FAQThis FAQ is intended to answer some of the most frequently asked questions relating to Gentoo/Alpha and Linux/Alpha in general.
Binary package guidePortage supports building and installing binary packages. This guide explains how to create them, install them, and how to setup a binary package server.
Complete AMD64 Handbook/Logical Volume ManagementLVM allows administrators to create meta devices that provide an abstraction layer between a file system and the physical storage that is used underneath.
Dm-cryptDM-Crypt is a disk encryption system using the Linux kernel crypto API framework and device mapper subsystem.
GRUB2 MigrationThe goal of this guide is to provide you with a smooth migration from GRUB Legacy to GRUB2.
IPv6 router guideThis guide explains how to use an IPv6 setup and routing on a Gentoo Linux system.
Initramfs/GuideMore and more systems require an initramfs to boot up properly. In this guide, the concepts of the initramfs as well as how to properly create and manage initramfs instances will be covered.
Installation alternativesThis HOWTO is meant to be a repository of alternative Gentoo installation methods, for those with special installation needs such as lack of a cdrom or a computer that can't boot CDs.
Kernel/OverviewThis document provides an overview on all kernel sources that Gentoo provides through Portage.
Kernel/RemovalThis article describes the removal of old kernels.
Kernel/UpgradeThis article describes the steps to upgrade to a new kernel.
LILOLILO is a simple boot loader to load Linux and other operating systems.
LVMLVM allows administrators to create meta devices that provide an abstraction layer between a file system and the physical storage that is used underneath.
Localization/GuideThis guide should help users localize their Gentoo Linux distribution to any European locale. It uses Germany as a case-study, since it is translated from the German doc. Includes configuration for use of the euro currency symbol.
MIPS/FAQThis FAQ is intended to answer some of the most frequently asked questions relating to Gentoo/MIPS and Linux/MIPS in general.
NVidia/nvidia-driversnvidia-drivers is the proprietary graphics driver for nVidia graphic cards. An open source alternative is nouveau.
OpenAFSThis guide shows you how to install an OpenAFS server and client on Gentoo Linux.
PPC/FAQThe Gentoo/PPC FAQ is a collection of questions and answers collected from the Gentoo/PPC mailing lists and from Internet Relay Chat (IRC).
Power management/GuideIn recent years, power management has become one of the differentiating features in the quest for finding the perfect laptop. Yet, the operating system must support the various power saving functionalities too. In this guide, we cover how to setup your Gentoo installation so it manages power-hungry resources in a flexible yet automated manner.
Q appletsThe q applets are a collection of small and fast portage helper tools written in C. This guide covers some common uses of these helper tools, also known as the app-portage/portage-utils package.
SyslinuxSyslinux is a package that contains a family of bootloaders. The package includes SYSLINUX (for FAT file systems), EXTLINUX (for Linux file systems), PXELINUX (for network PXE boot) and ISOLINUX (ISO-9660) for CD/DVD bootloading.
UTF-8UTF-8 is a variable-length character encoding, which in this instance means that it uses 1 to 4 bytes per symbol. So, the first UTF-8 byte is used for encoding ASCII, giving the character set full backwards compatibility with ASCII. UTF-8 means that ASCII and Latin characters are interchangeable with little increase in the size of the data, because only the first byte is used. Users of Eastern alphabets such as Japanese, who have been assigned a higher byte range are unhappy, as this results in as much as a 50% redundancy in their data.
Udevudev is the device manager for the Linux kernel. It manages device nodes in /dev and handles all user space actions when adding or removing devices.

Hardware

A full overview of all documents in this category can be found at Hardware.

PageAbstract
ATI FAQThis FAQ should help users avoid some common installation and configuration issues related to DRI and X11 for AMD/ATI boards.
NVidia/nvidia-driversnvidia-drivers is the proprietary graphics driver for nVidia graphic cards. An open source alternative is nouveau.

Software

A full overview of all documents in this category can be found at Software.

PageAbstract
BIND/GuideThis guide will teach you how install and configure BIND for your domain and your local network.
CgitA fast web-interface for git written in C.
DnsmasqDnsmasq is a lightweight DHCP/DNS server for small and medium sized networks.
Eselect/User guideeselect is a modular framework for writing configuration utilities. This guide introduces the reader to the tool and its design principles.
JavaThis guide introduces the reader to Java and explains how to use Java with Gentoo Linux.
Jepio/cmusAn ncurses based music player with support for remote control.
KeychainThis document describes how to use SSH shared keys along with the keychain program. It assumes basic knowledge of public key cryptography.
Maffblaster/Draft articles/PyCharm Community EditionPyCharm Community Edition is a powerful, open source, single-language integrated developer environment (IDE) for Python projects created by JetBrains. PyCharm features syntax and error highlighting, auto-indentation, code completion, spell check, and a built-in Python debugger.
Maffblaster/Draft articles/Tahoe-LAFSTahoe-LAFS (Least Authority File System) is an encrypted, secure, distributed (fault-tolerant) file system).
Maffblaster/Draft articles/UdevilUdevil is a small auto-mount utility created to be a "a hassle-free replacement for udisks."
Martijnlu/software(Introductory paragraph goes here.)
MonitMonit is a utility for managing and monitoring processes, programs, files, directories and filesystems on a UNIX system.
MumbleMumble is open source, cross platform, low-latency, high quality voice over IP (VoIP) application.
MySQL/GuideThis is an introduction to MySQL and its use of databases, tables and privileges.
MySQL/Startup GuideThis document helps a user set up and use MySQL.
PostgreSQL/QuickStartThis is a quick start guide to PostgreSQL. It covers emerging PostgreSQL and configuring it. This is complementary to the official documentation, but does not supplant it.
Q appletsThe q applets are a collection of small and fast portage helper tools written in C. This guide covers some common uses of these helper tools, also known as the app-portage/portage-utils package.
Raraneda/BIND/GuideEsta guía le enseñará como instalar y configurar BIND para tu dominio y red local.
SudoThe sudo command provides a simple and secure way to configure privilege escalation, e.g. letting normal users to execute certain (or all) commands as root or some different user, possibly without giving a password.
Udevudev is the device manager for the Linux kernel. It manages device nodes in /dev and handles all user space actions when adding or removing devices.
VLCVLC media player is a wildly popular, cross platform video player and streamer. VLC media player has been quickly achieving its goal of world domination since its initial release in February of 2001.
VMwareVMware is a cross-platform virtual machine software emulator produced by VMware, Inc.
VimVim is a text editor based on vi. It can be used from the command line or as a standalone application with graphical user interface.
WeeChatWeeChat is a light, extensible, highly featured IRC client.

Desktop

A full overview of all documents in this category can be found at Desktop.

PageAbstract
ATI FAQThis FAQ should help users avoid some common installation and configuration issues related to DRI and X11 for AMD/ATI boards.
FluxboxThis guide provides instructions on how to set up the Fluxbox window manager for X11.
GNOME/GuideA frequently used desktop environment is GNOME. This guide tries to describe all aspects of GNOME, including installation, configuration, usage, and more!
NVidia/nvidia-driversnvidia-drivers is the proprietary graphics driver for nVidia graphic cards. An open source alternative is nouveau.
Openbox/GuideThe aim of this guide is to show users how to install and configure the OpenBox window manager. Many potential programs to be used in conjunction with OpenBox are referenced throughout this article.
Xorg/GuideXorg is the X Window server which allows users to have a graphical environment at their fingertips. This guide explains what Xorg is, how to install it, and the various configuration options.
Xorg/Hardware 3D acceleration guideThis document is a guide to getting 3D acceleration working using the DRM with Xorg in Gentoo Linux.

Server and security

A full overview of all documents in this category can be found at Server & Security.

PageAbstract
AIDEAIDE (Advanced Intrusion Detection Environment) is a host-based intrusion detection system. AIDE scans files and other resources and stores information about these files in a database. Stored information includes key file attributes such as file hash output, file size, ownership, modification time, creation time, and more. After the initial database has been created, AIDE then rescans the system and compares new scan results with previously stored values. If values differ then the file has been changed and the change will be reported. The idea behind using AIDE is to create a snapshot of a system then compare the snapshot to another created snapshot to find compromised files.
ApacheThe Apache HTTP Server is an efficient, extensible web server. It is one of the most popular web servers used on the Internet.
BIND/GuideThis guide will teach you how install and configure BIND for your domain and your local network.
Centralized authentication using OpenLDAPThis guide introduces the basics of LDAP and shows you how to setup OpenLDAP for authentication purposes between a group of computers.
Gentoo installation tips and tricksThe Gentoo installation allows for very flexible approaches to the various installation methods. As it is almost impossible to insert every single tip or trick in the installation instructions this document tries to deal with all submitted tips and tricks for reference purposes.
GnuPGThis guide will teach Gentoo Linux users the basics of using GnuPG; a tool for secure communication.
Hardened/FAQFrequently Asked Questions that arise on the gentoo-hardened IRC channel and the gentoo-hardened mailing list.
Hardened/Introduction to Hardened GentooThis guide is meant for anyone unsure about the offerings of the Hardened Gentoo project, how to use them together, and their respective roles in the project.
Home RouterThis document details how to turn an old Gentoo machine into a router for connecting a home network to the Internet.
Kernel/Gentoo Kernel Configuration GuideThis document aims to introduce the concepts of manual kernel configuration and details some of the most common configuration pitfalls.
KeychainThis document describes how to use SSH shared keys along with the keychain program. It assumes basic knowledge of public key cryptography.
Mailfiltering GatewayThis guide is step-by-step guide for installing spam fighting technologies for Postfix. Among them Amavisd-new using Spamassassin and ClamAV, greylisting and SPF.
MuttThis guide shows you how to begin using the powerful command line e-mail client mutt.
MySQL/GuideThis is an introduction to MySQL and its use of databases, tables and privileges.
Nginxnginx is a robust, small, high performance web server and reverse proxy server. It is a good alternative to popular web servers like Apache and lighttpd.
OpenRC/Baselayout 1 to 2 migrationThis guide provides instructions on migrating from baselayout-1 to baselayout-2 using OpenRC.
PuppetPuppet is a configuration management system written in Ruby. It can be used for automating machine deployments.
Raraneda/BIND/GuideEsta guía le enseñará como instalar y configurar BIND para tu dominio y red local.
Sparc/FAQThis FAQ is designed to help answer the most commonly asked questions about Gentoo/SPARC and Linux on SPARC architecture. Feel free to send revisions and corrections to the Gentoo/SPARC team or the doc team.
Sparc/OBP ReferenceThe OpenBoot PROM (OBP) Reference provides a list of useful OBP commands that can help when booting, configuring and performing diagnostics upon Sun SPARC hardware and clones.
Sshguardsshguard is an intrusion prevention system that parses server logs, determines malicious activity, and uses the system firewall to block the IP addresses of malicious connections.
Upgrading GentooThis document explains how new Gentoo releases affect existing installs.

Project and community

A full overview of all documents in this category can be found at Project & Community.

PageAbstract
AMD64/FAQThis is the Gentoo Linux/AMD64 Frequently Asked Questions
CgitA fast web-interface for git written in C.
Eselect/User guideeselect is a modular framework for writing configuration utilities. This guide introduces the reader to the tool and its design principles.
GNOME/GuideA frequently used desktop environment is GNOME. This guide tries to describe all aspects of GNOME, including installation, configuration, usage, and more!
GnuPGThis guide will teach Gentoo Linux users the basics of using GnuPG; a tool for secure communication.
Jepio/cmusAn ncurses based music player with support for remote control.
Maffblaster/Draft articles/PyCharm Community EditionPyCharm Community Edition is a powerful, open source, single-language integrated developer environment (IDE) for Python projects created by JetBrains. PyCharm features syntax and error highlighting, auto-indentation, code completion, spell check, and a built-in Python debugger.
Maffblaster/Draft articles/Tahoe-LAFSTahoe-LAFS (Least Authority File System) is an encrypted, secure, distributed (fault-tolerant) file system).
Martijnlu/software(Introductory paragraph goes here.)
MumbleMumble is open source, cross platform, low-latency, high quality voice over IP (VoIP) application.
PortingA guide for porting Gentoo to new or alternative platforms.
VDRThis article contains instructions on how to prepare Gentoo Linux for DVB and VDR.
WeeChatWeeChat is a light, extensible, highly featured IRC client.

Gentoo.org guides

The previous documentation list, in so far the documents have not been moved to the wiki yet, can still be found on the gentoo.org site.