summaryrefslogtreecommitdiff
path: root/debian/deadbeef.1
blob: 6d69fc6f120ca5b134ef457fe88cee2aeddeb2fb (plain)
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
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
.\"                                                                -*- nroff -*-
.TH DEADBEEF "1" "December 29, 2014" "DeaDBeeF 0.6.2" "User Commands"
.SH NAME
deadbeef \- ultimate music player for GNU/Linux
.SH SYNOPSIS
.B deadbeef
[\fIOPTION\fR]... [\-\- \fIFILE\fR]...
.SH DESCRIPTION
.\" Add any additional description here
DeaDBeeF (as in 0xDEADBEEF) is an audio player for GNU/Linux, *BSD, OpenSolaris,
and other UNIX-like systems.  DeaDBeeF plays files encoded with MP3, Ogg Vorbis,
FLAC, WAV, and AAC, as well as many exotic codecs, and it offers a
fully-featured metadata editor with automatic character set detection and
Unicode support.

DeaDBeeF's interface is reminiscent of the well-known nonfree music player
Foobar2000, including multiple playlists with selection via tabs, customizable
groups within playlists, album cover display, global hotkey support, and OSD
integration.

When started without a file, \fBdeadbeef\fR opens a graphical window displaying
the user's music library.  When started with a file, \fBdeadbeef\fR behaves in
exactly the same way, but it also plays the specified file.

The following options modify \fBdeadbeef\fR's behaviour.

.TP
\fB\-\-help\fR
display a short help message and exit
.TP
\fB\-\-version\fR
display the current DeaDBeeF version and exit
.TP
\fB\-\-gui\fR \fIPLUGIN\fR
use the specified \fIPLUGIN\fR as the DeaDBeeF GUI (default: GTK2)

.PP
The following options control a running \fBdeadbeef\fR instance.  If no instance
is running, they start \fBdeadbeef\fR and then control it.

.TP
\fB\-\-quit\fR
exit \fBdeadbeef\fR
.TP
\fB\-\-play\fR
begin playing music
.TP
\fB\-\-stop\fR
stop playing music
.TP
\fB\-\-pause\fR
pause playback
.TP
\fB\-\-toggle\-pause\fR
toggle pause
.TP
\fB\-\-play\-pause\fR
start playback if stopped; otherwise, toggle pause
.TP
\fB\-\-next\fR
advance to the next song in the playlist
.TP
\fB\-\-prev\fR
return to the previous song in the playlist
.TP
\fB\-\-random\fR
select a random song in the playlist
.TP
\fB\-\-queue\fR
queue the specified \fIFILE\fRs in the playlist
.TP
\fB\-\-nowplaying\fR \fIFORMAT\fR
print the currently-playing track according to the specified \fIFORMAT\fR

.SH "FORMAT CODES"
The \-\-nowplaying option accepts the following format codes:

.TP
%a
artist name
.TP
%b
album name
.TP
%B
band, album artist, albumartist, or artist
.TP
%c
track comment
.TP
%c
composer
.TP
%d
directory, without full path
.TP
%D
directory, including full path
.TP
%e
time elapsed through playback
.TP
%f
file name, without path
.TP
%F
file name, including path or URL
.TP
%g
genre
.TP
%l
track length
.TP
%L
total playback length of playlist
.TP
%n
track number
.TP
%N
number of tracks in album
.TP
%r
copyright information
.TP
%t
track title, or file name if no title metadatum exists
.TP
%T
tags
.TP
%V
DeaDBeeF version number
.TP
%X
number of selected tracks in current playlist
.TP
%y
track date
.TP
%Z
channel configuration (mono, stereo, etc.)
.TP
%@\fIFIELD_NAME\fR@
Direct metadata access.  Specify any metadata field as \fIFIELD_NAME\fR, and
DeaDBeeF will read that metadata field from the currently playing track.

You can also specify derived track properties by prefixing them with a colon.
For instance, %@:BITRATE@ will expand to the bitrate of the current track.
These track properties are visible on the \fBProperties\fR tab of the \fBTrack
Properties\fR dialog.

.SH AUTHOR
DeaDBeef is the work of many authors; the primary author is Alexey Yakovenko.
Benjamin Barenblat wrote this manual page for the Debian project.

.SH "REPORTING BUGS"
Report bugs in DeaDBeeF using the DeaDBeeF bug tracker at <https://code.google.com/p/ddb/issues/list>.  You may also use the Debian bug tracker <https://bugs.debian.org/deadbeef>.

.SH COPYRIGHT
DeaDBeeF is copyright \(co 2009-2014 Alexey Yakovenko and many others and
licensed under the GNU GPL version 2 or later <http://gnu.org/licenses/gpl.html>.
It is free software: you are free to change and redistribute it.  There is NO
WARRANTY, to the extent permitted by law.

Much of the DeaDBeeF code is available under more permissive licences.  See the
various COPYING files throughout the DeaDBeeF source code for more details.

This manual page is copyright \(co 2014 Benjamin Barenblat and licensed under
the GNU GPL version 3 or later.