From f93bb79de81d683125fd41cb9b139bf1539f5b57 Mon Sep 17 00:00:00 2001
From: Arun Prakash Jana <engineerarun@gmail.com>
Date: Fri, 10 Apr 2020 18:00:52 +0530
Subject: [PATCH] Update docs
---
README.md | 31 ++++++++++++++++++++++++++++---
nnn.1 | 10 ++++++++++
2 files changed, 38 insertions(+), 3 deletions(-)
diff --git a/README.md b/README.md
index 0f9ca5e..b335f91 100644
--- a/README.md
+++ b/README.md
@@ -8,6 +8,7 @@
<a href="https://en.wikipedia.org/wiki/Privacy-invasive_software"><img src="https://img.shields.io/badge/privacy-✓-crimson?maxAge=2592000" alt="Privacy Awareness" /></a>
<a href="https://github.com/jarun/nnn/blob/master/LICENSE"><img src="https://img.shields.io/badge/license-BSD%202--Clause-yellow.svg?maxAge=2592000" alt="License" /></a>
<a href="https://github.com/jarun/nnn/wiki"><img src="https://img.shields.io/badge/nnn-Wiki-important?maxAge=2592000" alt="Wiki" /></a>
+<a href="https://www.paypal.com/cgi-bin/webscr?cmd=_s-xclick&hosted_button_id=RMLTQ76JSXJ4Q"><img src="https://img.shields.io/badge/PayPal-donate-1eb0fc.svg" alt="Donate via PayPal!" /></a>
</p>
<p align="center"><a href="https://www.youtube.com/watch?v=U2n5aGqou9E"><img src="https://i.imgur.com/MPWpmos.png" /></a></p>
@@ -23,9 +24,33 @@ It runs smoothly on the Pi, [Termux](https://www.youtube.com/watch?v=AbaauM7gUJw
Once installed (instructions below), visit the [Wiki](https://github.com/jarun/nnn/wiki).
-<p align="center">
-<a href="https://www.paypal.com/cgi-bin/webscr?cmd=_s-xclick&hosted_button_id=RMLTQ76JSXJ4Q"><img src="https://img.shields.io/badge/PayPal-donate-1eb0fc.svg" alt="Donate via PayPal!" /></a>
-</p>
+## Black magic!
+
+1. Turbo navigate with automatic dir selection
+2. Select files from anywhere (not just a single dir)
+3. Run custom commands with custom hotkeys
+4. Edit and preview markdown, man page, html quickly
+5. Open a file and auto-proceed to the next
+6. Export (filtered) list of files to a text file
+7. Find files by mime-type and list in `nnn`
+8. Write a plugin in any language you know
+9. Configure the middle mouse click to do anything
+10. Fuzzy search subtree and open the directory of a file
+11. Load four dirs with custom settings at once
+12. Show notifications on cp, mv completion
+13. Auto-sync selection to system clipboard
+14. Open text files detached in another pane/tab/window
+15. Create files/dirs/duplicates with parents (like `mkdir -p`)
+16. Toggle hidden with <kbd>.</kbd>, go HOME with <kbd>~</kbd> or to the last dir with <kbd>-</kbd>
+17. Pin a frequently visited directory at runtime
+18. Mount any cloud storage service in few keypresses
+19. Mount and modify archives
+20. Filter filtered entries
+21. Sort files by access time and inode change time
+22. Access selection from another instance of `nnn`
+23. Compile out features you don't need
+24. Watch matrix text flying or read random fortune messages
+25. Configure it in 5 minutes!
## Features
diff --git a/nnn.1 b/nnn.1
index 2ab10bf..69efdcf 100644
--- a/nnn.1
+++ b/nnn.1
@@ -280,6 +280,16 @@ or redirect a list from a file:
nnn < files.txt
.Ed
.Pp
+Handy bash/zsh shell function to list files by mime-type in current directory:
+.Bd -literal
+ # to show video files, run: list video
+
+ list ()
+ {
+ find . -maxdepth 1 | file -if- | grep "$1" | awk -F: '{printf "%s\0", $1}' | nnn
+ }
+.Ed
+.Pp
A temporary directory will be created containing symlinks to the given
paths. Any action performed on these symlinks will be performed only on their
targets, after which they might become invalid.