From 9f11c81dbe14b0b246d04d344cf4307ef9d59c7e Mon Sep 17 00:00:00 2001 From: danielbayley Date: Thu, 2 Jun 2022 15:21:58 +0100 Subject: [PATCH] Document `zsh_function` --- docs/Formula-Cookbook.md | 43 ++++++++++++++++++++++------------------ 1 file changed, 24 insertions(+), 19 deletions(-) diff --git a/docs/Formula-Cookbook.md b/docs/Formula-Cookbook.md index 08395d85c2..e416be18c1 100644 --- a/docs/Formula-Cookbook.md +++ b/docs/Formula-Cookbook.md @@ -661,25 +661,30 @@ Generally we'd rather you were specific about what files or directories need to #### Variables for directory locations -| Name | Default | Example | -|-----------------------|------------------------------------------------|---------------------------------------------------| -| **`HOMEBREW_PREFIX`** | `/usr/local` | | -| **`prefix`** | `#{HOMEBREW_PREFIX}/Cellar/#{name}/#{version}` | `/usr/local/Cellar/foo/0.1` | -| **`opt_prefix`** | `#{HOMEBREW_PREFIX}/opt/#{name}` | `/usr/local/opt/foo` | -| **`bin`** | `#{prefix}/bin` | `/usr/local/Cellar/foo/0.1/bin` | -| **`doc`** | `#{prefix}/share/doc/foo` | `/usr/local/Cellar/foo/0.1/share/doc/foo` | -| **`include`** | `#{prefix}/include` | `/usr/local/Cellar/foo/0.1/include` | -| **`info`** | `#{prefix}/share/info` | `/usr/local/Cellar/foo/0.1/share/info` | -| **`lib`** | `#{prefix}/lib` | `/usr/local/Cellar/foo/0.1/lib` | -| **`libexec`** | `#{prefix}/libexec` | `/usr/local/Cellar/foo/0.1/libexec` | -| **`man`** | `#{prefix}/share/man` | `/usr/local/Cellar/foo/0.1/share/man` | -| **`man[1-8]`** | `#{prefix}/share/man/man[1-8]` | `/usr/local/Cellar/foo/0.1/share/man/man[1-8]` | -| **`sbin`** | `#{prefix}/sbin` | `/usr/local/Cellar/foo/0.1/sbin` | -| **`share`** | `#{prefix}/share` | `/usr/local/Cellar/foo/0.1/share` | -| **`pkgshare`** | `#{prefix}/share/foo` | `/usr/local/Cellar/foo/0.1/share/foo` | -| **`etc`** | `#{HOMEBREW_PREFIX}/etc` | `/usr/local/etc` | -| **`var`** | `#{HOMEBREW_PREFIX}/var` | `/usr/local/var` | -| **`buildpath`** | A temporary directory somewhere on your system | `/private/tmp/[formula-name]-0q2b/[formula-name]` | +| Name | Default | Example | +|-----------------------|------------------------------------------------|-------------------------------------------------------------| +| **`HOMEBREW_PREFIX`** | `/usr/local` | | +| **`prefix`** | `#{HOMEBREW_PREFIX}/Cellar/#{name}/#{version}` | `/usr/local/Cellar/foo/0.1` | +| **`opt_prefix`** | `#{HOMEBREW_PREFIX}/opt/#{name}` | `/usr/local/opt/foo` | +| **`bin`** | `#{prefix}/bin` | `/usr/local/Cellar/foo/0.1/bin` | +| **`doc`** | `#{prefix}/share/doc/foo` | `/usr/local/Cellar/foo/0.1/share/doc/foo` | +| **`include`** | `#{prefix}/include` | `/usr/local/Cellar/foo/0.1/include` | +| **`info`** | `#{prefix}/share/info` | `/usr/local/Cellar/foo/0.1/share/info` | +| **`lib`** | `#{prefix}/lib` | `/usr/local/Cellar/foo/0.1/lib` | +| **`libexec`** | `#{prefix}/libexec` | `/usr/local/Cellar/foo/0.1/libexec` | +| **`man`** | `#{prefix}/share/man` | `/usr/local/Cellar/foo/0.1/share/man` | +| **`man[1-8]`** | `#{prefix}/share/man/man[1-8]` | `/usr/local/Cellar/foo/0.1/share/man/man[1-8]` | +| **`sbin`** | `#{prefix}/sbin` | `/usr/local/Cellar/foo/0.1/sbin` | +| **`share`** | `#{prefix}/share` | `/usr/local/Cellar/foo/0.1/share` | +| **`pkgshare`** | `#{prefix}/share/foo` | `/usr/local/Cellar/foo/0.1/share/foo` | +| **`zsh_function`** | `#{prefix}/share/zsh/site-functions` | `/usr/local/Cellar/foo/0.1/share/zsh/site-functions` | +| **`fish_function`** | `#{prefix}/share/fish/vendor_functions` | `/usr/local/Cellar/foo/0.1/share/fish/vendor_functions` | +| **`bash_completion`** | `#{prefix}/etc/bash_completion.d` | `/usr/local/Cellar/foo/0.1/etc/bash_completion.d` | +| **`zsh_completion`** | `#{prefix}/share/zsh/site-functions` | `/usr/local/Cellar/foo/0.1/share/zsh/site-functions` | +| **`zsh_completion`** | `#{prefix}/share/fish/vendor_completions.d` | `/usr/local/Cellar/foo/0.1/share/fish/vendor_completions.d` | +| **`etc`** | `#{HOMEBREW_PREFIX}/etc` | `/usr/local/etc` | +| **`var`** | `#{HOMEBREW_PREFIX}/var` | `/usr/local/var` | +| **`buildpath`** | A temporary directory somewhere on your system | `/private/tmp/[formula-name]-0q2b/[formula-name]` | These can be used, for instance, in code such as