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