mirror of
https://github.com/badaix/snapcast.git
synced 2025-05-03 20:26:38 +02:00
71 lines
2 KiB
Groff
71 lines
2 KiB
Groff
.TH SNAPSERVER 1 "December 2015"
|
|
.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\fR
|
|
server port
|
|
.TP
|
|
\fB--controlPort\fR
|
|
Remote control port (default =1705)
|
|
.TP
|
|
\fB-s, --stream\fR
|
|
URI of the PCM input stream. Format:
|
|
.br
|
|
TYPE://host/path?name=NAME[&codec=CODEC][&sampleformat=SAMPLEFORMAT]
|
|
.TP
|
|
\fB--sampleformat\fR
|
|
default sample format (default = 48000:16:2)
|
|
.TP
|
|
\fB--codec\fR
|
|
default transport codec [flac|ogg|pcm][:options]. Type codec:? to get codec specific options
|
|
.TP
|
|
\fB--streamBuffer\fR
|
|
Default stream read buffer [ms] (default = 20)
|
|
.TP
|
|
\fB-b, --buffer\fR
|
|
buffer [ms] (default = 1000)
|
|
.TP
|
|
\fB-b, --sendToMuted\fR
|
|
Send audio to muted clients
|
|
.TP
|
|
\fB-d, --daemon\fR
|
|
daemonize, optional process priority [-20..19]
|
|
.TP
|
|
\fB--user\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-2017 Johannes Pohl (johannes.pohl@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)
|