cgmnlm

colorful gemini line mode browser
git clone https://git.clttr.info/cgmnlm.git
Log (Feed) | Files | Refs (Tags) | README | LICENSE

README.md (2198B)

      1 # cgmnlm - a colorful Gemini line mode client
      2 
      3 This is a [Gemini](https://gemini.circumlunar.space/) client. Included are:
      4 
      5 * A CLI utility (like curl): gmni
      6 * A [line-mode browser](https://en.wikipedia.org/wiki/Line_Mode_Browser): cgmnlm
      7 
      8 ## Features:
      9 
     10 * Page history
     11 * Regex searches
     12 * Bookmarks
     13 * basic Client Certificate support (no autocreation of client certs currently)
     14 
     15 ## Non-Features:
     16 
     17 * no inlining of any link type
     18 * no caching of page content
     19 * no persistent history across sessions
     20 
     21 ## Modifications compared to upstream
     22 
     23 This project is of fork of https://git.sr.ht/~sircmpwn/gmni
     24 
     25 It includes the following modifications:
     26 
     27 * colored headings & links
     28 * default 4 char indenting
     29 * `s` command to directly search in geminispace (via geminispace.info)
     30 * `l` command to search for backlinks to current URI (via geminispace.info)
     31 * `K` command to remove the bookmark for the current page
     32 * `u` command to navigate 1 path element up
     33 * `e[N]` command to open a link or the current URI in default external program (requires `xdg-open`)
     34 * `t[N]` command to download the content behind a link or the current URI to a temporary file
     35 * `T` command line switch to automatically open files downloaded with `t` command (requires `xdg-open`) 
     36 * `a` command and `A` command line switch to toggle between preformatted text and the associated alt text
     37 
     38 ### Colors
     39 
     40 The actual colors used depend on your terminal palette:
     41 
     42 * heading 1: light red
     43 * heading 2: light yellow
     44 * heading 3: light green
     45 * gemini link on same capsule: light cyan
     46 * gemini link to another capsule: dark cyan
     47 * non-gemini link: light magenta
     48 * preformatted text: light gray
     49 
     50 Besides this rendering adjustments i'll try to keep track of upstream changes or send patches to upstream.
     51 
     52 ## Usage
     53 
     54 See `gmni(1)`, `cgmnlm(1)`.
     55 
     56 ## Installation
     57 
     58 * ArchLinux and derivates:
     59   * release: https://aur.archlinux.org/packages/cgmnlm/
     60   * latest: https://aur.archlinux.org/packages/cgmnlm-git/
     61 
     62 ## Compiling
     63 
     64 ```
     65 $ mkdir build && cd build
     66 $ ../configure
     67 $ make
     68 # make install
     69 ```
     70 
     71 ### Dependencies:
     72 
     73 * A POSIX-like system and a C11 compiler
     74 * [BearSSL](https://www.bearssl.org/index.html)
     75 * [scdoc](https://sr.ht/~sircmpwn/scdoc/) (optional)