2019-07-13 22:19:59 +00:00
|
|
|
====================
|
|
|
|
|
supysonic-cli-folder
|
|
|
|
|
====================
|
|
|
|
|
|
|
|
|
|
------------------------------------
|
|
|
|
|
Supysonic folder management commands
|
|
|
|
|
------------------------------------
|
|
|
|
|
|
2021-01-03 15:34:29 +00:00
|
|
|
:Author: Louis-Philippe Véronneau, Alban Féron
|
|
|
|
|
:Date: 2019, 2021
|
2019-07-13 22:19:59 +00:00
|
|
|
:Manual section: 1
|
|
|
|
|
|
|
|
|
|
Synopsis
|
|
|
|
|
========
|
|
|
|
|
|
2021-11-11 15:47:37 +00:00
|
|
|
| ``supysonic-cli folder --help``
|
2021-01-03 15:34:29 +00:00
|
|
|
| ``supysonic-cli folder list``
|
|
|
|
|
| ``supysonic-cli folder add`` `name` `path`
|
|
|
|
|
| ``supysonic-cli folder delete`` `name`
|
|
|
|
|
| ``supysonic-cli folder scan`` [``--force``] [``--background``\|\ ``--foreground``] [`name`]...
|
2019-07-13 22:19:59 +00:00
|
|
|
|
2021-01-03 15:34:29 +00:00
|
|
|
Description
|
|
|
|
|
===========
|
2019-07-13 22:19:59 +00:00
|
|
|
|
2021-01-03 15:34:29 +00:00
|
|
|
The ``supysonic-cli folder`` subcommand manages your library folders, where the
|
|
|
|
|
audio files are located. This allows to list, add, delete and scan the folders.
|
|
|
|
|
|
|
|
|
|
``supysonic-cli folder list``
|
|
|
|
|
List all the folders.
|
|
|
|
|
|
|
|
|
|
``supysonic-cli folder add`` `name` `path`
|
|
|
|
|
Add a new library folder called `name` and located at `path`. `name` must be
|
|
|
|
|
unique and `path` pointing to an existing directory. If ``supysonic-daemon``
|
|
|
|
|
is running it will start to listen for changes in this folder but will not
|
|
|
|
|
scan files already present in the folder.
|
|
|
|
|
|
|
|
|
|
``supysonic-cli folder delete`` `name`
|
|
|
|
|
Delete the folder called `name`.
|
|
|
|
|
|
|
|
|
|
``supysonic-cli folder scan`` [``--force``] [``--background``\|\ ``--foreground``] [`name`]...
|
|
|
|
|
Scan the specified folders. If none is given, all the registered folders are
|
|
|
|
|
scanned.
|
2019-07-13 22:19:59 +00:00
|
|
|
|
|
|
|
|
Options
|
|
|
|
|
=======
|
|
|
|
|
|
2021-11-11 15:47:37 +00:00
|
|
|
-h, --help
|
|
|
|
|
Shows help and exits. Depending on where this option appears it will either list the
|
|
|
|
|
available commands or display help for a specific command.
|
|
|
|
|
|
2021-01-03 15:34:29 +00:00
|
|
|
-f, --force
|
|
|
|
|
Force scan of already known files even if they haven't changed. Might be
|
2021-01-17 11:29:37 +00:00
|
|
|
useful if an update to Supysonic adds new metadata to audio files.
|
2021-01-03 15:34:29 +00:00
|
|
|
|
|
|
|
|
--background
|
|
|
|
|
Scan in the background. Requires the ``supysonic-daemon`` to be running
|
2019-07-13 22:19:59 +00:00
|
|
|
|
2021-01-03 15:34:29 +00:00
|
|
|
--foreground
|
|
|
|
|
Scan in the foreground, blocking the process while the scan is running
|
2019-07-13 22:19:59 +00:00
|
|
|
|
2021-01-03 15:34:29 +00:00
|
|
|
If neither ``--background`` nor ``--foreground`` 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't available.
|
2019-07-13 22:19:59 +00:00
|
|
|
|
|
|
|
|
Examples
|
|
|
|
|
========
|
|
|
|
|
|
|
|
|
|
To add a new folder to your music library, you can do something like this::
|
|
|
|
|
|
2021-01-03 15:34:29 +00:00
|
|
|
$ supysonic-cli folder add MyLibrary /home/username/Music
|
2019-07-13 22:19:59 +00:00
|
|
|
|
|
|
|
|
Once you've added a folder, you will need to scan it::
|
|
|
|
|
|
2021-01-03 15:34:29 +00:00
|
|
|
$ supysonic-cli folder scan MyLibrary
|
|
|
|
|
|
|
|
|
|
The audio files residing in `/home/username/Music` will now appear under the
|
|
|
|
|
`MyLibrary` folder on the clients.
|
2019-07-13 22:19:59 +00:00
|
|
|
|
|
|
|
|
See Also
|
|
|
|
|
========
|
|
|
|
|
|
2021-01-03 15:34:29 +00:00
|
|
|
``supysonic-cli``\ (1), ``supysonic-cli-user``\ (1)
|
