source: postlfs/shells/zsh.xml@ 06908bf6

10.0 10.1 11.0 9.0 9.1 ken/refactor-virt lazarus qt5new trunk xry111/git-date xry111/git-date-for-trunk xry111/git-date-test
Last change on this file since 06908bf6 was 06908bf6, checked in by Pierre Labastie <pieere@…>, 2 years ago

Add remap="doc", remap="test", or just realign them

git-svn-id: svn://svn.linuxfromscratch.org/BLFS/trunk/BOOK@21946 af4574ff-66df-0310-9fd7-8a98e5e911e0

  • Property mode set to 100644
File size: 12.0 KB
Line 
1<?xml version="1.0" encoding="ISO-8859-1"?>
2<!DOCTYPE sect1 PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
3 "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
4 <!ENTITY % general-entities SYSTEM "../../general.ent">
5 %general-entities;
6
7 <!ENTITY zsh-download-http "http://www.zsh.org/pub/zsh-&zsh-version;.tar.xz">
8 <!ENTITY zsh-download-ftp " ">
9 <!ENTITY zsh-md5sum "374f9fdd121b5b90e07abfcad7df0627">
10 <!ENTITY zsh-size "3.0 MB">
11 <!ENTITY zsh-buildsize "68 MB (includes documentation and tests)">
12 <!ENTITY zsh-time "1.5 SBU (Using parallelism=4; includes documentation and tests)">
13
14 <!ENTITY zsh-doc-md5sum "08f2f78aae9d739db9e30365a228a6fb">
15 <!ENTITY zsh-doc-size "3.0 MB">
16]>
17
18<sect1 id="zsh" xreflabel="zsh-&zsh-version;">
19 <?dbhtml filename="zsh.html"?>
20
21 <sect1info>
22 <othername>$LastChangedBy$</othername>
23 <date>$Date$</date>
24 </sect1info>
25
26 <title>zsh-&zsh-version;</title>
27
28 <indexterm zone="zsh">
29 <primary sortas="a-zsh">zsh</primary>
30 </indexterm>
31
32 <sect2 role="package">
33 <title>Introduction to zsh</title>
34
35 <para>The <application>zsh</application> package contains a command
36 interpreter (shell) usable as an interactive login shell and as
37 a shell script command processor. Of the standard shells,
38 <application>zsh</application> most closely resembles
39 <application>ksh</application> but includes many enhancements.</para>
40
41 &lfs84_checked;
42
43 <bridgehead renderas="sect3">Package Information</bridgehead>
44 <itemizedlist spacing="compact">
45 <listitem>
46 <para>Download (HTTP): <ulink url="&zsh-download-http;"/></para>
47 </listitem>
48 <listitem>
49 <para>Download (FTP): <ulink url="&zsh-download-ftp;"/></para>
50 </listitem>
51 <listitem>
52 <para>Download MD5 sum: &zsh-md5sum;</para>
53 </listitem>
54 <listitem>
55 <para>Download size: &zsh-size;</para>
56 </listitem>
57 <listitem>
58 <para>Estimated disk space required: &zsh-buildsize;</para>
59 </listitem>
60 <listitem>
61 <para>Estimated build time: &zsh-time;</para>
62 </listitem>
63 </itemizedlist>
64
65 <bridgehead renderas="sect3">Additional Downloads</bridgehead>
66 <itemizedlist spacing="compact">
67 <listitem>
68 <para>Optional Documentation: <ulink
69 url="http://www.zsh.org/pub/zsh-&zsh-version;-doc.tar.xz"/></para>
70 </listitem>
71 <listitem>
72 <para>Documentation MD5 sum: &zsh-doc-md5sum;</para>
73 </listitem>
74 <listitem>
75 <para>Documentation download size: &zsh-doc-size;</para>
76 </listitem>
77 </itemizedlist>
78
79 <note>
80 <para>
81 When there is a new <application>zsh</application> release, the old
82 files shown above are moved to a new server directory:
83 <ulink url="http://www.zsh.org/pub/old/"/>.
84 </para>
85 </note>
86
87 <bridgehead renderas="sect3">zsh Dependencies</bridgehead>
88
89 <bridgehead renderas="sect4">Optional</bridgehead>
90 <para role="optional">
91 <xref linkend="libcap-pam"/>,
92 <xref linkend="pcre"/>, and
93 <xref linkend="valgrind"/>,
94 </para>
95
96 <para condition="html" role="usernotes">User Notes:
97 <ulink url="&blfs-wiki;/zsh"/></para>
98
99 </sect2>
100
101 <sect2 role="installation">
102 <title>Installation of zsh</title>
103
104 <para>If you downloaded the optional documentation, unpack it with
105 the following command:</para>
106
107<screen><userinput>tar --strip-components=1 -xvf ../zsh-&zsh-version;-doc.tar.xz</userinput></screen>
108
109<!-- <note>
110 <para>
111 Using a script to build with "su -c script" may produce a funny
112 configure error message: "no controlling tty". If this happens, add
113 the switch -\-with-tcsetpgrp to configure.
114 </para>
115 </note>
116-->
117 <para>Install <application>zsh</application> by running the following
118 commands:</para>
119
120<screen><userinput>./configure --prefix=/usr \
121 --bindir=/bin \
122 --sysconfdir=/etc/zsh \
123 --enable-etcdir=/etc/zsh &amp;&amp;
124make &amp;&amp;
125
126makeinfo Doc/zsh.texi --plaintext -o Doc/zsh.txt &amp;&amp;
127makeinfo Doc/zsh.texi --html -o Doc/html &amp;&amp;
128makeinfo Doc/zsh.texi --html --no-split --no-headers -o Doc/zsh.html</userinput></screen>
129
130 <para>If you have <xref linkend="texlive"/>
131 installed, you can build PDF format of the documentation by issuing
132 the following command:</para>
133
134<screen remap="doc"><userinput>texi2pdf Doc/zsh.texi -o Doc/zsh.pdf</userinput></screen>
135
136 <para>To test the results, issue: <command>make check</command>.</para>
137
138 <para>Now, as the <systemitem class="username">root</systemitem> user:</para>
139
140<screen role="root"><userinput>make install &amp;&amp;
141make infodir=/usr/share/info install.info &amp;&amp;
142
143install -v -m755 -d /usr/share/doc/zsh-&zsh-version;/html &amp;&amp;
144install -v -m644 Doc/html/* /usr/share/doc/zsh-&zsh-version;/html &amp;&amp;
145install -v -m644 Doc/zsh.{html,txt} /usr/share/doc/zsh-&zsh-version;</userinput></screen>
146
147 <para>If you downloaded the optional documentation, install it by issuing
148 the following commands as the
149 <systemitem class="username">root</systemitem> user:</para>
150
151<screen role="root"><userinput>make htmldir=/usr/share/doc/zsh-&zsh-version;/html install.html &amp;&amp;
152install -v -m644 Doc/zsh.dvi /usr/share/doc/zsh-&zsh-version;</userinput></screen>
153
154 <para>If you built the PDF format of the documentation, install
155 it by issuing the following command as the
156 <systemitem class="username">root</systemitem> user:</para>
157
158<screen role="root"
159 remap="doc"><userinput>install -v -m644 Doc/zsh.pdf /usr/share/doc/zsh-&zsh-version;</userinput></screen>
160
161 </sect2>
162
163 <sect2 role="commands">
164 <title>Command Explanations</title>
165
166 <para><parameter>--sysconfdir=/etc/zsh</parameter> and
167 <parameter>--enable-etcdir=/etc/zsh</parameter>: These parameters are
168 used so that all the <application>zsh</application> configuration files
169 are consolidated into the <filename class='directory'>/etc/zsh</filename>
170 directory. Omit these parameters if you wish to retain historical
171 compatibility by having all the files located in the
172 <filename class='directory'>/etc</filename> directory.</para>
173
174 <para><parameter>--bindir=/bin</parameter>: This parameter places the
175 <command>zsh</command> binaries into the root filesystem.</para>
176
177 <para><option>--enable-cap</option>: This option enables
178 POSIX capabilities.</para>
179
180 <para><option>--disable-gdbm</option>: This option disables the
181 use of the <application>GDBM</application> library.</para>
182
183 <para><option>--enable-pcre</option>: This option allows zsh to use
184 the <application>PCRE</application> regular expression library in shell
185 builtins.</para>
186
187 <sect3 id="mountpoints">
188 <title>Multiple partitions</title>
189
190 <para>Linking <application>zsh</application> dynamically against
191 <application>pcre</application> and/or <application>gdbm</application>
192 produces runtime dependencies on <filename class='libraryfile'>
193 libpcre.so</filename> and/or <filename class='libraryfile'>libgdbm.so
194 </filename>respectively, which both reside in
195 <filename class='directory'>/usr</filename> hierarchy. If
196 <filename class='directory'>/usr</filename> is a separate mount point
197 and <application>zsh</application> needs to be available in boot time,
198 then its supporting libraries should be in
199 <filename class='directory'>/lib</filename> too. You can move the
200 libraries as follows:</para>
201
202<screen role="root"><userinput>mv -v /usr/lib/libpcre.so.* /lib &amp;&amp;
203ln -v -sf ../../lib/libpcre.so.0 /usr/lib/libpcre.so
204
205mv -v /usr/lib/libgdbm.so.* /lib &amp;&amp;
206ln -v -sf ../../lib/libgdbm.so.3 /usr/lib/libgdbm.so</userinput>
207</screen>
208
209 <para>Alternatively you can statically link <application>zsh</application>
210 against <application>pcre</application> and <application>gdbm</application>
211 if you modify the <filename>config.modules</filename> file (you need first
212 to run configure to generate it).</para>
213
214 </sect3>
215
216 </sect2>
217
218 <sect2 role="configuration">
219 <title>Configuring zsh</title>
220
221 <sect3 id="zsh-config">
222 <title>Config Files</title>
223
224 <para>There are a whole host of configuration files for
225 <application>zsh</application> including
226 <filename>/etc/zsh/zshenv</filename>,
227 <filename>/etc/zsh/zprofile</filename>,
228 <filename>/etc/zsh/zshrc</filename>,
229 <filename>/etc/zsh/zlogin</filename> and
230 <filename>/etc/zsh/zlogout</filename>.
231 You can find more information on these in the <filename>zsh(1)</filename>
232 and related manual pages.</para>
233
234 <para>
235 The first time zsh is executed, you will be prompted by messages asking
236 several questions. The answers will be used to create a
237 <filename>~/.zshrc</filename> file. If you wish to run these questions
238 again, run <command>zsh
239 /usr/share/zsh/&zsh-version;/functions/zsh-newuser-install -f</command>.
240 </para>
241
242 <para>
243 There are several built-in advanced prompts. In the
244 <command>zsh</command> shell, start advanced prompt support with
245 <command>autoload -U promptinit</command>, then
246 <command>promptinit</command>. Available prompt names are listed with
247 <command>prompt -l</command>. Select a particular one with
248 <command>prompt <literal>&lt;prompt-name&gt;</literal></command>. Display all available
249 prompts with <command>prompt -p</command>. Except for the list and
250 display commands above, you can insert the other ones in
251 <filename>~/.zshrc</filename> to be automatically executed at
252 shell start, with the prompt you chose.
253 </para>
254
255 <indexterm zone="zsh zsh-config">
256 <primary sortas="e-etc-zsh-zshenv">/etc/zsh/zshenv</primary>
257 </indexterm>
258
259 <indexterm zone="zsh zsh-config">
260 <primary sortas="e-etc-zsh-zprofile">/etc/zsh/zprofile</primary>
261 </indexterm>
262
263 <indexterm zone="zsh zsh-config">
264 <primary sortas="e-etc-zsh-zshrc">/etc/zsh/zshrc</primary>
265 </indexterm>
266
267 <indexterm zone="zsh zsh-config">
268 <primary sortas="e-etc-zsh-zlogin">/etc/zsh/zlogin</primary>
269 </indexterm>
270
271 <indexterm zone="zsh zsh-config">
272 <primary sortas="e-etc-zsh-zlogout">/etc/zsh/zlogout</primary>
273 </indexterm>
274
275 </sect3>
276
277 <sect3>
278 <title>Configuration Information</title>
279
280 <para>Update <filename>/etc/shells</filename> to include the
281 <application>zsh</application> shell program names (as the
282 <systemitem class="username">root</systemitem> user):</para>
283
284<screen role="root"><userinput>cat &gt;&gt; /etc/shells &lt;&lt; "EOF"
285<literal>/bin/zsh</literal>
286EOF</userinput></screen>
287
288 </sect3>
289
290 </sect2>
291
292 <sect2 role="content">
293 <title>Contents</title>
294
295 <segmentedlist>
296 <segtitle>Installed Programs</segtitle>
297 <segtitle>Installed Libraries</segtitle>
298 <segtitle>Installed Directories</segtitle>
299
300 <seglistitem>
301 <seg>zsh and zsh-&zsh-version; (hardlinked to each other)</seg>
302 <seg>Numerous plugin helper modules under
303 /usr/lib/zsh/&zsh-version;/</seg>
304 <seg>/usr/{lib,share}/zsh and /usr/share/doc/zsh-&zsh-version;</seg>
305 </seglistitem>
306 </segmentedlist>
307
308 <variablelist>
309 <bridgehead renderas="sect3">Short Description</bridgehead>
310 <?dbfo list-presentation="list"?>
311 <?dbhtml list-presentation="table"?>
312
313 <varlistentry id="zsh-prog">
314 <term><command>zsh</command></term>
315 <listitem>
316 <para>is a shell which has command-line editing, built-in spelling
317 correction, programmable command completion, shell functions (with
318 autoloading), a history mechanism, and a host of other features.</para>
319 <indexterm zone="zsh zsh-prog">
320 <primary sortas="b-zsh">zsh</primary>
321 </indexterm>
322 </listitem>
323 </varlistentry>
324
325 </variablelist>
326
327 </sect2>
328
329</sect1>
Note: See TracBrowser for help on using the repository browser.