This repository has been archived on 2024-10-22. You can view files and clone it, but cannot push or open issues or pull requests.
spacemacs/contrib/osx/README.md
2015-02-17 22:23:16 -05:00

56 lines
1.6 KiB
Markdown

# OSX contribution layer for Spacemacs
![applogo](img/apple.png)![osxlogo](img/osx.png)
<!-- markdown-toc start - Don't edit this section. Run M-x markdown-toc/generate-toc again -->
**Table of Contents**
- [OSX contribution layer for Spacemacs](#osx-contribution-layer-for-spacemacs)
- [Description](#description)
- [Philosophy](#philosophy)
- [Install](#install)
- [Key Bindings](#key-bindings)
- [Future Work](#future-work)
<!-- markdown-toc end -->
## Description
Spacemacs is not just emacs+vim. It can have OSX keybindings too!
This layer globally defines common OSX keybindings. ⌘ is set to
`super` and ⌥ is set to `meta`. Aside from that, there's nothing
much, really.
## Philosophy
While this layer enables common OSX bindings, it does not implement
OSX navigation keybindings. Spacemacs is meant to be used with evil,
and we encourage you to do so :)
## Install
To use this configuration layer, add it to your `~/.spacemacs`
```elisp
(setq-default dotspacemacs-configuration-layers '(osx)
;; List of contribution to load.
)
```
## Key Bindings
Key Binding | Description
------------------|------------------------------------------------------------
<kbd>⌘ q</kbd> | Quit
<kbd>⌘ v</kbd> | Paste
<kbd>⌘ c</kbd> | Copy
<kbd>⌘ x</kbd> | Cut
<kbd>⌘ w</kbd> | Close window
<kbd>⌘ z</kbd> | Undo
<kbd>⌘ Z</kbd> | Redo
<kbd>⌃ ⌘ f</kbd> | Toggle fullscreen
## Future Work
- Allow user to choose from either `hyper` or `super` as ⌘. This is an option that is supported cross-platform.
- Configurable option to keep the OSX and spacemacs clipboards separate