Return to pl.1 CVS log

Up to [Coherent Logic Development] / plm

Add install and uninstall rules to Makefile

    1: .\"
    2: .\" $Id: pl.1,v 1.2 2025/04/27 19:49:33 snw Exp $
    3: .\"  pl man page
    4: .\"
    5: .\"   $Log: pl.1,v $
    6: .\"   Revision 1.2  2025/04/27 19:49:33  snw
    7: .\"   Add install and uninstall rules to Makefile
    8: .\"
    9: .\"   Revision 1.1  2025/04/27 18:53:36  snw
   10: .\"   Add pl man page
   11: .\"
   12: .\"
   13: .\" SPDX-FileCopyrightText: (C) 2025 Serena Willis
   14: .\" SPDX-License-Identifier: GFDL-1.3-or-later
   15: .\"
   16: .TH pl 1 "27 Apr 2025" PLM "PLM User Manual"
   17: .SH NAME
   18: pl - playlist manager
   19: .SH SYNOPSIS
   20: .B pl [OPTIONS...] --check|--repair|--play|--sync|--merge|--help --input=[playlist1,...] [--output=playlist]
   21: .SH DESCRIPTION
   22: The \fBpl\fR program manages m3u playlists.
   23: .SH ACTIONS
   24: .TP
   25: \-c, --check
   26: .RS 4
   27: Check the playlists specified by \fI--input\fR for missing files
   28: .RE
   29: .TP
   30: \-r, --repair
   31: .RS 4
   32: Interactively repair playlists specified by \fI--input\fR
   33: .RE
   34: .TP
   35: \-p, --play
   36: .RS 4
   37: Plays the playlists specified by \fI--input\fR
   38: .RE
   39: .TP
   40: \-S, --sync \fIdirectory\fR
   41: .RS 4
   42: Synchronizes the playlists specified in \fI--input\fR to \fIdirectory\fR
   43: .RE
   44: .TP
   45: \-m, --merge
   46: .RS 4
   47: Combines the playlists specified in \fI--input\fR into a single playlist specified in \fI--output\fR
   48: .RE
   49: .TP
   50: \-h, --help
   51: .RS 4
   52: Displays a brief summary of \fBpl\fR syntax and options
   53: .RE
   54: .SH OPTIONS
   55: .TP
   56: \-v, --verbose
   57: .RS 4
   58: Increases verbosity of \fBpl\fR output during certain operations
   59: .RE
   60: .TP
   61: \-V, --overwrite
   62: .RS 4
   63: Allows \fBpl\fR to overwrite the playlist specified in \fI--output\fR if it already exists
   64: .RE
   65: .TP
   66: \-b, --basedir \fIdirectory\fR
   67: .RS 4
   68: Specifies \fIdirectory\fR as the base location of the media library with which \fBpl\fR operates
   69: .RE
   70: .TP
   71: \-s, --shuffle
   72: .RS 4
   73: Applies only to the \fI--play\fR action, and will shuffle all of the playlists selected by \fI--input\fR during playback
   74: .RE
   75: .TP
   76: \-R, --repeat
   77: .RS 4
   78: 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
   79: .RE
   80: .TP
   81: \-d, --delete=\fIall\fR|\fIupdate\fR
   82: .RS 4
   83: 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
   84: .RE
   85: .SH RETURN VALUES
   86: Returns \fB0\fR for successful completion; non-zero when errors occur
   87: .SH FILES
   88: .TP
   89: /etc/default/pl
   90: The default configuration of PLM, consisting of a name-value pair for \fBBASEDIR\fR, such as \fIBASEDIR=/path/to/music/library\fB
   91: .TP
   92: $HOME/.plrc
   93: Overrides \fI/etc/default/pl\fR
   94: .TP
   95: $HOME/.config/plm/defaults
   96: Overrides \fI$HOME/.plrc\fR
   97: .SH ENVIRONMENT
   98: .TP
   99: $PL_BASEDIR
  100: Overrides all configuration options for \fBBASEDIR\fR
  101: .SH BUGS
  102: Unknown at this time, though bugs are a very high likelihood.
  103: .SH AUTHOR
  104: Written by Serena Willis <snw@coherent-logic.com>
  105: .SH COPYRIGHT
  106: Copyright (C) 2025 Coherent Logic Development LLC
  107: 
  108: 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.
  109: .SH SEE ALSO
  110: .PP
  111: \fBgenpl\fR(1)