.\" Man page generated from reStructuredText.
.
.
.nr rst2man-indent-level 0
.
.de1 rstReportMargin
\\$1 \\n[an-margin]
level \\n[rst2man-indent-level]
level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
-
\\n[rst2man-indent0]
\\n[rst2man-indent1]
\\n[rst2man-indent2]
..
.de1 INDENT
.\" .rstReportMargin pre:
. RS \\$1
. nr rst2man-indent\\n[rst2man-indent-level] \\n[an-margin]
. nr rst2man-indent-level +1
.\" .rstReportMargin post:
..
.de UNINDENT
. RE
.\" indent \\n[an-margin]
.\" old: \\n[rst2man-indent\\n[rst2man-indent-level]]
.nr rst2man-indent-level -1
.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]]
.in \\n[rst2man-indent\\n[rst2man-indent-level]]u
..
.TH "SUPYSONIC-CLI-FOLDER" "1" "Dec 14, 2022" "0.7.2" "Supysonic"
.SH NAME
supysonic-cli-folder \- Supysonic folder management commands
.SH SYNOPSIS
.sp
supysonic\-cli folder \fI\-\-help\fP
.sp
supysonic\-cli folder \fBlist\fP
.sp
supysonic\-cli folder \fBadd\fP <\fIname\fP> <\fIpath\fP>
.sp
supysonic\-cli folder \fBdelete\fP <\fIname\fP>
.sp
supysonic\-cli folder \fBscan\fP [\fI\-\-force\fP] [\fI\-\-background\fP | \fI\-\-foreground\fP] <\fIname\fP>
.SH DESCRIPTION
.sp
The \fBsupysonic\-cli folder\fP subcommand manages your library folders, where the
audio files are located. This allows one to list, add, delete and scan the
folders.
.SH ARGUMENTS
.INDENT 0.0
.TP
\fBlist\fP
List all the folders.
.TP
\fBadd\fP <\fIname\fP> <\fIpath\fP>
Add a new library folder called <\fIname\fP> and located at <\fIpath\fP>. <\fIname\fP>
must be unique and <\fIpath\fP> pointing to an existing directory. If
\fBsupysonic\-daemon\fP is running it will start to listen for changes in this
folder but will not scan files already present in the folder.
.TP
\fBdelete\fP <\fIname\fP>
Delete the folder called <\fIname\fP>.
.TP
\fBscan\fP [\fI\-\-force\fP] [\fI\-\-background\fP | \fI\-\-foreground\fP] <\fIname\fP>
Scan the specified folders. If none is given, all the registered folders
are scanned.
.UNINDENT
.SH OPTIONS
.INDENT 0.0
.TP
\fB\-h\fP, \fB\-\-help\fP
Shows help and exits. Depending on where this option appears it will either
list the available commands or display help for a specific command.
.TP
\fB\-f\fP, \fB\-\-force\fP
Force scan of already known files even if they haven\(aqt changed. Might be
useful if an update to supysonic adds new metadata to audio files.
.TP
\fB\-\-background\fP
Scan in the background. Requires the \fBsupysonic\-daemon\fP to be running.
.TP
\fB\-\-foreground\fP
Scan in the foreground, blocking the process while the scan is running.
.UNINDENT
.sp
If neither \fB\-\-background\fP nor \fB\-\-foreground\fP is provided, supysonic\-cli
will try to connect to the daemon to initiate a background scan, falling back
to a foreground scan if it isn\(aqt available.
.SH EXAMPLES
.sp
To add a new folder to your music library, you can do something like this:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
$ supysonic\-cli folder add MyLibrary /home/username/Music
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Once you\(aqve added a folder, you will need to scan it:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
$ supysonic\-cli folder scan MyLibrary
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
The audio files residing in \fB/home/username/Music\fP will now appear under the
\fBMyLibrary\fP folder on the clients.
.SH SEE ALSO
.sp
\fBsupysonic\-cli (1)\fP, \fBsupysonic\-cli\-user (1)\fP,
\fBsupysonic\-server (1)\fP, \fBsupysonic\-daemon (1)\fP
.SH AUTHOR
Louis-Philippe Véronneau, Alban Féron
.SH COPYRIGHT
2013-2022, Alban Féron
.\" Generated by docutils manpage writer.
.