mirrors/nnn
1
0
Fork 0
mirror of https://github.com/jarun/nnn.git synced 2024-11-17 16:39:14 +00:00
Code Issues Packages Projects Releases Wiki Activity

Update docs

Browse source
This commit is contained in:
Arun Prakash Jana 2019-03-14 20:46:57 +05:30
parent 47d35e1396
commit 4d6ec9c475
No known key found for this signature in database
GPG key ID: A75979F35C080412
1 changed files with 17 additions and 12 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

29
README.md
View file

@ -75,36 +75,33 @@ It runs on Linux, macOS, Raspberry Pi, BSD, Cygwin, Linux subsystem for Windows
#### FEATURES #### FEATURES
- Modes - Modes
- Basic, detail (default), disk usage analyzer (du) - Detail (default), light, disk usage analyzer (du)
- File picker, vim (or neovim) plugin - File picker, vim (or neovim) plugin
- Navigation - Navigation
- Contexts (_aka_ tabs _aka_ workspaces)
- *Navigate-as-you-type* with auto-select directory - *Navigate-as-you-type* with auto-select directory
- Bookmarks - 4 contexts (_aka_ tabs _aka_ workspaces)
- Bookmarks; pin and visit a directory
- Familiar, easy shortcuts (arrows, <kbd>~</kbd>, <kbd>-</kbd>, <kbd>@</kbd>) - Familiar, easy shortcuts (arrows, <kbd>~</kbd>, <kbd>-</kbd>, <kbd>@</kbd>)
- Pin and visit a directory
- Sorting - Sorting
- Directories always listed on top
- Sort by file name, modification time, size
- Ordered pure numeric names by default (visit _/proc_) - Ordered pure numeric names by default (visit _/proc_)
- Sort by file name, modification time, size
- Version (_aka_ natural) sort - Version (_aka_ natural) sort
- Search - Search
- Instant filtering with *search-as-you-type* - Instant filtering with *search-as-you-type*
- Regex and substring match - Regex and substring match
- Mimes - Mimes
- Open with desktop opener or specify a custom app - Open with desktop opener or specify a custom app
- Create, list, extract archives (needs (p)atool) - Create, list, extract archive (needs (p)atool)
- Open all text files in EDITOR (optional) - Open all text files in EDITOR (optional)
- Information - Information
- Detailed stat-like file information - Detailed file information (stat and file)
- Media information (needs mediainfo/exiftool) - Media information (needs mediainfo/exiftool)
- Convenience - Convenience
- Create, rename files and directories - Create, rename files and directories
- Select files across dirs; all/range selection - Select files across dirs; all/range selection
- Copy, move, delete, archive selection - Copy, move, delete, archive, link selection
- FreeDesktop compliant trash (needs trash-cli) - FreeDesktop compliant trash (needs trash-cli)
- Show copy, move progress on Linux (needs avdcpmv) - Show copy, move progress on Linux (needs avdcpmv)
- Create sym/hard link(s) to selection
- Transfer files using lftp - Transfer files using lftp
- Batch rename (needs vidir) - Batch rename (needs vidir)
- Show directories in custom color (default: blue) - Show directories in custom color (default: blue)
@ -398,15 +395,23 @@ To lookup keyboard shortcuts at runtime, press <kbd>?</kbd>.
5. To use `nnn` as a GUI app launcher with fuzzy selection menu, drop [`nlaunch`](https://github.com/jarun/nnn/blob/master/user-scripts/nlaunch) somewhere in your `$PATH`. 5. To use `nnn` as a GUI app launcher with fuzzy selection menu, drop [`nlaunch`](https://github.com/jarun/nnn/blob/master/user-scripts/nlaunch) 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. 6. Don't memorize keys. Arrows, <kbd>/</kbd> and <kbd>q</kbd> suffice. Press <kbd>?</kbd> for help on keyboard shortcuts anytime.
- For additional functionality [setup custom scripts](https://github.com/jarun/nnn/wiki/How-to#run-custom-scripts). - For additional functionality [setup custom scripts](#user-scripts).
- Visit the [How to](https://github.com/jarun/nnn/wiki/How-to) for many more specific usecases. - Visit the [How to](https://github.com/jarun/nnn/wiki/How-to) for many more specific usecases.
#### USER SCRIPTS #### USER SCRIPTS
Copy the scripts in the [user-scripts](https://github.com/jarun/nnn/tree/master/user-scripts) directory and let `nnn` know the location: `nnn` can invoke custom scripts in the current directory (`$PWD` for the script) with the currently selected file name as the argument.
Copy the scripts of your interest in the [user-scripts](https://github.com/jarun/nnn/tree/master/user-scripts) directory and let `nnn` know the location:
export NNN_SCRIPT=/absolute/path/to/scripts_dir export NNN_SCRIPT=/absolute/path/to/scripts_dir
Use the run/pick script shortcut to jump to the script directory and pick a script. Repeating the same shortcut cancels the operation and puts you back in the original directory.
In case you need only one script:
export NNN_SCRIPT=/absolute/path/to/script
If you have an interesting script feel free to raise a PR. If you have an interesting script feel free to raise a PR.
#### TROUBLESHOOTING #### TROUBLESHOOTING