nirv.git

.\" nirv - music player
.\" Copyright (C) 2023 ArcNyxx
.\" see LICENCE file for licensing information
.TH NCTL 1 nirv\-VERSION
.SH NAME
nctl \- music player control
.SH SYNOPSIS
.SY nctl
.RI [ option ]\ [ argument ]
.YS
.SH DESCRIPTION
.BR nctl (1)
is a helper script which extends the functionality of
.BR nirv (1).
When invoked,
.BR nctl (1)
will automatically start
.BR nirv (1)
if it is not already running.
.SH OPTIONS
.TP
.B -q
Kill the current instance of
.BR nirv (1).
.TP
.B -p
Pause.
.TP
.BR -t \ [ \fInum\fB ]
Skip forwards or backwards a number of seconds, with a positive or negative
number respectively.
.TP
.B -e
End the currently playing song.
.TP
.B -r
Restart the currently playing song.
.TP
.B -c
Clear the queue.
.TP
.B -k
Shuffle the queue.
.TP
.B -l
Toggle loop for the currently playing song.
.TP
.BR -f \ [ \fIfile\fB ]
Append a song to the queue.
.TP
.BR -d \ [ \fIfile\fB ]
Append a directory of songs to the queue in numerical order.
.TP
.BR -s \ [ \fIfile\fB ]
Append a directory of songs to the queue shuffled.
.SH FILES
.TP
.B /tmp/nctl-list
A list of newline-separated canonical filenames of
.B flac
files to be played by
.BR nirv (1).
.TP
.B /tmp/nctl-loop
A regular empty file created when
.BR nctl (1)
is looping the same song.
.SH ENVIRONMENT
.TP
.B MUSIC
The path to a directory containing a folder structure of authors, albums, and
music files.  Defaults to
.IR $HOME /music
.SH AUTHOR
Written by ArcNyxx.
.SH SEE ALSO
.BR nirv (1)