Table of Contents

1. The Z Shell Manual

1.1 Producing documentation from zsh.texi

2. Introduction

2.1 Author
2.2 Availability
2.3 Mailing Lists
2.4 The Zsh FAQ
2.5 The Zsh Web Page
2.6 The Zsh Userguide
2.7 See Also

3. Invocation

3.1 Invocation Options
3.2 Compatibility
3.3 Restricted Shell

4. Files

4.1 Startup/Shutdown Files
4.2 Files

5. Shell Grammar

5.1 Simple Commands & Pipelines
5.2 Precommand Modifiers
5.3 Complex Commands
5.4 Alternate Forms For Complex Commands
5.5 Reserved Words
5.6 Comments
5.7 Aliasing
5.8 Quoting

6. Redirection

6.1 Multios
6.2 Redirections with no command

7. Command Execution
8. Functions

8.1 Autoloading Functions
8.2 Special Functions

9. Jobs & Signals

9.1 Jobs
9.2 Signals

10. Arithmetic Evaluation
11. Conditional Expressions
12. Prompt Expansion
13. Expansion

13.1 History Expansion

13.1.1 Overview
13.1.2 Event Designators
13.1.3 Word Designators
13.1.4 Modifiers

13.2 Process Substitution
13.3 Parameter Expansion

13.3.1 Parameter Expansion Flags
13.3.2 Rules
13.3.3 Examples

13.4 Command Substitution
13.5 Arithmetic Expansion
13.6 Brace Expansion
13.7 Filename Expansion
13.8 Filename Generation

13.8.1 Glob Operators
13.8.2 ksh-like Glob Operators
13.8.3 Precedence
13.8.4 Globbing Flags
13.8.5 Approximate Matching
13.8.6 Recursive Globbing
13.8.7 Glob Qualifiers

14. Parameters

14.1 Description
14.2 Array Parameters

14.2.1 Array Subscripts
14.2.2 Array Element Assignment
14.2.3 Subscript Flags
14.2.4 Subscript Parsing

14.3 Positional Parameters
14.4 Local Parameters
14.5 Parameters Set By The Shell
14.6 Parameters Used By The Shell

15. Options

15.1 Specifying Options
15.2 Description of Options
15.3 Option Aliases
15.4 Single Letter Options

15.4.1 Default set
15.4.2 sh/ksh emulation set
15.4.3 Also note

16. Shell Builtin Commands
17. Zsh Line Editor

17.1 Description
17.2 Keymaps

17.2.1 Reading Commands

17.3 Zle Builtins
17.4 Widgets
17.5 User-Defined Widgets
17.6 Standard Widgets

17.6.1 Movement
17.6.2 History Control
17.6.3 Modifying Text
17.6.4 Arguments
17.6.5 Completion
17.6.6 Miscellaneous

18. Completion Widgets

18.1 Description
18.2 Special Parameters
18.3 Builtin Commands
18.4 Condition Codes
18.5 Matching Control
18.6 Completion Widget Example

19. Completion System

19.1 Description
19.2 Initialization

19.2.1 Use of compinit
19.2.2 Autoloaded files
19.2.3 Functions

19.3 Completion System Configuration

19.3.1 Overview
19.3.2 Standard Tags
19.3.3 Standard Styles

19.4 Control Functions
19.5 Bindable Commands
19.6 Utility Functions
19.7 Completion Directories

20. Completion Using compctl

20.1 Types of completion
20.2 Description
20.3 Command Flags
20.4 Option Flags

20.4.1 Simple Flags
20.4.2 Flags with Arguments
20.4.3 Control Flags

20.5 Alternative Completion
20.6 Extended Completion
20.7 Example

21. Zsh Modules

21.1 Description
21.2 The zsh/cap Module
21.3 The zsh/clone Module
21.4 The zsh/compctl Module
21.5 The zsh/complete Module
21.6 The zsh/complist Module

21.6.1 Colored completion listings
21.6.2 Scrolling in completion listings
21.6.3 Menu selection

21.7 The zsh/computil Module
21.8 The zsh/deltochar Module
21.9 The zsh/example Module
21.10 The zsh/files Module
21.11 The zsh/mapfile Module

21.11.1 Limitations

21.12 The zsh/mathfunc Module
21.13 The zsh/parameter Module
21.14 The zsh/sched Module
21.15 The zsh/stat Module
21.16 The zsh/termcap Module
21.17 The zsh/terminfo Module
21.18 The zsh/zftp Module

21.18.1 Subcommands
21.18.2 Parameters
21.18.3 Functions
21.18.4 Problems

21.19 The zsh/zle Module
21.20 The zsh/zleparameter Module
21.21 The zsh/zprof Module
21.22 The zsh/zpty Module
21.23 The zsh/zutil Module

22. Zftp Function System

22.1 Description
22.2 Installation
22.3 Functions

22.3.1 Opening a connection
22.3.2 Directory management
22.3.3 Status commands
22.3.4 Retrieving files
22.3.5 Sending files
22.3.6 Closing the connection
22.3.7 Session management
22.3.8 Bookmarks
22.3.9 Other functions

22.4 Miscellaneous Features

22.4.1 Configuration
22.4.2 Remote globbing
22.4.3 Automatic and temporary reopening
22.4.4 Completion

23. User Contributions

23.1 Description
23.2 Utilities

23.2.1 Accessing On-Line Help
23.2.2 Recompiling Functions
23.2.3 Keyboard Definition
23.2.4 Dumping Shell State

23.3 Prompt Themes

23.3.1 Installation
23.3.2 Theme Selection

23.4 ZLE Functions

23.4.1 Widgets
23.4.2 Styles

23.5 Other Functions

23.5.1 Descriptions
23.5.2 Styles

Concept Index
Variables Index
Options Index
Functions Index
Editor Functions Index
Style and Tag Index