iUpdate 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 86fd49cff30911ecdd2b5eca124561d9384726e7 /scm/clic/commit/86fd49cff30911ecdd2b5eca124561d9384726e7.gph bitreich.org 70 1parent e44d7e9bf83b9f4f33612a9aa178cb05625c41a4 /scm/clic/commit/e44d7e9bf83b9f4f33612a9aa178cb05625c41a4.gph bitreich.org 70 hAuthor: Solene Rapenne URL:mailto:solene@perso.pw bitreich.org 70 iDate: Fri, 12 Jan 2018 12:17:09 +0100 Err bitreich.org 70 i Err bitreich.org 70 iUpdate README Err bitreich.org 70 i Err bitreich.org 70 iDiffstat: Err bitreich.org 70 i M README.md | 98 ++++++++++++++++++++----------- Err bitreich.org 70 i Err bitreich.org 70 i1 file changed, 64 insertions(+), 34 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@@ -1,10 +1,26 @@ Err bitreich.org 70 i-# Introduction Err bitreich.org 70 i+Introduction Err bitreich.org 70 i+============ Err bitreich.org 70 i Err bitreich.org 70 i-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+Clic (Common LISP Interactive Client) is a terminal based gopher Err bitreich.org 70 i+client. The name is a bad pun, **clic** is the sound of a mouse click Err bitreich.org 70 i+but the software is keyboard driven... Err bitreich.org 70 i Err bitreich.org 70 i-It currently works with **ecl** and **sbcl** compilers. Err bitreich.org 70 i+ Err bitreich.org 70 i+Requirements Err bitreich.org 70 i+============ Err bitreich.org 70 i+ Err bitreich.org 70 i+clic requires a few dependencies : Err bitreich.org 70 i+ Err bitreich.org 70 i+ + ANSI compatible terminal emulator Err bitreich.org 70 i+ + a Common LISP interpreter Err bitreich.org 70 i+ + C compiler Err bitreich.org 70 i+ + Linux/OpenBSD/FreeBSD/NetBSD Err bitreich.org 70 i+ Err bitreich.org 70 i+Both **ecl** and **sbcl** Common LISP compilers are supported. Err bitreich.org 70 i+ Err bitreich.org 70 i+ Err bitreich.org 70 i+How to build Err bitreich.org 70 i+============ Err bitreich.org 70 i Err bitreich.org 70 i `clic` binary must be compiled. Err bitreich.org 70 i Err bitreich.org 70 i@@ -18,18 +34,16 @@ To compile it with **sbcl** : Err bitreich.org 70 i 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-**I (the author) recommend using ecl**. Err bitreich.org 70 i- Err bitreich.org 70 i-# Requirements Err bitreich.org 70 i+Note : when using sbcl, a shared library extension.o is created and Err bitreich.org 70 i+then sbcl creates a binary linked against the library. But ecl will Err bitreich.org 70 i+translate the whole lisp code to C and then compile it, but linking Err bitreich.org 70 i+against ecl. Err bitreich.org 70 i 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-If you want to use ecl, you will need a C compiler. Err bitreich.org 70 i+**I (the author) recommend using ecl**. Err bitreich.org 70 i Err bitreich.org 70 i-# Information about the binary Err bitreich.org 70 i Err bitreich.org 70 i+Information about the binary Err bitreich.org 70 i+---------------------------- 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@@ -39,7 +53,9 @@ 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+How to use clic Err bitreich.org 70 i+=============== Err bitreich.org 70 i 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@@ -47,31 +63,45 @@ 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-## Keyboard bindings Err bitreich.org 70 i 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-- h : display history Err bitreich.org 70 i-- r : reload the page Err bitreich.org 70 i-- x : quit shell mode Err bitreich.org 70 i-- q : quit shell mode Err bitreich.org 70 i+Keyboard bindings Err bitreich.org 70 i+----------------- Err bitreich.org 70 i+ 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++ h : display history Err bitreich.org 70 i++ r : reload the page 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 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-- * : reload the page Err bitreich.org 70 i-- - : display bookmarks Err bitreich.org 70 i-- + : add to bookmark Err bitreich.org 70 i-- . : quit Err bitreich.org 70 i++ "a number" : follow the link "number Err bitreich.org 70 i++ / : previous page Err bitreich.org 70 i++ * : reload the page Err bitreich.org 70 i++ - : display bookmarks Err bitreich.org 70 i++ + : add to bookmark Err bitreich.org 70 i++ . : quit Err bitreich.org 70 i+ Err bitreich.org 70 i+ Err bitreich.org 70 i+Command line usage Err bitreich.org 70 i+================== Err bitreich.org 70 i+ Err bitreich.org 70 i+If you pass a gopher url to clic (gopher:// isn't mandatory for the Err bitreich.org 70 i+url), the behavor will change depending on two parameters : Err bitreich.org 70 i Err bitreich.org 70 i-# Command line Err bitreich.org 70 i+1. is the output a pipe/redirection ? Err bitreich.org 70 i+2. is the url type a menu ? (types 1 or 4) 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 i+If the output is a pipe or a redirection, clic will send the raw data Err bitreich.org 70 i+to stdout (text for type 0 and binary for others types) Err bitreich.org 70 i Err bitreich.org 70 i-Using "gopher://" at the start of an url isn't mandatory. Err bitreich.org 70 i+If the output is the terminal, clic will download the file in /tmp/ Err bitreich.org 70 i+folder and then call $PAGER if the type is 0 (text) or xdg-open for Err bitreich.org 70 i+others types. Err bitreich.org 70 i Err bitreich.org 70 i+If the url is a type 0 or 4 and the output is a terminal, it will open Err bitreich.org 70 i+clic and stay in interactive mode. Err bitreich.org 70 .