mirror of
https://github.com/badaix/snapcast.git
synced 2025-06-03 11:21:41 +02:00
75 lines
2.1 KiB
Groff
75 lines
2.1 KiB
Groff
.TH SNAPSERVER 1 "July 2018"
|
|
.SH NAME
|
|
snapserver - Snapcast server
|
|
.SH SYNOPSIS
|
|
\fBsnapserver\fR [\fIOPTION\fR]...
|
|
.SH DESCRIPTION
|
|
Snapcast is a multi-room client-server audio player, where all clients are
|
|
time synchronized with the server to play perfectly synced audio. It's not a
|
|
standalone player, but an extension that turns your existing audio player into
|
|
a Sonos-like multi-room solution.
|
|
.br
|
|
The server's audio input is a named pipe `/tmp/snapfifo`. All data that is fed
|
|
into this file will be send to the connected clients. One of the most generic
|
|
ways to use Snapcast is in conjunction with the music player daemon or Mopidy,
|
|
which can be configured to use a named pipe as audio output.
|
|
.SS Options
|
|
.TP
|
|
\fB-h, --help\fR
|
|
Produce help message
|
|
.TP
|
|
\fB-v, --version\fR
|
|
Show version number
|
|
.TP
|
|
\fB-p, --port arg (=1704)\fR
|
|
Server port
|
|
.TP
|
|
\fB--controlPort arg (=1705)\fR
|
|
Remote control port
|
|
.TP
|
|
\fB-s, --stream arg (=pipe:///tmp/snapfifo?name=default)\fR
|
|
URI of the PCM input stream.
|
|
Format: TYPE://host/path?name=NAME
|
|
[&codec=CODEC]
|
|
[&sampleformat=SAMPLEFORMAT]
|
|
.TP
|
|
\fB--sampleformat arg (=48000:16:2)\fR
|
|
Default sample format
|
|
.TP
|
|
\fB-c, --codec arg (=flac)\fR
|
|
Default transport codec
|
|
(flac|ogg|pcm)[:options]
|
|
Type codec:? to get codec specific options
|
|
.TP
|
|
\fB--streamBuffer arg (=20)\fR
|
|
Default stream read buffer [ms]
|
|
.TP
|
|
\fB-b, --buffer arg (=1000)\fR
|
|
Buffer [ms]
|
|
.TP
|
|
\fB--sendToMuted\fR
|
|
Send audio to muted clients
|
|
.TP
|
|
\fB-d, --daemon [=arg(=0)]\fR
|
|
Daemonize
|
|
optional process priority [-20..19]
|
|
.TP
|
|
\fB--user arg\fR
|
|
the user[:group] to run snapserver as when daemonized
|
|
.SH FILES
|
|
.TP
|
|
\fI/tmp/snapfifo\fR
|
|
PCM input fifo file
|
|
.TP
|
|
\fI/etc/default/snapserver\fR
|
|
the daemon default configuration file
|
|
.TP
|
|
\fI~/.config/snapcast/server.json\fR or (if $HOME is not set) \fI/var/lib/snapcast/server.json\fR
|
|
persistent server data file
|
|
.SH "COPYRIGHT"
|
|
Copyright (C) 2014-2018 Johannes Pohl (snapcast@badaix.de).
|
|
License GPLv3+: GNU GPL version 3 or later <http://gnu.org/licenses/gpl.html>.
|
|
This is free software: you are free to change and redistribute it.
|
|
There is NO WARRANTY, to the extent permitted by law.
|
|
.SH "SEE ALSO"
|
|
snapclient(1)
|