docs(:app): update READMEs to new format
This commit is contained in:
Henrik Lissner
Henrik Lissner
parent
0aad1399cc
commit
5b354ae4f3
7 changed files with 419 additions and 332 deletions
|
|
@ -1,12 +1,10 @@
|
||||||
← [[doom-module-index:][Back to module index]] ↙ [[doom-changelog-search:::app nil][Changelog]] ± [[doom-suggest-edit:][Suggest edits]] ? [[doom-help-modules:][Help]]
|
← [[doom-module-index:][Back to module index]] ↖ [[doom-module-source:app][Source]] ± [[doom-suggest-edit:][Suggest edits]] ? [[doom-help-modules:][Help]]
|
||||||
--------------------------------------------------------------------------------
|
--------------------------------------------------------------------------------
|
||||||
#+TITLE: :app
|
#+TITLE: :app
|
||||||
#+SUBTITLE: The ultimate code completion backend
|
#+CREATED: February 19, 2017
|
||||||
#+CREATED: February 19, 2017
|
#+SINCE: 21.12.0
|
||||||
#+SINCE: v21.12.0
|
|
||||||
#+SETUPFILE: ../../docs/.setupfile.org
|
|
||||||
|
|
||||||
* Description
|
* Description
|
||||||
Application modules are complex and opinionated modules that transform Emacs
|
Application modules are complex and opinionated modules that transform Emacs
|
||||||
toward a specific purpose. They may have additional dependencies and *should be
|
toward a specific purpose. They may have additional dependencies and *should be
|
||||||
loaded last*, before =:config= modules.
|
loaded last* (but before [[doom-module:][:config]] modules).
|
||||||
|
|
|
||||||
|
|
@ -1,34 +1,53 @@
|
||||||
#+TITLE: app/calendar
|
← [[doom-module-index:][Back to module index]] ↙ [[doom-module-issues:::app calendar][Issues]] ↖ [[doom-module-source:app/calendar][Source]] ± [[doom-suggest-edit:][Suggest edits]] ? [[doom-help-modules:][Help]]
|
||||||
#+DATE: January 13, 2018
|
--------------------------------------------------------------------------------
|
||||||
#+SINCE: v2.1
|
#+TITLE: :app calendar
|
||||||
#+STARTUP: inlineimages
|
#+SUBTITLE: Watch your missed deadlines in real time
|
||||||
|
#+CREATED: January 13, 2018
|
||||||
|
#+SINCE: 21.12.0 (#355)
|
||||||
|
|
||||||
* Table of Contents :TOC:
|
* Description :unfold:
|
||||||
- [[#description][Description]]
|
|
||||||
- [[#module-flags][Module Flags]]
|
|
||||||
- [[#packages][Packages]]
|
|
||||||
- [[#configuration][Configuration]]
|
|
||||||
- [[#changing-calendar-sources][Changing calendar sources]]
|
|
||||||
- [[#synchronizing-org-and-google-calendar][Synchronizing Org and Google Calendar]]
|
|
||||||
|
|
||||||
* Description
|
|
||||||
This module adds a calendar view for Emacs, with org and google calendar sync
|
This module adds a calendar view for Emacs, with org and google calendar sync
|
||||||
support.
|
support.
|
||||||
|
|
||||||
** Module Flags
|
** Maintainers
|
||||||
This module provides no flags.
|
/This module has no dedicated maintainers./ [[doom-contrib-maintainer:][Become a maintainer?]]
|
||||||
|
|
||||||
|
** Module flags
|
||||||
|
/This module has no flags./
|
||||||
|
|
||||||
** Packages
|
** Packages
|
||||||
+ [[https://github.com/kiwanami/emacs-calfw][calfw]]
|
- [[doom-package:][calfw]]
|
||||||
+ [[https://github.com/kiwanami/emacs-calfw][calfw-org]]
|
- [[doom-package:][calfw-org]]
|
||||||
+ [[https://github.com/kidd/org-gcal.el][org-gcal]]
|
- [[doom-package:][org-gcal]]
|
||||||
|
|
||||||
|
** 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 Google Calendar account.
|
||||||
|
- [[https://github.com/kidd/org-gcal.el#installation][An OAuth client ID]], for syncing said account with [[doom-package:][org-gcal]].
|
||||||
|
|
||||||
|
* TODO Usage
|
||||||
|
#+begin_quote
|
||||||
|
🔨 This module has no usage documentation yet. [[doom-contrib-module:][Write some?]]
|
||||||
|
#+end_quote
|
||||||
|
|
||||||
|
* TODO Configuration
|
||||||
|
#+begin_quote
|
||||||
|
🔨 /This module's configuration documentation is incomplete./ [[doom-contrib-module:][Complete it?]]
|
||||||
|
#+end_quote
|
||||||
|
|
||||||
* Configuration
|
|
||||||
** Changing calendar sources
|
** Changing calendar sources
|
||||||
By defining your own calendar commands, you can control what sources to pull
|
By defining your own calendar commands, you can control what sources to pull
|
||||||
calendar data from:
|
calendar data from:
|
||||||
|
#+begin_src emacs-lisp
|
||||||
#+BEGIN_SRC emacs-lisp
|
|
||||||
(defun my-open-calendar ()
|
(defun my-open-calendar ()
|
||||||
(interactive)
|
(interactive)
|
||||||
(cfw:open-calendar-buffer
|
(cfw:open-calendar-buffer
|
||||||
|
|
@ -41,10 +60,21 @@ calendar data from:
|
||||||
(cfw:ical-create-source "Moon" "~/moon.ics" "Gray") ; ICS source1
|
(cfw:ical-create-source "Moon" "~/moon.ics" "Gray") ; ICS source1
|
||||||
(cfw:ical-create-source "gcal" "https://..../basic.ics" "IndianRed") ; google calendar ICS
|
(cfw:ical-create-source "gcal" "https://..../basic.ics" "IndianRed") ; google calendar ICS
|
||||||
)))
|
)))
|
||||||
#+END_SRC
|
#+end_src
|
||||||
|
|
||||||
The [[https://github.com/kiwanami/emacs-calfw][kiwanami/emacs-calfw]] project readme contains more examples.
|
The [[https://github.com/kiwanami/emacs-calfw][kiwanami/emacs-calfw]] project readme contains more examples.
|
||||||
|
|
||||||
** Synchronizing Org and Google Calendar
|
** Synchronizing Org and Google Calendar
|
||||||
The [[https://github.com/kidd/org-gcal.el][kidd/org-gcal.el]] project README contains more detailed instructions on how
|
The [[https://github.com/kidd/org-gcal.el][kidd/org-gcal.el]] project README contains more detailed instructions on how
|
||||||
to link your calendar with Google calendars.
|
to link your calendar with Google calendars.
|
||||||
|
|
||||||
|
* 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,71 +1,76 @@
|
||||||
#+TITLE: app/emms
|
← [[doom-module-index:][Back to module index]] ↙ [[doom-module-issues:::app emms][Issues]] ↖ [[doom-module-source:app/emms][Source]] ± [[doom-suggest-edit:][Suggest edits]] ? [[doom-help-modules:][Help]]
|
||||||
#+DATE: March 6, 2021
|
--------------------------------------------------------------------------------
|
||||||
#+SINCE: v3.0.0
|
#+TITLE: :app emms
|
||||||
#+STARTUP: inlineimages nofold
|
#+SUBTITLE: A media player for music no one's heard of
|
||||||
|
#+CREATED: March 06, 2021
|
||||||
|
#+SINCE: 21.12.0
|
||||||
|
|
||||||
* Table of Contents :TOC_3:noexport:
|
* Description :unfold:
|
||||||
- [[#description][Description]]
|
|
||||||
- [[#maintainers][Maintainers]]
|
|
||||||
- [[#module-flags][Module Flags]]
|
|
||||||
- [[#plugins][Plugins]]
|
|
||||||
- [[#prerequisites][Prerequisites]]
|
|
||||||
- [[#arch-linux][Arch Linux]]
|
|
||||||
- [[#nixos][NixOS]]
|
|
||||||
- [[#ubuntu][Ubuntu]]
|
|
||||||
- [[#troubleshooting][Troubleshooting]]
|
|
||||||
- [[#new-music-files-not-showing-up-in-database][New music files not showing up in database]]
|
|
||||||
- [[#appendix][Appendix]]
|
|
||||||
- [[#keybinds][Keybinds]]
|
|
||||||
|
|
||||||
* Description
|
|
||||||
This module enables Emacs to be used as a music player. It uses [[https://www.musicpd.org/][mpd]] as a backend
|
This module enables Emacs to be used as a music player. It uses [[https://www.musicpd.org/][mpd]] as a backend
|
||||||
server and [[https://musicpd.org/clients/mpc/][mpc]] to update your music database.
|
server and [[https://musicpd.org/clients/mpc/][mpc]] to update your music database.
|
||||||
|
|
||||||
** Maintainers
|
** Maintainers
|
||||||
This module has no dedicated maintainers.
|
/This module has no dedicated maintainers./ [[doom-contrib-maintainer:][Become a maintainer?]]
|
||||||
|
|
||||||
** Module Flags
|
** Module flags
|
||||||
This module provides no flags.
|
/This module has no flags./
|
||||||
|
|
||||||
** Plugins
|
** Packages
|
||||||
+ [[https://git.savannah.gnu.org/git/emms.git/][emms]]
|
- [[doom-package:][emms]]
|
||||||
|
|
||||||
* Prerequisites
|
** Hacks
|
||||||
This module requires an active MPD server, the MPC utility, and a music library.
|
/No hacks documented for this module./
|
||||||
|
|
||||||
** Arch Linux
|
** TODO Changelog
|
||||||
#+BEGIN_SRC bash
|
# This section will be machine generated. Don't edit it by hand.
|
||||||
pacman -S mpd mpc
|
/This module does not have a changelog yet./
|
||||||
#+END_SRC
|
|
||||||
|
|
||||||
** NixOS
|
* Installation
|
||||||
#+BEGIN_SRC nix
|
[[id:01cffea4-3329-45e2-a892-95a384ab2338][Enable this module in your ~doom!~ block.]]
|
||||||
services.mpd.enable = true;
|
|
||||||
environment.systemPackages = [ pkgs.mpc_cli ];
|
|
||||||
#+END_SRC
|
|
||||||
|
|
||||||
** Ubuntu
|
This module requires:
|
||||||
#+BEGIN_SRC bash
|
- [[https://mpd.readthedocs.io/en/stable/user.html#installation][mpd]] (and a running mpd server)
|
||||||
apt install mpd mpc
|
- [[https://www.musicpd.org/clients/mpc/][mpc]]
|
||||||
#+END_SRC
|
|
||||||
|
These should be available through your OS package manager.
|
||||||
|
|
||||||
|
* TODO Usage
|
||||||
|
#+begin_quote
|
||||||
|
🔨 /This module's usage documentation is incomplete./ [[doom-contrib-module:][Complete it?]]
|
||||||
|
#+end_quote
|
||||||
|
|
||||||
|
** Keybinds
|
||||||
|
- [[kbd:][<localleader> l]] Toggles whether or not the player repeats the playlist.
|
||||||
|
- [[kbd:][<localleader> m]] Mixes the playlist.
|
||||||
|
- [[kbd:][<localleader> i]] Insert specific song
|
||||||
|
- [[kbd:][<localleader> s]] Save the current playlist to a file
|
||||||
|
- [[kbd:][<localleader> p]] Insert playlist save into current playlist
|
||||||
|
- [[kbd:][g a]] Sort the browser by artists
|
||||||
|
- [[kbd:][g b]] Sort the browser by genre
|
||||||
|
- [[kbd:][X]] Stops the player
|
||||||
|
- [[kbd:][x]] pauses the player
|
||||||
|
- [[kbd:][D]] in the playlist window removes that item
|
||||||
|
- [[kbd:][C]] clears the playlist
|
||||||
|
- [[kbd:][>]] move five seconds forward in the current track
|
||||||
|
- [[kbd:][<]] Opposite five back
|
||||||
|
- [[kbd:][RET]] In browser adds the artist's songs to the playlist, in the playlist starts
|
||||||
|
playlist.
|
||||||
|
|
||||||
|
* TODO Configuration
|
||||||
|
#+begin_quote
|
||||||
|
🔨 This module has no configuration documentation yet. [[doom-contrib-module:][Write some?]]
|
||||||
|
#+end_quote
|
||||||
|
|
||||||
* Troubleshooting
|
* Troubleshooting
|
||||||
** New music files not showing up in database
|
[[doom-report:][Report an issue?]]
|
||||||
Try =M-x +emms/mpd-restart-music-daemon=. If that doesn't work restart emacs.
|
|
||||||
|
|
||||||
* Appendix
|
** New music files not showing up in database
|
||||||
** Keybinds
|
Try [[kbd:][M-x +emms/mpd-restart-music-daemon]] then restart emacs.
|
||||||
+ =SPC m l= Toggles whether or not the player repeats the playlist.
|
|
||||||
+ =SPC m m= Mixes the playlist.
|
* Frequently asked questions
|
||||||
+ =SPC m i= Insert specific song
|
/This module has no FAQs yet./ [[doom-suggest-faq:][Ask one?]]
|
||||||
+ =SPC m s= Save the current playlist to a file
|
|
||||||
+ =SPC m p= Insert playlist save into current playlist
|
* TODO Appendix
|
||||||
+ =g a= Sort the browser by artists
|
#+begin_quote
|
||||||
+ =g b= Sort the browser by genre
|
🔨 This module has no appendix yet. [[doom-contrib-module:][Write one?]]
|
||||||
+ =X= Stops the player
|
#+end_quote
|
||||||
+ =x= pauses the player
|
|
||||||
+ =D= in the playlist window removes that item
|
|
||||||
+ =C= clears the playlist
|
|
||||||
+ =>= move five seconds forward in the current track
|
|
||||||
+ =<= Opposite five back
|
|
||||||
+ =RET= In browser adds the artist's songs to the playlist, in the playlist starts playlist.
|
|
||||||
|
|
|
||||||
|
|
@ -1,58 +1,74 @@
|
||||||
#+title: app/everywhere
|
← [[doom-module-index:][Back to module index]] ↙ [[doom-module-issues:::app everywhere][Issues]] ↖ [[doom-module-source:app/everywhere][Source]] ± [[doom-suggest-edit:][Suggest edits]] ? [[doom-help-modules:][Help]]
|
||||||
#+date: February 7, 2021
|
--------------------------------------------------------------------------------
|
||||||
#+since: v3.0
|
#+TITLE: :app everywhere
|
||||||
#+startup: inlineimages nofold
|
#+SUBTITLE: *leave* Emacs!? You must be joking
|
||||||
|
#+CREATED: February 07, 2021
|
||||||
|
#+SINCE: 21.12.0
|
||||||
|
|
||||||
* Table of Contents :TOC_3:noexport:
|
* Description :unfold:
|
||||||
- [[#description][Description]]
|
|
||||||
- [[#maintainers][Maintainers]]
|
|
||||||
- [[#module-flags][Module Flags]]
|
|
||||||
- [[#plugins][Plugins]]
|
|
||||||
- [[#prerequisites][Prerequisites]]
|
|
||||||
- [[#features][Features]]
|
|
||||||
- [[#configuration][Configuration]]
|
|
||||||
|
|
||||||
* Description
|
|
||||||
This module adds system-wide popup Emacs windows for quick edits.
|
This module adds system-wide popup Emacs windows for quick edits.
|
||||||
|
|
||||||
** Maintainers
|
** Maintainers
|
||||||
+ [[https://github.com/tecosaur][@tecosaur]]
|
- [[doom-user:][@tecosaur]]
|
||||||
|
|
||||||
** Module Flags
|
[[doom-contrib-maintainer:][Become a maintainer?]]
|
||||||
|
|
||||||
This module provides no flags.
|
** Module flags
|
||||||
|
/This module has no flags./
|
||||||
|
|
||||||
** Plugins
|
** Packages
|
||||||
+ [[https://github.com/tecosaur/emacs-everywhere][emacs-everywhere]]
|
- [[doom-package:][emacs-everywhere]]
|
||||||
|
|
||||||
* Prerequisites
|
** Hacks
|
||||||
|
/No hacks documented for this module./
|
||||||
|
|
||||||
On Linux =xclip=, =xdotool=, =xprop=, and =xwininfo= are needed.
|
** TODO Changelog
|
||||||
|
# This section will be machine generated. Don't edit it by hand.
|
||||||
|
/This module does not have a changelog yet./
|
||||||
|
|
||||||
On MacOS, Emacs must be allowed to "control your computer" under *Settings > Accessibility*.
|
* Installation
|
||||||
|
[[id:01cffea4-3329-45e2-a892-95a384ab2338][Enable this module in your ~doom!~ block.]]
|
||||||
|
|
||||||
* Features
|
This module requires:
|
||||||
|
- *On Linux:* (these should be available through your OS package manager)
|
||||||
|
- =xclip=
|
||||||
|
- =xdotool=
|
||||||
|
- =xprop=
|
||||||
|
- =xwininfo=
|
||||||
|
- *On MacOS:* that Emacs is allowed to "control your computer" under *System
|
||||||
|
Preferences > Accessibility*.
|
||||||
|
|
||||||
|
* Usage
|
||||||
To use this, invoke the =emacs-everywhere= executable. This can be done in two
|
To use this, invoke the =emacs-everywhere= executable. This can be done in two
|
||||||
ways:
|
ways:
|
||||||
+ ~emacsclient --eval "(emacs-everywhere)"~
|
+ ~$ emacsclient --eval "(emacs-everywhere)"~
|
||||||
+ ~doom everywhere~
|
+ ~$ doom everywhere~
|
||||||
|
|
||||||
It is recommended that you add a keybinding for this.
|
It is recommended that you add a keybinding for this.
|
||||||
|
|
||||||
From here, you can edit away to your hearts content in the created frame, then
|
From here, you can edit away to your hearts content in the created frame, then
|
||||||
return to the original window and paste the content with =C-c C-c= or =SPC q f=.
|
return to the original window and paste the content with [[kbd:][C-c C-c]] or [[kbd:][SPC q f]]. To
|
||||||
To exit without pasting, use =C-c C-k=.
|
exit without pasting, use [[kbd:][C-c C-k]].
|
||||||
|
|
||||||
* Configuration
|
* Configuration
|
||||||
|
[[doom-package:][emacs-everywhere]] likes to guess if you triggered it from an application which
|
||||||
=emacs-everywhere= likes to guess if you triggered it from an application which
|
|
||||||
supports markdown. Configure ~emacs-everywhere-markdown-windows~ and
|
supports markdown. Configure ~emacs-everywhere-markdown-windows~ and
|
||||||
~emacs-everywhere-markdown-apps~ to improve how accurate this is on your system.
|
~emacs-everywhere-markdown-apps~ to improve how accurate this is on your system.
|
||||||
|
|
||||||
By default, when markdown is detected, ~markdown-mode~ is used. It is possible to
|
By default, when markdown is detected, ~markdown-mode~ is used. It is possible
|
||||||
instead use pandoc to convert the content to Org (and export to markdown when
|
to instead use pandoc to convert the content to Org (and export to markdown when
|
||||||
closing the frame) by setting ~emacs-everywhere-major-mode-function~ to
|
closing the frame) by setting ~emacs-everywhere-major-mode-function~ to
|
||||||
=#'org-mode=.
|
~#'org-mode~.
|
||||||
|
|
||||||
Most other behaviour is implemented as hooks on ~emacs-everywhere-init-hooks~.
|
Most other behavior is implemented as hooks on ~emacs-everywhere-init-hooks~.
|
||||||
|
|
||||||
|
* 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,82 +1,83 @@
|
||||||
#+TITLE: app/irc
|
← [[doom-module-index:][Back to module index]] ↙ [[doom-module-issues:::app irc][Issues]] ↖ [[doom-module-source:app/irc][Source]] ± [[doom-suggest-edit:][Suggest edits]] ? [[doom-help-modules:][Help]]
|
||||||
#+DATE: June 11, 2017
|
--------------------------------------------------------------------------------
|
||||||
#+SINCE: v2.0.3
|
#+TITLE: :app irc
|
||||||
#+STARTUP: inlineimages
|
#+SUBTITLE: How neckbeards socialize
|
||||||
|
#+CREATED: June 11, 2017
|
||||||
|
#+SINCE: 2.0.3
|
||||||
|
|
||||||
* Table of Contents :TOC:
|
* Description :unfold:
|
||||||
- [[#description][Description]]
|
|
||||||
- [[#module-flags][Module Flags]]
|
|
||||||
- [[#plugins][Plugins]]
|
|
||||||
- [[#prerequisites][Prerequisites]]
|
|
||||||
- [[#macos][macOS]]
|
|
||||||
- [[#debian--ubuntu][Debian / Ubuntu]]
|
|
||||||
- [[#arch-linux][Arch Linux]]
|
|
||||||
- [[#nixos][NixOS]]
|
|
||||||
- [[#features][Features]]
|
|
||||||
- [[#an-irc-client-in-emacs][An IRC Client in Emacs]]
|
|
||||||
- [[#configuration][Configuration]]
|
|
||||||
- [[#pass-the-unix-password-manager][Pass: the unix password manager]]
|
|
||||||
- [[#emacs-auth-source-api][Emacs' auth-source API]]
|
|
||||||
- [[#troubleshooting][Troubleshooting]]
|
|
||||||
|
|
||||||
* Description
|
|
||||||
This module turns Emacs into an IRC client, capable of OS notifications.
|
This module turns Emacs into an IRC client, capable of OS notifications.
|
||||||
|
|
||||||
** Module Flags
|
** Maintainers
|
||||||
This module provides no flags.
|
/This module has no dedicated maintainers./ [[doom-contrib-maintainer:][Become a maintainer?]]
|
||||||
|
|
||||||
** Plugins
|
** Module flags
|
||||||
+ [[https://github.com/jorgenschaefer/circe][circe]]
|
/This module has no flags./
|
||||||
+ [[https://github.com/eqyiel/circe-notifications][circe-notifications]]
|
|
||||||
|
|
||||||
* Prerequisites
|
** Packages
|
||||||
This module requires =gnutls= for secure IRC connections to work.
|
- [[doom-package:][circe]]
|
||||||
|
- [[doom-package:][circe-notifications]]
|
||||||
|
|
||||||
|
** 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:
|
||||||
|
- [[https://www.gnutls.org/][GnuTLS]], for secure IRC connections to work.
|
||||||
|
|
||||||
|
This should be available through your OS package manager.
|
||||||
|
|
||||||
** macOS
|
** macOS
|
||||||
#+BEGIN_SRC sh
|
#+begin_src sh
|
||||||
brew install gnutls
|
brew install gnutls
|
||||||
#+END_SRC
|
#+end_src
|
||||||
|
|
||||||
** Debian / Ubuntu
|
** Debian / Ubuntu
|
||||||
#+BEGIN_SRC sh
|
#+begin_src sh
|
||||||
apt install gnutls-bin
|
apt install gnutls-bin
|
||||||
#+END_SRC
|
#+end_src
|
||||||
|
|
||||||
** Arch Linux
|
** Arch Linux
|
||||||
#+BEGIN_SRC sh
|
#+begin_src sh
|
||||||
pacman -S gnutls
|
pacman -S gnutls
|
||||||
#+END_SRC
|
#+end_src
|
||||||
** NixOS
|
** NixOS
|
||||||
#+BEGIN_SRC nix
|
#+begin_src nix
|
||||||
environment.systemPackages = [ pkgs.gnutls ];
|
environment.systemPackages = [ pkgs.gnutls ];
|
||||||
#+END_SRC
|
#+end_src
|
||||||
|
|
||||||
* Features
|
* TODO Usage
|
||||||
** An IRC Client in Emacs
|
#+begin_quote
|
||||||
To connect to IRC you can invoke the ~=irc~ function using =M-x= or your own
|
🔨 /This module's usage documentation is incomplete./ [[doom-contrib-module:][Complete it?]]
|
||||||
custom keybinding.
|
#+end_quote
|
||||||
|
|
||||||
| command | description |
|
To connect to IRC use ~M-x =irc~.
|
||||||
|---------+-------------------------------------------|
|
|
||||||
| ~=irc~ | Connect to IRC and all configured servers |
|
|
||||||
|
|
||||||
When in a circe buffer these keybindings will be available.
|
When in a circe buffer these keybindings will be available:
|
||||||
|
| command | key | description |
|
||||||
|
|-----------------------------+-----------------+----------------------------------------------|
|
||||||
|
| ~+irc/tracking-next-buffer~ | [[kbd:][<localleader> a]] | Switch to the next active buffer |
|
||||||
|
| ~circe-command-JOIN~ | [[kbd:][<localleader> j]] | Join a channel |
|
||||||
|
| ~+irc/send-message~ | [[kbd:][<localleader> m]] | Send a private message |
|
||||||
|
| ~circe-command-NAMES~ | [[kbd:][<localleader> n]] | List the names of the current channel |
|
||||||
|
| ~circe-command-PART~ | [[kbd:][<localleader> p]] | Part the current channel |
|
||||||
|
| ~+irc/quit~ | [[kbd:][<localleader> Q]] | Kill the current circe session and workgroup |
|
||||||
|
| ~circe-reconnect~ | [[kbd:][<localleader> R]] | Reconnect the current server |
|
||||||
|
|
||||||
| command | key | description |
|
* TODO Configuration
|
||||||
|-----------------------------+-----------+----------------------------------------------|
|
#+begin_quote
|
||||||
| ~+irc/tracking-next-buffer~ | =SPC m a= | Switch to the next active buffer |
|
🔨 /This module's configuration documentation is incomplete./ [[doom-contrib-module:][Complete it?]]
|
||||||
| ~circe-command-JOIN~ | =SPC m j= | Join a channel |
|
#+end_quote
|
||||||
| ~+irc/send-message~ | =SPC m m= | Send a private message |
|
|
||||||
| ~circe-command-NAMES~ | =SPC m n= | List the names of the current channel |
|
|
||||||
| ~circe-command-PART~ | =SPC m p= | Part the current channel |
|
|
||||||
| ~+irc/quit~ | =SPC m Q= | Kill the current circe session and workgroup |
|
|
||||||
| ~circe-reconnect~ | =SPC m R= | Reconnect the current server |
|
|
||||||
|
|
||||||
* Configuration
|
Use ~set-irc-server! SERVER PLIST~ to configure IRC servers. Its second argument
|
||||||
Use ~set-irc-server! SERVER PLIST~ to configure IRC servers. Its second argument (a plist)
|
(a plist) takes the same arguments as ~circe-network-options~:
|
||||||
takes the same arguments as ~circe-network-options~.
|
#+begin_src emacs-lisp
|
||||||
|
|
||||||
#+BEGIN_SRC emacs-lisp :tangle no
|
|
||||||
;; if you omit =:host=, ~SERVER~ will be used instead.
|
;; if you omit =:host=, ~SERVER~ will be used instead.
|
||||||
(after! circe
|
(after! circe
|
||||||
(set-irc-server! "irc.libera.chat"
|
(set-irc-server! "irc.libera.chat"
|
||||||
|
|
@ -86,20 +87,23 @@ takes the same arguments as ~circe-network-options~.
|
||||||
:sasl-username "myusername"
|
:sasl-username "myusername"
|
||||||
:sasl-password "mypassword"
|
:sasl-password "mypassword"
|
||||||
:channels ("#emacs"))))
|
:channels ("#emacs"))))
|
||||||
#+END_SRC
|
#+end_src
|
||||||
|
|
||||||
However, *it is a obviously a bad idea to store your password in plaintext,* so
|
However, *it is a obviously a bad idea to store your password in plaintext,* so
|
||||||
here are ways to avoid that:
|
here are ways to avoid that:
|
||||||
|
|
||||||
** Pass: the unix password manager
|
** TODO Pass: the unix password manager
|
||||||
|
#+begin_quote
|
||||||
|
🔨 /This section is outdated and needs to be rewritten./ [[doom-contrib-module:][Rewrite it?]]
|
||||||
|
#+end_quote
|
||||||
|
|
||||||
[[https://www.passwordstore.org/][Pass]] is my tool of choice. I use it to manage my passwords. If you activate the
|
[[https://www.passwordstore.org/][Pass]] is my tool of choice. I use it to manage my passwords. If you activate the
|
||||||
[[../../../modules/tools/pass/README.org][:tools pass]] module you get an elisp API through which to access your
|
[[doom-module:][:tools pass]] module you get an elisp API through which to access your password
|
||||||
password store.
|
store.
|
||||||
|
|
||||||
~set-irc-server!~ accepts a plist can use functions instead of strings.
|
~set-irc-server!~ accepts a plist can use functions instead of strings.
|
||||||
~+pass-get-user~ and ~+pass-get-secret~ can help here:
|
~+pass-get-user~ and ~+pass-get-secret~ can help here:
|
||||||
|
#+begin_src emacs-lisp
|
||||||
#+BEGIN_SRC emacs-lisp :tangle no
|
|
||||||
(set-irc-server! "irc.libera.chat"
|
(set-irc-server! "irc.libera.chat"
|
||||||
`(:tls t
|
`(:tls t
|
||||||
:port 6697
|
:port 6697
|
||||||
|
|
@ -107,12 +111,11 @@ password store.
|
||||||
:sasl-username ,(+pass-get-user "irc/libera.chat")
|
:sasl-username ,(+pass-get-user "irc/libera.chat")
|
||||||
:sasl-password ,(+pass-get-secret "irc/libera.chat")
|
:sasl-password ,(+pass-get-secret "irc/libera.chat")
|
||||||
:channels ("#emacs")))
|
:channels ("#emacs")))
|
||||||
#+END_SRC
|
#+end_src
|
||||||
|
|
||||||
But wait, there's more! This stores your password in a public variable which
|
But wait, there's more! This stores your password in a public variable which
|
||||||
could be accessed or appear in backtraces. Not good! So we go a step further:
|
could be accessed or appear in backtraces. Not good! So we go a step further:
|
||||||
|
#+begin_src emacs-lisp
|
||||||
#+BEGIN_SRC emacs-lisp :tangle no
|
|
||||||
(set-irc-server! "irc.libera.chat"
|
(set-irc-server! "irc.libera.chat"
|
||||||
`(:tls t
|
`(:tls t
|
||||||
:port 6697
|
:port 6697
|
||||||
|
|
@ -120,12 +123,12 @@ could be accessed or appear in backtraces. Not good! So we go a step further:
|
||||||
:sasl-username ,(+pass-get-user "irc/libera.chat")
|
:sasl-username ,(+pass-get-user "irc/libera.chat")
|
||||||
:sasl-password (lambda (&rest _) (+pass-get-secret "irc/libera.chat"))
|
:sasl-password (lambda (&rest _) (+pass-get-secret "irc/libera.chat"))
|
||||||
:channels ("#emacs")))
|
:channels ("#emacs")))
|
||||||
#+END_SRC
|
#+end_src
|
||||||
|
|
||||||
And you're good to go!
|
And you're good to go!
|
||||||
|
|
||||||
Note that =+pass-get-user= tries to find your username by looking for the fields
|
Note that ~+pass-get-user~ tries to find your username by looking for the fields
|
||||||
listed in =+pass-user-fields= (by default =login=, =user==, =username== and
|
listed in ~+pass-user-fields~ (by default =login=, =user==, =username== and
|
||||||
=email=)=). An example configuration looks like
|
=email=)=). An example configuration looks like
|
||||||
|
|
||||||
#+begin_example
|
#+begin_example
|
||||||
|
|
@ -136,8 +139,7 @@ username: myusername
|
||||||
** Emacs' auth-source API
|
** Emacs' auth-source API
|
||||||
~auth-source~ is built into Emacs. As suggested [[https://github.com/jorgenschaefer/circe/wiki/Configuration#safer-password-management][in the circe wiki]], you can store
|
~auth-source~ is built into Emacs. As suggested [[https://github.com/jorgenschaefer/circe/wiki/Configuration#safer-password-management][in the circe wiki]], you can store
|
||||||
(and retrieve) encrypted passwords with it.
|
(and retrieve) encrypted passwords with it.
|
||||||
|
#+begin_src emacs-lisp
|
||||||
#+BEGIN_SRC emacs-lisp :tangle no
|
|
||||||
(setq auth-sources '("~/.authinfo.gpg"))
|
(setq auth-sources '("~/.authinfo.gpg"))
|
||||||
|
|
||||||
(defun my-fetch-password (&rest params)
|
(defun my-fetch-password (&rest params)
|
||||||
|
|
@ -159,6 +161,15 @@ username: myusername
|
||||||
:nick "doom"
|
:nick "doom"
|
||||||
:sasl-password my-nickserver-password
|
:sasl-password my-nickserver-password
|
||||||
:channels ("#emacs")))
|
:channels ("#emacs")))
|
||||||
#+END_SRC
|
#+end_src
|
||||||
|
|
||||||
* TODO Troubleshooting
|
* TODO 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,92 +1,103 @@
|
||||||
#+TITLE: app/rss
|
← [[doom-module-index:][Back to module index]] ↙ [[doom-module-issues:::app rss][Issues]] ↖ [[doom-module-source:app/rss][Source]] ± [[doom-suggest-edit:][Suggest edits]] ? [[doom-help-modules:][Help]]
|
||||||
#+DATE: May 12, 2020
|
--------------------------------------------------------------------------------
|
||||||
#+SINCE: v2.0.9
|
#+TITLE: :app rss
|
||||||
#+STARTUP: inlineimages nofold
|
#+SUBTITLE: An RSS reader that Google can't shut down
|
||||||
|
#+CREATED: May 12, 2020
|
||||||
|
#+SINCE: 2.0.9
|
||||||
|
|
||||||
* Table of Contents :TOC_3:noexport:
|
* Description :unfold:
|
||||||
- [[#description][Description]]
|
Read RSS feeds in the comfort of Emacs.
|
||||||
- [[#maintainers][Maintainers]]
|
|
||||||
- [[#module-flags][Module Flags]]
|
|
||||||
- [[#plugins][Plugins]]
|
|
||||||
- [[#hacks][Hacks]]
|
|
||||||
- [[#prerequisites][Prerequisites]]
|
|
||||||
- [[#features][Features]]
|
|
||||||
- [[#configuration][Configuration]]
|
|
||||||
- [[#without-org][Without +org]]
|
|
||||||
- [[#with-org][With +org]]
|
|
||||||
- [[#keybindings][Keybindings]]
|
|
||||||
- [[#news-filtering][News filtering]]
|
|
||||||
- [[#automatically-updating-feed-when-opening-elfeed][Automatically updating feed when opening elfeed]]
|
|
||||||
- [[#troubleshooting][Troubleshooting]]
|
|
||||||
|
|
||||||
* Description
|
|
||||||
+ Read RSS feeds in the comfort of DOOM (Emacs)
|
|
||||||
|
|
||||||
** Maintainers
|
** Maintainers
|
||||||
This module has no dedicated maintainers.
|
/This module has no dedicated maintainers./ [[doom-contrib-maintainer:][Become a maintainer?]]
|
||||||
|
|
||||||
** Module Flags
|
** Module flags
|
||||||
+ =+org= to enable ~elfeed-org~ to use ~org-directory/elfeed.org~
|
- +org ::
|
||||||
|
Enable [[doom-package:][elfeed-org]], so you can configure your feeds with an org file
|
||||||
|
(={org-directory}/elfeed.org=) rather than Elisp.
|
||||||
|
|
||||||
** Plugins
|
** Packages
|
||||||
+ [[https://github.com/skeeto/elfeed][elfeed]]
|
- [[doom-package:][elfeed]]
|
||||||
+ [[https://github.com/algernon/elfeed-goodies][elfeed-goodies]]
|
- [[doom-package:][elfeed-goodies]]
|
||||||
+ =+org=
|
- [[doom-package:][elfeed-org]] if [[doom-module:][+org]]
|
||||||
+ [[https://github.com/remyhonig/elfeed-org][elfeed-org]]
|
|
||||||
|
|
||||||
** Hacks
|
** Hacks
|
||||||
+ By default ~elfeed-search-filter~ is set to ~@2-weeks-ago~ and makes the last 2 weeks of entries visible. This needs to be set after elfeed has loaded like so in your ~config.el~
|
- By default ~elfeed-search-filter~ is set to ~@2-weeks-ago~ and makes the last
|
||||||
#+begin_src elisp
|
2 weeks of entries visible. This needs to be set after elfeed has loaded like
|
||||||
(after! elfeed
|
so in your =$DOOMDIR/config.el=:
|
||||||
(setq elfeed-search-filter "@1-month-ago +unread"))
|
#+begin_src emacs-lisp
|
||||||
|
(after! elfeed
|
||||||
|
(setq elfeed-search-filter "@1-month-ago +unread"))
|
||||||
#+end_src
|
#+end_src
|
||||||
|
|
||||||
* Prerequisites
|
** TODO Changelog
|
||||||
This module has no prerequisites.
|
# This section will be machine generated. Don't edit it by hand.
|
||||||
|
/This module does not have a changelog yet./
|
||||||
|
|
||||||
* Features
|
* Installation
|
||||||
+ As there isn't currently binding for ~elfeed-update~ you can run it with ~M-x elfeed-update~
|
[[id:01cffea4-3329-45e2-a892-95a384ab2338][Enable this module in your ~doom!~ block.]]
|
||||||
|
|
||||||
|
/This module has no external requirements./
|
||||||
|
|
||||||
|
* TODO Usage
|
||||||
|
#+begin_quote
|
||||||
|
🔨 /This module's usage documentation is incomplete./ [[doom-contrib-module:][Complete it?]]
|
||||||
|
#+end_quote
|
||||||
|
|
||||||
|
- As there isn't currently binding for ~elfeed-update~ you can run it with ~M-x
|
||||||
|
elfeed-update~
|
||||||
|
|
||||||
|
* TODO Configuration
|
||||||
|
#+begin_quote
|
||||||
|
🔨 /This module's configuration documentation is incomplete./ [[doom-contrib-module:][Complete it?]]
|
||||||
|
#+end_quote
|
||||||
|
|
||||||
* Configuration
|
|
||||||
** Without +org
|
** Without +org
|
||||||
When you don't want to use org mode to manage your elfeed feeds you can put your subscriptions to personal ~config.el~ file, ex:
|
When you don't want to use org mode to manage your elfeed feeds you can put your
|
||||||
#+BEGIN_SRC elisp
|
subscriptions in =$DOOMDIR/config.el=:
|
||||||
|
#+begin_src emacs-lisp
|
||||||
(setq elfeed-feeds
|
(setq elfeed-feeds
|
||||||
'("https://this-week-in-rust.org/rss.xml"
|
'("https://this-week-in-rust.org/rss.xml"
|
||||||
"http://feeds.bbci.co.uk/news/rss.xml"))
|
"http://feeds.bbci.co.uk/news/rss.xml"))
|
||||||
#+END_SRC
|
#+end_src
|
||||||
|
|
||||||
** With +org
|
** With +org
|
||||||
When using ~+org~ flag then configuration is easier. You can use ~org-mode~ to configure feeds to follow.
|
When using ~+org~ flag then configuration is easier. You can use ~org-mode~ to
|
||||||
#+BEGIN_SRC org
|
configure feeds to follow:
|
||||||
|
#+begin_src org
|
||||||
,* root :elfeed:
|
,* root :elfeed:
|
||||||
,** Programming :programming:
|
,** Programming :programming:
|
||||||
,*** [[https://this-week-in-rust.org/rss.xml][This Week in Rust]] :rust:
|
,*** [[https://this-week-in-rust.org/rss.xml][This Week in Rust]] :rust:
|
||||||
,** News :news:
|
,** News :news:
|
||||||
,*** Top news :tops:
|
,*** Top news :tops:
|
||||||
,**** http://feeds.bbci.co.uk/news/rss.xml
|
,**** http://feeds.bbci.co.uk/news/rss.xml
|
||||||
#+END_SRC
|
#+end_src
|
||||||
+ Root of ~elfeed-org~ needs to have ~:elfeed:~ tag. This is where ~elfeed-org~ starts to read.
|
- Root of ~elfeed-org~ needs to have ~:elfeed:~ tag. This is where ~elfeed-org~
|
||||||
+ You can have subheaders as in example ~:programming:~, and ~elfeed-org~ applies that tag to all subheader feeds, in example it adds it to ~This Week in Rust~.
|
starts to read.
|
||||||
+ You can "name" feeds as you please with ~org-mode~ ~org-insert-link~ (~C-c C-l~) and put name as you want into ~description~.
|
- You can have subheaders as in example ~:programming:~, and ~elfeed-org~
|
||||||
+ If you don't want to use ~org-directory/elfeed.org~ file you can specify it with ~(setq rmh-elfeed-org-files '("path/to/your/elfeed/file.org))~
|
applies that tag to all subheader feeds, in example it adds it to ~This Week
|
||||||
|
in Rust~.
|
||||||
|
- You can "name" feeds as you please with ~org-mode~ ~org-insert-link~ ([[kbd:][C-c C-l]])
|
||||||
|
and put name as you want into ~description~.
|
||||||
|
- If you don't want to use ~org-directory/elfeed.org~ file you can specify it
|
||||||
|
with ~(setq rmh-elfeed-org-files '("path/to/your/elfeed/file.org))~
|
||||||
|
|
||||||
** Keybindings
|
** Keybindings
|
||||||
+ General
|
+ General
|
||||||
| Key | Mode | Description |
|
| Key | Mode | Description |
|
||||||
|---------+--------------------+--------------------------------|
|
|-------+--------------------+------------------------|
|
||||||
| =S-RET= | Elfeed-search-mode | Open link into browser |
|
| [[kbd:][S-RET]] | elfeed-search-mode | Open link into browser |
|
||||||
| =RET= | Elfeed-search-mode | Open item |
|
| [[kbd:][RET]] | elfeed-search-mode | Open item |
|
||||||
| =s= | Elfeed-search-mode | Filter |
|
| [[kbd:][s]] | elfeed-search-mode | Filter |
|
||||||
| =C-j= | Elfeed-show-mode | Move to next item |
|
| [[kbd:][C-j]] | elfeed-show-mode | Move to next item |
|
||||||
| =C-k= | Elfeed-show-mode | Move to previous item |
|
| [[kbd:][C-k]] | elfeed-show-mode | Move to previous item |
|
||||||
|
|
||||||
+ If ~:editor evil +everywhere~
|
+ If ~:editor evil +everywhere~
|
||||||
| Key | Description |
|
| Key | Description |
|
||||||
|-----+-----------------------------|
|
|-----+-----------------------------|
|
||||||
| q | elfeed-kill-buffer |
|
| [[kbd:][q]] | elfeed-kill-buffer |
|
||||||
| r | elfeed-search-update--force |
|
| [[kbd:][r]] | elfeed-search-update--force |
|
||||||
| g c | Copy link of current entry |
|
| [[kbd:][g c]] | Copy link of current entry |
|
||||||
|
|
||||||
** News filtering
|
** News filtering
|
||||||
+ Time filtering
|
+ Time filtering
|
||||||
|
|
@ -106,9 +117,18 @@ When using ~+org~ flag then configuration is easier. You can use ~org-mode~ to c
|
||||||
+ Exclude ~!something~
|
+ Exclude ~!something~
|
||||||
|
|
||||||
** Automatically updating feed when opening elfeed
|
** Automatically updating feed when opening elfeed
|
||||||
Hook ~elfeed-update~ to ~elfeed-search-mode-hook~
|
Hook ~elfeed-update~ to ~elfeed-search-mode-hook~:
|
||||||
#+BEGIN_SRC elisp
|
#+begin_src emacs-lisp
|
||||||
(add-hook! 'elfeed-search-mode-hook 'elfeed-update)
|
(add-hook 'elfeed-search-mode-hook #'elfeed-update)
|
||||||
#+END_SRC
|
#+end_src
|
||||||
|
|
||||||
* TODO Troubleshooting
|
* 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,96 +1,103 @@
|
||||||
#+TITLE: app/twitter
|
← [[doom-module-index:][Back to module index]] ↙ [[doom-module-issues:::app twitter][Issues]] ↖ [[doom-module-source:app/twitter][Source]] ± [[doom-suggest-edit:][Suggest edits]] ? [[doom-help-modules:][Help]]
|
||||||
#+DATE: October 11, 2019
|
--------------------------------------------------------------------------------
|
||||||
#+SINCE: v2.0
|
#+TITLE: :app twitter
|
||||||
#+STARTUP: inlineimages
|
#+SUBTITLE: Be superficial in plain text
|
||||||
|
#+CREATED: October 11, 2019
|
||||||
|
#+SINCE: 2.0.0
|
||||||
|
|
||||||
* Table of Contents :TOC_3:noexport:
|
* Description :unfold:
|
||||||
- [[#description][Description]]
|
|
||||||
- [[#module-flags][Module Flags]]
|
|
||||||
- [[#plugins][Plugins]]
|
|
||||||
- [[#hacks][Hacks]]
|
|
||||||
- [[#prerequisites][Prerequisites]]
|
|
||||||
- [[#features][Features]]
|
|
||||||
- [[#configuration][Configuration]]
|
|
||||||
- [[#troubleshooting][Troubleshooting]]
|
|
||||||
- [[#appendix][Appendix]]
|
|
||||||
- [[#commands--keybindings][Commands & Keybindings]]
|
|
||||||
|
|
||||||
* Description
|
|
||||||
Enjoy twitter from emacs.
|
Enjoy twitter from emacs.
|
||||||
|
|
||||||
+ View various timelines side by side, e.g. user's timeline, home, etc.
|
- View various timelines side by side, e.g. user's timeline, home, etc.
|
||||||
+ Post new tweets
|
- Post new tweets
|
||||||
+ Send direct messages
|
- Send direct messages
|
||||||
+ Retweet
|
- Retweet
|
||||||
+ Follow and un-follow users
|
- Follow and un-follow users
|
||||||
+ Favorite tweets
|
- Favorite tweets
|
||||||
|
|
||||||
** Module Flags
|
** Maintainers
|
||||||
This module provides no flags.
|
/This module has no dedicated maintainers./ [[doom-contrib-maintainer:][Become a maintainer?]]
|
||||||
|
|
||||||
** Plugins
|
** Module flags
|
||||||
+ [[https://github.com/hayamiz/twittering-mode][twittering-mode]]
|
/This module has no flags./
|
||||||
+ [[https://github.com/abo-abo/avy][avy]]
|
|
||||||
|
|
||||||
** TODO Hacks
|
** Packages
|
||||||
{A list of internal modifications to included packages}
|
- [[doom-package:][avy]]
|
||||||
|
- [[doom-package:][twittering-mode]]
|
||||||
|
|
||||||
* Prerequisites
|
** Hacks
|
||||||
|
/No hacks documented for this module./
|
||||||
|
|
||||||
+ For SSL connection (required by Twitter's API), one of the followings is required:
|
** TODO Changelog
|
||||||
+ [[http://curl.haxx.se/][cURL]]
|
# This section will be machine generated. Don't edit it by hand.
|
||||||
+ [[http://www.gnu.org/software/wget/][GNU Wget]]
|
/This module does not have a changelog yet./
|
||||||
+ [[http://www.openssl.org/][OpenSSL]]
|
|
||||||
+ [[http://www.gnu.org/software/gnutls/][GnuTLS]]
|
|
||||||
+ [[http://www.gnupg.org/][GnuPG]] is required for keeping the OAuth token encrypted in local storage.
|
|
||||||
+ ~twittering-icon-mode~ converts retrieved icons into XPM by default. To
|
|
||||||
achieve this and for displaying icons in formats that are not supported by
|
|
||||||
Emacs as well as for resizing icon images, [[http://www.imagemagick.org/][ImageMagick]] is required.
|
|
||||||
|
|
||||||
To build emacs with ImageMagick support the ~--with-imagemagick~ flag needs to
|
* Installation
|
||||||
be passed to the ~configure~ script, e.g. ~./configure --with-imagemagick~.
|
[[id:01cffea4-3329-45e2-a892-95a384ab2338][Enable this module in your ~doom!~ block.]]
|
||||||
For detailed instruction on how to build Emacs from source please refer to
|
|
||||||
[[https://git.savannah.gnu.org/cgit/emacs.git/tree/INSTALL][INSTALL]] in Emacs' savannah repository.
|
|
||||||
+ For keeping retrieved icons in local storage, [[http://www.gzip.org/][gzip]] is required.
|
|
||||||
|
|
||||||
* TODO Features
|
This module requires:
|
||||||
An in-depth list of features, how to use them, and their dependencies.
|
- One of the following (for SSL connections; required by Twitter's API):
|
||||||
|
- [[http://curl.haxx.se/][cURL]]
|
||||||
|
- [[http://www.gnu.org/software/wget/][GNU Wget]]
|
||||||
|
- [[http://www.openssl.org/][OpenSSL]]
|
||||||
|
- [[http://www.gnu.org/software/gnutls/][GnuTLS]]
|
||||||
|
- [[http://www.gnupg.org/][GnuPG]], for encrypting the OAuth token, stored locally.
|
||||||
|
- [[http://www.gzip.org/][gzip]], for compressing retrieved profile pictures,
|
||||||
|
- [[http://www.imagemagick.org/][ImageMagick]], for displaying and resizing profile pictures.
|
||||||
|
|
||||||
|
Build Emacs with ImageMagick support using the ~--with-imagemagick~ flag ([[https://git.savannah.gnu.org/cgit/emacs.git/tree/INSTALL][how
|
||||||
|
to build Emacs from source]]).
|
||||||
|
|
||||||
|
* TODO Usage
|
||||||
|
#+begin_quote
|
||||||
|
🔨 This module has no usage documentation yet. [[doom-contrib-module:][Write some?]]
|
||||||
|
#+end_quote
|
||||||
|
|
||||||
* TODO Configuration
|
* TODO Configuration
|
||||||
How to configure this module, including common problems and how to address them.
|
#+begin_quote
|
||||||
|
🔨 /This module's configuration documentation is incomplete./ [[doom-contrib-module:][Complete it?]]
|
||||||
|
#+end_quote
|
||||||
|
|
||||||
* Troubleshooting
|
|
||||||
Currently ~twittering-mode~ binds =SPC=, breaking its functionality as a leader
|
|
||||||
key. To work around this issue you may use =M-SPC= instead when in
|
|
||||||
~twittering-mode~.
|
|
||||||
|
|
||||||
* Appendix
|
|
||||||
** Commands & Keybindings
|
** Commands & Keybindings
|
||||||
Here is a list of available commands and their default keybindings (defined in
|
Here is a list of available commands and their default keybindings (defined in
|
||||||
[[./config.el][config.el]]).
|
[[./config.el][config.el]]):
|
||||||
|
|
||||||
| command | key / ex command | description |
|
| command | key / ex command | description |
|
||||||
|---------------------+------------------+-------------------------------------------------------------|
|
|---------------------+------------------+-------------------------------------------------------------|
|
||||||
| ~+twitter/quit~ | =q= | Close current window |
|
| ~+twitter/quit~ | [[kbd:][q]] | Close current window |
|
||||||
| ~+twitter/quit-all~ | =Q= | Close all twitter windows and buffers, and delete workspace |
|
| ~+twitter/quit-all~ | [[kbd:][Q]] | Close all twitter windows and buffers, and delete workspace |
|
||||||
|
|
||||||
And when ~:editor evil +everywhere~ is active:
|
|
||||||
|
|
||||||
|
And when [[doom-module:][:editor evil +everywhere]] is active:
|
||||||
| command | key / ex command | description |
|
| command | key / ex command | description |
|
||||||
|--------------------------------------------------+------------------+------------------------------------------------------------------|
|
|--------------------------------------------------+------------------+------------------------------------------------------------------|
|
||||||
| ~twittering-favorite~ | =f= | Favorite/Like a tweet |
|
| ~twittering-favorite~ | [[kbd:][f]] | Favorite/Like a tweet |
|
||||||
| ~twittering-unfavorite~ | =F= | Un-favorite/Un-like a tweet |
|
| ~twittering-unfavorite~ | [[kbd:][F]] | Un-favorite/Un-like a tweet |
|
||||||
| ~twittering-follow~ | =C-f= | Follow user |
|
| ~twittering-follow~ | [[kbd:][C-f]] | Follow user |
|
||||||
| ~twittering-unfollow~ | =C-F= | Un-follow user |
|
| ~twittering-unfollow~ | [[kbd:][C-F]] | Un-follow user |
|
||||||
| ~twittering-delete-status~ | =d= | Delete a tweet |
|
| ~twittering-delete-status~ | [[kbd:][d]] | Delete a tweet |
|
||||||
| ~twittering-retweet~ | =r= | Retweet |
|
| ~twittering-retweet~ | [[kbd:][r]] | Retweet |
|
||||||
| ~twittering-toggle-or-retrieve-replied-statuses~ | =R= | Toggle or retrieve replies |
|
| ~twittering-toggle-or-retrieve-replied-statuses~ | [[kbd:][R]] | Toggle or retrieve replies |
|
||||||
| ~twittering-update-status-interactive~ | =o= | Update tweets |
|
| ~twittering-update-status-interactive~ | [[kbd:][o]] | Update tweets |
|
||||||
| ~+twitter/ace-link~ | =O= | Open some visible link from a ~twittering-mode~ buffer using ace |
|
| ~+twitter/ace-link~ | [[kbd:][O]] | Open some visible link from a ~twittering-mode~ buffer using ace |
|
||||||
| ~twittering-search~ | =/= | Search |
|
| ~twittering-search~ | [[kbd:][/]] | Search |
|
||||||
| ~twittering-goto-next-status~ | =J= | Go to next tweet |
|
| ~twittering-goto-next-status~ | [[kbd:][J]] | Go to next tweet |
|
||||||
| ~twittering-goto-previous-status~ | =K= | Go to previous tweet |
|
| ~twittering-goto-previous-status~ | [[kbd:][K]] | Go to previous tweet |
|
||||||
| ~twittering-goto-first-status~ | =gg= | Go to first tweet |
|
| ~twittering-goto-first-status~ | [[kbd:][gg]] | Go to first tweet |
|
||||||
| ~twittering-goto-last-status~ | =G= | Go to last tweet |
|
| ~twittering-goto-last-status~ | [[kbd:][G]] | Go to last tweet |
|
||||||
| ~twittering-goto-next-status-of-user~ | =gj= | Go to next tweet of user |
|
| ~twittering-goto-next-status-of-user~ | [[kbd:][gj]] | Go to next tweet of user |
|
||||||
| ~twittering-goto-previous-status-of-user)))~ | =gk= | Go to previous tweet of user |
|
| ~twittering-goto-previous-status-of-user)))~ | [[kbd:][gk]] | Go to previous tweet of user |
|
||||||
|
|
||||||
|
* Troubleshooting
|
||||||
|
[[doom-report:][Report an issue?]]
|
||||||
|
|
||||||
|
** ~twittering-mode~ overrides the [[kbd:][SPC]] key
|
||||||
|
Currently ~twittering-mode~ binds [[kbd:][SPC]], breaking its functionality as a leader
|
||||||
|
key for evil users. To work around this issue you may use [[kbd:][M-SPC]] instead.
|
||||||
|
|
||||||
|
* 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