iUpdating the outdated README - clic - Clic is an command line interactive client for gopher written in Common LISP Err bitreich.org 70 hgit clone git://bitreich.org/clic/ git://enlrupgkhuxnvlhsf6lc3fziv5h2hhfrinws65d7roiv6bfj7d652fid.onion/clic/ URL:git://bitreich.org/clic/ git://enlrupgkhuxnvlhsf6lc3fziv5h2hhfrinws65d7roiv6bfj7d652fid.onion/clic/ bitreich.org 70 1Log /scm/clic/log.gph bitreich.org 70 1Files /scm/clic/files.gph bitreich.org 70 1Refs /scm/clic/refs.gph bitreich.org 70 1Tags /scm/clic/tag bitreich.org 70 1README /scm/clic/file/README.md.gph bitreich.org 70 1LICENSE /scm/clic/file/LICENSE.gph bitreich.org 70 i--- Err bitreich.org 70 1commit 9357d1d69981d44f740188cb9ef80d5097b0074a /scm/clic/commit/9357d1d69981d44f740188cb9ef80d5097b0074a.gph bitreich.org 70 1parent 3f8100a6e7505d2f879512461b392c83d934a444 /scm/clic/commit/3f8100a6e7505d2f879512461b392c83d934a444.gph bitreich.org 70 hAuthor: Solene Rapenne URL:mailto:solene@perso.pw bitreich.org 70 iDate: Sun, 31 Dec 2017 16:31:04 +0100 Err bitreich.org 70 i Err bitreich.org 70 iUpdating the outdated README Err bitreich.org 70 i Err bitreich.org 70 iDiffstat: Err bitreich.org 70 i M README.md | 73 ++++++++++++++----------------- Err bitreich.org 70 i Err bitreich.org 70 i1 file changed, 33 insertions(+), 40 deletions(-) Err bitreich.org 70 i--- Err bitreich.org 70 1diff --git a/README.md b/README.md /scm/clic/file/README.md.gph bitreich.org 70 i@@ -4,51 +4,52 @@ Clic (Common LISP Interactive Client) is a gopher client. The name is Err bitreich.org 70 i a bad pun because **clic** is the sound of a mouse click while this Err bitreich.org 70 i client is keyboard only... Err bitreich.org 70 i Err bitreich.org 70 i-It currently works with **ecl** and **sbcl** compilers. Just load it Err bitreich.org 70 i-with sbcl like this Err bitreich.org 70 i+It currently works with **ecl** and **sbcl** compilers. Err bitreich.org 70 i Err bitreich.org 70 i- sbcl --load clic.lisp Err bitreich.org 70 i+Clic must be compiled to be used : Err bitreich.org 70 i Err bitreich.org 70 i-or with ecl Err bitreich.org 70 i+To compile it with **sbcl** : Err bitreich.org 70 i Err bitreich.org 70 i- ecl --load clic.lisp**. Err bitreich.org 70 i+ make LISP=sbcl Err bitreich.org 70 i Err bitreich.org 70 i-# Requirements Err bitreich.org 70 i+To compile it with **ecl** : Err bitreich.org 70 i Err bitreich.org 70 i-You need a Common LISP interpreter like ecl or sbcl to use Clic. Err bitreich.org 70 i+ make Err bitreich.org 70 i Err bitreich.org 70 i-If you want to produce a binary, you need ecl and a C compiler. Err bitreich.org 70 i+then you can use `make install` to deploy it in `/usr/bin/`. Err bitreich.org 70 i Err bitreich.org 70 i-# Make a binary Err bitreich.org 70 i+**I (the author) recommend using ecl**. Err bitreich.org 70 i Err bitreich.org 70 i-## Linked binary requiring ECL Err bitreich.org 70 i+# Requirements Err bitreich.org 70 i Err bitreich.org 70 i-If you have ecl and a C or C++ compiler, just type `make`. You will Err bitreich.org 70 i-get a binary named *clic*. The makefile is a wrapper that call Err bitreich.org 70 i-**make-binary.lisp** with ecl. Err bitreich.org 70 i+You need a Common LISP interpreter like ecl or sbcl to use Clic. This Err bitreich.org 70 i+is only tested with Linux, OpenBSD and FreeBSD, it should works fine Err bitreich.org 70 i+on any Unix system. Err bitreich.org 70 i Err bitreich.org 70 i-## Static binary (standalone) Err bitreich.org 70 i+If you want to use ecl, you will need a C compiler. Err bitreich.org 70 i Err bitreich.org 70 i-If you want to deploy **clic** without installing sbcl or ecl, you can Err bitreich.org 70 i-create a standalone executable (10 Mb approximately) with sbcl. Err bitreich.org 70 i+# Information about the binary Err bitreich.org 70 i Err bitreich.org 70 i- make standalone Err bitreich.org 70 i+If you compile clic with ecl, you will need ecl library installed on Err bitreich.org 70 i+the computer, the startup time is really fast. While compiling clic Err bitreich.org 70 i+with SBCL will provide a standalone binary embedding the whole SBCL Err bitreich.org 70 i+compiler, weighting approximately 10 Mb with a slower startup time. Err bitreich.org 70 i Err bitreich.org 70 i-If you use OpenBSD, you will need wxallowed mountflag on the partition Err bitreich.org 70 i-from where you try to start clic standalone because sbcl has a W^X Err bitreich.org 70 i-issue. Err bitreich.org 70 i+If you use OpenBSD and SBCL, you will need wxallowed mountflag on the Err bitreich.org 70 i+partition from where you try to start clic standalone because sbcl has Err bitreich.org 70 i+a W^X issue. Err bitreich.org 70 i Err bitreich.org 70 i # Use it Err bitreich.org 70 i Err bitreich.org 70 i-By default *clic* will load the page **bitreich.org/1/** and make you Err bitreich.org 70 i-in "shell mode". Just type the number of a link to follow the link. If Err bitreich.org 70 i-you have seen a long text or multiple texts and you don't know what Err bitreich.org 70 i-links you can use, type **p** to show again the latest page with the Err bitreich.org 70 i-links. You can exit shell mode with **x**. Err bitreich.org 70 i+By default *clic* will load the page **gopherproject/1/** with a Err bitreich.org 70 i+number on the left of each link. Pleas type the number of a link to Err bitreich.org 70 i+follow it. If it's a text, the $PAGER program will be called to show Err bitreich.org 70 i+it, if it's a binary file (types g,I and 9) it will be downloaded into Err bitreich.org 70 i+`/tmp/` and then `xdg-open` will be called on the filename. Err bitreich.org 70 i Err bitreich.org 70 i-## Shell mode Err bitreich.org 70 i+## Keyboard bindings Err bitreich.org 70 i Err bitreich.org 70 i-- "a number" : follow the link "number" Err bitreich.org 70 i+- 1-999 : follow the link "number" Err bitreich.org 70 i - a : add to bookmark (it saves the file too) Err bitreich.org 70 i - b : display bookmarks and choose a link Err bitreich.org 70 i - p : previous page Err bitreich.org 70 i@@ -57,8 +58,8 @@ links. You can exit shell mode with **x**. Err bitreich.org 70 i - x : quit shell mode Err bitreich.org 70 i - q : quit shell mode Err bitreich.org 70 i Err bitreich.org 70 i-In addition to the previous keybinding, a different layout coexist, Err bitreich.org 70 i-using the numpad to use clic with only one hand : Err bitreich.org 70 i+In addition to the previous keybinding, a different layout coexists, Err bitreich.org 70 i+permitting to use clic with the numpad with only one hand : Err bitreich.org 70 i Err bitreich.org 70 i - "a number" : follow the link "number Err bitreich.org 70 i - / : previous page Err bitreich.org 70 i@@ -67,15 +68,7 @@ using the numpad to use clic with only one hand : Err bitreich.org 70 i - + : add to bookmark Err bitreich.org 70 i - . : quit Err bitreich.org 70 i Err bitreich.org 70 i-## Non shell-mode ## Err bitreich.org 70 i- Err bitreich.org 70 i-### Fetch a page Err bitreich.org 70 i- Err bitreich.org 70 i-- use `(getpage "hostname" 70 "/")` to fetch the root of a gopherspace Err bitreich.org 70 i-- one can use `(getpage "hostname" 70 "/sometext.txt" 0)` to tell it's a type 0 Err bitreich.org 70 i-- using *getpage* you will have numbers on links, use (g numer) to request the link Err bitreich.org 70 i- Err bitreich.org 70 i-## Variables Err bitreich.org 70 i- Err bitreich.org 70 i-There is a hash-table named *links* with links available. Err bitreich.org 70 i+# Command line Err bitreich.org 70 i Err bitreich.org 70 i+If you call clic with an argument which is a request for a binary Err bitreich.org 70 i+type, clic will output the data to stdout. Err bitreich.org 70 .