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 2020-02-20 00:57:14 +05:30
parent f6e814e364
commit f7f53bbd6b
No known key found for this signature in database
GPG key ID: A75979F35C080412
2 changed files with 22 additions and 8 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

6
README.md
View file

@ -149,8 +149,10 @@ 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 ```sh
$ sudo make strip install sudo apt-get install pkg-config libncursesw5-dev libreadline-dev
sudo make 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.

12
plugins/README.md
View file

@ -16,7 +16,9 @@ Plugins extend the capabilities of `nnn`. They are _executable_ scripts (or bina
The following command installs or updates (after backup) all plugins: The following command installs or updates (after backup) all plugins:
```sh
curl -Ls https://raw.githubusercontent.com/jarun/nnn/master/plugins/getplugs | sh curl -Ls https://raw.githubusercontent.com/jarun/nnn/master/plugins/getplugs | sh
```
Plugins are installed to `${XDG_CONFIG_HOME:-$HOME/.config}/nnn/plugins`. Plugins are installed to `${XDG_CONFIG_HOME:-$HOME/.config}/nnn/plugins`.
@ -69,7 +71,9 @@ Plugins are installed to `${XDG_CONFIG_HOME:-$HOME/.config}/nnn/plugins`.
Use the plugin shortcut (<kbd>;key</kbd> or <kbd>^Skey</kbd>) to list the defined plugin keys and press the required key. E.g., with the below config: Use the plugin shortcut (<kbd>;key</kbd> or <kbd>^Skey</kbd>) to list the defined plugin keys and press the required key. E.g., with the below config:
```sh
export NNN_PLUG='o:fzopen;p:mocplay;d:diffs;m:nmount;n:notes;v:imgviu;t:imgthumb' export NNN_PLUG='o:fzopen;p:mocplay;d:diffs;m:nmount;n:notes;v:imgviu;t:imgthumb'
```
Plugin `fzopen` can be run with the keybind <kbd>;o</kbd>, `mocplay` can be run with <kbd>;p</kbd> and so on... The key vs. plugin pairs are shown in the help and config screen. Plugin `fzopen` can be run with the keybind <kbd>;o</kbd>, `mocplay` can be run with <kbd>;p</kbd> and so on... The key vs. plugin pairs are shown in the help and config screen.
@ -79,7 +83,9 @@ A maximum of 15 keys can be defined. To select and invoke a plugin from the plug
`nnn` refreshes the directory after running a plugin to reflect any changes by the plugin. To disable this (say while running the `mediainfo` plugin on some filtered files), add a `-` before the plugin name: `nnn` refreshes the directory after running a plugin to reflect any changes by the plugin. To disable this (say while running the `mediainfo` plugin on some filtered files), add a `-` before the plugin name:
```sh
export NNN_PLUG='m:-mediainfo' export NNN_PLUG='m:-mediainfo'
```
Now `nnn` will not refresh the directory after running the `mediainfo` plugin. Now `nnn` will not refresh the directory after running the `mediainfo` plugin.
@ -89,7 +95,9 @@ To assign keys to arbitrary non-background, non-shell-interpreted cli commands a
For example: For example:
```sh
export NNN_PLUG='x:_chmod +x $nnn;g:_git log;s:_smplayer $nnn;o:fzopen' export NNN_PLUG='x:_chmod +x $nnn;g:_git log;s:_smplayer $nnn;o:fzopen'
```
Now <kbd>;x</kbd> can be used to make a file executable, <kbd>;g</kbd> can be used to the git log of a git project directory, <kbd>;s</kbd> can be used to preview a partially downloaded media file. Now <kbd>;x</kbd> can be used to make a file executable, <kbd>;g</kbd> can be used to the git log of a git project directory, <kbd>;s</kbd> can be used to preview a partially downloaded media file.
@ -97,7 +105,9 @@ Now <kbd>;x</kbd> can be used to make a file executable, <kbd>;g</kbd> can be us
`nnn` waits for user confirmation (the prompt `Press Enter to continue`) after it executes a command as plugin (unlike plugins which can add a `read` to wait). To skip this, add a `*` after the command. For example: `nnn` waits for user confirmation (the prompt `Press Enter to continue`) after it executes a command as plugin (unlike plugins which can add a `read` to wait). To skip this, add a `*` after the command. For example:
```sh
export NNN_PLUG='s:_smplayer $nnn*;n:-_vim /home/vaio/Dropbox/Public/synced_note*' export NNN_PLUG='s:_smplayer $nnn*;n:-_vim /home/vaio/Dropbox/Public/synced_note*'
```
Now there will be no prompt after <kbd>;s</kbd> and <kbd>;n</kbd>. Now there will be no prompt after <kbd>;s</kbd> and <kbd>;n</kbd>.
@ -105,7 +115,9 @@ Now there will be no prompt after <kbd>;s</kbd> and <kbd>;n</kbd>.
To run a GUI app as plugin, add a `|` after `_`. For example: To run a GUI app as plugin, add a `|` after `_`. For example:
```sh
export NNN_PLUG='m:-_|mousepad $nnn' export NNN_PLUG='m:-_|mousepad $nnn'
```
Notes: Notes: