2019-01-03 01:54:02 -05:00
|
|
|
#+TITLE: ui/modeline
|
|
|
|
|
#+DATE: July 29, 2018
|
|
|
|
|
#+SINCE: v2.0.9
|
|
|
|
|
#+STARTUP: inlineimages
|
|
|
|
|
|
|
|
|
|
* Table of Contents :TOC_2:noexport:
|
|
|
|
|
- [[Description][Description]]
|
|
|
|
|
- [[Module Flags][Module Flags]]
|
|
|
|
|
- [[Plugins][Plugins]]
|
|
|
|
|
- [[Prerequisites][Prerequisites]]
|
|
|
|
|
- [[Usage][Usage]]
|
|
|
|
|
- [[Hiding the modeline][Hiding the modeline]]
|
|
|
|
|
- [[Switching the modeline and header line][Switching the modeline and header line]]
|
|
|
|
|
- [[Configuration][Configuration]]
|
|
|
|
|
- [[Changing the default modeline][Changing the default modeline]]
|
|
|
|
|
- [[Activating a format][Activating a format]]
|
|
|
|
|
- [[Defining a modeline format][Defining a modeline format]]
|
|
|
|
|
- [[Defining a modeline segment][Defining a modeline segment]]
|
|
|
|
|
- [[Extracting Doom's modeline into your config][Extracting Doom's modeline into your config]]
|
|
|
|
|
- [[Troubleshooting][Troubleshooting]]
|
|
|
|
|
- [[Where are my minor modes?][Where are my minor modes?]]
|
|
|
|
|
- [[Icons in my modeline look strange][Icons in my modeline look strange]]
|
|
|
|
|
- [[Appendix][Appendix]]
|
|
|
|
|
- [[Commands][Commands]]
|
|
|
|
|
- [[Autodefs][Autodefs]]
|
|
|
|
|
- [[Functions][Functions]]
|
|
|
|
|
- [[Variables][Variables]]
|
|
|
|
|
- [[Faces][Faces]]
|
|
|
|
|
- [[Modeline segments][Modeline segments]]
|
|
|
|
|
|
|
|
|
|
* Description
|
|
|
|
|
This module provides an Atom-inspired, minimalistic modeline for Doom Emacs, as
|
|
|
|
|
well as an API for building your own.
|
|
|
|
|
|
|
|
|
|
+ A match count panel (for ~evil-search~, ~iedit~ and ~evil-substitute~)
|
|
|
|
|
+ An indicator for recording a macro
|
|
|
|
|
+ Local python/ruby version in the major-mode
|
|
|
|
|
+ A customizable mode-line height (see ~+doom-modeline-height~)
|
|
|
|
|
+ An error/warning count segment for flycheck
|
|
|
|
|
|
|
|
|
|
[[/../screenshots/ml.png]]
|
|
|
|
|
[[/../screenshots/ml-search.png]]
|
|
|
|
|
[[/../screenshots/ml-subst.png]]
|
|
|
|
|
[[/../screenshots/ml-macro.png]]
|
|
|
|
|
[[/../screenshots/ml-version.png]]
|
|
|
|
|
[[/../screenshots/ml-errors.png]]
|
|
|
|
|
|
|
|
|
|
** Module Flags
|
|
|
|
|
This module provides no flags.
|
|
|
|
|
|
|
|
|
|
** Plugins
|
|
|
|
|
+ [[https://github.com/syohex/emacs-anzu][anzu]]
|
|
|
|
|
+ [[https://github.com/syohex/emacs-evil-anzu][evil-anzu]]
|
|
|
|
|
+ [[https://gitlab.com/bennya/shrink-path.el][shrink-path]]
|
|
|
|
|
|
|
|
|
|
* Prerequisites
|
|
|
|
|
This module has no prerequisites.
|
|
|
|
|
|
|
|
|
|
* Usage
|
|
|
|
|
** TODO Hiding the modeline
|
|
|
|
|
|
|
|
|
|
** TODO Switching the modeline and header line
|
|
|
|
|
|
|
|
|
|
* Configuration
|
|
|
|
|
** TODO Changing the default modeline
|
|
|
|
|
|
|
|
|
|
** TODO Activating a format
|
|
|
|
|
|
|
|
|
|
** TODO Defining a modeline format
|
|
|
|
|
|
|
|
|
|
** TODO Defining a modeline segment
|
|
|
|
|
|
|
|
|
|
** TODO Extracting Doom's modeline into your config
|
|
|
|
|
|
|
|
|
|
* Troubleshooting
|
|
|
|
|
** Where are my minor modes?
|
|
|
|
|
I rarely need to know what minor modes are active, so I removed them. ~M-x
|
|
|
|
|
doom/what-minor-mode~ was written to substitute for it.
|
|
|
|
|
|
|
|
|
|
** TODO Icons in my modeline look strange
|
|
|
|
|
|
|
|
|
|
* Appendix
|
|
|
|
|
** Commands
|
|
|
|
|
This module exposes no public commands.
|
|
|
|
|
** Autodefs
|
|
|
|
|
+ ~def-modeline-format! NAME LEFT &optional RIGHT~
|
|
|
|
|
+ ~def-modeline-segment! NAME &rest REST~
|
|
|
|
|
+ ~set-modeline! NAME &optional DEFAULT~
|
|
|
|
|
** Functions
|
|
|
|
|
+ +modeline-file-path
|
|
|
|
|
** Variables
|
|
|
|
|
+ +modeline-width
|
|
|
|
|
+ +modeline-height
|
|
|
|
|
+ +modeline-buffer-path-function
|
|
|
|
|
+ +modeline-format-left
|
|
|
|
|
+ +modeline-format-rigth
|
|
|
|
|
** Faces
|
|
|
|
|
+ doom-modeline-buffer-path
|
|
|
|
|
+ doom-modeline-buffer-file
|
|
|
|
|
+ doom-modeline-buffer-modified
|
|
|
|
|
+ doom-modeline-buffer-major-mode
|
|
|
|
|
+ doom-modeline-highlight
|
|
|
|
|
+ doom-modeline-panel
|
|
|
|
|
+ doom-modeline-info
|
|
|
|
|
+ doom-modeline-warning
|
|
|
|
|
+ doom-modeline-urgent
|
|
|
|
|
+ doom-modeline-bar
|
|
|
|
|
** Modeline segments
|
|
|
|
|
+ +modeline-buffer-state
|
|
|
|
|
+ +modeline-buffer-id
|
|
|
|
|
+ +modeline-buffer-directory
|
|
|
|
|
+ +modeline-vcs
|
|
|
|
|
+ +modeline-encoding
|
|
|
|
|
+ +modeline-major-mode
|
|
|
|
|
+ +modeline-matches
|
|
|
|
|
+ +modeline-selection-info
|
