<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE guide SYSTEM "/dtd/guide.dtd">
<!-- $Header$ -->

<guide link="/doc/en/guide.xml" lang="en">

<title>Quick guide to Zsh installation and configuration</title>

<author title="Author">
	<mail link="hak8@wp.pl">Henryk Konsek</mail>
</author>


<abstract>
This guide shows how to install and configure Zsh quickly. After lecture of this document you
will be able use such Zsh features as advanced tab-completion, commands correction or prompt
management.
</abstract>

<!-- The content of this document is licensed under the CC-BY-SA license -->
<!-- See http://creativecommons.org/licenses/by-sa/2.5 -->
<license/>

<version>1.0</version>
<date>2006-02-18</date>

<chapter>
<title>Installation</title>
<section>
<title>Packages download</title>

<body>
<p>
To install Zsh under Gentoo we need to emerge app-shells/zsh (Zsh itself) and app-shells/zsh-completion
(Zsh completion scripts) packages.
</p>

<pre caption="Emerging Zsh">

	# emerge zsh zsh-completion
</pre>

</body>
</section>
</chapter>

<chapter>
<title>Configuration</title>
<section>
<title>Introduction</title>
<body>
<p>
After installation Zsh seems to be very simple and rather limited in the area of functionality. To change 
this state several configuration fixes should be performed.
</p>
</body>
</section>
<section>
<title>Advanced Tab-completion</title>
<body>

<p>
To enable famous Zsh tab-completion system we have to type the following commands:
</p>

<pre caption="Completion enabling">

% autoload -U compinit
% compinit
</pre>

</body>
</section>

<section>
<title>Command correction</title>
<body>
<p>
This is also a good idea to enable correction of the commands written under shell.
</p>

<pre caption="Correction enabling">

% setopt correctall
</pre>

</body>
</section>

<section>
<title>Prompts</title>
<body>
<p>
Our prompt may seem quite boring however we can fix it easily in several steps. 
At first we need to initialize advanced prompt support:
</p>

<pre caption="Advanced prompts enabling">

% autoload -U promptinit
% promptinit
</pre>

<p>
Available prompts samples may be printed via prompt -p command. Now we can activate our 
favourite one (oliver for example):
</p>

<pre caption="Prompt choice">

% prompt oliver
</pre>

</body>
</section>

</chapter>

<chapter>
<title>Saving settings</title>
<section>
<title>How to save Zsh settings in zshrc script</title>
<body>
<p>
This is good idea to enable these option as a Zsh defaults for our system. Possible
way to achieve this is to write our settings in the /etc/zsh/zshrc script using our
favourite text editor (nano or vim for example):
</p>

<pre caption="vim /etc/zsh/zshrc">

#!/bin/zsh

# completion
autoload -U compinit
compinit

# correction
setopt correctall

# prompt
autoload -U promptinit
promptinit
prompt oliver

</pre>

<p>
The last thing we need to do is to set zshrc script as executable:
</p>

<pre caption="Making zshrc executable">

% chmod a+x /etc/zsh/zshrc
</pre>
</body>
</section>
</chapter>

</guide>
