Change kitty +kitten -> kitten in docs

All kittens except for the broadcast and panel kittens have now been
ported to Go and so can be run with just kitten rather than kitty
+kitten. So update the docs to use this canonical form for launching
kittens
This commit is contained in:
Kovid Goyal
2023-09-21 12:25:02 +05:30
parent eb05f6864f
commit 0a2f164062
18 changed files with 45 additions and 45 deletions

View File

@@ -9,13 +9,13 @@ clipboard
The ``clipboard`` kitten can be used to read or write to the system clipboard
from the shell. It even works over SSH. Using it is as simple as::
echo hooray | kitty +kitten clipboard
echo hooray | kitten clipboard
All text received on :file:`STDIN` is copied to the clipboard.
To get text from the clipboard::
kitty +kitten clipboard --get-clipboard
kitten clipboard --get-clipboard
The text will be written to :file:`STDOUT`. Note that by default kitty asks for
permission when a program attempts to read the clipboard. This can be
@@ -29,22 +29,22 @@ more than just plain text from the system clipboard. You can transfer arbitrary
data types. Best illustrated with some examples::
# Copy an image to the clipboard:
kitty +kitten clipboard picture.png
kitten clipboard picture.png
# Copy an image and some text to the clipboard:
kitty +kitten clipboard picture.jpg text.txt
kitten clipboard picture.jpg text.txt
# Copy text from STDIN and an image to the clipboard:
echo hello | kitty +kitten clipboard picture.png /dev/stdin
echo hello | kitten clipboard picture.png /dev/stdin
# Copy any raster image available on the clipboard to a PNG file:
kitty +kitten clipboard -g picture.png
kitten clipboard -g picture.png
# Copy an image to a file and text to STDOUT:
kitty +kitten clipboard -g picture.png /dev/stdout
kitten clipboard -g picture.png /dev/stdout
# List the formats available on the system clipboard
kitty +kitten clipboard -g -m . /dev/stdout
kitten clipboard -g -m . /dev/stdout
Normally, the kitten guesses MIME types based on the file names. To control the
MIME types precisely, use the :option:`--mime <kitty +kitten clipboard --mime>` option.

View File

@@ -39,7 +39,7 @@ Usage
In the kitty terminal, run::
kitty +kitten diff file1 file2
kitten diff file1 file2
to see the diff between :file:`file1` and :file:`file2`.
@@ -48,7 +48,7 @@ example:
.. code-block:: sh
alias d="kitty +kitten diff"
alias d="kitten diff"
Now all you need to do to diff two files is::
@@ -103,9 +103,9 @@ Add the following to :file:`~/.gitconfig`:
prompt = false
trustExitCode = true
[difftool "kitty"]
cmd = kitty +kitten diff $LOCAL $REMOTE
cmd = kitten diff $LOCAL $REMOTE
[difftool "kitty.gui"]
cmd = kitty kitty +kitten diff $LOCAL $REMOTE
cmd = kitten diff $LOCAL $REMOTE
Now to use kitty-diff to view git diffs, you can simply do::

View File

@@ -26,7 +26,7 @@ following contents:
Now, run a search with::
kitty +kitten hyperlinked_grep something
kitten hyperlinked_grep something
Hold down the :kbd:`Ctrl+Shift` keys and click on any of the result lines, to
open the file in :program:`vim` at the matching line. If you use some editor
@@ -36,7 +36,7 @@ accordingly.
Finally, add an alias to your shell's rc files to invoke the kitten as
:command:`hg`::
alias hg="kitty +kitten hyperlinked_grep"
alias hg="kitten hyperlinked_grep"
You can now run searches with::

View File

@@ -6,7 +6,7 @@ icat
The ``icat`` kitten can be used to display arbitrary images in the |kitty|
terminal. Using it is as simple as::
kitty +kitten icat image.jpeg
kitten icat image.jpeg
kitten icat image.jpeg
It supports all image types supported by `ImageMagick
@@ -15,7 +15,7 @@ It supports all image types supported by `ImageMagick
You might want to create an alias in your shell's configuration files::
alias icat="kitty +kitten icat"
alias icat="kitten icat"
Then you can simply use ``icat image.png`` to view images.

View File

@@ -33,14 +33,14 @@ To try it out, simply run:
.. code-block:: sh
kitty +kitten ssh some-hostname-to-connect-to
kitten ssh some-hostname-to-connect-to
You should end up at a shell prompt on the remote host, with shell integration
enabled. If you like it you can add an alias to it in your shell's rc files:
.. code-block:: sh
alias s="kitty +kitten ssh"
alias s="kitten ssh"
So now you can just type ``s hostname`` to connect.
@@ -79,7 +79,7 @@ Additionally, you can pass config options on the command line:
.. code-block:: sh
kitty +kitten ssh --kitten interpreter=python servername
kitten ssh --kitten interpreter=python servername
The :code:`--kitten` argument can be specified multiple times, with directives
from :file:`ssh.conf`. These override the final options used for the matched host, as if they

View File

@@ -5,7 +5,7 @@ The themes kitten allows you to easily change color themes, from a collection of
over three hundred pre-built themes available at `kitty-themes
<https://github.com/kovidgoyal/kitty-themes>`_. To use it, simply run::
kitty +kitten themes
kitten themes
.. image:: ../screenshots/themes.png
@@ -72,7 +72,7 @@ Changing the theme non-interactively
You can specify the theme name as an argument when invoking the kitten to have
it change to that theme instantly. For example::
kitty +kitten themes --reload-in=all Dimmed Monokai
kitten themes --reload-in=all Dimmed Monokai
Will change the theme to ``Dimmed Monokai`` in all running kitty instances. See
below for more details on non-interactive operation.