nnn/noice.1

109 lines
2.8 KiB
Groff
Raw Normal View History

2015-01-27 10:24:09 +00:00
.Dd January 27, 2015
2014-10-22 11:52:45 +00:00
.Dt NOICE 1
.Os
.Sh NAME
.Nm noice
2014-10-22 14:27:53 +00:00
.Nd small file browser
2014-10-22 11:52:45 +00:00
.Sh SYNOPSIS
.Nm noice
.Op Ar dir
.Sh DESCRIPTION
.Nm
2014-10-22 14:27:53 +00:00
is a simple and efficient file browser that gets out of your way
2014-10-22 11:52:45 +00:00
as much as possible. It was initially implemented to be controlled
with a TV remote control.
.Pp
.Nm
defaults to the current directory if
.Ar dir
2014-11-14 14:22:07 +00:00
is not specified. As an extra feature, if
.Ar dir
is a relative path,
.Nm
will not go back beyond the first component of the path using standard
navigation key presses.
.Pp
.Nm
2014-10-22 11:52:45 +00:00
supports both vi-like and emacs-like key bindings in the default
configuration. The default key bindings are described below;
their functionality is described in more detail later.
.Pp
2014-11-14 14:41:46 +00:00
.Bl -tag -width "l, [Right], [Return] or C-mXXXX" -offset indent -compact
.It Ic k, [Up] or C-p
2014-10-22 11:52:45 +00:00
Move to previous entry.
2014-11-14 14:41:46 +00:00
.It Ic j, [Down] or C-n
2014-10-22 11:52:45 +00:00
Move to next entry.
2014-11-14 14:41:46 +00:00
.It Ic [Pgup] or C-u
Scroll up half a page.
.It Ic [Pgdown] or C-d
Scroll down half a page.
.It Ic l, [Right], [Return] or C-m
2014-10-22 11:52:45 +00:00
Open file or enter directory.
2014-11-14 14:41:46 +00:00
.It Ic h, [Left] or [Backspace]
2014-10-22 11:52:45 +00:00
Back up one directory level.
2014-11-14 14:41:46 +00:00
.It Ic / or &
Change filter (see below for more information).
2015-01-27 10:24:09 +00:00
.It Ic ?
Enter filter-as-you-type mode.
2014-10-22 11:52:45 +00:00
.It Ic c
Change into the given directory.
2014-11-14 14:41:46 +00:00
.It Ic !
Spawn shell in current directory.
2014-10-22 11:52:45 +00:00
.It Ic q
2014-11-14 14:41:46 +00:00
Quit.
2014-10-22 11:57:22 +00:00
.El
.Pp
Backing up one directory level will set the cursor position at the
directory you came out of.
2014-10-22 11:52:45 +00:00
.Sh CONFIGURATION
.Nm
is configured by modifying
.Pa config.h
and recompiling the code.
.Pp
The file associations are specified by regexes
matching on the currently selected filename. If a match is found the associated
program is executed with the filename passed in as the argument. If no match
2014-11-14 14:41:46 +00:00
is found the program
.Xr less 1
is invoked. This is useful for editing text files
as one can use the 'v' command in
.Xr less 1 to edit the file in $EDITOR.
2014-10-22 11:52:45 +00:00
.Pp
See the examples section below for more information.
.Sh FILTERS
Filters allow you to use regexes to display only the matched
entries in the current directory view. This effectively allows
searching through the directory tree for a particular entry.
.Pp
Filters do not stack on top of each other. They are applied anew
every time.
.Pp
2015-01-27 10:24:09 +00:00
To reset the filter you can input an empty filter expression.
.Pp
If
.Nm
is invoked as root the default filter will also match hidden
files.
2014-10-22 11:52:45 +00:00
.Sh EXAMPLES
The following example shows one possible configuration for
2014-11-14 14:41:46 +00:00
file associations which is also the default:
2014-10-22 11:52:45 +00:00
.Bd -literal
struct assoc assocs[] = {
2015-01-12 17:10:45 +00:00
{ "\\.(avi|mp4|mkv|mp3|ogg|flac)$", "mplayer" },
{ "\\.(png|jpg|gif)$", "feh" },
{ "\\.(html|svg)$", "firefox" },
{ "\\.pdf$", "mupdf" },
{ "\\.sh$", "sh" },
{ ".", "less" },
2014-10-22 11:52:45 +00:00
};
.Ed
2014-10-22 13:59:15 +00:00
.Sh KNOWN ISSUES
2014-10-22 16:43:55 +00:00
If you are using urxvt you might have to start it with
2014-10-22 13:59:15 +00:00
backspacekey set to DEC.
2014-10-22 11:52:45 +00:00
.Pp
.Sh AUTHORS
.Nm
was developed by Lazaros Koromilas <lostd@2f30.org> with
contributions by sin <sin@2f30.org>.