doomemacs/modules/os/macos/README.org

← [[doom-module-index:][Back to module index]]               ! [[doom-module-issues:::os macos][Issues]]  ↖ [[doom-source:modules/os/macos/][Github]]  ± [[doom-suggest-edit:][Suggest edits]]  ? [[doom-help-modules:][Help]]
--------------------------------------------------------------------------------
#+TITLE:    :os macos
#+SUBTITLE: Compatibility for our favorite walled garden
#+CREATED:  February 19, 2017
#+SINCE:    1.3

* Description :unfold:
This module provides extra functionality for macOS.

** Maintainers
/This module has no dedicated maintainers./ [[doom-contrib-maintainer:][Become a maintainer?]]

** Module flags
/This module has no flags./

** Packages
- [[doom-package:][ns-auto-titlebar]]
- [[doom-package:][osx-trash]]

** Hacks
/No hacks documented for this module./

** TODO Changelog
# This section will be machine generated. Don't edit it by hand.
/This module does not have a changelog yet./

* Installation
[[id:01cffea4-3329-45e2-a892-95a384ab2338][Enable this module in your ~doom!~ block.]]

This module requires a macOS environment.

* TODO Usage
#+begin_quote
 🔨 /This module's usage documentation is incomplete./ [[doom-contrib-module:][Complete it?]]
#+end_quote

** "Open with X"
This module adds various macOS-specific launchers under the [[kbd:][SPC o]] prefix ([[kbd:][C-c
o]] for users with Evil disabled).

It also enables Keychain integration for [[doom-package:][auth-source]]. This is used by our [[doom-module:][:app
irc]] and [[doom-module:][:tools magit]] modules, for instance.

To support GitHub Forge add an internet password like this to your keychain:
| Field    | Value                   |
|----------+-------------------------|
| Name     | api.github.com          |
| Kind     | Internet password       |
| Account  | <username>^forge        |
| Where    | https://api.github.com/ |
| Password | <token>                 |

* TODO Configuration
#+begin_quote
 🔨 This module has no configuration documentation yet. [[doom-contrib-module:][Write some?]]
#+end_quote

* Troubleshooting
/There are no known problems with this module./ [[doom-report:][Report one?]]

* Frequently asked questions
/This module has no FAQs yet./ [[doom-suggest-faq:][Ask one?]]

* TODO Appendix
#+begin_quote
 🔨 This module has no appendix yet. [[doom-contrib-module:][Write one?]]
#+end_quote