Blame


1 a2728733 2021-07-18 op # Help
2 a2728733 2021-07-18 op
3 a2728733 2021-07-18 op Welcome to Telescope!
4 a2728733 2021-07-18 op
5 f2b332a5 2021-07-19 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 a2728733 2021-07-18 op
7 a2728733 2021-07-18 op This page is always available as
8 f2b332a5 2021-07-19 op
9 a2728733 2021-07-18 op > $ telescope about:help
10 a2728733 2021-07-18 op
11 a2728733 2021-07-18 op
12 a2728733 2021-07-18 op ## What is Telescope?
13 a2728733 2021-07-18 op
14 a2728733 2021-07-18 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 a2728733 2021-07-18 op
16 a2728733 2021-07-18 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 a2728733 2021-07-18 op
18 a2728733 2021-07-18 op => gemini://telescope.omarpolo.com Telescope Project Homepage
19 a2728733 2021-07-18 op
20 f2b332a5 2021-07-19 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 a2728733 2021-07-18 op
22 f2b332a5 2021-07-19 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 f2b332a5 2021-07-19 op
24 a2728733 2021-07-18 op > man telescope
25 a2728733 2021-07-18 op
26 f2b332a5 2021-07-19 op
27 f2b332a5 2021-07-19 op ## Operate the Telescope
28 f2b332a5 2021-07-19 op
29 97edc702 2021-08-16 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 f2b332a5 2021-07-19 op
31 f2b332a5 2021-07-19 op * > to prompt for a URL;
32 821814c3 2021-07-20 op * < to edit the current URL;
33 f2b332a5 2021-07-19 op * arrow keys to move the cursor;
34 f2b332a5 2021-07-19 op * page up/down to scroll;
35 f2b332a5 2021-07-19 op * tab and shift-tab to jump to the next/previous link;
36 f2b332a5 2021-07-19 op * F and B (uppercase) to navigate forward and backward in the history;
37 f2b332a5 2021-07-19 op * enter to open the link under the cursor;
38 f2b332a5 2021-07-19 op * alt-enter to open the link under the cursor in a new tab;
39 f2b332a5 2021-07-19 op * [ and ] to move between tabs;
40 f2b332a5 2021-07-19 op * control + t to open a new tab;
41 f2b332a5 2021-07-19 op * control + w to close the current tab;
42 f2b332a5 2021-07-19 op * q to quit
43 f2b332a5 2021-07-19 op
44 f2b332a5 2021-07-19 op
45 f2b332a5 2021-07-19 op ## Operate — Emacs version
46 f2b332a5 2021-07-19 op
47 f2b332a5 2021-07-19 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!
48 f2b332a5 2021-07-19 op
49 0e6183ab 2021-07-20 op
50 f2b332a5 2021-07-19 op ## Operate — vi version
51 f2b332a5 2021-07-19 op
52 f2b332a5 2021-07-19 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!
53 f2b332a5 2021-07-19 op
54 f2b332a5 2021-07-19 op
55 a2728733 2021-07-18 op ## Appearance
56 a2728733 2021-07-18 op
57 cb23fa3e 2021-07-20 op Telescope is fully customizable. The configuration file is
58 a2728733 2021-07-18 op
59 eb2ed626 2021-10-07 op > ~/.config/telescope/config
60 a2728733 2021-07-18 op
61 f2b332a5 2021-07-19 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.
62 a2728733 2021-07-18 op
63 a2728733 2021-07-18 op
64 662c7431 2021-07-21 op ## Custom pages
65 2035b01f 2021-07-20 op
66 2035b01f 2021-07-20 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.
67 2035b01f 2021-07-20 op
68 662c7431 2021-07-21 op All the ‘about:*’ pages can be locally overridden. For example, to customise about:new create:
69 662c7431 2021-07-21 op
70 de04b178 2021-11-26 op > ~/.local/share/telescope/pages/about_new.gmi
71 662c7431 2021-07-21 op
72 662c7431 2021-07-21 op about:bookmarks is the only page that doesn’t follow this pattern; it’s located at
73 662c7431 2021-07-21 op
74 eb2ed626 2021-10-07 op > ~/.local/share/telescope/bookmarks.gmi
75 662c7431 2021-07-21 op
76 662c7431 2021-07-21 op
77 662c7431 2021-07-21 op ## Protocol Proxies
78 662c7431 2021-07-21 op
79 2035b01f 2021-07-20 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.
80 2035b01f 2021-07-20 op
81 2980bbb1 2021-08-26 op => https://github.com/LukeEmmet/duckling-proxy The Duckling Proxy
82 2980bbb1 2021-08-26 op
83 2035b01f 2021-07-20 op Configuring telescope to use a proxy is easy, just drop something like the following to your configuration file:
84 2035b01f 2021-07-20 op
85 97edc702 2021-08-16 op ```Example of protocol proxy configuration for http and https
86 97edc702 2021-08-16 op proxy "http" via "gemini://127.0.0.1:1965"
87 2035b01f 2021-07-20 op proxy "https" via "gemini://127.0.0.1:1965"
88 2035b01f 2021-07-20 op ```
89 2035b01f 2021-07-20 op
90 2035b01f 2021-07-20 op
91 f2b332a5 2021-07-19 op # What is Gemini?
92 a2728733 2021-07-18 op
93 f2b332a5 2021-07-19 op Gemini is a new internet protocol which:
94 a2728733 2021-07-18 op
95 f2b332a5 2021-07-19 op * is heavier than gopher
96 f2b332a5 2021-07-19 op * is lighter than the web
97 f2b332a5 2021-07-19 op * will not replace either
98 f2b332a5 2021-07-19 op * strives for maximum power to weight ratio
99 f2b332a5 2021-07-19 op * takes user privacy very seriously
100 a2728733 2021-07-18 op
101 f2b332a5 2021-07-19 op => gemini://gemini.circumlunar.space Project Gemini Homepage