rtfm-filemanager 3.0.3 → 3.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 76bd197d0a9c8613ab381e40e427d4784ad70304c65799a2a939777be9cf6e54
-  data.tar.gz: e386caba16205f6f9ae5694bbd6e56f58fa7c7d4947bff08380dd7ca483cfabe
+  metadata.gz: fe11017b37608ece785d04b740e858ee400a3518f7ec6e2e90d318c36069d431
+  data.tar.gz: c1f526b4b1a347c106915e6c4e03486e1adf1464c8050e153b625f1510fa6aa7
 SHA512:
-  metadata.gz: 0ffee736412785328cdeaf2d29860d9ff0dfb948d653be36c3b82a279d579f13fcdce37c53ec4ec3dcbd67757d2e4c4397394520c73013ab67b28cf8542e38bf
-  data.tar.gz: cf758653dbdc1894fad957729cdd25783f70545e6d26cabe48eaca62c324e7e21ac98182478094108fbee0c8a470097baf971748cfa9f2c19cbc37999b4ebd42
+  metadata.gz: 8cb52b1a6b0d7bd0db5f76486cde99416a1a3fcb9ceee3d1e5e0cc912c6c79c567e104982e9fa32f6a8f53a7cbbe34481f72d30980e24c9a2ffc31ac544db96e
+  data.tar.gz: 8376fb44256d84321f755842daa76009c5e116a86024977bd1af5bc01c24915198b51c0c082f2e609cd6181ee5dfef36484a6394a376da8f08f1816ad76c5567

data/README.md

@@ -18,7 +18,7 @@ Note: RTFM works best with the (u)rxvt, xterm and Eterm terminal emulators.
 ## Features
 
 RTFM is one of the more feature rich terminal file managers. Some of the
-features:
+features are:
 
 * RTFM shows images inline in the terminal (can be turned off)
 * File contents is shown with proper syntax highlighting
@@ -64,17 +64,18 @@ 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, etc. 
 
-You can run any command in the bottom "command line" and have the output
+You can run any command in the bottom "command bar" and have the output
 presented in the right pane. Use LEFT and RIGHT keys to go back and forth on
 the command line, HOME to beginning of line, END to end of line, Backspace or
 Ctrl-h to delete previous character, Ctrl-w to delete previous word, TAB to
 complete directories and file names and ENTER to issue the command, while
-Ctrl-u deletes the line. Issuing ENTER on a blank line has no effect.
+Ctrl-u deletes the line. Issuing ENTER on a blank line has no effect. Use
+Ctrl-g to leave the command bar without executing anything.
 
 ## Installation
 
-You can install RTFM by simply coloning this repo and put the file `rtfm` in
-your "bin" directory. Or you can simply run `gem install rtfm-filemanager`.
+You can install RTFM by coloning this repo and put the file `rtfm` in your
+"bin" directory. 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`.
@@ -82,12 +83,12 @@ Ubuntu these would be installed via `apt install x11-utils xdotool`.
 In order to run RTFM (without generating [a bunch of
 warnings](https://github.com/isene/RTFM/issues/1)), you need to do a `gem
 install curses` (gets version 1.3.2) instead of installing via `apt install
-ruby-curses` (gets version 1.2.4-1build1 on Ubuntu 20.04). 
+ruby-curses` (gets version 1.2.4-1build1 on Ubuntu 20.04). If you install RTFM
+via `gem install rtfm-filemanager`, this dependency is already taken care of.
 
 Content of text files are handled by `cat` - or by `bat` if you want beautiful
-highlighting. Other files are shown via external programs. It is shown if you
-have the program installed (Debian/Ubuntu family of Linux distros command in
-last column):
+highlighting. Other files are shown via external programs (Debian/Ubuntu
+family of Linux distros command in last column):
 
 File type                   | Requirements                     | Installation
 ----------------------------|----------------------------------|-------------------------------
@@ -109,13 +110,17 @@ sudo gem install curses
 git clone https://github.com/isene/RTFM
 cd RTFM
 sudo cp rtfm /usr/bin/
-cp .rtfm.launch ~/
-echo "source ~/.rtfm.launch" >> .zshrc # or .bashrc if you run bash as shell
+```
+Or with a simpler gem install:
+```
+sudo apt update
+sudo apt install ruby-full git libncurses-dev x11-utils xdotool bat poppler-utils odt2txt docx2txt catdoc w3m imagemagick ffmpegthumbnailer
+gem install rtfm-filemanager
 ```
 
 ## Screenshot
 
-![](img/screenshot.png)
+![RTFM screenshot](img/screenshot.png)
 
 ## Image preview in the terminal
 
@@ -153,11 +158,12 @@ These are the set of keys to move around and do actions within RTFM:
 Key    | Description
 -------|------------------------------------------------------------------
 ?      | Show this help text
-r      | Refresh RTFM (recreates all windows. Use on terminal resize or when there is garbage somewhere)
+r      | Refresh RTFM (recreates the panes. Use on terminal resize or when there is garbage somewhere)
 R      | Reload configuration (~/.rtfm.conf)
 W      | Write parameters to ~/.rtfm.conf (@lsall, @lslong, @lsorder, @lsinvert, @border, @width, @preview, @tagged, @marks)
 q      | Quit
 Q      | QUIT (without writing changes to the config file)
+v      | Display RTFM version in bottom command bar
 
 ### Motion
 
@@ -186,7 +192,7 @@ M      | Show marked items in right pane
 
 Key    | Description
 -------|------------------------------------------------------------------
-/      | Enter search string in bottom window to highlight matching items and jump to the first match
+/      | Enter search string in bottom command bar 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 '/'
@@ -211,7 +217,7 @@ p      | Put (copy) tagged items here
 P      | PUT (move) tagged items here
 s      | Create symlink to tagged items here
 d      | Delete selected item and tagged items. Press 'y' to confirm
-c      | Change/rename selected (adds command to bottom window)
+c      | Change/rename selected (adds the proper command to change in the command bar)
 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)
 z      | Extract tagged zipped archive to current directory
@@ -225,7 +231,7 @@ a      | Show all (also hidden) items
 A      | Show All 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)
+O      | Show the Ordering in the bottom command bar (the full ls command)
 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. If RTFM is installed as a gem, the ruby-openai gem is included in the installation
@@ -237,7 +243,7 @@ Key    | Description
 ENTER  | Refresh the right pane
 TAB    | Next page of the preview (if doc long and ∇ in the bottom right)
 S-TAB  | Previous page (if you have moved down the document first - ∆ in the top right)
-w      | Change the width of the left/right panes (left pane ⇒ ⅓ ⇒ ¼ ⇒ ⅕ ⇒ ⅙ ⇒ ½ ⇒ ⅓)
+w      | Change the width of the left/right panes (left pane ⇒ 20%, 30%, 40%, 50%, 60%)
 \-      | Toggle preview in right pane (turn it off for faster traversing of directories)
 _      | Toggle preview of images in right pane
 b      | Toggle syntax highlighting (and line numbering)
@@ -247,24 +253,25 @@ b      | Toggle syntax highlighting (and line numbering)
 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)*")
+F      | Show only files matching a pattern (Ruby Regex) (e.g. "abc" or "ab.+12(\w3)+")
 B      | Toggle border
-:      | Enter "command mode" in bottom window (press ENTER to execute, press Ctrl-G to escape)
+:      | Enter "command mode" in bottom command bar (press ENTER to execute, press Ctrl-G to escape)
 ;      | Show command history in right pane
 y      | Copy path of selected item to primary selection (for pasting with middle mouse button)
 Y      | Copy path of selected item to clipboard
-C-Y    | Copy content of right pane to clipboard
+Ctrl-y | Copy content of right pane to clipboard
 S      | Show comprehensive system info (system, CPU, filesystem, latest dmesg messages)
-Ctrl-n | Invoke navi (see https://github.com/denisidoro/navi) with any output in right window
-
-
-## A convenient shell function
-Add this line to your `.bashrc` or `.zshrc` to make RTFM exit to the current
-directory by launching the file manager via `r` in the terminal:
+Ctrl-n | Invoke navi (see https://github.com/denisidoro/navi) with any output in right pane
 
-`source ~/.rtfm.launch`
+## Keyboard cheat sheet
+![RTFM keyboard cheat sheet](img/rtfm-kb.png)
 
-... and place the file `.rtfm.launch` in your home directory.
+## First run
+The first time you run RTFM, you are greeted with a welcome message. RTFM will
+then create a file (`.rtfm.launch`) in your home directory 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`.
@@ -291,7 +298,8 @@ any files containg the word "test", you could do this:
 ```
 
 To change the default width of the left pane to something other than ⅓rd of
-the terminal width: `@width = 5` (would set the left pane width to ⅕th).
+the terminal width: `@width = 5` (would set the left pane width to 50% of the
+window size).
 
 To add borders in RTFM: `@border = true`
 
@@ -345,6 +353,6 @@ 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 window will be sent to the Ruby
+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. 

data/bin/rtfm

@@ -14,7 +14,7 @@
 #             for any damages resulting from its use. Further, I am under no
 #             obligation to maintain or extend this software. It is provided 
 #             on an 'as is' basis without any expressed or implied warranty.
-@version    = "3.0.3"
+@version    = "3.5"
 
 # PRELIMINARIES
 @help = <<HELPTEXT
@@ -104,7 +104,7 @@ RIGHT PANE
 
 ADDITIONAL COMMANDS
  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)*")
+ F       = Show only files matching a pattern (Ruby Regex) (e.g. "abc" or "ab.+12(\w3)+")
  B       = Toggle border
  :       = Enter "command mode" in bottom window (press ENTER to execute, press Ctrl-G to escape)
  ;       = Show command history in right pane
@@ -116,30 +116,62 @@ ADDITIONAL COMMANDS
 
 COPYRIGHT: Geir Isene, 2020-3. No rights reserved. See http://isene.com for more.
 HELPTEXT
-@firstrun = <<FIRSTRUN
+def firstrun
+  @firstrun = <<~FIRSTRUN
 
-Welcome to RTFM - the Ruby Terminal File Manager. This help text is shown on the first run.
-To benefit fully from all the features, you need to install some auxilliary software.
-On Ubuntu Linux you would use "apt install":
+  Welcome to RTFM - the Ruby Terminal File Manager. This help text is shown on the first run.
+  Next time you run RTFM, you can launch it from your terminal with a one letter command: "r"
+  When launched this way, RTFM will also exit in the directory you are currently in.
 
-Basic requirments is "x11-utils" and "xdotool":           apt install x11-utils xdotool
-Syntax highlighting of text uses "bat":                   apt install bat
-Viewing PDFs uses "pdftotext":                            apt install poppler-utils
-Viewing LibreOffice docs uses "odt2txt":                  apt install odt2txt
-Viewing MS docx	uses "docx2txt":                          apt install docx2txt
-Viewing MS pptx	uses "unzip":                             apt install unzip
-Viewing MS xlsx uses "ssconvert":                         apt install gnumeric
-Viewing MS doc/xls/ppt uses "catdoc, xls2csv and catppt": apt install catdoc
-Viewing Images uses "w3m and ImageMagick":                apt install w3m imagemagick
-Viewing Video thumbnails uses "ffmpegthumbnailer"         apt install ffmpegthumbnailer
+  To benefit fully from all the features, you need to install some auxilliary software.
+  On Ubuntu Linux you would use "apt install":
+
+  Basic requirments is "x11-utils" and "xdotool":           apt install x11-utils xdotool
+  Syntax highlighting of text uses "bat":                   apt install bat
+  Viewing PDFs uses "pdftotext":                            apt install poppler-utils
+  Viewing LibreOffice docs uses "odt2txt":                  apt install odt2txt
+  Viewing MS docx	uses "docx2txt":                          apt install docx2txt
+  Viewing MS pptx	uses "unzip":                             apt install unzip
+  Viewing MS xlsx uses "ssconvert":                         apt install gnumeric
+  Viewing MS doc/xls/ppt uses "catdoc, xls2csv and catppt": apt install catdoc
+  Viewing Images uses "w3m and ImageMagick":                apt install w3m imagemagick
+  Viewing Video thumbnails uses "ffmpegthumbnailer"         apt install ffmpegthumbnailer
+
+  All of the above: 
+  apt install x11-utils xdotool bat poppler-utils odt2txt docx2txt unzip gnumeric catdoc w3m imagemagick ffmpegthumbnailer
 
 FIRSTRUN
-unless File.exist?(Dir.home+'/.rtfm.conf')
+  
+  if not File.exist?(Dir.home+'/.rtfm.launch')
+    @rtfmlaunch = <<RTFMLAUNCH
+# This is the RTFM launcher (https://github.com/isene/RTFM)
+function r { 
+	f=$(mktemp)
+  (
+  set +e
+	rtfm "$f"
+  code=$?
+  if [ "$code" != 0 ]; then
+    rm -f "$f"
+    exit "$code"
+  fi
+  )
+  code=$?
+  if [ "$code" != 0 ]; then
+    return "$code"
+  fi
+  d=$(<"$f")
+  rm -f "$f"
+  cd "$d"
+}
+RTFMLAUNCH
+    File.write(Dir.home+'/.rtfm.launch', @rtfmlaunch)
+    @shell = File.basename(`echo "$SHELL"`.chomp)
+    `echo "source ~/.rtfm.launch" >> .#{@shell}rc`
+  end
+
   puts @firstrun
-  puts "... hit ENTER to show the RTFM help text."
-  STDIN.gets
-  puts @help
-  puts "\n... hit ENTER to start RTFM. Enjoy :-)"
+  puts "\n... hit ENTER to start RTFM. Hit ? inside RTFM to show the help text. Enjoy :-)"
   STDIN.gets
 end
 begin # BASIC SETUP
@@ -150,6 +182,8 @@ begin # BASIC SETUP
   require 'curses'
   include  Curses
 
+  firstrun unless File.exist?(Dir.home+'/.rtfm.conf')
+
   def cmd?(command)
     system("which #{command} > /dev/null 2>&1")
   end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rtfm-filemanager
 version: !ruby/object:Gem::Version
-  version: 3.0.3
+  version: '3.5'
 platform: ruby
 authors:
 - Geir Isene
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2023-05-02 00:00:00.000000000 Z
+date: 2023-05-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: curses
@@ -47,14 +47,13 @@ dependencies:
 description: 'A full featured terminal browser with syntax highlighted files, images
   shown in the terminal, videos thumbnailed, etc. You can bookmark and jump around
   easily, delete, rename, copy, symlink and move files. RTFM has a a wide range of
-  other features. New in 3.0.3: Fixed OpenAI error message'
+  other features. New in 3.5: Simplified install :-)'
 email: g@isene.com
 executables:
 - rtfm
 extensions: []
 extra_rdoc_files: []
 files:
-- ".rtfm.launch"
 - README.md
 - bin/rtfm
 - rtfm-kb.png

data/.rtfm.launch

@@ -1,28 +0,0 @@
-# This function starts RTFM and will cd to the exit dir
-#
-# Add this line to your .bashrc or .zshrc to make RTFM exit to the
-# current directory by launching the file manager via r in the terminal:
-#    source ~/.rtfm.launch
-# ... and place the file .rtfm.launch in your home directory.
-# 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.
-
-function r { 
-	f=$(mktemp)
-    (
-    set +e
-	rtfm "$f"
-    code=$?
-    if [ "$code" != 0 ]; then
-        rm -f "$f"
-        exit "$code"
-    fi
-    )
-    code=$?
-    if [ "$code" != 0 ]; then
-		return "$code"
-    fi
-    d=$(<"$f")
-    rm -f "$f"
-    cd "$d"
-}