Table of Contents

  1. Introduction
    1. Author
    2. Availability
    3. Mailing Lists
    4. The Zsh FAQ
    5. The Zsh Web Page
    6. See Also
  2. Roadmap
    1. When the shell starts
    2. Interactive Use
      1. Completion
      2. Extending the line editor
    3. Options
    4. Pattern Matching
    5. General Comments on Syntax
    6. Programming
  3. Invocation
    1. Invocation
    2. Compatibility
    3. Restricted Shell
  4. Files
    1. Startup/Shutdown Files
    2. Files
  5. Shell Grammar
    1. Simple Commands & Pipelines
    2. Precommand Modifiers
    3. Complex Commands
    4. Alternate Forms For Complex Commands
    5. Reserved Words
    6. Errors
    7. Comments
    8. Aliasing
      1. Alias difficulties
    9. Quoting
  6. Redirection
    1. Opening file descriptors using parameters
    2. Multios
    3. Redirections with no command
  7. Functions
    1. Command Execution
    2. Autoloading Functions
    3. Anonymous Functions
    4. Special Functions
      1. Hook Functions
      2. Trap Functions
  8. Jobs & Signals
    1. Jobs
    2. Signals
  9. Arithmetic Evaluation
  10. Conditional Expressions
  11. Prompt Expansion
    1. Expansion of Prompt Sequences
    2. Simple Prompt Escapes
      1. Special characters
      2. Login information
      3. Shell state
      4. Date and time
      5. Visual effects
    3. Conditional Substrings in Prompts
  12. Expansion
    1. History Expansion
      1. Overview
      2. Event Designators
      3. Word Designators
      4. Modifiers
    2. Process Substitution
    3. Parameter Expansion
      1. Parameter Expansion Flags
      2. Rules
      3. Examples
    4. Command Substitution
    5. Arithmetic Expansion
    6. Brace Expansion
    7. Filename Expansion
      1. Dynamic named directories
      2. Static named directories
      3. '=' expansion
      4. Notes
    8. Filename Generation
      1. Glob Operators
      2. ksh-like Glob Operators
      3. Precedence
      4. Globbing Flags
      5. Approximate Matching
      6. Recursive Globbing
      7. Glob Qualifiers
  13. Parameters
    1. Description
    2. Array Parameters
      1. Array Subscripts
      2. Array Element Assignment
      3. Subscript Flags
      4. Subscript Parsing
    3. Positional Parameters
    4. Local Parameters
    5. Parameters Set By The Shell
    6. Parameters Used By The Shell
  14. Options
    1. Specifying Options
    2. Description of Options
      1. Changing Directories
      2. Completion
      3. Expansion and Globbing
      4. History
      5. Initialisation
      6. Input/Output
      7. Job Control
      8. Prompting
      9. Scripts and Functions
      10. Shell Emulation
      11. Shell State
      12. Zle
    3. Option Aliases
    4. Single Letter Options
      1. Default set
      2. sh/ksh emulation set
      3. Also note
  15. Shell Builtin Commands
  16. Zsh Line Editor
    1. Description
    2. Keymaps
      1. Reading Commands
      2. Local Keymaps
    3. Zle Builtins
    4. Widgets
    5. User-Defined Widgets
      1. Special Widgets
    6. Standard Widgets
      1. Movement
      2. History Control
      3. Modifying Text
      4. Arguments
      5. Completion
      6. Miscellaneous
      7. Text Objects
    7. Character Highlighting
  17. Completion Widgets
    1. Description
    2. Completion Special Parameters
    3. Completion Builtin Commands
    4. Completion Condition Codes
    5. Completion Matching Control
    6. Completion Widget Example
  18. Completion System
    1. Description
    2. Initialization
      1. Use of compinit
      2. Autoloaded files
      3. Functions
    3. Completion System Configuration
      1. Overview
      2. Standard Tags
      3. Standard Styles
    4. Control Functions
    5. Bindable Commands
    6. Utility Functions
    7. Completion System Variables
    8. Completion Directories
  19. Completion Using compctl
    1. Types of completion
    2. Description
    3. Command Flags
    4. Option Flags
      1. Simple Flags
      2. Flags with Arguments
      3. Control Flags
    5. Alternative Completion
    6. Extended Completion
    7. Example
  20. Zsh Modules
    1. Description
    2. The zsh/attr Module
    3. The zsh/cap Module
    4. The zsh/clone Module
    5. The zsh/compctl Module
    6. The zsh/complete Module
    7. The zsh/complist Module
      1. Colored completion listings
      2. Scrolling in completion listings
      3. Menu selection
    8. The zsh/computil Module
    9. The zsh/curses Module
      1. Builtin
      2. Parameters
    10. The zsh/datetime Module
    11. The zsh/db/gdbm Module
    12. The zsh/deltochar Module
    13. The zsh/example Module
    14. The zsh/files Module
    15. The zsh/langinfo Module
    16. The zsh/mapfile Module
      1. Limitations
    17. The zsh/mathfunc Module
    18. The zsh/nearcolor Module
    19. The zsh/newuser Module
    20. The zsh/parameter Module
    21. The zsh/pcre Module
    22. The zsh/param/private Module
    23. The zsh/regex Module
    24. The zsh/sched Module
    25. The zsh/net/socket Module
      1. Outbound Connections
      2. Inbound Connections
    26. The zsh/stat Module
    27. The zsh/system Module
      1. Builtins
      2. Math Functions
      3. Parameters
    28. The zsh/net/tcp Module
      1. Outbound Connections
      2. Inbound Connections
      3. Closing Connections
      4. Example
    29. The zsh/termcap Module
    30. The zsh/terminfo Module
    31. The zsh/zftp Module
      1. Subcommands
      2. Parameters
      3. Functions
      4. Problems
    32. The zsh/zle Module
    33. The zsh/zleparameter Module
    34. The zsh/zprof Module
    35. The zsh/zpty Module
    36. The zsh/zselect Module
    37. The zsh/zutil Module
  21. Calendar Function System
    1. Description
    2. File and Date Formats
      1. Calendar File Format
      2. Date Format
      3. Relative Time Format
      4. Example
    3. User Functions
      1. Calendar system functions
      2. Glob qualifiers
    4. Styles
    5. Utility functions
    6. Bugs
  22. TCP Function System
    1. Description
    2. TCP User Functions
      1. Basic I/O
      2. Session Management
      3. Advanced I/O
      4. 'One-shot' file transfer
    3. TCP User-defined Functions
    4. TCP Utility Functions
    5. TCP User Parameters
    6. TCP User-defined Parameters
    7. TCP Utility Parameters
    8. TCP Examples
    9. TCP Bugs
  23. Zftp Function System
    1. Description
    2. Installation
    3. Functions
      1. Opening a connection
      2. Directory management
      3. Status commands
      4. Retrieving files
      5. Sending files
      6. Closing the connection
      7. Session management
      8. Bookmarks
      9. Other functions
    4. Miscellaneous Features
      1. Configuration
      2. Remote globbing
      3. Automatic and temporary reopening
      4. Completion
  24. User Contributions
    1. Description
    2. Utilities
      1. Accessing On-Line Help
      2. Recompiling Functions
      3. Keyboard Definition
      4. Dumping Shell State
      5. Manipulating Hook Functions
    3. Remembering Recent Directories
      1. Installation
      2. Use
      3. Options
      4. Configuration
      5. Use with dynamic directory naming
      6. Details of directory handling
    4. Abbreviated dynamic references to directories
      1. Usage
      2. Configuration
      3. Complete example
    5. Gathering information from version control systems
      1. Quickstart
      2. Configuration
      3. Oddities
      4. Quilt Support
      5. Function Descriptions (Public API)
      6. Variable Description
      7. Hooks in vcs_info
      8. Examples
    6. Prompt Themes
      1. Installation
      2. Theme Selection
      3. Utility Themes
      4. Writing Themes
    7. ZLE Functions
      1. Widgets
      2. Utility Functions
      3. Styles
    8. Exception Handling
    9. MIME Functions
    10. Mathematical Functions
    11. User Configuration Functions
    12. Other Functions
      1. Descriptions
      2. Styles