More docs cleanups

This commit is contained in:
Kovid Goyal 2021-07-19 09:08:55 +05:30
parent 94f8fb4a4b
commit d912d96f00
No known key found for this signature in database
GPG Key ID: 06BC317B515ACE7C
6 changed files with 21 additions and 16 deletions

View File

@ -65,7 +65,9 @@ System and data visualisation tools
`gnuplot <http://www.gnuplot.info/>`_ `gnuplot <http://www.gnuplot.info/>`_
a graphing and data visualization tool that can be made to display its a graphing and data visualization tool that can be made to display its
output in kitty with the following bash snippet:: output in kitty with the following bash snippet:
.. code-block:: sh
function iplot { function iplot {
cat <<EOF | gnuplot cat <<EOF | gnuplot
@ -79,7 +81,9 @@ System and data visualisation tools
EOF EOF
} }
Add this to bashrc and then to plot a function, simply do:: Add this to bashrc and then to plot a function, simply do:
.. code-block:: sh
iplot 'sin(x*3)*exp(x*.2)' iplot 'sin(x*3)*exp(x*.2)'

View File

@ -1,6 +1,8 @@
broadcast - type text in all kitty windows broadcast
================================================== ==================================================
*Type text in all kitty windows simultaneously*
The ``broadcast`` kitten can be used to type text simultaneously in The ``broadcast`` kitten can be used to type text simultaneously in
all kitty windows (or a subset as desired). all kitty windows (or a subset as desired).

View File

@ -1,6 +1,8 @@
clipboard - copy/paste to the system clipboard clipboard
================================================== ==================================================
*Copy/paste to the system clipboard from shell scripts*
.. highlight:: sh .. highlight:: sh

View File

@ -27,9 +27,6 @@ you can switch layouts using :sc:`next_layout`. To control which layouts
are available use :opt:`enabled_layouts`, the first listed layout becomes are available use :opt:`enabled_layouts`, the first listed layout becomes
the default. Individual layouts and how to use them are described below. the default. Individual layouts and how to use them are described below.
.. contents::
:local:
The Stack Layout The Stack Layout
------------------ ------------------

View File

@ -89,12 +89,11 @@ The syntax of the :code:`toggle_marker` command is::
Here :code:`marker-type` is one of: Here :code:`marker-type` is one of:
* :code:`text` - simple substring matching * :code:`text` - simple substring matching
* :code:`itext` - case-insensitive substring matching * :code:`itext` - case-insensitive substring matching
* :code:`regex` - A python regular expression * :code:`regex` - A python regular expression
* :code:`iregex` - A case-insensitive python regular expression * :code:`iregex` - A case-insensitive python regular expression
* :code:`function` - An arbitrary function defined in a python file, see * :code:`function` - An arbitrary function defined in a python file, see :ref:`marker_funcs`.
:ref:`marker_funcs`.
.. _marker_funcs: .. _marker_funcs:

View File

@ -209,11 +209,12 @@ Note that when calling this from another program, be very
careful not to perform any I/O on the terminal device careful not to perform any I/O on the terminal device
until the kitten exits. until the kitten exits.
Available queries are:: Available queries are:
{} {}
'''.format(' ' + '\n '.join(
f'{name}: {c.help_text}' for name, c in all_queries.items())) '''.format('\n'.join(
f'``{name}``\n {c.help_text}\n' for name, c in all_queries.items()))
usage = '[query1 query2 ...]' usage = '[query1 query2 ...]'