README.md - clic - Clic is an command line interactive client for gopher writte… | |
git clone git://bitreich.org/clic/ git://enlrupgkhuxnvlhsf6lc3fziv5h2hhfrinws65… | |
Log | |
Files | |
Refs | |
Tags | |
README | |
LICENSE | |
--- | |
README.md (3258B) | |
--- | |
1 Introduction | |
2 ============ | |
3 | |
4 Clic (Common LISP Interactive Client) is a terminal based gopher | |
5 client. The name is a bad pun, **clic** is the sound of a mouse click | |
6 but the software is keyboard driven... | |
7 | |
8 Clic supports TLS connections by first trying to speak TLS to the remote | |
9 server, if it doesn't work, it falls back to plaintext. The status prompt | |
10 will show either "**TLS**" or "UNSECURE" depending on how the communicat… | |
11 has been negotiated. | |
12 | |
13 | |
14 Requirements | |
15 ============ | |
16 | |
17 clic requires a few dependencies: | |
18 | |
19 + ANSI compatible terminal emulator | |
20 + ecl common lisp interpreter | |
21 + C compiler | |
22 + Linux/OpenBSD/FreeBSD/NetBSD | |
23 | |
24 | |
25 How to build | |
26 ============ | |
27 | |
28 `clic` binary must be compiled. | |
29 | |
30 To compile it with **ecl**, it's really easy type the following | |
31 command: | |
32 | |
33 make | |
34 | |
35 then you can use `make install` to deploy it in `/usr/bin/`. | |
36 | |
37 The binary will be linked to ecl shared library. You need to install | |
38 ecl if you want to deploy clic binary on others systems. | |
39 | |
40 | |
41 How to use clic | |
42 =============== | |
43 | |
44 By default *clic* will load the page **gopherproject/1/** with a | |
45 number on the left of each link. Please type the number of a link to | |
46 follow it. If it's a text, the $PAGER program will be called to show it, | |
47 if it's a binary file (types g,I and 9) it will be downloaded into | |
48 `/tmp/` and then `xdg-open` will be called on the filename. | |
49 | |
50 | |
51 Keyboard bindings | |
52 ----------------- | |
53 | |
54 + 1-999 : follow the link "number" | |
55 + p : previous page | |
56 + h : display history | |
57 + r : reload the page | |
58 + x or q or ^D : quit | |
59 + sNUMBER : show the gopher url for link $number | |
60 + / pattern : redisplay the menu only with lines containing string (no r… | |
61 + d : display the raw response | |
62 | |
63 In addition to the previous keybinding, a different layout coexists, | |
64 permitting clic to be used with the numpad with only one hand: | |
65 | |
66 + "a number" : follow the link "number | |
67 + / : previous page | |
68 + * : reload the page | |
69 + . : quit | |
70 | |
71 | |
72 Command line usage | |
73 ================== | |
74 | |
75 clic [-t] [-k] [url|file] | |
76 | |
77 If you start clic with the -t option, menus will be displayed in a | |
78 single operation, instead of asking to display next page once it reaches | |
79 your terminal size. | |
80 | |
81 If you start clic with the -k option, then kiosk mode is enabled, in | |
82 which case it won't call any external program or save any data to disk. | |
83 Texts (type 0) will be shown as-is in the output. It only allows the use | |
84 of texts, menus and searches. | |
85 | |
86 If you pass a gopher url to clic (gopher:// isn't mandatory for the | |
87 url), the behavior will be determined by two parameters: | |
88 | |
89 1. is the output a pipe/redirection ? | |
90 2. is the url type a menu ? (types 1 or 7) | |
91 | |
92 If the output is a pipe or a redirection, clic will send the raw data | |
93 to stdout (text for type 0 and binary for others types) | |
94 | |
95 If the output is the terminal, clic will download the file in the | |
96 `/tmp/` folder, then call $PAGER if the type is 0 (text) or xdg-open | |
97 for others types. | |
98 | |
99 If the url is a type 0 or 7 and the output is a terminal, it will open | |
100 clic and stay in interactive mode. | |
101 | |
102 Clic can open a local file respecting the gopher menu protocol, this | |
103 can be used to create a bookmark file and load it locally without a | |
104 gopher server. In order to proceed, you need to pass the file path as | |
105 a parameter beginning with file://, as in the following example: | |
106 | |
107 clic file://path/to/my_file.txt |