Mercurial > vim
annotate runtime/doc/os_mac.txt @ 30719:71137f73c94d v9.0.0694
patch 9.0.0694: no native sound support on Mac OS
Commit: https://github.com/vim/vim/commit/4314e4f7da4db5d85f63cdf43b73be3689502c93
Author: Yee Cheng Chin <ychin.git@gmail.com>
Date: Sat Oct 8 13:50:05 2022 +0100
patch 9.0.0694: no native sound support on Mac OS
Problem: No native sound support on Mac OS.
Solution: Add sound support for Mac OS. (Yee Cheng Chin, closes https://github.com/vim/vim/issues/11274)
| author | Bram Moolenaar <Bram@vim.org> |
|---|---|
| date | Sat, 08 Oct 2022 15:00:05 +0200 |
| parents | f8116058ca76 |
| children | 4635e43f2c6f |
| rev | line source |
|---|---|
| 29314 | 1 *os_mac.txt* For Vim version 9.0. Last change: 2019 Apr 21 |
| 7 | 2 |
| 3 | |
| 4 VIM REFERENCE MANUAL by Bram Moolenaar et al. | |
| 5 | |
| 6 | |
| 7 *mac* *Mac* *macintosh* *Macintosh* | |
| 8 | |
| 9 This file documents the particularities of the Macintosh version of Vim. | |
| 10 | |
| 11 NOTE: This file is a bit outdated. You might find more useful info here: | |
| 19 | 12 http://macvim.org/ |
| 7 | 13 |
| 14 1. Filename Convention |mac-filename| | |
| 11262 | 15 2. .vimrc and .vim files |mac-vimfile| |
| 16 3. Standard mappings |mac-standard-mappings| | |
| 17 4. FAQ |mac-faq| | |
| 18 5. Known Lack |mac-lack| | |
| 19 6. Mac Bug Report |mac-bug| | |
| 20 7. Compiling Vim |mac-compile| | |
| 11407 | 21 8. The darwin feature |mac-darwin-feature| |
| 7 | 22 |
| 23 There was a Mac port for version 3.0 of Vim. Here are the first few lines | |
| 24 from the old file: | |
| 25 | |
| 26 VIM Release Notes | |
| 27 Initial Macintosh release, VIM version 3.0 | |
| 28 19 October 1994 | |
| 29 | |
| 30 Eric Fischer | |
| 31 <enf1@midway.uchicago.edu>, <eric@jcp.uchicago.edu>, <etaoin@uchicago.edu> | |
| 32 5759 N. Guilford Ave | |
| 33 Indianapolis IN 46220 USA | |
| 34 | |
| 35 ============================================================================== | |
| 36 1. Filename Convention *mac-filename* | |
| 37 | |
| 719 | 38 Starting with Vim version 7 you can just use the unix path separators with |
| 39 Vim. In order to determine if the specified filename is relative to the | |
| 40 current folder or absolute (i.e. relative to the "Desktop"), the following | |
| 41 algorithm is used: | |
| 7 | 42 |
| 43 If the path start by a "/", the path is absolute | |
| 44 If the path start by a ":", the path is relative | |
| 45 If the path doesn't start by neither a "/" nor ":", | |
| 46 and a ":" is found before a "/" then the path is absolute | |
| 47 > | |
| 48 :e /HD/text | |
| 49 :e HD:text | |
| 50 < Edit the file "text" of the disk "HD" > | |
| 51 :e :src:main.c | |
| 52 :e src/main.c | |
| 53 < Edit the file "main.c" in the folder "src" in the current folder > | |
| 54 :e os_mac.c | |
| 55 < Edit the file "os_mac.c" in the current folder. | |
| 56 | |
| 57 You can use the |$VIM| and |$VIMRUNTIME| variable. > | |
| 58 | |
| 59 :so $VIMRUNTIME:syntax:syntax.vim | |
| 60 | |
| 61 ============================================================================== | |
| 62 2. .vimrc and .vim files *mac-vimfile* | |
| 63 | |
| 719 | 64 It is recommended to use Unix style line separators for Vim scripts, thus a |
| 65 single newline character. | |
| 66 | |
| 67 When starting up Vim will load the $VIMRUNTIME/macmap.vim script to define | |
| 68 default command-key mappings. | |
| 69 | |
| 70 On older systems files starting with a dot "." are discouraged, thus the rc | |
| 71 files are named "vimrc" or "_vimrc" and "gvimrc" or "_gvimrc". These files | |
| 72 can be in any format (mac, dos or unix). Vim can handle any file format when | |
| 73 the |'nocompatible'| option is set, otherwise it will only handle mac format | |
| 7 | 74 files. |
| 75 | |
| 76 ============================================================================== | |
| 11262 | 77 3. Standard mappings *mac-standard-mappings* |
| 78 | |
| 79 The following mappings are available for cut/copy/paste from/to clipboard. | |
| 80 | |
| 81 key Normal Visual Insert Description ~ | |
| 82 Command-v "*P "-d"*P <C-R>* paste text *<D-v>* | |
| 83 Command-c "*y copy Visual text *<D-c>* | |
| 84 Command-x "*d cut Visual text *<D-x>* | |
| 85 Backspace "*d cut Visual text | |
| 86 | |
| 87 ============================================================================== | |
| 88 4. Mac FAQ *mac-faq* | |
| 7 | 89 |
| 810 | 90 On the internet: http://macvim.org/OSX/index.php#FAQ |
| 91 | |
| 7 | 92 Q: I can't enter non-ASCII character in Apple Terminal. |
| 93 A: Under Window Settings, Emulation, make sure that "Escape non-ASCII | |
| 94 characters" is not checked. | |
| 95 | |
| 39 | 96 Q: How do I start the GUI from the command line? |
| 97 A: Assuming that Vim.app is located in /Applications: | |
| 98 open /Applications/Vim.app | |
| 99 Or: | |
| 856 | 100 /Applications/Vim.app/Contents/MacOS/Vim -g {arguments} |
| 39 | 101 |
| 818 | 102 Q: How can I set $PATH to something reasonable when I start Vim.app from the |
| 103 GUI or with open? | |
| 104 A: The following trick works with most shells. Put it in your vimrc file. | |
| 105 This is included in the system vimrc file included with the binaries | |
| 106 distributed at macvim.org . > | |
| 107 let s:path = system("echo echo VIMPATH'${PATH}' | $SHELL -l") | |
| 108 let $PATH = matchstr(s:path, 'VIMPATH\zs.\{-}\ze\n') | |
| 109 | |
| 7 | 110 ============================================================================== |
| 11262 | 111 5. Mac Lack *mac-lack* |
| 7 | 112 |
| 9 | 113 In a terminal CTRL-^ needs to be entered as Shift-Control-6. CTRL-@ as |
| 114 Shift-Control-2. | |
| 7 | 115 |
| 116 ============================================================================== | |
| 11262 | 117 6. Mac Bug Report *mac-bug* |
| 7 | 118 |
| 119 When reporting any Mac specific bug or feature change, please use the vim-mac | |
| 120 maillist |vim-mac|. However, you need to be subscribed. An alternative is to | |
| 121 send a message to the current MacVim maintainers: | |
| 122 | |
| 123 mac@vim.org | |
| 124 | |
| 125 ============================================================================== | |
| 11262 | 126 7. Compiling Vim *mac-compile* |
| 7 | 127 |
| 128 See the file "src/INSTALLmac.txt" that comes with the source files. | |
| 129 | |
| 11407 | 130 ============================================================================== |
| 131 8. The Darwin Feature *mac-darwin-feature* | |
| 132 | |
| 133 If you have a Mac that isn't very old, you will be running OS X, also called | |
| 134 Darwin. The last pre-Darwin OS was Mac OS 9. The darwin feature makes Vim | |
| 135 use Darwin-specific properties. | |
| 136 | |
| 137 What is accomplished with this feature is two-fold: | |
| 138 | |
| 139 - Make Vim interoperable with the system clipboard. | |
| 140 - Incorporate into Vim a converter module that bridges the gap between some | |
| 141 character encodings specific to the platform and those known to Vim. | |
| 142 | |
| 143 Needless to say, both are not to be missed for any decent text editor to work | |
| 144 nicely with other applications running on the same desktop environment. | |
| 145 | |
| 146 As Vim is not an application dedicated only to macOS, we need an extra feature | |
| 147 to add in order for it to offer the same user experience that our users on | |
| 148 other platforms enjoy to people on macOS. | |
| 149 | |
| 150 For brevity, the feature is referred to as "darwin" to signify it one of the | |
| 151 Vim features that are specific to that particular platform. | |
| 152 | |
| 153 The feature is a configuration option. Accordingly, whether it is enabled or | |
| 154 not is determined at build time; once it is selected to be enabled, it is | |
| 155 compiled in and hence cannot be disabled at runtime. | |
| 156 | |
| 157 The feature is enabled by default. For most macOS users, that should be | |
| 158 sufficient unless they have specific needs mentioned briefly below. | |
| 159 | |
| 160 If you want to disable it, pass `--disable-darwin` to the configure script: > | |
| 161 | |
| 162 ./configure --disable-darwin <other options> | |
| 163 | |
| 164 and then run `make` to build Vim. The order of the options doesn't matter. | |
| 165 | |
| 166 To make sure at runtime whether or not the darwin feature is compiled in, you | |
|
12716
351cf7c67bbe
patch 8.0.1236: Mac features are confusing
Christian Brabandt <cb@256bit.org>
parents:
11407
diff
changeset
|
167 can use `has('osxdarwin')` which returns 1 if the feature is compiled in; 0 |
| 13125 | 168 otherwise. For backward compatibility, you can still use `macunix` instead of |
|
12716
351cf7c67bbe
patch 8.0.1236: Mac features are confusing
Christian Brabandt <cb@256bit.org>
parents:
11407
diff
changeset
|
169 `osxdarwin`. |
| 11407 | 170 |
| 171 Notable use cases where `--disable-darwin` is turned out to be useful are: | |
| 172 | |
| 173 - When you want to use |x11-selection| instead of the system clipboard. | |
| 174 - When you want to use |x11-clientserver|. | |
| 175 | |
| 176 Since both have to make use of X11 inter-client communication for them to work | |
| 177 properly, and since the communication mechanism can come into conflict with | |
| 178 the system clipboard, the darwin feature should be disabled to prevent Vim | |
| 179 from hanging at runtime. | |
| 180 | |
| 7 | 181 |
| 14421 | 182 vim:tw=78:ts=8:noet:ft=help:norl: |