[
Top
]
[
Contents
]
[
Index
]
[
?
]
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 Roadmap
3.1 When the shell starts
3.2 Interactive Use
3.2.1 Completion
3.2.2 Extending the line editor
3.3 Options
3.4 Pattern Matching
3.5 General Comments on Syntax
3.6 Programming
4 Invocation
4.1 Invocation
4.2 Compatibility
4.3 Restricted Shell
5 Files
5.1 Startup/Shutdown Files
5.2 Files
6 Shell Grammar
6.1 Simple Commands & Pipelines
6.2 Precommand Modifiers
6.3 Complex Commands
6.4 Alternate Forms For Complex Commands
6.5 Reserved Words
6.6 Errors
6.7 Comments
6.8 Aliasing
6.8.1 Alias difficulties
6.9 Quoting
7 Redirection
7.1 Opening file descriptors using parameters
7.2 Multios
7.3 Redirections with no command
8 Command Execution
9 Functions
9.1 Autoloading Functions
9.2 Anonymous Functions
9.3 Special Functions
9.3.1 Hook Functions
9.3.2 Trap Functions
10 Jobs & Signals
10.1 Jobs
10.2 Signals
11 Arithmetic Evaluation
12 Conditional Expressions
13 Prompt Expansion
13.1 Expansion of Prompt Sequences
13.2 Simple Prompt Escapes
13.2.1 Special characters
13.2.2 Login information
13.2.3 Shell state
13.2.4 Date and time
13.2.5 Visual effects
13.3 Conditional Substrings in Prompts
14 Expansion
14.1 History Expansion
14.1.1 Overview
14.1.2 Event Designators
14.1.3 Word Designators
14.1.4 Modifiers
14.2 Process Substitution
14.3 Parameter Expansion
14.3.1 Parameter Expansion Flags
14.3.2 Rules
14.3.3 Examples
14.4 Command Substitution
14.5 Arithmetic Expansion
14.6 Brace Expansion
14.7 Filename Expansion
14.7.1 Dynamic named directories
14.7.2 Static named directories
14.7.3 ‘=’ expansion
14.7.4 Notes
14.8 Filename Generation
14.8.1 Glob Operators
14.8.2 ksh-like Glob Operators
14.8.3 Precedence
14.8.4 Globbing Flags
14.8.5 Approximate Matching
14.8.6 Recursive Globbing
14.8.7 Glob Qualifiers
15 Parameters
15.1 Description
15.2 Array Parameters
15.2.1 Array Subscripts
15.2.2 Array Element Assignment
15.2.3 Subscript Flags
15.2.4 Subscript Parsing
15.3 Positional Parameters
15.4 Local Parameters
15.5 Parameters Set By The Shell
15.6 Parameters Used By The Shell
16 Options
16.1 Specifying Options
16.2 Description of Options
16.2.1 Changing Directories
16.2.2 Completion
16.2.3 Expansion and Globbing
16.2.4 History
16.2.5 Initialisation
16.2.6 Input/Output
16.2.7 Job Control
16.2.8 Prompting
16.2.9 Scripts and Functions
16.2.10 Shell Emulation
16.2.11 Shell State
16.2.12 Zle
16.3 Option Aliases
16.4 Single Letter Options
16.4.1 Default set
16.4.2 sh/ksh emulation set
16.4.3 Also note
17 Shell Builtin Commands
18 Zsh Line Editor
18.1 Description
18.2 Keymaps
18.2.1 Reading Commands
18.2.2 Local Keymaps
18.3 Zle Builtins
18.4 Widgets
18.5 User-Defined Widgets
18.5.1 Special Widgets
18.6 Standard Widgets
18.6.1 Movement
18.6.2 History Control
18.6.3 Modifying Text
18.6.4 Arguments
18.6.5 Completion
18.6.6 Miscellaneous
18.6.7 Text Objects
18.7 Character Highlighting
19 Completion Widgets
19.1 Description
19.2 Completion Special Parameters
19.3 Completion Builtin Commands
19.4 Completion Condition Codes
19.5 Completion Matching Control
19.6 Completion Widget Example
20 Completion System
20.1 Description
20.2 Initialization
20.2.1 Use of compinit
20.2.2 Autoloaded files
20.2.3 Functions
20.3 Completion System Configuration
20.3.1 Overview
20.3.2 Standard Tags
20.3.3 Standard Styles
20.4 Control Functions
20.5 Bindable Commands
20.6 Utility Functions
20.7 Completion System Variables
20.8 Completion Directories
21 Completion Using compctl
21.1 Types of completion
21.2 Description
21.3 Command Flags
21.4 Option Flags
21.4.1 Simple Flags
21.4.2 Flags with Arguments
21.4.3 Control Flags
21.5 Alternative Completion
21.6 Extended Completion
21.7 Example
22 Zsh Modules
22.1 Description
22.2 The zsh/attr Module
22.3 The zsh/cap Module
22.4 The zsh/clone Module
22.5 The zsh/compctl Module
22.6 The zsh/complete Module
22.7 The zsh/complist Module
22.7.1 Colored completion listings
22.7.2 Scrolling in completion listings
22.7.3 Menu selection
22.8 The zsh/computil Module
22.9 The zsh/curses Module
22.9.1 Builtin
22.9.2 Parameters
22.10 The zsh/datetime Module
22.11 The zsh/db/gdbm Module
22.12 The zsh/deltochar Module
22.13 The zsh/example Module
22.14 The zsh/files Module
22.15 The zsh/langinfo Module
22.16 The zsh/mapfile Module
22.16.1 Limitations
22.17 The zsh/mathfunc Module
22.18 The zsh/newuser Module
22.19 The zsh/parameter Module
22.20 The zsh/pcre Module
22.21 The zsh/param/private Module
22.22 The zsh/regex Module
22.23 The zsh/sched Module
22.24 The zsh/net/socket Module
22.24.1 Outbound Connections
22.24.2 Inbound Connections
22.25 The zsh/stat Module
22.26 The zsh/system Module
22.26.1 Builtins
22.26.2 Math Functions
22.26.3 Parameters
22.27 The zsh/net/tcp Module
22.27.1 Outbound Connections
22.27.2 Inbound Connections
22.27.3 Closing Connections
22.27.4 Example
22.28 The zsh/termcap Module
22.29 The zsh/terminfo Module
22.30 The zsh/zftp Module
22.30.1 Subcommands
22.30.2 Parameters
22.30.3 Functions
22.30.4 Problems
22.31 The zsh/zle Module
22.32 The zsh/zleparameter Module
22.33 The zsh/zprof Module
22.34 The zsh/zpty Module
22.35 The zsh/zselect Module
22.36 The zsh/zutil Module
23 Calendar Function System
23.1 Description
23.2 File and Date Formats
23.2.1 Calendar File Format
23.2.2 Date Format
23.2.3 Relative Time Format
23.2.4 Example
23.3 User Functions
23.3.1 Calendar system functions
23.3.2 Glob qualifiers
23.4 Styles
23.5 Utility functions
23.6 Bugs
24 TCP Function System
24.1 Description
24.2 TCP User Functions
24.2.1 Basic I/O
24.2.2 Session Management
24.2.3 Advanced I/O
24.2.4 ‘One-shot’ file transfer
24.3 TCP User-defined Functions
24.4 TCP Utility Functions
24.5 TCP User Parameters
24.6 TCP User-defined Parameters
24.7 TCP Utility Parameters
24.8 TCP Examples
24.9 TCP Bugs
25 Zftp Function System
25.1 Description
25.2 Installation
25.3 Functions
25.3.1 Opening a connection
25.3.2 Directory management
25.3.3 Status commands
25.3.4 Retrieving files
25.3.5 Sending files
25.3.6 Closing the connection
25.3.7 Session management
25.3.8 Bookmarks
25.3.9 Other functions
25.4 Miscellaneous Features
25.4.1 Configuration
25.4.2 Remote globbing
25.4.3 Automatic and temporary reopening
25.4.4 Completion
26 User Contributions
26.1 Description
26.2 Utilities
26.2.1 Accessing On-Line Help
26.2.2 Recompiling Functions
26.2.3 Keyboard Definition
26.2.4 Dumping Shell State
26.2.5 Manipulating Hook Functions
26.3 Remembering Recent Directories
26.3.1 Installation
26.3.2 Use
26.3.3 Options
26.3.4 Configuration
26.3.5 Use with dynamic directory naming
26.3.6 Details of directory handling
26.4 Abbreviated dynamic references to directories
26.4.1 Usage
26.4.2 Configuration
26.4.3 Complete example
26.5 Gathering information from version control systems
26.5.1 Quickstart
26.5.2 Configuration
26.5.3 Oddities
26.5.4 Quilt Support
26.5.5 Function Descriptions (Public API)
26.5.6 Variable Description
26.5.7 Hooks in vcs_info
26.5.8 Examples
26.6 Prompt Themes
26.6.1 Installation
26.6.2 Theme Selection
26.6.3 Utility Themes
26.6.4 Writing Themes
26.7 ZLE Functions
26.7.1 Widgets
26.7.2 Utility Functions
26.7.3 Styles
26.8 Exception Handling
26.9 MIME Functions
26.10 Mathematical Functions
26.11 User Configuration Functions
26.12 Other Functions
26.12.1 Descriptions
26.12.2 Styles
Concept Index
Variables Index
Options Index
Functions Index
Editor Functions Index
Style and Tag Index
[
Top
]
[
Contents
]
[
Index
]
[
?
]
This document was generated on
September 8, 2018
using
texi2any
.
Zsh version 5.6.1, released on September 8, 2018.