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