diff --git a/.travis.yml b/.travis.yml index ec1507fee..0cf432341 100644 --- a/.travis.yml +++ b/.travis.yml @@ -142,7 +142,7 @@ before_script: - $PYTHON setup.py build --debug --verbose $SANITIZE_ARG; script: - - if grep -Inr '\s$' kitty kitty_tests *.py *.asciidoc .gitattributes .gitignore; then echo Trailing whitespace found, aborting.; exit 1; fi + - if grep -Inr '\s$' kitty kitty_tests kittens docs *.py *.asciidoc *.rst .gitattributes .gitignore; then echo Trailing whitespace found, aborting.; exit 1; fi - if [[ -z $SANITIZE_ARG ]]; then $PYTHON test.py; else ./asan-launcher test.py; fi - if [[ "$RUN_FLAKE" == "1" ]]; then flake8 --count .; fi - if [[ "$BUILD_PKG" == "1" ]]; then $PYTHON setup.py linux-package; fi diff --git a/docs/_static/custom.css b/docs/_static/custom.css index 4666f1eac..a3d4aa9ab 100644 --- a/docs/_static/custom.css +++ b/docs/_static/custom.css @@ -37,7 +37,7 @@ img[style] { height: auto !important; } -a { +a { text-decoration: none !important; border-bottom: none !important; } diff --git a/docs/binary.rst b/docs/binary.rst index 33da80930..f7db62272 100644 --- a/docs/binary.rst +++ b/docs/binary.rst @@ -12,11 +12,11 @@ the following simple command: :class: pre |ins| - + The binaries will be installed in the standard location for your OS, :file:`/Applications/kitty.app` on macOS and :file:`~/.local/kitty.app` on -Linux. The installer only touches files in that directory. +Linux. The installer only touches files in that directory. Customizing the installation diff --git a/docs/build.rst b/docs/build.rst index 676fada38..2cd799e38 100644 --- a/docs/build.rst +++ b/docs/build.rst @@ -25,8 +25,8 @@ Run-time dependencies: Build-time dependencies: - * gcc or clang - * pkg-config + * gcc or clang + * pkg-config * For building on Linux in addition to the above dependencies you might also need to install the ``-dev`` packages for: ``libxcursor-dev``, ``libxrandr-dev``, ``libxi-dev``, ``libxinerama-dev``, ``libgl1-mesa-dev`` and ``libxkbcommon-x11-dev``, if they are not already installed by your distro. diff --git a/docs/changelog.rst b/docs/changelog.rst index c8c586c6e..a0185508e 100644 --- a/docs/changelog.rst +++ b/docs/changelog.rst @@ -10,7 +10,7 @@ Changelog (:iss:`595`) - A :doc:`new kitten ` to create dock panels on X11 desktops showing the output from - arbitrary terminal programs. + arbitrary terminal programs. - Reduce data sent to the GPU per render by 30% (:commit:`8dea5b3`) @@ -72,7 +72,7 @@ Changelog be disabled for all OS windows in a kitty instance after the first window (:iss:`571`) -- Fix Ctrl+Alt+Space not working in normal and application keyboard modes +- Fix Ctrl+Alt+Space not working in normal and application keyboard modes (:iss:`562`) @@ -117,10 +117,10 @@ Changelog Arabic is never going to be perfect, but now it is at least readable. - Fix Ctrl+backspace acting as plain backspace in normal and application - keyboard modes (:iss:`538`). + keyboard modes (:iss:`538`). - Have the paste_from_selection action paste from the clipboard on platforms - that do not have a primary selection such as Wayland and macOS + that do not have a primary selection such as Wayland and macOS (:iss:`529`) - Fix cursor_stop_blinking_after=0 not working (:iss:`530`) @@ -172,7 +172,7 @@ Changelog - Fix Shift+function key not working - Support the F13 to F25 function keys - + - Don't fail to start if the user deletes the hintstyle key from their fontconfig configuration. @@ -191,7 +191,7 @@ Changelog - Ignore -e if it is specified on the command line. This is for compatibility with broken software that assumes terminals should run with an -e option to - execute commands instead of just passing the commands as arguments. + execute commands instead of just passing the commands as arguments. 0.9.0 [2018-04-15] @@ -284,11 +284,11 @@ Changelog - Add configurable keyboard shortcuts to switch to a specific layout -- Add a keyboard shortcut to edit the kitty config file easily +- Add a keyboard shortcut to edit the kitty config file easily - macOS: Fix restoring of window size not correct on Retina screens -- macOS: Add a facility to specify command line arguments when running kitty from the GUI +- macOS: Add a facility to specify command line arguments when running kitty from the GUI - Add a focus-tab remote command @@ -321,7 +321,7 @@ Changelog - Wayland: Add support for window decorations provided by the Wayland shell -- macOS: Fix URL hints not working +- macOS: Fix URL hints not working - macOS: Fix shell not starting in login mode on some computers @@ -398,7 +398,7 @@ Changelog - Add "Horizontal" and "Vertical" window layouts -- Sessions: Allow setting titles and working directories for individual windows +- Sessions: Allow setting titles and working directories for individual windows - Option to copy to clipboard on mouse select @@ -435,7 +435,7 @@ Changelog - Add an option to fade the text in inactive windows -- Add new actions to open windows/tabs/etc. with the working directory set to +- Add new actions to open windows/tabs/etc. with the working directory set to the working directory of the current window. - Automatically adjust cell size when DPI changes, for example when kitty is @@ -500,7 +500,7 @@ Changelog - Add an option to control the underline style for URL highlighting on hover -- X11: Set the WINDOWID environment variable +- X11: Set the WINDOWID environment variable - Fix middle and right buttons swapped when sending mouse events to child processes @@ -565,7 +565,7 @@ Changelog - Fix a regression in 0.4.0 that broke custom key mappings -- Fix a regression in 0.4.0 that broke support for non-QWERTY keyboard layouts +- Fix a regression in 0.4.0 that broke support for non-QWERTY keyboard layouts - Avoid using threads to reap zombie child processes. Also prevent kitty from hanging if the open program hangs when clicking on a URL. @@ -579,7 +579,7 @@ Changelog ssh connections and files/shared memory (when available) for better performance. The drawing primitives support alpha blending and z-index. Images can be drawn both above and below text. See :doc:`graphics-protocol`. - for details. + for details. - Refactor kitty's internals to make it even faster and more efficient. The CPU usage of kitty + X server while doing intensive tasks such as scrolling a diff --git a/docs/conf.rst b/docs/conf.rst index ba0af3849..849eca997 100644 --- a/docs/conf.rst +++ b/docs/conf.rst @@ -21,5 +21,5 @@ You can also display the current configuration by running ``kitty :file:`~/.config/kitty/kitty.conf` and additionally :file:`~/Library/Preferences/kitty/kitty.conf` on macOS) but you can pass a specific path via the :option:`kitty --config` option or use the ``KITTY_CONFIG_DIRECTORY`` -environment variable. See the :option:`kitty --config` option -for full details. +environment variable. See the :option:`kitty --config` option +for full details. diff --git a/docs/graphics-protocol.rst b/docs/graphics-protocol.rst index 938daca1a..88f33bb2d 100644 --- a/docs/graphics-protocol.rst +++ b/docs/graphics-protocol.rst @@ -346,9 +346,9 @@ Key Value Default Description **Keys for image transmission** ----------------------------------------------------------- ``f`` Positive integer. ``32`` The format in which the image data is sent. - ``(24, 32, 100)``. + ``(24, 32, 100)``. ``t`` Single character. ``d`` The transmission medium used. - ``(d, f, t, s)``. + ``(d, f, t, s)``. ``s`` Positive integer. ``0`` The width of the image being sent. ``v`` Positive integer. ``0`` The height of the image being sent. ``S`` Positive integer. ``0`` The size of data to read from a file. @@ -356,7 +356,7 @@ Key Value Default Description ``i`` Positive integer. ``(0 - 4294967295)`` ``0`` The image id ``o`` Single character. ``null`` The type of data compression. - ``only z`` + ``only z`` ``m`` zero or one ``0`` Whether there is more chunked data available. **Keys for image display** ----------------------------------------------------------- @@ -374,7 +374,7 @@ Key Value Default Description ``d`` Single character. ``a`` What to delete. ``(a, A, c, C, p, P, q, Q, x, X, y, - Y, z, Z)``. + Y, z, Z)``. ======= ==================== ========= ================= diff --git a/docs/index.rst b/docs/index.rst index cf898ef8a..bbe7cf20a 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -54,7 +54,7 @@ page `_. If you are on Linux, install the |kitty| package if your distro provides it, otherwise follow the :doc:`Build from source instructions `. |kitty| -packages are available for: +packages are available for: `Debian `_, `openSUSE `_, `Arch Linux `_, @@ -146,7 +146,7 @@ Previous window |sc_previous_window| Move window forward |sc_move_window_forward| Move window backward |sc_move_window_backward| Move window to top |sc_move_window_to_top| -Focus specific window |sc_first_window|, |sc_second_window| ... |sc_tenth_window| +Focus specific window |sc_first_window|, |sc_second_window| ... |sc_tenth_window| (clockwise from the top-left) ======================== ======================= @@ -231,7 +231,7 @@ Some prominent kittens: :doc:`diff ` A fast, side-by-side diff for the terminal with syntax highlighting and - images + images :doc:`Unicode Input ` @@ -320,7 +320,7 @@ Colors and text formatting are preserved. You can explore the scrollback buffer comfortably within the pager. -Frequently Asked Questions +Frequently Asked Questions --------------------------------- The list of Frequently Asked Questions (*FAQ*) is :doc:`available here `. diff --git a/docs/kittens/icat.rst b/docs/kittens/icat.rst index 8d9ea700c..1bff7dbf6 100644 --- a/docs/kittens/icat.rst +++ b/docs/kittens/icat.rst @@ -10,7 +10,7 @@ It supports all image types supported by `ImageMagick `_. It even works over SSH. For details, see the :doc:`kitty graphics protocol `. -.. note:: +.. note:: `ImageMagick `_ must be installed for ``icat`` to work. diff --git a/docs/kittens/unicode-input.rst b/docs/kittens/unicode-input.rst index d21091cac..21865d8f6 100644 --- a/docs/kittens/unicode-input.rst +++ b/docs/kittens/unicode-input.rst @@ -19,4 +19,4 @@ typing a leading period and then the two character index and pressing Enter. In *Name* mode you instead type words from the character name and use the arrow keys/tab to select the character from the displayed matches. You can also type a leading period and the index for the match if you dont like to use arrow -keys. +keys. diff --git a/kitty/threading.h b/kitty/threading.h index 085fe9c27..1416e2cfe 100644 --- a/kitty/threading.h +++ b/kitty/threading.h @@ -14,7 +14,7 @@ extern int pthread_setname_np(const char *name); #elif defined(__FreeBSD__) // Function has a different name on FreeBSD void pthread_set_name_np(pthread_t tid, const char *name); -#else +#else // Need _GNU_SOURCE for pthread_setname_np on linux and that causes other issues on systems with old glibc extern int pthread_setname_np(pthread_t, const char *name); #endif