mirrors/nnn
1
0
Fork 0
mirror of https://github.com/jarun/nnn.git synced 2024-09-28 16:57:50 +00:00
Code Issues Packages Projects Releases Wiki Activity

Update docs

Browse source
This commit is contained in:
Arun Prakash Jana 2019-12-13 19:22:19 +05:30
parent 2886abc90c
commit 78830781ee
No known key found for this signature in database
GPG key ID: A75979F35C080412
1 changed files with 9 additions and 3 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

12
README.md
View file

@ -80,6 +80,8 @@ Add to that an awesome [Wiki](https://github.com/jarun/nnn/wiki)!
2. Configure [cd on quit](https://github.com/jarun/nnn/wiki/Basic-use-cases#configure-cd-on-quit). 2. Configure [cd on quit](https://github.com/jarun/nnn/wiki/Basic-use-cases#configure-cd-on-quit).
3. Optionally open all text files in `$EDITOR` (fallback vi): `export NNN_USE_EDITOR=1`. 3. Optionally open all text files in `$EDITOR` (fallback vi): `export NNN_USE_EDITOR=1`.
4. For additional functionality [install plugins](https://github.com/jarun/nnn/tree/master/plugins#installing-plugins). 4. For additional functionality [install plugins](https://github.com/jarun/nnn/tree/master/plugins#installing-plugins).
5. To copy selected file paths to system clipboard and show notis on cp, mv, rm completion use option `-x`.
6. For a strictly CLI-only experience, see plugin `nuke`. It's a sample opener you can customize.
Notes: Notes:
@ -90,7 +92,7 @@ Notes:
#### Library dependencies #### Library dependencies
A curses library with wide char support (e.g. ncursesw), libreadline (`make O_NORL=1` to drop) and standard libc. A curses library with wide char support (e.g. ncursesw), libreadline (optional) and standard libc.
#### Utility dependencies #### Utility dependencies
@ -134,9 +136,13 @@ Packages for Arch Linux, CentOS, Debian, Fedora and Ubuntu are auto-generated wi
Download the latest stable release or clone this repository (*risky*), install deps and compile. On Ubuntu 18.04: Download the latest stable release or clone this repository (*risky*), install deps and compile. On Ubuntu 18.04:
$ sudo apt-get install pkg-config libncursesw5-dev libreadline-dev $ sudo apt-get install pkg-config libncursesw5-dev libreadline-dev
$ make
$ sudo make strip install $ sudo make strip install
To compile _without_ libreadline:
$ sudo apt-get install pkg-config libncursesw5-dev
$ sudo make O_NORL=1 strip install
`PREFIX` is supported, in case you want to install to a different location. `PREFIX` is supported, in case you want to install to a different location.
Visit the [developer guides](https://github.com/jarun/nnn/wiki/Developer-guides) for compilation notes on the Pi, Cygwin and other compilation modes. Visit the [developer guides](https://github.com/jarun/nnn/wiki/Developer-guides) for compilation notes on the Pi, Cygwin and other compilation modes.
@ -241,7 +247,7 @@ The list below is from the **dev branch**. Press <kbd>?</kbd> in `nnn` to see th
Notes: Notes:
1. Help & settings, file details and archive listing are shown in the `$PAGER`. 1. Help & settings, file details and archive listing are shown in the `$PAGER`.
2. To change shortcuts modify key bindings in `nnn.h` and compile. 2. To change shortcuts modify key bindings in `nnn.h` and compile. Option `-K` detects collisions.
| Mouse click | Function | | Mouse click | Function |
|---| --- | |---| --- |