mirrors
/
nnn
mirror of https://github.com/jarun/nnn.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Fix #97: add manpage for nlay

This commit is contained in:
Arun Prakash Jana 2018-03-14 22:29:59 +05:30
parent 6ac45b92bd
commit 063882c420
No known key found for this signature in database
GPG Key ID: A75979F35C080412
3 changed files with 40 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
Makefile
View File

@ -17,7 +17,7 @@ else
LDLIBS += -lncurses
endif
DISTFILES = nlay nnn.c nnn.h nnn.1 Makefile README.md LICENSE
DISTFILES = nlay nlay.1 nnn.c nnn.h nnn.1 Makefile README.md LICENSE
SRC = nnn.c
BIN = nnn
PLAYER = nlay
@ -37,11 +37,13 @@ install: all
$(INSTALL) -m 0755 $(BIN) $(PLAYER) $(DESTDIR)$(PREFIX)/bin
$(INSTALL) -m 0755 -d $(DESTDIR)$(MANPREFIX)/man1
$(INSTALL) -m 0644 $(BIN).1 $(DESTDIR)$(MANPREFIX)/man1
$(INSTALL) -m 0644 $(PLAYER).1 $(DESTDIR)$(MANPREFIX)/man1
uninstall:
$(RM) $(DESTDIR)$(PREFIX)/bin/$(BIN)
$(RM) $(DESTDIR)$(PREFIX)/bin/$(PLAYER)
$(RM) $(DESTDIR)$(MANPREFIX)/man1/$(BIN).1
$(RM) $(DESTDIR)$(MANPREFIX)/man1/$(PLAYER).1
strip: $(BIN)
$(STRIP) $^

2
nlay
View File

@ -3,7 +3,7 @@
# #############################################################################
# nlay: a customizable script to play files in different apps by file type
#
# usage: nlay file type
# usage: nlay file/path type/action
#
# MUST READ:
#

36
nlay.1 Normal file
View File

@ -0,0 +1,36 @@
.Dd Mar 14, 2018
.Dt NLAY 1
.Os
.Sh NAME
.Nm nlay
.Nd a bash script to play files in different apps by file type or run some actions.
.Sh SYNOPSIS
.Nm
file/path type/action
.Sh DESCRIPTION
.Nm
is shipped with \fInnn\fR to deliver a level of flexibility to users to choose their own apps when running some actions. It has provisions to handle text files too. However, the capability is not used in the latest releases and the file type is limited to text files only. Now
.Nm
is invoked to run a desktop search utility (\fIgnome-search-tool\fR or \fIcatfish\fR in the same order of priority) or screen locker (\fIvlock\fR, Linux-only). However,
.Nm
can run independently and can be highly customized for personal usage.
.Pp
.Nm
supports the following options:
.Pp
"file/path"
The first argument can be the file or path to pass as an argument to the app. It can also be an empty string e.g., while locking the terminal.
.Pp
"type/action"
This can be any of the strings \fItext\fR, \fIsearch\fR or \fI screensaver\fR.
.Sh USAGE
.Pp
.Bd -literal
$ nlay info.txt text
$ nlay . search
$ nlay "" screensaver
.Ed
.Sh AUTHOR
.An Arun Prakash Jana Aq Mt engineerarun@gmail.com .
.Sh HOME
.Em https://github.com/jarun/nnn