Blame


1 0e4c3d62 2022-02-26 op # Help
2 0e4c3d62 2022-02-26 op
3 0e4c3d62 2022-02-26 op Welcome to Telescope!
4 0e4c3d62 2022-02-26 op
5 0e4c3d62 2022-02-26 op Essential key bindings: arrow keys to move the cursor and read the page, > to enter an URL, B and F (uppercase) to navigate backward and forward in the history. ‘q’ to quit.
6 0e4c3d62 2022-02-26 op
7 0e4c3d62 2022-02-26 op This page is always available as
8 0e4c3d62 2022-02-26 op
9 0e4c3d62 2022-02-26 op > $ telescope about:help
10 0e4c3d62 2022-02-26 op
11 0e4c3d62 2022-02-26 op
12 0e4c3d62 2022-02-26 op ## What is Telescope?
13 0e4c3d62 2022-02-26 op
14 0e4c3d62 2022-02-26 op Telescope is a Gemini browser written for fun, as hobbystic project in my free time. As such, it lacks tons of features available in others, more mature Gemini browsers, but it also has some unique ones.
15 0e4c3d62 2022-02-26 op
16 0e4c3d62 2022-02-26 op The UI is strongly inspired from Emacs and w3m, so it’s possible to notice various familiar concepts, such as the minibuffer or the tab line. Care has been taken to make it as familiar as possible for vi and “CUA” users too.
17 0e4c3d62 2022-02-26 op
18 0e4c3d62 2022-02-26 op => gemini://telescope.omarpolo.com Telescope Project Homepage
19 0e4c3d62 2022-02-26 op
20 0e4c3d62 2022-02-26 op > Tip: move the cursor over a link and press M-RET (alt + enter) to open it in another tab. Then use [ and ] to switch between tabs.
21 0e4c3d62 2022-02-26 op
22 0e4c3d62 2022-02-26 op Telescope is documented carefully, so please refer to the manual page to know more about all the available keybindings, the format and location of the configuration file and more:
23 0e4c3d62 2022-02-26 op
24 0e4c3d62 2022-02-26 op > man telescope
25 0e4c3d62 2022-02-26 op
26 0e4c3d62 2022-02-26 op
27 0e4c3d62 2022-02-26 op ## Operate the Telescope
28 0e4c3d62 2022-02-26 op
29 0e4c3d62 2022-02-26 op By default Telescope includes various keys inspired from either Emacs or vi. However, knowledge of these editors is not required. Here’s a list of essential commands
30 0e4c3d62 2022-02-26 op
31 0e4c3d62 2022-02-26 op * > to prompt for a URL;
32 0e4c3d62 2022-02-26 op * < to edit the current URL;
33 0e4c3d62 2022-02-26 op * arrow keys to move the cursor;
34 0e4c3d62 2022-02-26 op * page up/down to scroll;
35 0e4c3d62 2022-02-26 op * tab and shift-tab to jump to the next/previous link;
36 0e4c3d62 2022-02-26 op * F and B (uppercase) to navigate forward and backward in the history;
37 0e4c3d62 2022-02-26 op * enter to open the link under the cursor;
38 0e4c3d62 2022-02-26 op * alt-enter to open the link under the cursor in a new tab;
39 0e4c3d62 2022-02-26 op * [ and ] to move between tabs;
40 0e4c3d62 2022-02-26 op * control + t to open a new tab;
41 0e4c3d62 2022-02-26 op * control + w to close the current tab;
42 0e4c3d62 2022-02-26 op * u to re-open a closed tab;
43 0e4c3d62 2022-02-26 op * q to quit.
44 0e4c3d62 2022-02-26 op
45 0e4c3d62 2022-02-26 op
46 0e4c3d62 2022-02-26 op ## Operate — Emacs version
47 0e4c3d62 2022-02-26 op
48 0e4c3d62 2022-02-26 op If you’re familiar with Emacs, most of the keybindings are available on Telescope by default! C-{b,f,n,p} works as expected, as well as C-x C-c, C-x t o, C-v/M-v and even M-x!
49 0e4c3d62 2022-02-26 op
50 0e4c3d62 2022-02-26 op
51 0e4c3d62 2022-02-26 op ## Operate — vi version
52 0e4c3d62 2022-02-26 op
53 0e4c3d62 2022-02-26 op Telescope strives to be familiar for vi/vim users too! hjkl is available by default, as well as ‘g t’, ‘g T’ etc. :tabnew, :tabn and :wq work too!
54 0e4c3d62 2022-02-26 op
55 0e4c3d62 2022-02-26 op
56 0e4c3d62 2022-02-26 op ## Appearance
57 0e4c3d62 2022-02-26 op
58 0e4c3d62 2022-02-26 op Telescope is fully customizable. The configuration file is
59 0e4c3d62 2022-02-26 op
60 0e4c3d62 2022-02-26 op > ~/.config/telescope/config
61 0e4c3d62 2022-02-26 op
62 0e4c3d62 2022-02-26 op By default Telescope doesn’t use colours too much in order to adapt to both light and dark-themed terminals. This doesn’t mean that Telescope cannot use colours though! See for example contrib/light.config and contrib/dark.config.
63 0e4c3d62 2022-02-26 op
64 0e4c3d62 2022-02-26 op
65 0e4c3d62 2022-02-26 op ## Custom pages
66 0e4c3d62 2022-02-26 op
67 0e4c3d62 2022-02-26 op > Tip: on long and structured pages like this one, try to use the ‘toc’ command. Press ‘t’ to open the table of content and jump to a specific heading.
68 0e4c3d62 2022-02-26 op
69 0e4c3d62 2022-02-26 op All the ‘about:*’ pages can be locally overridden. For example, to customise about:new create:
70 0e4c3d62 2022-02-26 op
71 0e4c3d62 2022-02-26 op > ~/.local/share/telescope/pages/about_new.gmi
72 0e4c3d62 2022-02-26 op
73 0e4c3d62 2022-02-26 op about:bookmarks is the only page that doesn’t follow this pattern; it’s located at
74 0e4c3d62 2022-02-26 op
75 0e4c3d62 2022-02-26 op > ~/.local/share/telescope/bookmarks.gmi
76 0e4c3d62 2022-02-26 op
77 0e4c3d62 2022-02-26 op
78 0e4c3d62 2022-02-26 op ## Protocol Proxies
79 0e4c3d62 2022-02-26 op
80 0e4c3d62 2022-02-26 op Telescope supports custom protocol proxies (proxies that translate between protocols). Thanks to programs like the duckling-proxy, it’s possible to navigate the web using a Gemini browser.
81 0e4c3d62 2022-02-26 op
82 0e4c3d62 2022-02-26 op => https://github.com/LukeEmmet/duckling-proxy The Duckling Proxy
83 0e4c3d62 2022-02-26 op
84 0e4c3d62 2022-02-26 op Configuring telescope to use a proxy is easy, just drop something like the following to your configuration file:
85 0e4c3d62 2022-02-26 op
86 0e4c3d62 2022-02-26 op ```Example of protocol proxy configuration for http and https
87 0e4c3d62 2022-02-26 op proxy "http" via "gemini://127.0.0.1:1965"
88 0e4c3d62 2022-02-26 op proxy "https" via "gemini://127.0.0.1:1965"
89 0e4c3d62 2022-02-26 op ```
90 0e4c3d62 2022-02-26 op
91 0e4c3d62 2022-02-26 op
92 0e4c3d62 2022-02-26 op # What is Gemini?
93 0e4c3d62 2022-02-26 op
94 0e4c3d62 2022-02-26 op Gemini is a new internet protocol which:
95 0e4c3d62 2022-02-26 op
96 0e4c3d62 2022-02-26 op * is heavier than gopher
97 0e4c3d62 2022-02-26 op * is lighter than the web
98 0e4c3d62 2022-02-26 op * will not replace either
99 0e4c3d62 2022-02-26 op * strives for maximum power to weight ratio
100 0e4c3d62 2022-02-26 op * takes user privacy very seriously
101 0e4c3d62 2022-02-26 op
102 0e4c3d62 2022-02-26 op => gemini://gemini.circumlunar.space Project Gemini Homepage