Return to pl.1 CVS log

Up to [Coherent Logic Development] / plm

Annotation of plm/pl.1, revision 1.2

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