~ubuntu-branches/ubuntu/wily/squeezelite/wily

« back to all changes in this revision

Viewing changes to debian/man/squeezelite.1

  • Committer: Package Import Robot
  • Author(s): Chris Boot
  • Date: 2015-05-12 19:56:54 UTC
  • mfrom: (5.1.2 sid)
  • Revision ID: package-import@ubuntu.com-20150512195654-z4pb7qxxp0vo4r85
Tags: 1.8-1
* New upstream release.
  - Refresh patches for Makefile changes.
  - Should fix a crash when resampling. (Closes: #774524)
* Tweak debian/copyright based on debmake -k's suggestions.
* Enable LIRC support.
* Bump standards version to 3.8.6 (no changes required).
* Update debian/man/squeezelite.1 to document new features/options added
  since 1.6.4.

Show diffs side-by-side

added added

removed removed

Lines of Context:
4
4
.\" First parameter, NAME, should be all caps
5
5
.\" Second parameter, SECTION, should be 1-8, maybe w/ subsection
6
6
.\" other parameters are allowed: see man(7), man(1)
7
 
.TH SQUEEZELITE 1 "2014-06-16" "Debian Project"
 
7
.TH SQUEEZELITE 1 "2015-05-10" "Debian Project"
8
8
.\" Please adjust this date whenever revising the manpage.
9
9
.\"
10
10
.\" Some roff macros, for reference:
32
32
.SH OPTIONS
33
33
This program supports the following options:
34
34
.TP
35
 
.B \-h
 
35
.B \-?
36
36
Show a summary of the available command-line options.
37
37
.TP
38
38
.B \-s <server>[:<port>]
42
42
segment (e.g. behind a router).
43
43
.TP
44
44
.B \-o <output device>
45
 
Specify the audio output device; the default value is 
 
45
Specify the audio output device; the default value is
46
46
.IR default .
47
47
Use the
48
48
.B \-l
87
87
.B squeezelite -h
88
88
to obtain the list of codecs built into \fBsqueezelite\fR.
89
89
.TP
 
90
.B \-C <timeout>
 
91
Close the output device after
 
92
.B <timeout>
 
93
seconds of the player being idle; the default is to always keep the device open
 
94
as long as the payer is "on".
 
95
.TP
90
96
.B \-d <category>=<level>
91
97
Set logging level. Categories are:
92
 
.IR all ", " slimproto ", " stream ", " decode " or " output .
 
98
.IR all ", " slimproto ", " stream ", " decode ", " output " or " ir .
93
99
Levels can be:
94
100
.IR info ", " debug " or " sdebug .
95
101
The option can be repeated to set different log levels for different categories.
102
108
.B \-f <logfile>
103
109
Send logging output to a log file instead of standard output or standard error.
104
110
.TP
 
111
.B \-i [<filename>]
 
112
Enable LIRC remote control support. If the optional
 
113
.B <filename>
 
114
is not provided,
 
115
.I ~/.lircrc
 
116
is used instead.
 
117
.TP
105
118
.B \-m <mac addr>
106
119
Override the player's MAC address. The format must be colon-delimited
107
120
hexadecimal, for example: ab:cd:ef:12:34:56. This is usually automatically
108
121
detected, and should not need to be provided in most circumstances.
109
122
.TP
 
123
.B \-M <modelname>
 
124
Override the player's hardware model name. The default value is
 
125
.IR SqueezeLite .
 
126
.TP
110
127
.B \-n <name>
111
128
Set the player name. This name is used by the Logitech Media Server to refer to
112
129
the player by name. This option is mututally exclusive with
124
141
.IR 45 ).
125
142
Not applicable when using PortAudio.
126
143
.TP
 
144
.B \-P <filename>
 
145
Write the process ID (PID) number to the given
 
146
.BR <filename> .
 
147
This may be useful when running \fBsqueezelite\fR as a daemon.
 
148
.TP
127
149
.B \-r <rates>[:<delay>]
128
150
Specify sample rates supported by the output device; this is required if the
129
151
output device is switched off when \fBsqueezelite\fR is started. The format is
150
172
some of the audio being played, so that an external visualiser can read and
151
173
process this to create visualisations.
152
174
.TP
 
175
.B \-L
 
176
List available volume controls for the output device. Only applicable when
 
177
using ALSA output.
 
178
.TP
 
179
.B \-U <control>
 
180
Unmute the given ALSA
 
181
.B <control>
 
182
at daemon startup and set it to full volume. Use software volume adjustment for
 
183
playback. This option is mutually exclusive with the \fB\-V\fR option. Only
 
184
applicable when using ALSA output.
 
185
.TP
 
186
.B \-V <control>
 
187
Use the given ALSA
 
188
.B <control>
 
189
for volume adjustment during playback. This prevents the use of software volume
 
190
control within \fBsqueezelite\fR. This option is mutually exclusive with the
 
191
\fB\-V\fR option. If neither \fB\-U\fR nor \fB\-V\fR options are provided,
 
192
no ALSA controls are adjusted while running \fBsqueezelite\fR and software
 
193
volume control is used instead. Only applicable when using ALSA output.
 
194
.TP
153
195
.B \-z
154
196
Cause \fBsqueezelite\fR to run as a daemon. That is, it detaches itself from the
155
197
terminal and runs in the background.