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

Update docs

Browse source
This commit is contained in:
Arun Prakash Jana 2018-12-02 05:10:19 +05:30
parent e61917d75e
commit d2c7a5a7cb
No known key found for this signature in database
GPG key ID: A75979F35C080412
2 changed files with 7 additions and 7 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

12
README.md
View file

@ -23,9 +23,9 @@ Noice is Not Noice, a noicer fork...
`nnn` is probably the [fastest and most resource-sensitive](#memory-usage) file manager you have ever used. It integrates seamlessly with your DE and favourite GUI utilities, has a unique [navigate-as-you-type](#navigate-as-you-type-mode) mode with auto-select, disk usage analyzer mode, bookmarks, contexts, application launcher, familiar navigation shortcuts, subshell spawning and much more. `nnn` is probably the [fastest and most resource-sensitive](#memory-usage) file manager you have ever used. It integrates seamlessly with your DE and favourite GUI utilities, has a unique [navigate-as-you-type](#navigate-as-you-type-mode) mode with auto-select, disk usage analyzer mode, bookmarks, contexts, application launcher, familiar navigation shortcuts, subshell spawning and much more.
[Integrate utilities](https://github.com/jarun/nnn#sample-scripts) like sxiv or fzy easily, or use it as a [vim file picker](https://github.com/jarun/nnn#neovim-plugin); `nnn` supports as many scripts as you need! [Integrate utilities](https://github.com/jarun/nnn#sample-scripts) like sxiv or fzy easily, or use it as a [(neo)vim plugin](https://github.com/jarun/nnn#neovim-plugin); `nnn` supports as many scripts as you need!
It runs on Linux, OS X, Raspberry Pi, Cygwin, Linux subsystem for Windows and Termux. It runs on Linux, macOS, Raspberry Pi, Cygwin, Linux subsystem for Windows and Termux.
[Quickstart](#quickstart) and see how `nnn` simplifies those long desktop sessions... Missing a feature? Want to contribute? Head to the rolling [ToDo list](https://github.com/jarun/nnn/issues/137). [Quickstart](#quickstart) and see how `nnn` simplifies those long desktop sessions... Missing a feature? Want to contribute? Head to the rolling [ToDo list](https://github.com/jarun/nnn/issues/137).
@ -142,7 +142,7 @@ Intrigued? Find out [HOW](https://github.com/jarun/nnn/wiki/performance-factors)
#### Dependencies #### Dependencies
`nnn` needs libncursesw (on Linux or ncurses on OS X) and standard libc. `nnn` needs libncursesw (on Linux or ncurses on macOS) and standard libc.
#### From a package manager #### From a package manager
@ -322,13 +322,13 @@ The following indicators are used in the detail view:
| External dependency | Operation | | External dependency | Operation |
| --- | --- | | --- | --- |
| xdg-open (Linux), open(1) (OS X), cygstart (Cygwin) | desktop opener | | xdg-open (Linux), open(1) (macOS), cygstart (Cygwin) | desktop opener |
| file | determine file type | | file | determine file type |
| cp, mv, rm, xargs (from findutils on Linux) | copy, move and remove files | | cp, mv, rm, xargs (from findutils on Linux) | copy, move and remove files |
| mediainfo, exiftool | multimedia file details | | mediainfo, exiftool | multimedia file details |
| atool, patool ([integration](#integrate-patool)) | create, list and extract archives | | atool, patool ([integration](#integrate-patool)) | create, list and extract archives |
| vidir (from moreutils) | batch rename, move, delete dir entries | | vidir (from moreutils) | batch rename, move, delete dir entries |
| vlock (Linux), bashlock (OS X), lock(1) (BSD) | terminal locker | | vlock (Linux), bashlock (macOS), lock(1) (BSD) | terminal locker |
| $EDITOR (overridden by $VISUAL, if defined) | edit files (fallback vi) | | $EDITOR (overridden by $VISUAL, if defined) | edit files (fallback vi) |
| $PAGER | page through files (fallback less) | | $PAGER | page through files (fallback less) |
| $SHELL | spawn a shell, run script (fallback sh) | | $SHELL | spawn a shell, run script (fallback sh) |
@ -417,7 +417,7 @@ so you can easily handle files together:
##### to clipboard ##### to clipboard
Along with default copy, `nnn` can pipe the absolute path of the current file or multiple files to a copier script. For example, you can use `xsel` on Linux or `pbcopy` on OS X. Here's a sample [copier script](https://github.com/jarun/nnn/tree/master/scripts/copier). Along with default copy, `nnn` can pipe the absolute path of the current file or multiple files to a copier script. For example, you can use `xsel` on Linux or `pbcopy` on macOS. Here's a sample [copier script](https://github.com/jarun/nnn/tree/master/scripts/copier).
To inform `nnn` of the executable copier script location: To inform `nnn` of the executable copier script location:

2
nnn.1
View file

@ -192,7 +192,7 @@ supports the following options:
show program help and exit show program help and exit
.Sh CONFIGURATION .Sh CONFIGURATION
.Nm .Nm
uses \fIxdg-open\fR (on Linux) and \fIopen(1)\fR (on OS X) as the desktop opener. uses \fIxdg-open\fR (on Linux) and \fIopen(1)\fR (on macOS) as the desktop opener.
.Pp .Pp
There is no configuration file. Settings work on environment variables. Please There is no configuration file. Settings work on environment variables. Please
refer to the ENVIRONMENT section below. refer to the ENVIRONMENT section below.