mirror of
https://github.com/jarun/nnn.git
synced 2024-11-24 11:51:27 +00:00
Update docs
This commit is contained in:
parent
3b42b6fc42
commit
f231c35ef9
|
@ -60,6 +60,7 @@ Add to that an awesome [Wiki](https://github.com/jarun/nnn/wiki)!
|
||||||
- Spawn a shell, run apps, run commands, execute file
|
- Spawn a shell, run apps, run commands, execute file
|
||||||
- Hovered file set as `$nnn` at prompt and spawned shell
|
- Hovered file set as `$nnn` at prompt and spawned shell
|
||||||
- Lock terminal (needs a locker)
|
- Lock terminal (needs a locker)
|
||||||
|
- Privacy-aware (no user information stored)
|
||||||
- Minimal deps, minimal config
|
- Minimal deps, minimal config
|
||||||
- Widely available
|
- Widely available
|
||||||
- Unicode support
|
- Unicode support
|
||||||
|
@ -149,7 +150,7 @@ There is no config file. Associated files are stored under `${XDG_CONFIG_HOME:-$
|
||||||
| --- | --- |
|
| --- | --- |
|
||||||
| `NNN_OPENER=mimeopen` | custom file opener |
|
| `NNN_OPENER=mimeopen` | custom file opener |
|
||||||
| `NNN_BMS='d:~/Documents;D:~/Docs archive/'` | key-bookmark pairs [max 10] |
|
| `NNN_BMS='d:~/Documents;D:~/Docs archive/'` | key-bookmark pairs [max 10] |
|
||||||
| `NNN_PLUG='m:nmount;t:imgthumb;x:_chmod +x $nnn'` | key-plugin (or cmd) pairs (<kbd>:key</kbd> to run) [max 15] |
|
| `NNN_PLUG='o:fzopen;m:nmount;x:_chmod +x $nnn'` | key-plugin (or cmd) pairs (<kbd>:key</kbd> to run) [max 15] |
|
||||||
| `NNN_USE_EDITOR=1` | open text files in `$VISUAL` (else `$EDITOR`, fallback vi) |
|
| `NNN_USE_EDITOR=1` | open text files in `$VISUAL` (else `$EDITOR`, fallback vi) |
|
||||||
| `NNN_CONTEXT_COLORS='1234'` | specify per context color [default: '4444' (all blue)] |
|
| `NNN_CONTEXT_COLORS='1234'` | specify per context color [default: '4444' (all blue)] |
|
||||||
| `NNN_SSHFS_OPTS='sshfs -o reconnect,idmap=user'` | specify SSHFS options |
|
| `NNN_SSHFS_OPTS='sshfs -o reconnect,idmap=user'` | specify SSHFS options |
|
||||||
|
|
|
@ -8,6 +8,7 @@ n ()
|
||||||
|
|
||||||
# The default behaviour is to cd on quit (nnn checks if NNN_TMPFILE is set)
|
# The default behaviour is to cd on quit (nnn checks if NNN_TMPFILE is set)
|
||||||
# To cd on quit only on ^G, export NNN_TMPFILE after the call to nnn
|
# To cd on quit only on ^G, export NNN_TMPFILE after the call to nnn
|
||||||
|
# NOTE: NNN_TMPFILE is fixed, should not be modified
|
||||||
export NNN_TMPFILE="${XDG_CONFIG_HOME:-$HOME/.config}/nnn/.lastd"
|
export NNN_TMPFILE="${XDG_CONFIG_HOME:-$HOME/.config}/nnn/.lastd"
|
||||||
|
|
||||||
# Unmask ^Q (, ^V etc.) (if required, see `stty -a`) to Quit nnn
|
# Unmask ^Q (, ^V etc.) (if required, see `stty -a`) to Quit nnn
|
||||||
|
|
|
@ -2,6 +2,7 @@
|
||||||
|
|
||||||
# The default behaviour is to cd on quit (nnn checks if NNN_TMPFILE is set)
|
# The default behaviour is to cd on quit (nnn checks if NNN_TMPFILE is set)
|
||||||
# To cd on quit only on ^G, export NNN_TMPFILE after the call to nnn
|
# To cd on quit only on ^G, export NNN_TMPFILE after the call to nnn
|
||||||
|
# NOTE: NNN_TMPFILE is fixed, should not be modified
|
||||||
set NNN_TMPFILE=~/.config/nnn/.lastd
|
set NNN_TMPFILE=~/.config/nnn/.lastd
|
||||||
|
|
||||||
# Unmask ^Q (, ^V etc.) (if required, see `stty -a`) to Quit nnn
|
# Unmask ^Q (, ^V etc.) (if required, see `stty -a`) to Quit nnn
|
||||||
|
|
|
@ -11,6 +11,7 @@ function n --description 'support nnn quit and change directory'
|
||||||
|
|
||||||
# The default behaviour is to cd on quit (nnn checks if NNN_TMPFILE is set)
|
# The default behaviour is to cd on quit (nnn checks if NNN_TMPFILE is set)
|
||||||
# To cd on quit only on ^G, export NNN_TMPFILE after the call to nnn
|
# To cd on quit only on ^G, export NNN_TMPFILE after the call to nnn
|
||||||
|
# NOTE: NNN_TMPFILE is fixed, should not be modified
|
||||||
if test -n "$XDG_CONFIG_HOME"
|
if test -n "$XDG_CONFIG_HOME"
|
||||||
set -x NNN_TMPFILE "$XDG_CONFIG_HOME/nnn/.lastd"
|
set -x NNN_TMPFILE "$XDG_CONFIG_HOME/nnn/.lastd"
|
||||||
else
|
else
|
||||||
|
|
|
@ -8,6 +8,7 @@ n ()
|
||||||
|
|
||||||
# The default behaviour is to cd on quit (nnn checks if NNN_TMPFILE is set)
|
# The default behaviour is to cd on quit (nnn checks if NNN_TMPFILE is set)
|
||||||
# To cd on quit only on ^G, export NNN_TMPFILE after the call to nnn
|
# To cd on quit only on ^G, export NNN_TMPFILE after the call to nnn
|
||||||
|
# NOTE: NNN_TMPFILE is fixed, should not be modified
|
||||||
export NNN_TMPFILE="${XDG_CONFIG_HOME:-$HOME/.config}/nnn/.lastd"
|
export NNN_TMPFILE="${XDG_CONFIG_HOME:-$HOME/.config}/nnn/.lastd"
|
||||||
|
|
||||||
# Unmask ^Q (, ^V etc.) (if required, see `stty -a`) to Quit nnn
|
# Unmask ^Q (, ^V etc.) (if required, see `stty -a`) to Quit nnn
|
||||||
|
|
2
nnn.1
2
nnn.1
|
@ -192,7 +192,7 @@ when dealing with the !, e and p commands respectively. A single combination to
|
||||||
To assign keys to arbitrary non-background non-shell-interpreted cli
|
To assign keys to arbitrary non-background non-shell-interpreted cli
|
||||||
commands and invoke like plugins, add \fI_\fR (underscore) before the command.
|
commands and invoke like plugins, add \fI_\fR (underscore) before the command.
|
||||||
.Bd -literal
|
.Bd -literal
|
||||||
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;m:nmount'
|
||||||
|
|
||||||
NOTES:
|
NOTES:
|
||||||
1. Use single quotes for $NNN_PLUG so $nnn is not interpreted
|
1. Use single quotes for $NNN_PLUG so $nnn is not interpreted
|
||||||
|
|
Loading…
Reference in a new issue