Return to pl.1 CVS log

Up to [Coherent Logic Development] / plm

Annotation of plm/pl.1, revision 1.1

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