rcurses 4.9.0 → 4.9.1

data/README.md

@@ -1,257 +1,585 @@
-# rcurses - An alternative curses library written in pure Ruby
+# RTFM - Ruby Terminal File Manager
  
-![Ruby](https://img.shields.io/badge/language-Ruby-red) [![Gem Version](https://badge.fury.io/rb/rcurses.svg)](https://badge.fury.io/rb/rcurses) ![Unlicense](https://img.shields.io/badge/license-Unlicense-green) ![Stay Amazing](https://img.shields.io/badge/Stay-Amazing-important)
- 
-<img src="img/rcurses-logo.png" width="150" height="150">
-
-Create curses applications for the terminal easier than ever.
-
-Here's a somewhat simple example of a TUI program using rcurses: The [T-REX](https://github.com/isene/T-REX) calculator.
-
-And here's a much more involved example: The [RTFM](https://github.com/isene/RTFM) terminal file manager.
-
-# NOTE: Version 4.5 gives full RGB support in addition to 256-colors
-Just write a color as a string - e.g. `"d533e0"` for a hexadecimal RGB color (or use the terminal 256 colors by supplying an integer in the range 0-255)
+![Ruby](https://img.shields.io/badge/language-Ruby-red) [![Gem Version](https://badge.fury.io/rb/rtfm-filemanager.svg)](https://badge.fury.io/rb/rtfm-filemanager) ![Unlicense](https://img.shields.io/badge/license-Unlicense-green) ![Stay Amazing](https://img.shields.io/badge/Stay-Amazing-important)
+
+## Version 5
+
+Version 5 is a complete rewrite of RTFM using
+[rcurses](https://github.com/isene/rcurses) as the underlying library. With
+this, RTFM gains more stability, higher quality code and more features.
+
+Among the new version 5 features are an optional trash bin, advanced OpenAI
+integrations, plugin architectures for keybindings, user defined features and
+file viewers. You also get better feedback, better visuals, more error
+capture. Plenty.
+
+The major feature additions in v5 are marked in ***bold italic***.
+
+## What?  
+<img src="img/logo.png" align="left" width="150" height="150"> RTFM is a
+terminal file manager jam packed with features. 
+
+Apart from viewing and manipulating directories, you get syntax highlighting
+of file content, image and video thumbnailing in the terminal, OpenAI
+integration, system info panel, git status, fzf and navi integration and much,
+much more.
+
+Note: RTFM (Ruby Terminal File Manager) works best with the (u)rxvt, xterm and
+Eterm terminal emulators.
+
+### Features
+RTFM is one of the most feature rich terminal file managers. Some of the
+features are:
+
+* RTFM parses your LS_COLORS to ensure color consistency with the terminal experience
+* Images are shown inline in the terminal (can be turned off)
+* File contents is shown with proper syntax highlighting
+* Item's meta data is shown at the top
+* Easily browse file content (pdf, MS/OpenOffice, etc.)
+* Move around the file systems using arrow keys or VI keys
+* Copy, move, rename, symlink and delete files easily
+* Simply use 'r' in your terminal to launch RTFM - and exit into the directory where you ended RTFM
+* ***Toggle the use of a "trash bin" to move dirs/files there instead of deleting***
+* Easily copy an item's path to clipboard or primary selection
+* Order items the way you want, see only files of a certain type
+* Filter out all files not matching a [regex](https://www.rubyguides.com/2015/06/ruby-regex/) pattern
+* Mark files and directories and do group actions on them
+* Bookmark directories for easy jumping
+* Follow a symlink to where it points with one key stroke
+* Highlight files and directories matching a given pattern
+* Find items using `locate` and jump directly to the desired item
+* Find items and jump there using fuzzy search (with [fzf](https://github.com/junegunn/fzf))
+* Execute any shell command from inside RTFM - ***incuding other curses applications***
+* [navi](https://github.com/denisidoro/navi) integration for easier command executions
+* Easily unpack or create archives
+* Show git status for the current directory
+* Show comprehensive system info (processes running, disk space, dmesg, etc.)
+* See if a directory (with sub dirs) has changed using cryptographic hashes
+* Integration with OpenAI to get an executive summary of file content
+* ***OpenAI chat integrated; Discuss files, content, commands with OpenAI***
+* ***Enhanced tab management*** with duplication, renaming, and smart navigation
+* ***Improved stability*** with simplified architecture and eliminated flickering
+* ***Automatic image redraw*** after workspace switching (i3-wm compatible)
+* Possibility to change top line background when matching a path
+* Theming of pane colors
+
+## Why?
+The idea came to mind as I was working on [a complete LS_COLORS
+setup](https://github.com/isene/LS_COLORS) with a corresponding
+[ranger](https://ranger.github.io/) theme. But making a separate theme for
+ranger to mimic a massive LS_COLOR setup is rather stupid. File managers
+should parse LS_COLORS as default rather than implement their own themes. This
+became an itch that I kept scratching until I could happily replace ranger two
+weeks later. But, coding RTFM based on the old curses library was clumsy,
+inefficient and painful. So I decided to create
+[rcurses](https://github.com/isene/rcurses) - a complete curses library
+written from scratch in pure Ruby - and from v5 and onwards, RTFM is based
+completely on this modern curses implementation.
+
+## How?
+RTFM is a modern two-pane file manager with **enhanced tab support** for multi-directory navigation. You navigate in the left pane and the content of the selected item (directory or file) is shown in the right pane. The right pane is also used to show information such as the currently tagged items, your (book)marks, output from commands, error messages, etc.
+
+The **tab system** is visible in the top-right corner showing your current position like `[2/5]` (tab 2 of 5 total tabs). The tab bar displays when you have multiple tabs or use tab commands, showing directory names and management shortcuts.
+
+**Enhanced Tab Features:**
+* **Multiple tabs** for easy multi-directory management  
+* **Tab duplication** (`}`) to quickly copy current directory context
+* **Tab renaming** (`{`) for better organization  
+* **Smart tab display** showing current directory and shortcuts
+* **Quick tab switching** with number keys (1-9), J/K navigation
+* **Visual tab indicator** in top-right corner `[current/total]` 
+
+When you start RTFM, you can supply a directory path as an argument to let
+RTFM start up in that directory. When you exit it exits into the current RTFM
+directory.
+
+You can run any command in the bottom "command bar" and have the output
+presented in the right pane. History of commands are preserved like in your
+shell.
+
+## Installation
+You can install RTFM by cloning this repo and put the file `rtfm` in your
+"bin" directory. If you do, you need to install
+[rcurses](https://github.com/isene/rcurses) first.
+
+Or you can simply run `gem install rtfm-filemanager`.
+
+There are two basic prerequisites needed: `x11-utils` and `xdotool`. On
+Ubuntu these would be installed via `apt install x11-utils xdotool`.
+
+Content of text files are handled by `cat` - or by `bat` if you want beautiful
+highlighting. Other files are shown via external programs (Debian/Ubuntu
+family of Linux distros command in last column):
+
+File type                   | Requirements                     | Installation
+----------------------------|----------------------------------|-------------------------------
+Syntax highlighting of text | `bat`                            | `apt install bat`
+Markdown                    | `pandoc`                         | `apt install pandoc`
+PDFs                        | `pdftotext`                      | `apt install poppler-utils`
+LibreOffice                 | `odt2txt`                        | `apt install odt2txt`
+MS docx                     | `docx2txt`                       | `apt install docx2txt`
+MS pptx                     | `unzip`                          | `apt install unzip`
+MS xlsx                     | `ssconvert`                      | `apt install gnumeric`
+MS doc/xls/ppt              | `catdoc`, `xls2csv` and `catppt` | `apt install catdoc`
+Images                      | `w3m` and `ImageMagick`          | `apt install w3m imagemagick`
+Video (thumbnails)          | `ffmpegthumbnailer`              | `apt install ffmpegthumbnailer`
+
+Install rtfm from scratch with all of the above on Ubuntu:
+```
+sudo apt update
+sudo apt install ruby-full git libncurses-dev x11-utils xdotool bat pandoc poppler-utils odt2txt docx2txt unzip gnumeric catdoc w3m imagemagick ffmpegthumbnailer
+sudo gem install rcurses
+git clone https://github.com/isene/RTFM
+cd RTFM
+sudo cp rtfm /usr/bin/
+```
+Or with a simpler gem install:
+```
+sudo apt update
+sudo apt install ruby-full git libncurses-dev x11-utils xdotool bat pandoc poppler-utils odt2txt docx2txt unzip gnumeric catdoc w3m imagemagick ffmpegthumbnailer
+gem install rtfm-filemanager
+```
 
-# Why?
-Having struggled with the venerable curses library and the ruby interface to it for many years, I finally got around to write an alternative - in pure Ruby.
+## Screenshot
+![RTFM screenshot](img/screenshot-logo.png)
+
+
+## Image preview in the terminal
+RTFM uses w3mimgdisplay (part of the w3m package) to show images in the
+terminal. Some terminals have an issue with this - either the images don't
+show, the previous image is not cleared (new image overlaps the previous) or
+they show for only a flash or a few seconds. The table below shows how the
+most popular terminals fare with this. An "O" indicates that the terminal is
+OK, while an "X" indicates that it fails:
+
+Terminal      |Images | No overlap | Images stay
+--------------|-------|------------|-----------
+(u)rxvt       |   O   |    O       |   O
+xterm         |   O   |    O       |   O
+Eterm         |   O   |    O       |   O
+kitty         |   O   |    O       |   O
+alacritty     |   O   |    O       |   X
+terminology   |   O   |    O       |   X
+stterm        |   O   |    O       |   X
+gnome-terminal|   O   |    X       |
+xfce4-terminal|   O   |    X       |
+mate-terminal |   O   |    X       |
+lilyterm      |   O   |    X       |
+termit        |   X   |            |
+lxterminal    |   X   |            |
+qterminal     |   X   |            |
+
+
+## Keys
+These are the set of keys to move around and do actions within RTFM:
+
+### Basic keys
+Key      | Description
+---------|------------------------------------------------------------------
+ ?       | Show this help text
+ v       | Display RTFM version (and latest Gem version) in bottom window/command bar
+ r       | Refresh RTFM (recreates all windows. Use on terminal resize or when there is garbage somewhere)
+ R       | Reload configuration (~/.rtfm/conf)
+ W       | Write parameters to ~/.rtfm/conf: @marks, @hash, @history, @rubyhistory, @aihistory, @lslong, @lsall, @lsorder, @lsinvert, @width, @border, @preview, @trash
+ C       | ***Show the current configuration in ~/.rtfm/conf***
+ q       | Quit (save basic configuration: @marks, @hash, @history, @rubyhistory, @aihistory)
+ Q       | QUIT (without writing any changes to the config file)
+
+### Layout
+Key      | Description
+---------|------------------------------------------------------------------
+ w       | Change the width of the left/right panes (left pane ⇒ 20%, 30%, 40%, 50%, 60%)
+ B       | Cycle border
+ \-       | (Minus sign) Toggle preview in right pane (turn it off for faster traversing of directories)
+ _       | (Underscore) Toggle preview of images in right pane
+ b       | Toggle syntax highlighting (and line numbering)
+
+### Motion
+Key      | Description
+---------|------------------------------------------------------------------
+ j/DOWN  | Go one item down in left pane (rounds to top)
+ k/UP    | Go one item up in left pane (rounds to bottom)
+ h/LEFT  | Go up one directory level
+ l/RIGHT | Enter directory or open file (using run-mailcap or xdg-open) Use the key 'x' to force open using xdg-open (or run-mailcap) - used for opening html files in a browser rather than editing the file in your text editor
+ PgDown  | Go one page down in left pane
+ PgUp    | Go one page up in left pane
+ END     | Go to last item in left pane
+ HOME    | Go to first item in left pane
+
+### Marks and jumping
+Key      | Description
+---------|------------------------------------------------------------------
+ m       | Mark current dir (persistent). Next letter is the name of the mark [a-zA-Z'] The special mark "'" jumps to the last directory (makes toggling dirs easy) Press '-' and a letter to delete that mark. Mark '0' is the dir where RTFM was started.  Marks '1' - '5' are the past five directories visited
+ M       | Show marked items in right pane
+ '       | Jump to mark (next letter is the name of the mark [a-zA-Z']) The 5 latest directories visited are stored in marks 1-5 (1 being the very latest)
+ ~       | Jump to Home directory
+ \>       | Follow symlink to the directory where the target resides
+
+### Directory views
+Key      | Description
+---------|------------------------------------------------------------------
+ a       | Show all (also hidden) items
+ A       | Show long info per item (show item attributes)
+ o       | Change the order/sorting of directories (circular toggle)
+ i       | Invert/reverse the sorting
+ O       | Show the Ordering in the bottom window (the full ls command)
+
+### Tagging
+Key      | Description
+---------|------------------------------------------------------------------
+ t       | Tag item (toggles)
+ Ctrl-t  | Add items matching a pattern to list of tagged items (Ctrl-t and then . will tag all items)
+ T       | Show currently tagged items in right pane
+ u       | Untag all tagged items
+
+### Tab management
+Key      | Description
+---------|------------------------------------------------------------------
+ ]       | Create new tab in current directory
+ [       | Close current tab (keeps at least one tab open)
+ J       | Previous tab (wraps around)
+ K       | Next tab (wraps around)
+ }       | Duplicate current tab (creates a copy with same directory)
+ {       | Rename current tab
+ 1-9     | Switch to tab by number (1 = first tab, 2 = second tab, etc.)
+
+### Manipulate items
+Key      | Description
+---------|------------------------------------------------------------------
+ p       | Put (copy) tagged items here
+ P       | PUT (move) tagged items here
+ c       | Change/rename selected (adds command to bottom window)
+ s       | Create symlink to tagged items here
+ d       | Delete selected item and tagged items. Confirm with 'y'. ***Moves items to trash directory (~/.rtfm/trash/) if @trash | true***
+ D       | ***Empty trash directory***
+ Ctrl-d  | ***Toggle use of trash directory***
+ Ctrl-o  | Change ownership to user:group of selected and tagged items
+ Ctrl-p  | Change permissions of selected and tagged items
+           Format | rwxr-xr-x or 755 or rwx (applies the trio to user, group and others)
+
+### Filter and search
+Key      | Description
+---------|------------------------------------------------------------------
+ f       | Show only files in the left pane matching extension(s) (e.g. "txt" or "pdf,png,jpg")
+ F       | Show only files matching a pattern (Ruby Regex) (e.g. "abc" or "ab.+12(\w3)+")
+ Ctrl-f  | Clear all filtering
+ /       | Enter search string in bottom window to highlight matching items and jump to the first match
+ \\       | Remove search pattern
+ n       | Jump to the next item matched by '/'
+ N       | Jump to the previous item matched by '/'
+ g       | Run 'grep' to show files that contains the MATCH in current directory
+ L       | Start 'locate' search for files, then use '#' to jump to desired line/directory
+ Ctrl-l  | Locate files via fzf from the current directory down (fuzzy file finder must be installed https://github.com/junegunn/fzf)
+
+### Archives
+Key      | Description
+---------|------------------------------------------------------------------
+ z       | Extract tagged zipped archive to current directory
+ Z       | Create zipped archive from tagged files/directories
+
+### Git/hash/openai
+Key      | Description
+---------|------------------------------------------------------------------
+ G       | Show git status for current directory
+ H       | Do a cryptographic hash of the current directory with subdirs. If a previous hash was made, compare and report if there has been any change
+ I       | Show OpenAI's description of the selected item and its content (if available). You must have installed the ruby-openai gem and added your openai secret key in the ~/.rtfm/conf (add `@ai | "your-secret-openai-key") for this to work.
+ Ctrl-a  | ***Start an OpenAI chat (the context window is kept until you exit RTFM). The OpenAI agent is specialized in answering questions about cli, files and dirs***
+
+### Right pane controls
+Key      | Description
+---------|------------------------------------------------------------------
+ ENTER   | Refresh the right pane
+ S-RIGHT | ***One line down in the preview***
+ S-LEFT  | ***One line up in the preview***
+ S-DOWN  | ***Next page of the preview (if doc long and ∇ in the bottom right)*** (TAB does the same)
+ S-UP    | ***Previous page (if you have moved down the document first - ∆ in the top right)*** (or S-TAB)
+
+### Clipboard copy
+Key      | Description
+---------|------------------------------------------------------------------
+ y       | Copy path of selected item to primary selection (for pasting with middle mouse button)
+ Y       | Copy path of selected item to clipboard
+ Ctrl-y  | Copy content of right pane to clipboard (turn off batcat syntax highlighting with 'b' for a clean copy of content)
+
+### System shortcuts
+Key      | Description
+---------|------------------------------------------------------------------
+ S       | Show comprehensive System info (system, CPU, filesystem, latest dmesg messages)
+ =       | Create a new directory (a shortcut for ":mkdir ")
+ Ctrl-n  | Invoke navi (see https://github.com/denisidoro/navi) with any output in right window
+
+### Command mode
+Key      | Description
+---------|------------------------------------------------------------------
+ :       | Enter "command mode" in bottom window (press ENTER to execute, press ESC to escape). Prefix the command with a '§' to force the program to run in interactive mode (full screen TUI programs like htop, vim or any shell)
+ ;       | Show command history in right pane
+ \+       | ***Add program(s) to the list of full-UI interactive terminal programs***
+
+
+### Ruby debug mode
+Key      | Description
+---------|------------------------------------------------------------------
+ @       | Enter Ruby mode to execute any Ruby command (ENTER to execute, ESC to escape)
+
+
+## Keyboard cheat sheet
+![RTFM keyboard cheat sheet](img/rtfm-kb.png)
+
+## First run
+The first time you run RTFM, you are greeted with a welcome message. RTFM will
+add a simple function to your shell (bash, zsh, fish, maybe others) that will
+let you launch RTFM via the one key command `r`. It also lets RTFM exit in the
+directory you are currently in (inside of RTFM) rather than where you launched
+RTFM.
+
+With this, you can jump around in your directory structure via RTFM, exit to
+the desired directory, do work in the terminal and go back into RTFM via `r`.
+
+If you want to launch rtfm straight into a specified directory, do this
+instead: `rtfm ~/mydir/subdir`
+
+## Configuration file
+When you first exit RTFM, it will write your (book)marks and the set of tagged
+files to `.rtfm/conf`. This ensures your marks and tagged files are
+persistent. It also means you can launch rtfm tag a bunch of dirs and files,
+drop out back to the terminal to do some work, back into rtfm and resume to
+work with your previously tagged items.
+
+You can also set persistent variables in the config file manually:
+
+To have long info per item: `@lslong = true` (this is otherwise set to `false`)
+
+To show hidden files: `@lsall = "-a"` (this is otherwise set to `""`)
+
+To set a specific order for ls: `@lsorder = "-S"` (to order by size).
+
+To revert your ls order: `@lsinvert = "-r"`
+
+To set any additional 'ls' switches, set the variable `@lsuser`. To not list
+any files containg the word "test", you could do this:
+```
+@lsuser = "--ignore=test"
+```
+To suppress image viewing in the terminal: `@showimage = false`
 
-# Design principles
-Simple and with minimum of external dependencies.
+To suppress showing any content in the right pane: `@preview = false`
 
-# Installation
-Simply run `gem install rcurses`.
+To change the default width of the left pane: `@width = 5` (experiment with numbers 2-8).
 
-To use this library do:
-```
-require 'rcurses'
-```
+To toggle borders in RTFM: `@border = 1` (any number 0-3)
 
-# Features
-* Create panes (with the colors and(or border), manipulate the panes and add content
-* Dress up text (in panes or anywhere in the terminal) in bold, italic, underline, reverse color, blink and in any 256 terminal colors for foreground and background
-* Use a simple editor to let users edit text in panes
-* Left, right or center align text in panes
-* Cursor movement around the terminal
-
-# The elements
-`rcurses` gives you the following elements:
-* The class `Pane` to create and manilpulate panes/boxes
-* Extensions to the class String to print text in various degrees of fancy and also strip any fanciness
-* A module `Cursor` to give you cursor movements around the terminal
-* A module `Rinput` providing the function `getchr` to capture a single character input from the user (much better than any Ruby built-ins)
-
-# class Pane
-To create a pane do something like this:
+To have some commands already prepared for the command history, you can set:
 ```
-mypane = Rcurses::Pane.new(80, 30, 30, 10, 19, 229)
+@history = ["cat /home/me/MyTodo.txt", "neofetch --stdout"]
 ```
-This will create a pane/box starting at terminal column/x 80 and row/y 30 with the width of 30 characters and a hight of 10 characters and with the foreground color 19 and background color 229 (from the 256 choices available)
-
-The format for creating a pane is:
+To open files with `run-mailcap` instead of `open-xdg` set:
 ```
-Rcurses::Pane.new(x, y, w, h, fg, bg)
+@runmailcap = true
 ```
-You can drop the last two 256-color codes to create a pane with the defaults for your terminal. 
-
-By adding values for the terminal size in your program:
+***To use the trash bin: `@trash = true`***
+
+***To change the list of "whitelisted full-UI programs", change the variable @interactive.
+This is a comma separated string listing all programs that can be run from
+within RTFM's "command mode" (via the key `:`). Programs such as `htop`, `vim`
+and all shells will take over the terminal when they run and need explicit
+permission via this variable to be able to "replace" RTFM in the terminal.
+When you exit such a whitelisted program, RTFM resumes control. If you try to
+run such a program while it is not whitelisted, it will hang the terminal. To
+add a program to the whitelist inside RTFM, press the `+` key. All ususal
+shell comands that do not take over the full terminal such as `ls`, `touch`,
+`neofetch`, etc. will run just fine in command mode without being whitelisted.
+You can also explicitly run a program as interactive by prefixing the command
+with a single `§` - e.g. `:` `§saidar`. Programs added to @interactive will
+open as interactive also when opened via xdg-open or runmailcap (when you
+press `RIGHT` on a selected item).***
+
+All the variables above that you manually add to the top of the config files are
+undisturbed by launching and exiting RTFM.
+
+You can structure the config file the way you want. Let your OCD make it pretty.
+
+You can use `W` inside of RTFM to write all the parameters mentioned above to
+the config file - instead of adding them manually. Example: You press `+` to
+add `emacs` to your list of whitelisted interactive programs. Then you would
+want to press `W` to update @interactive in your config file so that `emacs`
+is permanently whitelisted as an interactive program for you.
+
+To exit RTFM without writing any changes to you marks or list of tagged items,
+exit with `Q`. They will then remain the same as when you launched RTFM for
+that session.
+
+## Extra info
+The top line shows information about the currently item in the left pane. When
+you are at a file, the information is pretty self explanatory:
+
+`Path: /home/geir/RTFM/README.md (-rw-r--r-- geir:geir 2023-04-25 11:49  16K)`
+
+This shows the full path of the selected file as well as the permissions,
+ownership, timestamp and the size of the file. When you are at a directory in
+the left pane, you get two numbers in brackets. The first number is the number
+of regular dirs/files in that directory. The second shows the total number of
+entries, including the hidden directories and files:
+
+`Path: /home/geir/RTFM (drwxr-xr-x geir:geir 2023-04-29 01:55  4,0) [4 8]`
+
+Different file types may have extra self explanatory information included in
+square brackets at the end of the top info line. Image files will have the
+size of the image included while pdf files will have the number of pages. More
+file specific information will be included when I feel like adding such.
+
+## Top and bottom line background colors
+You can customize the background colors for the top and bottom lines/panes.
+
+Bottom color is by default `238`. Change it by setting @bottomcolor to your
+desired colors in your `.rtfm/conf`.
+
+You can also set the background color at the bottom when you enter command
+mode (via `:`) by setting @cmdcolor and the Ruby mode (via `@`) by setting
+@rubycolor.
+
+Background color for OpenAI chats (invoked with `Ctrl-a`) is set with @aicolor.
+
+You can set the variable `@topmatch` in your `.rtfm/conf` so that it will change
+the background color of the top line/pane when you are in a directory matching
+a pattern.
+
+Example:
 ```
-@max_h, @max_w = IO.console.winsize
+@topmatch =  [["passionfruit", 165], ["kiwi", 50], ["", 238]]
 ```
-...you can use these values to create proportinally sized panes. So, a hight value of "@max_h/2" is valid to create a pane with the height of half the terminal height (the integer corresponding to half the terminal height will then be accessible as the variable `h`). Use the variables `@max_h` for terminal height and `@max_w` for terminal width.
-
-Avaliable properties/variables:
-
-Property       | Description
----------------|---------------------------------------------------------------
-x              | The x (column) position of the Pane
-y              | The y (row) position of the Pane
-w              | The width of the Pane
-h              | The heigth of the Pane
-fg             | Foreground color for the Pane
-bg             | Background color for the Pane
-border         | Draw border around the Pane (=true) or not (=false), default being false
-scroll         | Whether to indicate more text to be shown above/below the Pane, default is true
-text           | The text/content of the Pane
-ix             | The line number at the top of the Pane, starts at 0, the first line of text in the Pane
-index          | An attribute that can be used to track the selected line/element in the pane
-align          | Text alignment in the Pane: "l" = lefts aligned, "c" = center, "r" = right, with the default "l"
-prompt         | The prompt to print at the beginning of a one-liner Pane used as an input box
-moreup         | Set to true when there is more text above what is shown (top scroll bar i showing)
-moredown       | Set to true when there is more text below what is shown (bottom scroll bar i showing)
-
-The methods for Pane:
-
-Method         | Description
----------------|---------------------------------------------------------------
-new/init       | Initializes a Pane with optional arguments `x, y, w, h, fg and bg`
-move(x,y)      | Move the pane by `x`and `y` (`mypane.move(-4,5)` will move the pane left four characters and five characters down)
-refresh        | Refreshes/redraws the Pane with content
-border_refresh | Refresh the Pane border only
-full_refresh   | Refreshes/redraws the Pane with content completely (without diff rendering)
-edit           | An editor for the Pane. When this is invoked, all existing font dressing is stripped and the user gets to edit the raw text. The user can add font effects similar to Markdown; Use an asterisk before and after text to be drawn in bold, text between forward-slashes become italic, and underline before and after text means the text will be underlined, a hash-sign before and after text makes the text reverse colored. You can also combine a whole set of dressings in this format: `<23,245,biurl\|Hello World!>` - this will make "Hello World!" print in the color 23 with the background color 245 (regardless of the Pane's fg/bg setting) in bold, italic, underlined, reversed colored and blinking. Hitting `ESC` while in edit mode will disregard the edits, while `Ctrl-S` will save the edits
-editline       | Used for one-line Panes. It will print the content of the property `prompt` and then the property `text` that can then be edited by the user. Hitting `ESC` will disregard the edits, while `ENTER` will save the edited text
-clear          | Clears the pane
-say(text)      | Short form for setting panel.text, then doing a refresh of that panel
-ask(prompt,text) | Short form of setting panel.prompt, then panel.text, doing a panel.editline and then returning panel.text
-pagedown       | Scroll down one page height in the text (minus one line), but not longer than the length of the text
-pageup         | Scroll up one page height in the text (minus one line)
-linedown       | Scroll down one line in the text
-lineup         | Scroll up one line in the text
-bottom         | Scroll to the bottom of the text in the pane
-top            | Scroll to the top of the text in the pane
-
-# class String extensions
-Method extensions provided for the class String.
-
-A color can either be an integer in the range 0-255 for the usual 256 colors in a terminal, or it can be a string representing RGB. So both of these are valid: `string.fg(219)` and `string.fg("4d22a0")`.
-
-Method         | Description
----------------|---------------------------------------------------------------
-fg(fg)         | Set text to be printed with the foreground color `fg` (example: `"TEST".fg(84)`)
-bg(bg)         | Set text to be printed with the background color `bg` (example: `"TEST".bg("dd32a9")`)
-fb(fg, bg)     | Set text to be printed with the foreground color `fg` and background color `bg` (example: `"TEST".fb(84,196)`)
-b              | Set text to be printed in bold (example: `"TEST".b`)
-i              | Set text to be printed in italic (example: `"TEST".i`)
-u              | Set text to be printed underlined (example: `"TEST".u`)
-l              | Set text to be printed blinking (example: `"TEST".l`)
-r              | Set text to be printed in reverse colors (example: `"TEST".r`)
-c(code)        | Use coded format like "TEST".c("204,45,bui") to print "TEST" in bold, underline italic, fg=204 and bg=45 (the format is `.c("fg,bg,biulr")`)
-pure           | Strip text of any "dressing" (example: with `text = "TEST".b`, you will have bold text in the variable `text`, then with `text.pure` it will show "uncoded" or pure text)
-clean_ansi     | Strip seemingly uncolored strings of ansi code (those that are enclosed in "\e[0m"
-shorten(n)     | Shorten the pure version of the string to 'n' characters, preserving any ANSI coding
-inject("chars",pos) | Inject "chars" at position 'pos' in the pure version of the string (if 'pos' is '-1', then append at end). Preserves any ANSI code
-
-PS: Blink does not work in conjunction with setting a background color in urxvt. It does work in gnome-terminal. But the overall performance in urxvt as orders of magnitude better than gnome-terminal.
-
-# Cleaning up upon exit
-End a program with `Rcurses.clear_screen` to clear the screen for any rcurses residues.
-
-# module Cursor
-To use this module, first do `include Rcurses::Cursor`. Create a new cursor object with `mycursor = Rcurses::Cursor`. Then you can apply the following methods to `mycursor`:
-
-Method            | Description
-------------------|---------------------------------------------------------------
-save              | Save current position
-restore           | Restore cursor position
-pos               | Query cursor current position (example: `row,col = mycursor.pos`)
-colget            | Query cursor current cursor col/x position (example: `row = mycursor.rowget`)
-rowget            | Query cursor current cursor row/y position (example: `row = mycursor.rowget`)         
-set(c = 1, r = 1) | Set the position of the cursor to row/y,col/x (example: `mycursor.set(row,col)`) (default = top row, first column)
-col(c = 1)        | Cursor moves to the nth position horizontally in the current line (default = first column)
-row(r = 1)        | Cursor moves to the nth position vertically in the current column (default = first/top row)
-up(n = 1)         | Move cursor up by n (default is 1 character up)
-down(n = 1)       | Move cursor down by n (default is 1 character down)
-left(n = 1)       | Move cursor backward by n (default is one character)
-right(n = 1)      | Move cursor forward by n (default is one character)
-next_line         | Move cursor down to beginning of next line
-prev_line         | Move cursor up to beginning of previous line
-clear_char(n = 1) | Erase n characters from the current cursor position (default is one character)
-clear_line        | Erase the entire current line and return to beginning of the line
-clear_line_before | Erase from the beginning of the line up to and including the current cursor position
-clear_line_after  | Erase from the current position (inclusive) to the end of the line
-scroll_up         | Scroll display up one line
-scroll_down       | Scroll display down one line
-clear_screen_down | Clear screen down from current row
-hide              | Hide the cursor
-show              | Show cursor
-
-# The function getchr
-rcurses provides a vital extension to Ruby in reading characters entered by the user. This is especially needed for curses applications where readline inputs are required.
-The function getchr is automatically included in your arsenal when you first do `include Rcurses::Input`.
-
-Simply use `chr = getchr` in a program to read any character input by the user. The returning code (the content of `chr` in this example) could be any of the following:
-
-Key pressed     | string returned
-----------------|----------------------------------------------------------
-`esc`           | "ESC"
-`up`            | "UP"
-`shift-up`      | "S-UP"
-`ctrl-up`       | "C-UP"
-`down`          | "DOWN"
-`shift-down`    | "S-DOWN"
-`ctrl-down`     | "C-DOWN"
-`right`         | "RIGHT"
-`shift-right`   | "S-RIGHT"
-`ctrl-right`    | "C-RIGHT"
-`left`          | "LEFT"
-`shifth-left`   | "S-LEFT"
-`ctrl-left`     | "C-LEFT"
-`shift-tab`     | "S-TAB"
-`insert`        | "INS"   
-`ctrl-insert`   | "C-INS"
-`del`           | "DEL"   
-`ctrl-del`      | "C-DEL"
-`pageup`        | "PgUP"  
-`ctrl-pageup`   | "C-PgUP"
-`pagedown`      | "PgDOWN"
-`ctrl-pagedown` | "C-PgDOWN"
-`home`          | "HOME"  
-`ctrl-home`     | "C-HOME"
-`end`           | "END"   
-`ctrl-end`      | "C-END"
-`backspace`     | "BACK"
-`ctrl- `        | "C-SPACE"
-`ctrl-h`        | "BACK"
-`ctrl-a`        | "C-A"
-`ctrl-b`        | "C-B"
-`ctrl-c`        | "C-C"
-`ctrl-d`        | "C-D"
-`ctrl-e`        | "C-E"
-`ctrl-f`        | "C-F"
-`ctrl-g`        | "C-G"
-`ctrl-i`        | "C-I"
-`ctrl-j`        | "C-J"
-`ctrl-k`        | "C-K"
-`ctrl-l`        | "C-L"
-`ctrl-m`        | "C-M"
-`ctrl-n`        | "C-N"
-`ctrl-o`        | "C-O"
-`ctrl-p`        | "C-P"
-`ctrl-q`        | "C-Q"
-`ctrl-r`        | "C-R"
-`ctrl-s`        | "C-S"
-`ctrl-t`        | "C-T"
-`ctrl-u`        | "C-U"
-`ctrl-v`        | "C-V"
-`ctrl-a`        | "WBACK"
-`ctrl-x`        | "C-X"
-`ctrl-y`        | "C-Y"
-`ctrl-z`        | "C-Z"
-`enter`         | "ENTER"
-`tab`           | "TAB"
-`F1` - `F12`    | "F1" - "F12"
-
-Any other character enter will be returned (to `chr` in the example above).
-
-In order to handle several character pased into STDIN by the user (and not only returned the first character only, your program should empty the STDIN like this:
-
+With this, the background color of the top line/pane will be set to `165` if
+you are in a directory path that includes "passionfruits". The last pair is
+the default background color when no match is found. If you don't set this
+variable in your `.rtfm/conf`, rtfm will set this value to:
 ```
-while $stdin.ready?
-  chr += $stdin.getc
-end
+@topmatch =  [["", 238]]
 ```
-You can also pass a timeout to `getchr` with `getchr(time)` to wait for `time` number of seconds and returning `nil` if the user does not press a key.
+Make sure to have a default value set as the last pair in `@topmatch`.
 
+## Plugin architecture
+***Upon first running RTFM, a few files are created in the `.rtfm/` directory.***
 
-# Example
+One is `preview.rb`, the other is `keys.rb`.
 
-Try this in `irb`:
+You can add new "previewers" to show files with extensions that is not
+previewed by default in RTFM. The `preview.rb` explains how you add thesea:
 ```
-require 'rcurses'
-@max_h, @max_w = IO.console.winsize
-mypane = Pane.new(@max_w/2, 30, 30, 10, 19, 229)
-mypane.border = true
-mypane.text = "Hello".i + " World!".b.i + "\n \n" + "rcurses".r + " " + "is cool".c("16,212")
-mypane.refresh
-mypane.edit
+# ~/.rtfm/preview.rb
+#
+# Define one handler per line in the form:
+#
+#   ext1, ext2, ext3 = command with @s placeholder
+#
+# @s will be replaced by the shell-escaped filename.
+#
+# Lines beginning with # or blank are ignored.
+#
+# Examples:
+#   # plain text, Ruby, Python, shell
+#   txt, rb, py, sh = bat -n --color=always @s
+#
+#   # markdown via pandoc
+#   md = pandoc @s -t plain
+#
+#   # PDFs
+#   pdf = pdftotext -f 1 -l 4 @s -
 ```
-... and then try to add some bold text by enclosing it in '*' and italics by enclosing text in '/'. Then press 'ctrl-s' to save your edited text - and then type `mypane.refresh` to see the result.
-
-And - try running the example file `rcurses_example.rb`.
-
-# Not yet implemented
-Let me know what other features you like to see.
+Likewise, you can add or rewrite any keys in RTFM and add new functionality to
+RTFM by following the instructions in `keys.rb`:
+```
+# ~/.rtfm/keys.rb
+#
+# Override or add key bindings simply by assigning into KEYMAP
+# and defining the corresponding handler methods.
+#
+# Syntax:
+#   KEYMAP['X'] = :my_handler
+#
+#   def my_handler(chr)
+#     # anything you like - use @pB, @pR, Dir.pwd, etc.
+#     @pB.say("You pressed X!")
+#   end
+#
+# Examples:
+#
+#   # remap 'C' to show config
+#   KEYMAP['C'] = :show_config
+#
+#   # add a new binding: 'Z'
+#   KEYMAP['Z'] = :zap_all
+#   def zap_all(_chr)
+#     @pB.say("ZAPPED!")
+#   end
+```
+Here is another example of what you could add as a plugin:
+```
+KEYMAP['C-G'] = :git_update
 
-# License and copyright
-Just steal or borrow anything you like. This is now Public Domain.
+def git_update
+  @pR.say("Updating...")
+  message = @pCmd.ask('Commit message: ', '')
+  shellexec("git add . && git commit -m '#{message}' && git push")
+  @pB.full_refresh
+end
+```
+***With this, you can mold RTFM to fit your needs better.***
+
+When writing plugins, there are a few variables you should know:
+
+Variable  | Description
+----------|------------------------------------------------------------------
+@pT       | Top pane (info bar)
+@pL       | Left pane
+@pR       | Right pane
+@pB       | Bottom pane (status bar)
+@pCmd     | Command pane (asking for commands to execute)
+@pSearch  | Search pane (prompting for what to search for)
+@pAI      | Pane for interacting with (Open)AI
+@pRuby    | Ruby debug/command pane
+@selected | The selected item in the Left pane
+
+Here are three importan hook-ins to use with your plugins:
+
+### Summary of overlap & choice
+- **Use `command`** when you need to _capture_ output as a value (and optionally handle stderr yourself).
+- **Use `shell`** for fire-and-forget side-effects where you don't care about stdout but still want error reporting.
+- **Use `shellexec`** when you want both stdout and stderr printed into RTFM's Right pane automatically.
+
+#### `command(cmd, timeout: 5, return_both: false) → String or [stdout, stderr]`
+- **What it does:** Runs `bash -c cmd`, captures both stdout and stderr, enforces a timeout.
+- **When to use:** Programmatically grab output (and optionally errors) of a shell command (e.g. building directory listings or previews).
+- **Key points:**
+  - By default prints stderr into the Right pane and returns stdout.
+  - `return_both: true` returns `[stdout, stderr]` instead of auto-printing errors.
+  - Times out after `timeout` seconds, killing the process if necessary.
+
+#### `shell(cmd, background: false, err: nil) → nil`
+- **What it does:** Fires off `cmd` via `system`, redirecting stderr into a log file (default: `$TMP/rtfm_err.log`), optionally in the background.
+- **When to use:** Run side-effecting commands (e.g. `xdg-open`, `mv`) where you don't need stdout but still want error reporting.
+- **Key points:**
+  - If `background: true`, runs `cmd &`.
+  - Any stderr output is read from the log and shown via `@pR.say`.
+  - Doesn't return command output, errors only.
+
+#### `shellexec(cmd, timeout: 10) → nil`
+- **What it does:** A thin wrapper over `command(cmd, timeout:, return_both: true)` that _always_ prints both stdout and stderr into the Right pane.
+- **When to use:** Run a command and echo both its stdout and any errors back to the user—e.g. interactive grep, locate, or other one-off shell tools.
+- **Key points:**
+  - Internally calls `command(..., return_both: true)`.
+  - Prints stderr first, then stdout.
+  - Doesn't return anything to the caller.
+
+## Screencast
+Here's a screencast for an early version of RTFM, but it shows the basic stuff:
+[![RTFM screencast](/img/screenshot.png)](https://youtu.be/ANUOlDryUng)
+
+## Development
+I don't expect this program to be used by others. I do this for my own
+enjoyment and because I want a file manager that fits my needs better than any
+others I have found. If you come up with a feature request I feel is cool, I
+may include it. Bug reports are always welcome.
+
+A note to developers: You can hit the "@" key to enter the Ruby debug mode
+where anything you enter in the bottom command bar will be sent to the Ruby
+eval() function and output to the right pane. You can for instance issue
+`puts @searched` to see the currently active search pattern.