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 binary package hosts and use binary packages.
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.
Genkernelgenkernel is used to automate the build process of the kernel and initramfs.
IPv6 router guideThis guide explains how to use an IPv6 setup and routing on a Gentoo Linux system.
Initramfs/HOWTOMore 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/ConfigurationThis article describes the manual configuration and setup of the Linux kernel. For an authomatic method, see the genkernel article.
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/HOWTOThis 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 IRC.
Power management/HOWTOIn 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.
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 (for CD/DVDs)
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.
Upgrading GCCThis document will guide the user through the process of upgrading GCC.

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/TutorialThis guide will teach you how install and configure BIND for your domain and your local network.
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.
Infrastructure/RsyncThis document explains how to set up a official rsync mirror and your own local mirror.
MonitMonit is a utility for managing and monitoring processes, programs, files, directories and filesystems on a UNIX system.
MySQL/First StepsThis 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.
SSHSSH (Secure Shell) is an encrypted terminal program that replaces the classic telnet tool on Unix-like operating systems.
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.
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.

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 howto will show you how to set up the Fluxbox window manager for X11.
GNOME/ConfigurationA frequently used environment is GNOME. This HOWTO 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/HOWTOThe 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/ConfigurationXorg is the X Window server which allows users to have a graphical environment at their fingertips. This HOWTO explains what Xorg is, how to install it and what the various configuration options are.
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 stands for Advanced Intrusion Detection Environment and is an application that scans files and other resources and stores information about these files in a database. Rescanning the system can then identify (possibly unwanted) modifications and report those.
ApacheThe Apache HTTP Server is an efficient and extensible web server. It is one of the most popular web servers used on the Internet.
BIND/TutorialThis 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 small guide will teach you 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 what their respective roles in the project are.
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/First StepsThis is an introduction to MySQL and its use of databases, tables and privileges.
Nginxnginx is a robust, small and high performance web server and reverse proxy server.
OpenRC/Baselayout 1 to 2 migrationThis guide shows you how to migrate from baselayout-1 to baselayout-2 and OpenRC.
PuppetPuppet is a configuration management system written in Ruby. It can be used for automating machine deployments.
SSHSSH (Secure Shell) is an encrypted terminal program that replaces the classic telnet tool on Unix-like operating systems.
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/NetbootGuide for setting up a netboot server for use with the Gentoo/SPARC netboot installation images.
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 which parses server logs, determines malicious activity and then uses the system firewall to block those ip addresses.
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
Eselect/User guideeselect is a modular framework for writing configuration utilities. This guide introduces the reader to the tool and its design principles.
GNOME/ConfigurationA frequently used environment is GNOME. This HOWTO tries to describe all aspects of GNOME, including installation, configuration, usage, and more!
Kernel/Gentoo Kernel Configuration GuideThis document aims to introduce the concepts of manual kernel configuration and details some of the most common configuration pitfalls.
PortingA howto for porting Gentoo to new/alternative platforms

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.