Blame


1 057c47a3 2021-07-18 op # Telescope
2 057c47a3 2021-07-18 op
3 714541bb 2021-08-01 op Telescope is a Emacs/w3m-inspired browser for the "small internet"
4 714541bb 2021-08-01 op that supports Gemini, Gopher and Finger.
5 4def0885 2021-03-12 op
6 62dba329 2021-08-18 op Features:
7 62dba329 2021-08-18 op
8 62dba329 2021-08-18 op - tabs
9 62dba329 2021-08-18 op - bookmarks
10 62dba329 2021-08-18 op - privsep
11 62dba329 2021-08-18 op - minibuffer live narrowing
12 62dba329 2021-08-18 op
13 4def0885 2021-03-12 op There are still various things missing or, if you prefer, various
14 4def0885 2021-03-12 op things that you can help develop :)
15 4def0885 2021-03-12 op
16 4def0885 2021-03-12 op - subscriptions
17 3be78a24 2021-03-17 op - tofu oob verification
18 4def0885 2021-03-12 op - client certificates
19 0f7e6318 2021-06-20 op - add other GUIs: at the moment it uses only ncurses, but telescope
20 0f7e6318 2021-06-20 op shouldn't be restricted to TTYs only!
21 4def0885 2021-03-12 op
22 cd2f2c82 2021-07-24 op [![asciicast](https://asciinema.org/a/426862.svg)](https://asciinema.org/a/426862)
23 4def0885 2021-03-12 op
24 2058a15d 2021-03-13 op
25 cd302034 2021-03-15 op ## Why yet another browser?
26 cd302034 2021-03-15 op
27 cd302034 2021-03-15 op One of the great virtues of Gemini is its simplicity. It means that
28 cd302034 2021-03-15 op writing browsers or server is easy and thus a plethora of those
29 cd302034 2021-03-15 op exists. I myself routinely switch between a couple of them, depending
30 cd302034 2021-03-15 op on my mood.
31 cd302034 2021-03-15 op
32 cd302034 2021-03-15 op More browsers brings more stability as it became more difficult to
33 cd302034 2021-03-15 op change the protocol, too.
34 cd302034 2021-03-15 op
35 cd302034 2021-03-15 op However, Telescope was ultimately written for fun, on a whim, just to
36 cd302034 2021-03-15 op play with ncurses, libtls, libevent and the macros from `sys/queue.h`,
37 cd302034 2021-03-15 op but I'd like to finish it into a complete Gemini browser.
38 cd302034 2021-03-15 op
39 cd302034 2021-03-15 op
40 cd302034 2021-03-15 op ## Goals
41 cd302034 2021-03-15 op
42 cd302034 2021-03-15 op - Fun: hacking on Telescope should be fun.
43 cd302034 2021-03-15 op - Clean: write readable and clean code mostly following the style(9)
44 cd302034 2021-03-15 op guideline. Don't become a kitchen sink.
45 cd302034 2021-03-15 op - Secure: write secure code with privilege separation to mitigate the
46 cd302034 2021-03-15 op security risks of possible bugs.
47 cd302034 2021-03-15 op - Fast: it features a modern, fast, event-based asynchronous I/O
48 018a3114 2021-07-03 op model.
49 656b4b64 2021-03-16 op - Cooperation: re-use existing conventions to allow inter-operations
50 656b4b64 2021-03-16 op and easy migrations from/to other clients.
51 cd302034 2021-03-15 op
52 cd302034 2021-03-15 op
53 3be78a24 2021-03-17 op ## TOFU
54 3be78a24 2021-03-17 op
55 3be78a24 2021-03-17 op Telescope aims to use the "Trust, but Verify (where appropriate)"
56 3be78a24 2021-03-17 op approach outlined here:
57 3be78a24 2021-03-17 op [gemini://thfr.info/gemini/modified-trust-verify.gmi](gemini://thfr.info/gemini/modified-trust-verify.gmi).
58 3be78a24 2021-03-17 op
59 3be78a24 2021-03-17 op The idea is to define three level of verification for a certificate:
60 3be78a24 2021-03-17 op
61 3be78a24 2021-03-17 op - **untrusted**: the server fingerprint does NOT match the stored
62 3be78a24 2021-03-17 op value
63 3be78a24 2021-03-17 op - **trusted**: the server fingerprint matches the stored one
64 3be78a24 2021-03-17 op - **verified**: the fingerprint matches and has been verified
65 3be78a24 2021-03-17 op out-of-band by the client.
66 3be78a24 2021-03-17 op
67 3be78a24 2021-03-17 op Most of the time, the `trusted` level is enough, but where is
68 3be78a24 2021-03-17 op appropriate users should be able to verify out-of-band the
69 3be78a24 2021-03-17 op certificate.
70 3be78a24 2021-03-17 op
71 018a3114 2021-07-03 op At the moment there is no UI for oob-verification though.
72 3be78a24 2021-03-17 op
73 3be78a24 2021-03-17 op
74 4def0885 2021-03-12 op ## Building
75 4def0885 2021-03-12 op
76 4def0885 2021-03-12 op Telescope depends on ncursesw, libtls (from either LibreSSL or
77 741428e3 2021-06-15 op libretls), libevent (either v1 or v2). When building from a git
78 741428e3 2021-06-15 op checkout, yacc (or bison) is also needed.
79 4def0885 2021-03-12 op
80 97e30cc6 2021-03-14 op To build from a release tarball just execute:
81 4def0885 2021-03-12 op
82 4def0885 2021-03-12 op ./configure
83 4def0885 2021-03-12 op make
84 4def0885 2021-03-12 op sudo make install
85 4def0885 2021-03-12 op
86 7eaf997f 2021-08-19 op The configure script has optional support for building with libraries
87 7eaf997f 2021-08-19 op provided by your distribution instead of internal compatibility funcs:
88 7eaf997f 2021-08-19 op
89 86ce72db 2021-08-19 op - `--with-libbsd`: link with [libbsd](https://libbsd.freedesktop.org)
90 7eaf997f 2021-08-19 op - `--with-libimsg`: link with the
91 7eaf997f 2021-08-19 op [imsg-compat](https://github.com/bsd-ac/imsg-compat) library
92 7eaf997f 2021-08-19 op
93 4def0885 2021-03-12 op If you want to build from the git checkout, something that's
94 cd302034 2021-03-15 op discouraged for users that don't intend to hack on telescope
95 4def0885 2021-03-12 op
96 4def0885 2021-03-12 op ./autogen.sh
97 4def0885 2021-03-12 op ./configure
98 4def0885 2021-03-12 op make
99 4def0885 2021-03-12 op sudo make install # eventually
100 4def0885 2021-03-12 op
101 4def0885 2021-03-12 op Please keep in mind that the main branch, from time to time, may be
102 4def0885 2021-03-12 op accidentally broken on some platforms. Telescope is developed
103 4def0885 2021-03-12 op primarily on OpenBSD/amd64 and commits on the main branch don't get
104 4def0885 2021-03-12 op always tested in other OSes. Before tagging a release however, a
105 12a43913 2021-06-26 op comprehensive testing on various platforms is done to ensure everything
106 4def0885 2021-03-12 op is working as intended.
107 4def0885 2021-03-12 op
108 4def0885 2021-03-12 op
109 c6cad9e5 2021-07-17 op ## Contrib
110 c6cad9e5 2021-07-17 op
111 c6cad9e5 2021-07-17 op Any form of contribution is appreciated, not only patches or bug
112 1c4989cd 2021-07-17 op reports. The contrib directory is for external things such as sample
113 1c4989cd 2021-07-17 op configuration files, themes, scripts and things like that.
114 c6cad9e5 2021-07-17 op
115 c6cad9e5 2021-07-17 op
116 afa57f78 2021-07-15 op ## User files
117 afa57f78 2021-07-15 op
118 afa57f78 2021-07-15 op Telescope stores user files in `~/.telescope`. The usage and contents
119 afa57f78 2021-07-15 op of these files are described in [the man page](telescope.1), under
120 afa57f78 2021-07-15 op "FILES". There's no support yet for XDG-style directories.
121 afa57f78 2021-07-15 op
122 afa57f78 2021-07-15 op Only one instance of Telescope can be running at time per user.
123 afa57f78 2021-07-15 op
124 afa57f78 2021-07-15 op
125 4def0885 2021-03-12 op ## License
126 4def0885 2021-03-12 op
127 4def0885 2021-03-12 op Telescope is distributed under a BSD-style licence. The main code is
128 3d7d29b3 2021-08-13 op under the ISC but for files under `compat/` it varies.
129 bf6551ee 2021-07-18 op
130 bf6551ee 2021-07-18 op `data/emoji.txt` is copyright © 1991-2021 Unicode, Inc. and
131 bf6551ee 2021-07-18 op distributed under the [UNICODE, Inc license agreement][unicode-license].
132 bf6551ee 2021-07-18 op
133 bf6551ee 2021-07-18 op
134 bf6551ee 2021-07-18 op [unicode-license]: https://www.unicode.org/license.html