[ab4fdfc] | 1 | <?xml version="1.0" encoding="UTF-8"?>
|
---|
[6732c094] | 2 | <!DOCTYPE sect1 PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
|
---|
| 3 | "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
|
---|
[44f085a] | 4 | <!ENTITY % general-entities SYSTEM "../../general.ent">
|
---|
| 5 | %general-entities;
|
---|
| 6 |
|
---|
[c6b192c] | 7 | <!ENTITY zsh-download-http "https://www.zsh.org/pub/zsh-&zsh-version;.tar.xz">
|
---|
[8070ffce] | 8 | <!ENTITY zsh-download-ftp " ">
|
---|
[06333e6] | 9 | <!ENTITY zsh-md5sum "182e37ca3fe3fa6a44f69ad462c5c30e">
|
---|
| 10 | <!ENTITY zsh-size "3.2 MB">
|
---|
| 11 | <!ENTITY zsh-buildsize "48 MB (includes documentation and tests)">
|
---|
| 12 | <!ENTITY zsh-time "1.6 SBU (Using parallelism=4; includes documentation and tests)">
|
---|
[44f085a] | 13 | ]>
|
---|
| 14 |
|
---|
[f17b2db] | 15 | <sect1 id="zsh" xreflabel="zsh-&zsh-version;">
|
---|
[a6a160b] | 16 | <?dbhtml filename="zsh.html"?>
|
---|
[f45b1953] | 17 |
|
---|
[a6a160b] | 18 |
|
---|
[f17b2db] | 19 | <title>zsh-&zsh-version;</title>
|
---|
[a6a160b] | 20 |
|
---|
| 21 | <indexterm zone="zsh">
|
---|
[f17b2db] | 22 | <primary sortas="a-zsh">zsh</primary>
|
---|
[a6a160b] | 23 | </indexterm>
|
---|
| 24 |
|
---|
| 25 | <sect2 role="package">
|
---|
[f17b2db] | 26 | <title>Introduction to zsh</title>
|
---|
[a6a160b] | 27 |
|
---|
[f716ef4] | 28 | <para>
|
---|
| 29 | The <application>zsh</application> package contains a command
|
---|
| 30 | interpreter (shell) usable as an interactive login shell and as
|
---|
| 31 | a shell script command processor. Of the standard shells,
|
---|
| 32 | <application>zsh</application> most closely resembles
|
---|
| 33 | <application>ksh</application> but includes many enhancements.
|
---|
| 34 | </para>
|
---|
[a6a160b] | 35 |
|
---|
[fa4aa313] | 36 | &lfs122_checked;
|
---|
[6eff6e1] | 37 |
|
---|
[a6a160b] | 38 | <bridgehead renderas="sect3">Package Information</bridgehead>
|
---|
| 39 | <itemizedlist spacing="compact">
|
---|
| 40 | <listitem>
|
---|
[f716ef4] | 41 | <para>
|
---|
| 42 | Download (HTTP): <ulink url="&zsh-download-http;"/>
|
---|
| 43 | </para>
|
---|
[a6a160b] | 44 | </listitem>
|
---|
| 45 | <listitem>
|
---|
[f716ef4] | 46 | <para>
|
---|
| 47 | Download (FTP): <ulink url="&zsh-download-ftp;"/>
|
---|
| 48 | </para>
|
---|
[a6a160b] | 49 | </listitem>
|
---|
| 50 | <listitem>
|
---|
[f716ef4] | 51 | <para>
|
---|
| 52 | Download MD5 sum: &zsh-md5sum;
|
---|
| 53 | </para>
|
---|
[a6a160b] | 54 | </listitem>
|
---|
| 55 | <listitem>
|
---|
[f716ef4] | 56 | <para>
|
---|
| 57 | Download size: &zsh-size;
|
---|
| 58 | </para>
|
---|
[a6a160b] | 59 | </listitem>
|
---|
| 60 | <listitem>
|
---|
[f716ef4] | 61 | <para>
|
---|
| 62 | Estimated disk space required: &zsh-buildsize;
|
---|
| 63 | </para>
|
---|
[a6a160b] | 64 | </listitem>
|
---|
| 65 | <listitem>
|
---|
[f716ef4] | 66 | <para>
|
---|
| 67 | Estimated build time: &zsh-time;
|
---|
| 68 | </para>
|
---|
[a6a160b] | 69 | </listitem>
|
---|
| 70 | </itemizedlist>
|
---|
| 71 |
|
---|
[1590eb9] | 72 | <note>
|
---|
| 73 | <para>
|
---|
| 74 | When there is a new <application>zsh</application> release, the old
|
---|
| 75 | files shown above are moved to a new server directory:
|
---|
[c6b192c] | 76 | <ulink url="https://www.zsh.org/pub/old/"/>.
|
---|
[1590eb9] | 77 | </para>
|
---|
| 78 | </note>
|
---|
| 79 |
|
---|
[f17b2db] | 80 | <bridgehead renderas="sect3">zsh Dependencies</bridgehead>
|
---|
[a6a160b] | 81 |
|
---|
| 82 | <bridgehead renderas="sect4">Optional</bridgehead>
|
---|
[ca17955] | 83 | <para role="optional">
|
---|
[abfacaf] | 84 | <!-- <xref linkend="pcre2"/>, The next zsh release will support it -->
|
---|
| 85 | <xref linkend="valgrind"/> and
|
---|
[d472e22c] | 86 | <ulink url='https://fbb-git.gitlab.io/yodl/'>yodl</ulink>
|
---|
[fcf4b970] | 87 | </para>
|
---|
[a6a160b] | 88 |
|
---|
| 89 | </sect2>
|
---|
| 90 |
|
---|
| 91 | <sect2 role="installation">
|
---|
[f17b2db] | 92 | <title>Installation of zsh</title>
|
---|
[a6a160b] | 93 |
|
---|
[f716ef4] | 94 | <para>
|
---|
[7299d5e] | 95 | Adapt the documentation build system for texinfo-7.0 or later:
|
---|
[f716ef4] | 96 | </para>
|
---|
[98078a63] | 97 |
|
---|
[7299d5e] | 98 | <screen><userinput>sed -e 's/set_from_init_file/texinfo_&/' \
|
---|
| 99 | -i Doc/Makefile.in</userinput></screen>
|
---|
[6eff6e1] | 100 |
|
---|
[ea36f0f] | 101 | <!-- https://github.com/zsh-users/zsh/commit/4c89849c9817
|
---|
| 102 | https://github.com/zsh-users/zsh/commit/ab4d62eb975a -->
|
---|
| 103 | <para>
|
---|
| 104 | Some programs shipped in the building system for detecting system
|
---|
| 105 | features use pre-C99 syntax rejected by GCC-14.1 or later. Fix them
|
---|
| 106 | up or Zsh would be wrongly configured and fail to build:
|
---|
| 107 | </para>
|
---|
| 108 |
|
---|
[fa4aa313] | 109 | <screen><userinput>sed -e 's/^main/int &/' \
|
---|
| 110 | -e 's/exit(/return(/' \
|
---|
| 111 | -i aczsh.m4 configure.ac &&
|
---|
| 112 |
|
---|
| 113 | sed -e 's/test = /&(char**)/' \
|
---|
| 114 | -i configure.ac &&
|
---|
| 115 |
|
---|
[ea36f0f] | 116 | autoconf</userinput></screen>
|
---|
| 117 |
|
---|
[d472e22c] | 118 | <para>
|
---|
| 119 | The documentation files contain references to zsh configuration
|
---|
| 120 | files in <filename class='directory'>/etc</filename>, but we'll
|
---|
| 121 | use <filename class='directory'>/etc/zsh</filename> to hold these
|
---|
| 122 | configuration files instead. The building system will fix up those
|
---|
| 123 | references if the <application>yodl</application> package is
|
---|
| 124 | available, but it's out of the scope of BLFS. So we need to fix up
|
---|
| 125 | the references manually:
|
---|
| 126 | </para>
|
---|
| 127 |
|
---|
[fa4aa313] | 128 | <screen><userinput>sed -e 's|/etc/z|/etc/zsh/z|g' \
|
---|
| 129 | -i Doc/*.*</userinput></screen>
|
---|
[d472e22c] | 130 |
|
---|
[8f1fc267] | 131 | <!-- <note>
|
---|
[37b6e78] | 132 | <para>
|
---|
| 133 | Using a script to build with "su -c script" may produce a funny
|
---|
| 134 | configure error message: "no controlling tty". If this happens, add
|
---|
[8f1fc267] | 135 | the switch -\-with-tcsetpgrp to configure.
|
---|
[37b6e78] | 136 | </para>
|
---|
| 137 | </note>
|
---|
[8f1fc267] | 138 | -->
|
---|
[f716ef4] | 139 | <para>
|
---|
| 140 | Install <application>zsh</application> by running the following
|
---|
| 141 | commands:
|
---|
| 142 | </para>
|
---|
[a6a160b] | 143 |
|
---|
[4f4e7f18] | 144 | <screen><userinput>./configure --prefix=/usr \
|
---|
| 145 | --sysconfdir=/etc/zsh \
|
---|
| 146 | --enable-etcdir=/etc/zsh \
|
---|
| 147 | --enable-cap \
|
---|
[7299d5e] | 148 | --enable-gdbm &&
|
---|
| 149 | make &&
|
---|
[a6a160b] | 150 |
|
---|
[7299d5e] | 151 | makeinfo Doc/zsh.texi --html -o Doc/html &&
|
---|
| 152 | makeinfo Doc/zsh.texi --plaintext -o zsh.txt &&
|
---|
| 153 | makeinfo Doc/zsh.texi --html --no-split --no-headers -o zsh.html</userinput></screen>
|
---|
[6eff6e1] | 154 |
|
---|
[f716ef4] | 155 | <para>
|
---|
| 156 | If you have <xref linkend="texlive"/>
|
---|
| 157 | installed, you can build PDF format of the documentation by issuing
|
---|
| 158 | the following command:
|
---|
| 159 | </para>
|
---|
[f1e103a] | 160 |
|
---|
[06908bf6] | 161 | <screen remap="doc"><userinput>texi2pdf Doc/zsh.texi -o Doc/zsh.pdf</userinput></screen>
|
---|
[f1e103a] | 162 |
|
---|
[f716ef4] | 163 | <para>
|
---|
| 164 | To test the results, issue: <command>make check</command>.
|
---|
| 165 | </para>
|
---|
[5ef8b741] | 166 |
|
---|
[f716ef4] | 167 | <para>
|
---|
| 168 | Now, as the <systemitem class="username">root</systemitem> user:
|
---|
| 169 | </para>
|
---|
[a6a160b] | 170 |
|
---|
[7299d5e] | 171 | <screen role="root"><userinput>make install &&
|
---|
| 172 | make infodir=/usr/share/info install.info &&
|
---|
| 173 | make htmldir=/usr/share/doc/zsh-&zsh-version;/html install.html &&
|
---|
| 174 | install -v -m644 zsh.{html,txt} Etc/FAQ /usr/share/doc/zsh-&zsh-version;</userinput></screen>
|
---|
[6eff6e1] | 175 |
|
---|
[f716ef4] | 176 | <para>
|
---|
| 177 | If you built the PDF format of the documentation, install
|
---|
| 178 | it by issuing the following command as the
|
---|
| 179 | <systemitem class="username">root</systemitem> user:
|
---|
| 180 | </para>
|
---|
[6eff6e1] | 181 |
|
---|
[06908bf6] | 182 | <screen role="root"
|
---|
| 183 | remap="doc"><userinput>install -v -m644 Doc/zsh.pdf /usr/share/doc/zsh-&zsh-version;</userinput></screen>
|
---|
[6eff6e1] | 184 |
|
---|
| 185 | </sect2>
|
---|
| 186 |
|
---|
| 187 | <sect2 role="commands">
|
---|
| 188 | <title>Command Explanations</title>
|
---|
[29f80ebc] | 189 |
|
---|
[f716ef4] | 190 | <para>
|
---|
| 191 | <parameter>--sysconfdir=/etc/zsh</parameter> and
|
---|
| 192 | <parameter>--enable-etcdir=/etc/zsh</parameter>: These parameters are
|
---|
| 193 | used so that all the <application>zsh</application> configuration files
|
---|
| 194 | are consolidated into the <filename class='directory'>/etc/zsh</filename>
|
---|
| 195 | directory. Omit these parameters if you wish to retain historical
|
---|
| 196 | compatibility by having all the files located in the
|
---|
| 197 | <filename class='directory'>/etc</filename> directory.
|
---|
| 198 | </para>
|
---|
[fd7e0ed6] | 199 |
|
---|
[f716ef4] | 200 | <para>
|
---|
[4f4e7f18] | 201 | <parameter>--enable-cap</parameter>: This option enables
|
---|
[f716ef4] | 202 | POSIX capabilities.
|
---|
| 203 | </para>
|
---|
[fcf4b970] | 204 |
|
---|
[f716ef4] | 205 | <para>
|
---|
[4f4e7f18] | 206 | <parameter>--enable-gdbm</parameter>: This option enables the
|
---|
[f716ef4] | 207 | use of the <application>GDBM</application> library.
|
---|
| 208 | </para>
|
---|
[abfacaf] | 209 | <!-- the next zsh release will support it
|
---|
[f716ef4] | 210 | <para>
|
---|
[abfacaf] | 211 | <option>- -enable-pcre</option>: This option allows zsh to use
|
---|
| 212 | the <application>PCRE2</application> regular expression library in shell
|
---|
[f716ef4] | 213 | builtins.
|
---|
| 214 | </para>
|
---|
[abfacaf] | 215 | -->
|
---|
[a6a160b] | 216 | </sect2>
|
---|
| 217 |
|
---|
| 218 | <sect2 role="configuration">
|
---|
[f17b2db] | 219 | <title>Configuring zsh</title>
|
---|
[a6a160b] | 220 |
|
---|
| 221 | <sect3 id="zsh-config">
|
---|
| 222 | <title>Config Files</title>
|
---|
| 223 |
|
---|
[f716ef4] | 224 | <para>
|
---|
| 225 | There are a whole host of configuration files for
|
---|
| 226 | <application>zsh</application> including
|
---|
| 227 | <filename>/etc/zsh/zshenv</filename>,
|
---|
| 228 | <filename>/etc/zsh/zprofile</filename>,
|
---|
| 229 | <filename>/etc/zsh/zshrc</filename>,
|
---|
| 230 | <filename>/etc/zsh/zlogin</filename> and
|
---|
| 231 | <filename>/etc/zsh/zlogout</filename>.
|
---|
| 232 | You can find more information on these in the
|
---|
[fedbe2f] | 233 | <ulink role='man' url='&man;zsh.1'>zsh(1)</ulink> and related
|
---|
| 234 | manual pages.
|
---|
[f716ef4] | 235 | </para>
|
---|
[a6a160b] | 236 |
|
---|
[37b6e78] | 237 | <para>
|
---|
| 238 | The first time zsh is executed, you will be prompted by messages asking
|
---|
[8763a1da] | 239 | several questions. The answers will be used to create a
|
---|
[37b6e78] | 240 | <filename>~/.zshrc</filename> file. If you wish to run these questions
|
---|
| 241 | again, run <command>zsh
|
---|
| 242 | /usr/share/zsh/&zsh-version;/functions/zsh-newuser-install -f</command>.
|
---|
| 243 | </para>
|
---|
| 244 |
|
---|
| 245 | <para>
|
---|
| 246 | There are several built-in advanced prompts. In the
|
---|
| 247 | <command>zsh</command> shell, start advanced prompt support with
|
---|
| 248 | <command>autoload -U promptinit</command>, then
|
---|
| 249 | <command>promptinit</command>. Available prompt names are listed with
|
---|
| 250 | <command>prompt -l</command>. Select a particular one with
|
---|
[f716ef4] | 251 | <command>prompt <literal><prompt-name></literal></command>.
|
---|
| 252 | Display all available
|
---|
[37b6e78] | 253 | prompts with <command>prompt -p</command>. Except for the list and
|
---|
| 254 | display commands above, you can insert the other ones in
|
---|
| 255 | <filename>~/.zshrc</filename> to be automatically executed at
|
---|
| 256 | shell start, with the prompt you chose.
|
---|
| 257 | </para>
|
---|
| 258 |
|
---|
[a6a160b] | 259 | <indexterm zone="zsh zsh-config">
|
---|
[6eff6e1] | 260 | <primary sortas="e-etc-zsh-zshenv">/etc/zsh/zshenv</primary>
|
---|
[a6a160b] | 261 | </indexterm>
|
---|
| 262 |
|
---|
| 263 | <indexterm zone="zsh zsh-config">
|
---|
[6eff6e1] | 264 | <primary sortas="e-etc-zsh-zprofile">/etc/zsh/zprofile</primary>
|
---|
[a6a160b] | 265 | </indexterm>
|
---|
| 266 |
|
---|
| 267 | <indexterm zone="zsh zsh-config">
|
---|
[6eff6e1] | 268 | <primary sortas="e-etc-zsh-zshrc">/etc/zsh/zshrc</primary>
|
---|
[a6a160b] | 269 | </indexterm>
|
---|
| 270 |
|
---|
| 271 | <indexterm zone="zsh zsh-config">
|
---|
[6eff6e1] | 272 | <primary sortas="e-etc-zsh-zlogin">/etc/zsh/zlogin</primary>
|
---|
[a6a160b] | 273 | </indexterm>
|
---|
| 274 |
|
---|
| 275 | <indexterm zone="zsh zsh-config">
|
---|
[6eff6e1] | 276 | <primary sortas="e-etc-zsh-zlogout">/etc/zsh/zlogout</primary>
|
---|
[a6a160b] | 277 | </indexterm>
|
---|
| 278 |
|
---|
| 279 | </sect3>
|
---|
| 280 |
|
---|
[5ef8b741] | 281 | <sect3>
|
---|
| 282 | <title>Configuration Information</title>
|
---|
| 283 |
|
---|
[f716ef4] | 284 | <para>
|
---|
| 285 | Update <filename>/etc/shells</filename> to include the
|
---|
| 286 | <application>zsh</application> shell program names (as the
|
---|
| 287 | <systemitem class="username">root</systemitem> user):
|
---|
| 288 | </para>
|
---|
[5ef8b741] | 289 |
|
---|
| 290 | <screen role="root"><userinput>cat >> /etc/shells << "EOF"
|
---|
[e74610e7] | 291 | <literal>/bin/zsh</literal>
|
---|
[5ef8b741] | 292 | EOF</userinput></screen>
|
---|
| 293 |
|
---|
| 294 | </sect3>
|
---|
| 295 |
|
---|
[a6a160b] | 296 | </sect2>
|
---|
| 297 |
|
---|
| 298 | <sect2 role="content">
|
---|
| 299 | <title>Contents</title>
|
---|
| 300 |
|
---|
| 301 | <segmentedlist>
|
---|
[5ef8b741] | 302 | <segtitle>Installed Programs</segtitle>
|
---|
[a6a160b] | 303 | <segtitle>Installed Libraries</segtitle>
|
---|
| 304 | <segtitle>Installed Directories</segtitle>
|
---|
| 305 |
|
---|
| 306 | <seglistitem>
|
---|
[e74610e7] | 307 | <seg>zsh and zsh-&zsh-version; (hardlinked to each other)</seg>
|
---|
[8763a1da] | 308 | <seg>Numerous plugin helper modules under
|
---|
[36e088d] | 309 | /usr/lib/zsh/&zsh-version;/</seg>
|
---|
[8763a1da] | 310 | <seg>/usr/{lib,share}/zsh and /usr/share/doc/zsh-&zsh-version;</seg>
|
---|
[a6a160b] | 311 | </seglistitem>
|
---|
| 312 | </segmentedlist>
|
---|
| 313 |
|
---|
| 314 | <variablelist>
|
---|
| 315 | <bridgehead renderas="sect3">Short Description</bridgehead>
|
---|
| 316 | <?dbfo list-presentation="list"?>
|
---|
| 317 | <?dbhtml list-presentation="table"?>
|
---|
| 318 |
|
---|
| 319 | <varlistentry id="zsh-prog">
|
---|
| 320 | <term><command>zsh</command></term>
|
---|
| 321 | <listitem>
|
---|
[f716ef4] | 322 | <para>
|
---|
| 323 | is a shell which has command-line editing, built-in spelling
|
---|
| 324 | correction, programmable command completion, shell functions (with
|
---|
[4c24eb0a] | 325 | autoloading), a history mechanism, and a host of other features
|
---|
[f716ef4] | 326 | </para>
|
---|
[a6a160b] | 327 | <indexterm zone="zsh zsh-prog">
|
---|
| 328 | <primary sortas="b-zsh">zsh</primary>
|
---|
| 329 | </indexterm>
|
---|
| 330 | </listitem>
|
---|
| 331 | </varlistentry>
|
---|
[1aa3a3ca] | 332 |
|
---|
[a6a160b] | 333 | </variablelist>
|
---|
| 334 |
|
---|
| 335 | </sect2>
|
---|
| 336 |
|
---|
| 337 | </sect1>
|
---|