mirror of
https://github.com/badaix/snapcast.git
synced 2025-05-03 12:16:36 +02:00
64 lines
1.7 KiB
Groff
64 lines
1.7 KiB
Groff
.\"groff -Tascii -man snapclient.1
|
|
.TH SNAPCLIENT 1 "July 2018"
|
|
.SH NAME
|
|
snapclient - Snapcast client
|
|
.SH SYNOPSIS
|
|
\fBsnapclient\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--help\fR
|
|
produce help message
|
|
.TP
|
|
\fB-v, --version\fR
|
|
show version number
|
|
.TP
|
|
\fB-l, --list\fR
|
|
list pcm devices
|
|
.TP
|
|
\fB-s, --soundcard arg (=default)\fR
|
|
index or name of the soundcard
|
|
.TP
|
|
\fB-e, --mstderr\fR
|
|
send metadata to stderr
|
|
.TP
|
|
\fB-h, --host arg\fR
|
|
server hostname or ip address
|
|
.TP
|
|
\fB-p, --port arg (=1704)\fR
|
|
server port
|
|
.TP
|
|
\fB-d, --daemon [=arg(=-3)]\fR
|
|
daemonize, optional process priority [-20..19]
|
|
.TP
|
|
\fB--user arg\fR
|
|
the user[:group] to run snapclient as when daemonized
|
|
.TP
|
|
\fB--latency arg (=0)\fR
|
|
latency of the soundcard
|
|
.TP
|
|
\fB-i, --instance arg (=1)\fR
|
|
instance id
|
|
.TP
|
|
\fB--hostID arg\fR
|
|
unique host id
|
|
.SH FILES
|
|
.TP
|
|
\fI/etc/default/snapclient\fR
|
|
the daemon default configuration file
|
|
.SH "COPYRIGHT"
|
|
Copyright (C) 2014-2019 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"
|
|
snapserver(1)
|