Return to pl.1 CVS log

Up to [Coherent Logic Development] / plm

Add install and uninstall rules to Makefile

.\"
.\" $Id: pl.1,v 1.2 2025/04/27 19:49:33 snw Exp $
.\"  pl man page
.\"
.\"   $Log: pl.1,v $
.\"   Revision 1.2  2025/04/27 19:49:33  snw
.\"   Add install and uninstall rules to Makefile
.\"
.\"   Revision 1.1  2025/04/27 18:53:36  snw
.\"   Add pl man page
.\"
.\"
.\" SPDX-FileCopyrightText: (C) 2025 Serena Willis
.\" SPDX-License-Identifier: GFDL-1.3-or-later
.\"
.TH pl 1 "27 Apr 2025" PLM "PLM User Manual"
.SH NAME
pl - playlist manager
.SH SYNOPSIS
.B pl [OPTIONS...] --check|--repair|--play|--sync|--merge|--help --input=[playlist1,...] [--output=playlist]
.SH DESCRIPTION
The \fBpl\fR program manages m3u playlists.
.SH ACTIONS
.TP
\-c, --check
.RS 4
Check the playlists specified by \fI--input\fR for missing files
.RE
.TP
\-r, --repair
.RS 4
Interactively repair playlists specified by \fI--input\fR
.RE
.TP
\-p, --play
.RS 4
Plays the playlists specified by \fI--input\fR
.RE
.TP
\-S, --sync \fIdirectory\fR
.RS 4
Synchronizes the playlists specified in \fI--input\fR to \fIdirectory\fR
.RE
.TP
\-m, --merge
.RS 4
Combines the playlists specified in \fI--input\fR into a single playlist specified in \fI--output\fR
.RE
.TP
\-h, --help
.RS 4
Displays a brief summary of \fBpl\fR syntax and options
.RE
.SH OPTIONS
.TP
\-v, --verbose
.RS 4
Increases verbosity of \fBpl\fR output during certain operations
.RE
.TP
\-V, --overwrite
.RS 4
Allows \fBpl\fR to overwrite the playlist specified in \fI--output\fR if it already exists
.RE
.TP
\-b, --basedir \fIdirectory\fR
.RS 4
Specifies \fIdirectory\fR as the base location of the media library with which \fBpl\fR operates
.RE
.TP
\-s, --shuffle
.RS 4
Applies only to the \fI--play\fR action, and will shuffle all of the playlists selected by \fI--input\fR during playback
.RE
.TP
\-R, --repeat
.RS 4
Applies only to the \fI--play\fR action, and will cause playback to restart at the beginning of the first playlist specified in \fI--input\fR when the last item in the last playlist has finished playing
.RE
.TP
\-d, --delete=\fIall\fR|\fIupdate\fR
.RS 4
Applies only to the \fI--sync\fR action: \fBall\fR will delete everything in the destination prior to syncing, while \fBupdate\fR will only delete items removed from the playlists specified in \fI--input\fR since the last sync was performed
.RE
.SH RETURN VALUES
Returns \fB0\fR for successful completion; non-zero when errors occur
.SH FILES
.TP
/etc/default/pl
The default configuration of PLM, consisting of a name-value pair for \fBBASEDIR\fR, such as \fIBASEDIR=/path/to/music/library\fB
.TP
$HOME/.plrc
Overrides \fI/etc/default/pl\fR
.TP
$HOME/.config/plm/defaults
Overrides \fI$HOME/.plrc\fR
.SH ENVIRONMENT
.TP
$PL_BASEDIR
Overrides all configuration options for \fBBASEDIR\fR
.SH BUGS
Unknown at this time, though bugs are a very high likelihood.
.SH AUTHOR
Written by Serena Willis <snw@coherent-logic.com>
.SH COPYRIGHT
Copyright (C) 2025 Coherent Logic Development LLC

Permission is granted to copy, distribute and/or modify this document under the terms of the GNU Free Documentation License, Version 1.3 or any later version published by the Free Software Foundation; with no Invariant Sections, with no Front-Cover texts, and with no Back-Cover Texts.
.SH SEE ALSO
.PP
\fBgenpl\fR(1)