mirrors
/
nnn
mirror of https://github.com/jarun/nnn.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Update docs

This commit is contained in:
Arun Prakash Jana 2019-04-30 08:36:55 +05:30
parent b555887ca8
commit 8f1fdcf3e8
No known key found for this signature in database
GPG Key ID: A75979F35C080412
4 changed files with 23 additions and 12 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

22
README.md
View File

@ -23,11 +23,11 @@
<p align="center"><i>3 modes of nnn (light with filter, detail, du analyzer) with memory usage. Click for a demo video.</i></a></p>
`nnn` is smooth... like butter. It's one of the fastest and most lightweight file managers, thanks to a [highly optimized](https://github.com/jarun/nnn/wiki/performance-factors) code. And yet, it doesn't lack in features!
`nnn` is smooth... like butter. It's one of the fastest and most lightweight file managers, thanks to a **[highly optimized](https://github.com/jarun/nnn/wiki/performance-factors)** code. And yet, it doesn't lack in features!
It runs on Linux, macOS, Raspberry Pi, BSD, Cygwin, Linux subsystem for Windows and Termux on Android.
`nnn` works seamlessly with DEs and GUI utilities. Several plugins are available to extend its power. New plugins can be added easily.
`nnn` works seamlessly with DEs and GUI utilities. Several **[plugins](https://github.com/jarun/nnn/tree/master/plugins)** are available to extend its power. New plugins can be added easily.
**[Quickstart](#quickstart)** and see how `nnn` simplifies long desktop sessions.
@ -78,8 +78,8 @@ It runs on Linux, macOS, Raspberry Pi, BSD, Cygwin, Linux subsystem for Windows
- Disk usage analyzer (block/apparent)
- File picker, (neo)vim plugin
- Navigation
- *Navigate-as-you-type* with auto-select dir, *wild load*
- 4 contexts (_aka_ tabs _aka_ workspaces)
- *Navigate-as-you-type* with dir auto-select, *wild load*
- 4 contexts (_aka_ tabs/workspaces)
- Bookmarks; pin and visit a directory
- Familiar, easy shortcuts (arrows, <kbd>~</kbd>, <kbd>-</kbd>, <kbd>@</kbd>)
- Sorting
@ -93,19 +93,19 @@ It runs on Linux, macOS, Raspberry Pi, BSD, Cygwin, Linux subsystem for Windows
- Mimes
- Open with desktop opener or specify a custom app
- Create, list, extract archive (needs (p)atool)
- Open all text files in EDITOR (optional)
- Option to open all text files in EDITOR
- Information
- Detailed file information (stat and file)
- Detailed file information
- Media information (needs mediainfo/exiftool)
- Convenience
- Create, rename files and directories
- Select files across dirs; all/range selection
- Copy, move, delete, archive, link selection
- FreeDesktop compliant trash (needs trash-cli)
- Show copy, move progress on Linux (needs avdcpmv)
- Plugin repository
- SSHFS mounts (needs sshfs)
- Batch rename (needs vidir)
- Show copy, move progress on Linux (needs avdcpmv)
- Per-context directory color (default: blue)
- Spawn a shell in the current directory
- Launch applications, run a command
@ -129,6 +129,8 @@ It runs on Linux, macOS, Raspberry Pi, BSD, Cygwin, Linux subsystem for Windows
#### Utility dependencies
The following table is a complete list. Some of the utilities may be installed by default (e.g. desktop opener, file, coreutils, findutils) and some may not be required by all users (e.g. sshfs, vlock, advcpmv).
| Dependency | Operation |
| --- | --- |
| xdg-open (Linux), open(1) (macOS), cygstart (Cygwin) | desktop opener |
@ -136,7 +138,6 @@ It runs on Linux, macOS, Raspberry Pi, BSD, Cygwin, Linux subsystem for Windows
| trash-cli | trash files (default: delete) |
| mediainfo / exiftool | multimedia file details |
| atool / patool ([integration](https://github.com/jarun/nnn/wiki/hacking-nnn#integrate-patool)) | create, list and extract archives |
| fzy | app launcher, subtree search |
| vidir (from moreutils) | batch rename dir entries |
| sshfs, fusermount(3) | mount, unmount remote over SSHFS |
| vlock (Linux), bashlock (macOS), lock(1) (BSD) | terminal locker |
@ -194,10 +195,9 @@ Option completion scripts for Bash, Fish and Zsh can be found in respective subd
2. Configure [cd on quit](https://github.com/jarun/nnn/wiki/hacking-nnn#cd-on-quit).
3. Optionally open all text files in `$EDITOR` (fallback vi): `export NNN_USE_EDITOR=1`
4. Run `n`.
5. To enable the GUI app launcher with a fuzzy drop-down selection menu [`nlaunch`](https://github.com/jarun/nnn/tree/master/scripts/nlaunch), drop it somewhere in your `$PATH`.
6. Don't memorize keys. Arrows, <kbd>/</kbd> and <kbd>q</kbd> suffice. Press <kbd>?</kbd> for help on keyboard shortcuts anytime.
5. For additional functionality [setup plugins](https://github.com/jarun/nnn/tree/master/plugins#installing-plugins) and the GUI app launcher [`nlaunch`](https://github.com/jarun/nnn/tree/master/scripts/nlaunch).
- For additional functionality [setup plugins](#plugins).
- Don't memorize keys. Arrows, <kbd>/</kbd> and <kbd>q</kbd> suffice. Press <kbd>?</kbd> for help on keyboard shortcuts anytime.
- When you are ready for more, start [hacking `nnn`](https://github.com/jarun/nnn/wiki/hacking-nnn).
- To set `nnn` as the default file manager, follow these [instructions](https://github.com/jarun/nnn/wiki/nnn-as-default-file-manager).

6
plugins/README.md
View File

@ -19,6 +19,12 @@
| transfer | sh | curl | Upload current file to transfer.sh |
| upgrade | sh | wget | Upgrade to latest nnn version manually on Debian 9 Stretch |
#### Installing plugins
Download the `getplugs` plugin and execute it to get all the plugins. You can run it again later to update the plugins.
Note that `getplugs` also downloads the launcher `nlaunch` which you have to drop somewhere in your `$PATH` manually.
#### File access from plugins
Plugins can access:

3
plugins/getplugs
View File

@ -5,7 +5,10 @@
# Shell: POSIX compliant
# Author: Arun Prakash Jana
mkdir -p ~/.config/nnn/plugins
cd ~/.config/nnn/plugins
wget -nv --show-progress https://github.com/jarun/nnn/archive/master.tar.gz
tar -xf master.tar.gz
cp -vf nnn-master/plugins/* .
cp -vf nnn-master/scripts/nlaunch/nlaunch .
rm -rf nnn-master/ master.tar.gz README.md

4
scripts/nlaunch/README.md
View File

@ -1,4 +1,6 @@
`nlaunch` is an independent POSIX-compliant GUI application launcher shell script. Its only dependency is `fzy`. It's possible to set a keyboard shortcut to open `nlaunch` in a terminal and use it as the regular launcher.
`nlaunch` is an independent POSIX-compliant GUI application launcher shell script. To use it with `nnn` you need to mark the file executable and drop it somewhere in your `$PATH`.
It requires [`fzy`](https://github.com/jhawthorn/fzy) to show a fuzzy drop-down menu.
To use `nlaunch` as an independent launcher add a keybind to open `nlaunch` in a terminal e.g.