mirror of
https://github.com/mawww/kakoune.git
synced 2024-10-05 17:18:00 +03:00
Page:
Hacking
Pages
Ambiguous Keys
Annotated examples of "Kakoune script"
Avoid the escape key
Bar
Bc
Building
Clang
Community
Ctags
Distinguish between focused and unfocused clients in Tmux
Documenting Plugins
EditorConfig
Eval Exec
Fuzzy finder
Git integration via Tig
Grep
HTML editing
Hacking
Header files
Highlighters
Home
IDE
Implementing user mode
Increment and Decrement
Indentation and Tabulation
Info boxes
Installing Plugins
Integrating Other CLI apps
JSON RPC
Jumplist
Kak daemon helper : 1 session per project
Languages
Line flags
Manipulating dates with Chronic
Migrating from Vim popular plugins
Migrating from Vim
Normal mode commands
OpenBSD
Plugin Managers
Qalculate
Ranger
Readline
Regex
Registers & Clipboard
Registers Clipboard
Reverse search
Running commands at startup
Rust
Selections combinations
Selections
Setting Plugin Options
Shell scripting
Status line
String syntax
TUI
The window scope
Tips for building from source
Undo tree
Wc
Windows tips
Wrapping
Writing Plugins
kak ‐p
macOS tips
zsh zle
4
Hacking
Johannes Altmanninger edited this page 2022-08-07 19:46:14 +02:00
Table of Contents
C++ tooling setup
If you want to use Clang tools (e.g. clangd via kak-lsp) to hack on Kakoune's C++ sources. you'll need to create a compile_commands.json
file so the Clang tool will use the correct build flags.
One solution is to wrap your make
invocations with bear:
bear -- make debug=yes clean all
Another solution is to teach the build system to output compile_commands.json
.
GDB
For debugging interactive scenarios that don't have tests yet you can usegdbserver
:
gdbserver :2345 ./kak; reset
(If Kakoune crashes, it might not be able to reset terminal modes. The reset
takes care of that.)
Then, connect to gdbserver
from another terminal
gdb -ex 'target remote :2345'
Since this is a remote target, gdbserver will by default fail to pick up pretty printers (for both stdlib and Kakoune types).
To fix this, add this to your ~/.gdbinit
(or to src/.gdbinit
):
set sysroot
Wiki Home Page
Onboarding
Keys
- Normal mode commands
- Avoid the escape key
- Implementing user mode (Leader key)
- Kakoune explain
- Kakoune TV
Editing
User Interface
Integration with OS and other tools
- Languages
- IDE
- Bar
- Kak daemon helper : 1 session per project
- Registers & Clipboard
- macOS tips
- Windows tips
- Fuzzy finders
- JSON-RPC UI
- bc
- Qalculate!
- wc
- Shell Scripting
- Manipulating dates with Chronic
- Integrating Other CLI apps