forked from badaix/snapcast
-
Notifications
You must be signed in to change notification settings - Fork 0
/
snapclient.1
64 lines (64 loc) · 1.72 KB
/
snapclient.1
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
.\"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-2018 Johannes Pohl ([email protected]).
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)