From 21d7cc1a60f9632f49c69702e13af094fc0e2a16 Mon Sep 17 00:00:00 2001 From: Kovid Goyal Date: Wed, 30 May 2018 09:44:53 +0530 Subject: [PATCH] Configure the alabaster theme a bit And remove duplicated FAQ from README --- README.asciidoc | 112 ------------------------------------------------ docs/conf.py | 7 ++- 2 files changed, 5 insertions(+), 114 deletions(-) diff --git a/README.asciidoc b/README.asciidoc index fbd55861b..0d90b0eea 100644 --- a/README.asciidoc +++ b/README.asciidoc @@ -4,118 +4,6 @@ image::https://travis-ci.org/kovidgoyal/kitty.svg?branch=master[Build status, li -== Frequently Asked Questions - -=== Some special symbols are rendered small/truncated in kitty? - -The number of cells a unicode character takes up are controlled by the unicode -standard. All characters are rendered in a single cell unless the unicode -standard says they should be rendered in two cells. When a symbol does not fit, -it will either be rescaled to be smaller or truncated (depending on how much -extra space it needs). This is often different from other terminals which just -let the character overflow into neighboring cells, which is fine if the -neighboring cell is empty, but looks terrible if it is not. - -Some programs, like powerline, vim with fancy gutter symbols/status-bar, etc. -misuse unicode characters from the private use area to represent symbols. Often -these symbols are square and should be rendered in two cells. However, since -private use area symbols all have their width set to one in the unicode -standard, kitty renders them either smaller or truncated. The exception is if -these characters are followed by a space or empty cell in which case kitty -makes use of the extra cell to render them in two cells. - -=== How do I build kitty.app on macOS? - -Install `imagemagick`, `optipng` and `librsvg` using `brew` or similar (needed for the logo generation step). - -And run: -``` -make app -``` - -This `kitty.app` unlike the released one does not include its own copy of -python and the other dependencies. So if you ever un-install/upgrade those dependencies -you might have to rebuild the app. - -Note that the released kitty.dmg includes all dependencies, unlike the -`kitty.app` built above and is built automatically by using the `kitty` branch of -link:https://github.com/kovidgoyal/build-calibre[build-calibre] however, that -is designed to run on Linux and is not for the faint of heart. - - -=== Using a color theme with a background color does not work well in vim? - -First make sure you have not changed the TERM environment variable, it should -be `xterm-kitty`. vim uses *background color erase* even if the terminfo file -does not contain the `bce` capability. This is a bug in vim. You can work around -it by adding the following to your vimrc: - -.... -let &t_ut='' -.... - -See link:https://github.com/kovidgoyal/kitty/blob/master/protocol-extensions.asciidoc#setting-text-styles-colors-in-arbitrary-regions-of-the-screen[here] -for why kitty does not support background color erase. - -=== I get errors about the terminal being unknown or opening the terminal failing when SSHing into a different computer? - -This happens because the kitty terminfo files are not available on the server. -You can ssh in using the following command which will automatically copy the -terminfo files to the server: - -.... -kitty +kitten ssh myserver -.... - -If for some reason that does not work (typically because the server is using a -very limited shell), you can use the following one-liner instead (it is slower -as it needs to ssh into the server twice, but will work with most servers). - -.... -infocmp xterm-kitty | ssh myserver tic -x -o \~/.terminfo /dev/stdin -.... - -Really, the correct solution for this is to convince the OpenSSH maintainers to -have ssh do this automatically when connecting to a server, so that all -terminals work transparently. - - -=== How do I change the colors in a running kitty instance? - -You can either use the -link:http://invisible-island.net/xterm/ctlseqs/ctlseqs.html#h2-Operating-System-Commands[OSC -terminal escape codes] to set colors or you can enable link:remote-control.asciidoc[remote control] -for kitty and use `kitty @ set-colors --help`. - - -=== How do I specify command line options for kitty on macOS? - -Apple does not want you to use command line options with GUI applications. To -workaround that limitation, kitty will read command line options from the file -`/macos-launch-services-cmdline` when it is launched -from the GUI, i.e. by clicking the kitty application icon or using `open -a kitty`. -Note that this file is *only read* when running via the GUI. - -You can, of course, also run kitty from a terminal with command line options, using: -`/Applications/kitty.app/Contents/MacOS/kitty`. - -And within kitty itself, you can always run kitty using just `kitty` as it -cleverly adds itself to the PATH. - - -=== kitty is not able to use my favorite font? - -kitty achieves its stellar performance by caching alpha masks of each rendered -character on the GPU, so that every character needs to be rendered only once. -This means it is a strictly character cell based display. As such it can use -only monospace fonts, since every cell in the grid has to be the same size. If -your font is not listed in `kitty list-fonts` it means that it is not -monospace. On Linux you can list all monospace fonts with, - -``` -fc-list : family spacing | grep spacing=100 -``` - == Resources on terminal behavior http://invisible-island.net/xterm/ctlseqs/ctlseqs.html diff --git a/docs/conf.py b/docs/conf.py index db1c07b88..a841d509d 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -103,8 +103,11 @@ html_theme_options = { 'show_powered_by': False, 'fixed_sidebar': True, 'sidebar_collapse': True, - 'analytics_id': 'UA-20736318-1', - 'github_button': True, + 'analytics_id': 'UA-20736318-2', + 'github_button': False, + 'github_banner': True, + 'github_user': 'kovidgoyal', + 'github_repo': 'kitty', }