cgo

[Fork] Gopher Client
git clone https://git.jojolepro.com/cgo.git
Log | Files | Refs | README | LICENSE

README.md (3303B)


      1 cgo - a terminal gopher client
      2 ==============================
      3 
      4 Summary
      5 -------
      6 
      7 cgo is a UNIX/Linux terminal based gopher client. It has no other
      8 dependencies than libc and some syscalls. It should run on every
      9 VT100 compatible terminal. To show media like images, music or
     10 webpages it relies on external programs you can specify.
     11 
     12 
     13 What does cgo mean?
     14 -------------------
     15 
     16 cgo means more or less, the "c go"pher client. And c could
     17 stand for C (the programming language), colorful or console.
     18 You may choose one of the meanings or propose other :)
     19 (but please not crappy!)
     20 
     21 
     22 How to install
     23 --------------
     24 
     25 Grab the source code, open cgo.c and adjust the external programs
     26 to your needs. You can also change the default gopherhole where
     27 cgo connects on startup without any parameters (e.g. you can
     28 tell cgo to connect directly to some Veronica search engine).
     29 And if you don't like the default colors, you're able to change
     30 them also here.
     31 If you're done with changing the defaults, just "make" the
     32 final binary.
     33 
     34 
     35 Parameters
     36 ----------
     37 
     38 In case you omit all parameters cgo will show you the default
     39 gopherhole specified in the source file.
     40 
     41  * -H               show usage
     42  * -v               print version
     43  * gopher URI       opens the given gopher URI
     44 
     45 
     46 Usage
     47 -----
     48 
     49  When "surfing" in the gopherspace cgo only presents you
     50  with directory listings. Every selector is preceeded with two
     51  ascii chars, or three if we run out of selectors in the
     52  range 'aa', 'ab' ... 'zz'. By typing in these chars cgo will
     53  jump to the given selector. Every time you jump to another
     54  directory listing cgo generates a history entry (like every
     55  browser). To show other media cgo uses external programs
     56  to present it (e.g. less, display, mplayer, firefox).
     57  Following commands are understood by cgo:
     58 
     59   * <kbd>?</kbd>           help
     60   * <kbd><</kbd>           jump back in history
     61   * <kbd>*</kbd>           reload directory
     62   * [link]      show / jump to selector
     63   * <kbd>.</kbd>[link]     download selector
     64   * <kbd>H</kbd>           show history
     65   * <kbd>H</kbd>[link]     jump to specified history item
     66   * <kbd>G</kbd>[URI]      jumps right to the specified gopher URI
     67   * <kbd>B</kbd>           show bookmarks
     68   * <kbd>B</kbd>[link]     jump to specified bookmark item
     69 
     70 [link] stands for the two (or three) colored letters in front of selectors.
     71 
     72 Configuration
     73 -------------
     74 
     75  cgo reads `/etc/cgorc` and then `$(HOME)/.cgorc` for defaults. If both
     76  files are missing, hardcoded defaults will be used. Following configuration
     77  keys are recognized by cgo:
     78 
     79  * `start_uri`        the gopher URI which is displayed at start
     80  * `cmd_text`         command to show text files
     81  * `cmd_browser`      command to HTML links
     82  * `cmd_image`        command to show images
     83  * `cmd_player`       command to play audio files
     84  * `color_prompt`     ANSI color sequence for the prompt
     85  * `color_selector`   ANSI color sequence for selectors
     86  * `verbose`          If not "false" or "off" it will show messages like "downloading" / "executing" when downloading a selector
     87  * `bookmarkN`        configure bookmarks
     88 
     89 Todo
     90 ----
     91 
     92  * list is empty :D
     93 
     94 
     95 Bugs
     96 ----
     97 
     98  * none I'm aware of :)
     99 
    100 
    101 Feel free to use this small gopher client. I hope you'll
    102 find it as useful as I do. Send me comments or patches if you
    103 like. I would appreciate it.