docs(:os): update READMEs to new format
This commit is contained in:
parent
20cac97c08
commit
f6335befb4
3 changed files with 118 additions and 67 deletions
9
modules/os/README.org
Normal file
9
modules/os/README.org
Normal file
|
@ -0,0 +1,9 @@
|
||||||
|
← [[doom-module-index:][Back to module index]] ↖ [[doom-module-source:os][Source]] ± [[doom-suggest-edit:][Suggest edits]] ? [[doom-help-modules:][Help]]
|
||||||
|
--------------------------------------------------------------------------------
|
||||||
|
#+TITLE: :os
|
||||||
|
#+CREATED: November 03, 2021
|
||||||
|
#+SINCE: 21.12.0
|
||||||
|
|
||||||
|
* Description
|
||||||
|
Modules in this category are designed to improve compatibility with certain
|
||||||
|
operating systems or OS features (like the shell).
|
|
@ -1,36 +1,46 @@
|
||||||
#+TITLE: os/macos
|
← [[doom-module-index:][Back to module index]] ↙ [[doom-module-issues:::os macos][Issues]] ↖ [[doom-module-source:os/macos][Source]] ± [[doom-suggest-edit:][Suggest edits]] ? [[doom-help-modules:][Help]]
|
||||||
#+DATE: February 19, 2017
|
--------------------------------------------------------------------------------
|
||||||
#+SINCE: v1.3
|
#+TITLE: :os macos
|
||||||
#+STARTUP: inlineimages nofold
|
#+SUBTITLE: Compatibility for our favorite walled garden
|
||||||
|
#+CREATED: February 19, 2017
|
||||||
|
#+SINCE: 1.3
|
||||||
|
|
||||||
* Table of Contents :TOC_3:noexport:
|
* Description :unfold:
|
||||||
- [[#description][Description]]
|
|
||||||
- [[#module-flags][Module Flags]]
|
|
||||||
- [[#maintainers][Maintainers]]
|
|
||||||
- [[#plugins][Plugins]]
|
|
||||||
- [[#features][Features]]
|
|
||||||
- [[#open-with-x]["Open with X"]]
|
|
||||||
|
|
||||||
* Description
|
|
||||||
This module provides extra functionality for macOS.
|
This module provides extra functionality for macOS.
|
||||||
|
|
||||||
** Module Flags
|
|
||||||
This module provides no flags.
|
|
||||||
|
|
||||||
** Maintainers
|
** Maintainers
|
||||||
This module has no dedicated maintainers
|
/This module has no dedicated maintainers./ [[doom-contrib-maintainer:][Become a maintainer?]]
|
||||||
|
|
||||||
** Plugins
|
** Module flags
|
||||||
+ [[https://github.com/emacsorphanage/osx-trash][osx-trash]]
|
/This module has no flags./
|
||||||
+ [[https://github.com/purcell/ns-auto-titlebar][ns-auto-titlebar]]
|
|
||||||
|
** 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
|
||||||
|
|
||||||
* Features
|
|
||||||
** "Open with X"
|
** "Open with X"
|
||||||
This module adds various macOS-specific launchers under the =SPC o= prefix (=C-c
|
This module adds various macOS-specific launchers under the [[kbd:][SPC o]] prefix ([[kbd:][C-c
|
||||||
o= for users with Evil disabled).
|
o]] for users with Evil disabled).
|
||||||
|
|
||||||
It also enables Keychain integration for =auth-source=. This is used by our [[file:../../../modules/app/irc/README.org][irc]]
|
It also enables Keychain integration for [[doom-package:][auth-source]]. This is used by our [[doom-module:][:app
|
||||||
and [[file:../../../modules/tools/magit/README.org][magit]]-forge modules, for instance.
|
irc]] and [[doom-module:][:tools magit]] modules, for instance.
|
||||||
|
|
||||||
To support GitHub Forge add an internet password like this to your keychain:
|
To support GitHub Forge add an internet password like this to your keychain:
|
||||||
| Field | Value |
|
| Field | Value |
|
||||||
|
@ -40,3 +50,19 @@ To support GitHub Forge add an internet password like this to your keychain:
|
||||||
| Account | <username>^forge |
|
| Account | <username>^forge |
|
||||||
| Where | https://api.github.com/ |
|
| Where | https://api.github.com/ |
|
||||||
| Password | <token> |
|
| 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
|
||||||
|
|
|
@ -1,66 +1,82 @@
|
||||||
#+TITLE: os/tty
|
← [[doom-module-index:][Back to module index]] ↙ [[doom-module-issues:::os tty][Issues]] ↖ [[doom-module-source:os/tty][Source]] ± [[doom-suggest-edit:][Suggest edits]] ? [[doom-help-modules:][Help]]
|
||||||
#+DATE: August 7, 2020
|
--------------------------------------------------------------------------------
|
||||||
#+SINCE: v3.0.0
|
#+TITLE: :os tty
|
||||||
#+STARTUP: inlineimages nofold
|
#+SUBTITLE: Make TTY Emacs suck less
|
||||||
|
#+CREATED: August 07, 2020
|
||||||
|
#+SINCE: 21.12.0
|
||||||
|
|
||||||
* Table of Contents :TOC_3:noexport:
|
* Description :unfold:
|
||||||
- [[#description][Description]]
|
|
||||||
- [[#maintainers][Maintainers]]
|
|
||||||
- [[#module-flags][Module Flags]]
|
|
||||||
- [[#plugins][Plugins]]
|
|
||||||
- [[#prerequisites][Prerequisites]]
|
|
||||||
- [[#configuration][Configuration]]
|
|
||||||
- [[#true-color-and-italic-support][True-color and italic support]]
|
|
||||||
- [[#troubleshooting][Troubleshooting]]
|
|
||||||
|
|
||||||
* Description
|
|
||||||
This module configures Emacs for use in the terminal, by providing:
|
This module configures Emacs for use in the terminal, by providing:
|
||||||
|
|
||||||
+ System clipboard integration (through an external clipboard program or OSC-52
|
- System clipboard integration (through an external clipboard program or OSC-52
|
||||||
escape codes in supported terminals).
|
escape codes in supported terminals).
|
||||||
+ Cursor-shape changing across evil states (requires a terminal that supports
|
- Cursor-shape changing across evil states (requires a terminal that supports
|
||||||
it).
|
it).
|
||||||
+ Mouse support in the terminal.
|
- Mouse support in the terminal.
|
||||||
|
|
||||||
** Maintainers
|
** Maintainers
|
||||||
This module has no dedicated maintainers.
|
/This module has no dedicated maintainers./ [[doom-contrib-maintainer:][Become a maintainer?]]
|
||||||
|
|
||||||
** Module Flags
|
** Module flags
|
||||||
+ =+osc= Instead of piping your kill ring through external programs, like xclip
|
- +osc ::
|
||||||
or pbcopy, have Emacs emit OSC-52 escape codes instead, allowing Emacs to
|
Instead of piping your kill ring through external programs, like =xclip= or
|
||||||
|
=pbcopy=, have Emacs emit OSC-52 escape codes instead, allowing Emacs to
|
||||||
communicate with your clipboard through your terminal, even across SSH
|
communicate with your clipboard through your terminal, even across SSH
|
||||||
connections or Tmux. However, this requires [[https://github.com/spudlyo/clipetty#terminals-that-support-osc-clipboard-operations][a supported terminal]].
|
connections or Tmux. However, this requires [[https://github.com/spudlyo/clipetty#terminals-that-support-osc-clipboard-operations][a supported terminal]].
|
||||||
|
|
||||||
** Plugins
|
** Packages
|
||||||
+ [[https://github.com/spudlyo/clipetty][clipetty]]* (if =+osc=)
|
- [[doom-package:][clipetty]] if [[doom-module:][+osc]]
|
||||||
+ [[https://github.com/7696122/evil-terminal-cursor-changer][evil-terminal-cursor-changer]]* (if =:editor evil=)
|
- [[doom-package:][evil-terminal-cursor-changer]] if [[doom-module:][:editor evil]]
|
||||||
+ [[https://github.com/emacs-straight/xclip][xclip]]* (unless =+osc=)
|
- [[doom-package:][xclip]] unless [[doom-module:][+osc]]
|
||||||
|
|
||||||
|
** 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.]]
|
||||||
|
|
||||||
* Prerequisites
|
|
||||||
This module has no hard prerequisites, but in order for its features to work you
|
This module has no hard prerequisites, but in order for its features to work you
|
||||||
need:
|
need:
|
||||||
|
|
||||||
+ For system clipboard integration:
|
- For system clipboard integration:
|
||||||
+ A supported clipboard program, such as:
|
- A supported clipboard program, such as:
|
||||||
+ Linux: =xclip=, =xsel=, or =wl-clibpoard= (Wayland)
|
- Linux: =xclip=, =xsel=, or =wl-clibpoard= (Wayland)
|
||||||
+ macOS: =pbcopy= and =pbpaste= (included with macOS)
|
- macOS: =pbcopy= and =pbpaste= (included with macOS)
|
||||||
+ Windows: =getclip= and =putclip= (cygwin)
|
- Windows: =getclip= and =putclip= (cygwin)
|
||||||
+ (If =+osc= is enabled) A terminal that supports OSC 52 escape codes, such
|
- (If [[doom-module:][+osc]] is enabled) A terminal that supports OSC 52 escape codes, such as:
|
||||||
as: xterm (unix), iTerm2 (macOS), alacritty (cross platform), kitty (macOS,
|
xterm (unix), iTerm2 (macOS), alacritty (cross platform), kitty (macOS,
|
||||||
linux), mintty (Windows), hterm (javascript), st (unix), mlterm (cross
|
linux), mintty (Windows), hterm (javascript), st (unix), mlterm (cross
|
||||||
platform)
|
platform)
|
||||||
+ For cursor shape changing in the terminal you need A terminal that supports
|
- For cursor shape changing in the terminal you need A terminal that supports
|
||||||
VT's DECSCUSR sequence, such as: Gnome Terminal, xterm, iTerm (macOS),
|
VT's DECSCUSR sequence, such as: Gnome Terminal, xterm, iTerm (macOS),
|
||||||
Konsole, or mintty (Windows). Terminal.app (macOS) is supported too, but
|
Konsole, or mintty (Windows). Terminal.app (macOS) is supported too, but
|
||||||
requires [[http://www.culater.net/software/SIMBL/SIMBL.php][SIMBL]] and [[https://github.com/saitoha/mouseterm-plus/releases][MouseTerm]] Plus to work.
|
requires [[http://www.culater.net/software/SIMBL/SIMBL.php][SIMBL]] and [[https://github.com/saitoha/mouseterm-plus/releases][MouseTerm]] Plus to work.
|
||||||
|
|
||||||
* Configuration
|
* TODO Usage
|
||||||
** True-color and italic support
|
#+begin_quote
|
||||||
Emacs 26.3 users should consult [[https://github.com/syl20bnr/spacemacs/wiki/Terminal][the spacemacs wiki]] for details on achieving true
|
🔨 This module has no usage documentation yet. [[doom-contrib-module:][Write some?]]
|
||||||
color support in terminal Emacs.
|
#+end_quote
|
||||||
|
|
||||||
Emacs 27.x users don't need todo anything, as true color support is [[https://github.com/emacs-mirror/emacs/commit/7f6153d9563cfe7753083996f59eacc9f4c694df][built into
|
* TODO Configuration
|
||||||
27.1+ and newer]].
|
#+begin_quote
|
||||||
|
🔨 /This module's configuration documentation is incomplete./ [[doom-contrib-module:][Complete it?]]
|
||||||
|
#+end_quote
|
||||||
|
|
||||||
|
** True-color and italic support
|
||||||
|
Consult [[https://github.com/syl20bnr/spacemacs/wiki/Terminal][the spacemacs wiki]] for details on achieving true color support for
|
||||||
|
terminal Emacs.
|
||||||
|
|
||||||
* Troubleshooting
|
* Troubleshooting
|
||||||
# Common issues and their solution, or places to look for help.
|
/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
|
||||||
|
|
Loading…
Add table
Add a link
Reference in a new issue