KittyPatch/kitty
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

Documentation work

Browse Source
This commit is contained in:
Kovid Goyal 2018-05-31 08:40:32 +05:30
parent 087f13f293
commit 77d149518c
No known key found for this signature in database
GPG Key ID: 06BC317B515ACE7C
3 changed files with 12 additions and 11 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
docs/conf.rst
View File

@ -15,6 +15,8 @@ You can also display the current configuration by running ``kitty
:language: ini
.. _confloc:
|kitty| looks for a config file in the OS config directories (usually
:file:`~/.config/kitty/kitty.conf` and additionally
:file:`~/Library/Preferences/kitty/kitty.conf` on macOS) but you can pass a

19
docs/kittens/diff.rst
View File

@ -89,9 +89,9 @@ Restore default context ``=``
Configuring kitty-diff
------------------------
You can configure the colors used, keyboard shortcut, the diff implementation,
the default lines of context, etc. by creating a diff.conf in your kitty
config folder. The default diff.conf is below.
You can configure the colors used, keyboard shortcuts, the diff implementation,
the default lines of context, etc. by creating a diff.conf in your :ref:`kitty
config folder <confloc>`. The default :file:`diff.conf` is below.
.. literalinclude:: ../../kittens/diff/diff.conf
:language: ini
@ -126,13 +126,12 @@ Once again, creating an alias for this command is useful.
Why does this work only in kitty?
----------------------------------------
The diff kitten makes use of various features that are
:doc:`kitty only </protocol-extensions>`, such as the
:doc:`kitty graphics protocol </graphics-protocol>`,
the extended keyboard protocol, etc. It also leverages
terminal program infrastructure I created for all of kitty's other kittens to
reduce the amount of code needed (the entire implementation is under 2000 lines
of code).
The diff kitten makes use of various features that are :doc:`kitty only
</protocol-extensions>`, such as the :doc:`kitty graphics protocol
</graphics-protocol>`, the :ref:`extended keyboard protocol
<extended-key-protocol>`, etc. It also leverages terminal program
infrastructure I created for all of kitty's other kittens to reduce the amount
of code needed (the entire implementation is under 2000 lines of code).
And fundamentally, it's kitty only because I wrote it for myself, and I am
highly unlikely to use any other terminals :)

2
docs/protocol-extensions.rst
View File

@ -71,7 +71,7 @@ include:
* No way to use modifiers other than ``Ctrl`` and ``Alt``
* No way to use multiple modifier keys, other than, ``Shift+Alt``.
* No way to reliably use multiple modifier keys, other than, ``Shift+Alt``.
* No way to handle different types of keyboard events, such as press, release or repeat