Commit | Line | Data |
---|---|---|
460b9539 | 1 | <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN"> |
2 | <!-- | |
3 | This file is part of DisOrder. | |
8f9616f1 | 4 | Copyright (C) 2004-2008 Richard Kettlewell |
460b9539 | 5 | |
6 | This program is free software; you can redistribute it and/or modify | |
7 | it under the terms of the GNU General Public License as published by | |
8 | the Free Software Foundation; either version 2 of the License, or | |
9 | (at your option) any later version. | |
10 | ||
11 | This program is distributed in the hope that it will be useful, but | |
12 | WITHOUT ANY WARRANTY; without even the implied warranty of | |
13 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU | |
14 | General Public License for more details. | |
15 | ||
16 | You should have received a copy of the GNU General Public License | |
17 | along with this program; if not, write to the Free Software | |
18 | Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 | |
19 | USA | |
20 | --> | |
21 | <html> | |
22 | <head> | |
0d0253c9 | 23 | @stdhead{help} |
460b9539 | 24 | </head> |
25 | <body> | |
0d0253c9 | 26 | @stdmenu{help} |
595b20dc | 27 | <h1>@label{help.title}</h1> |
460b9539 | 28 | |
21c8e53a | 29 | <h2 class=helptitle>Introduction</h2> |
4a4c673c | 30 | |
31 | <div class=helpsection> | |
32 | ||
33 | <p>All screens in the DisOrder web interface have a set of | |
34 | hyperlinks at the top. You can use these to visit the various | |
35 | screens described below. Note that if you are not logged in some | |
21c8e53a | 36 | of these will be greyed out. The link for the currently active |
37 | screen is highlighted.</p> | |
4a4c673c | 38 | |
39 | </div> | |
40 | ||
21c8e53a | 41 | <h2 class=helptitle><a name=playing>Playing</a></h2> |
460b9539 | 42 | |
43 | <div class=helpsection> | |
44 | ||
45 | <p>This screen displays the currently playing track (if there is one) and | |
46 | lists all the tracks in the queue (the track that will be played soonest | |
47 | being listed first.) Where possible, estimated start times are | |
48 | given.</p> | |
49 | ||
0d0253c9 RK |
50 | <p>Each track has a <img class=button src="@image{scratch}" |
51 | title="@label{playing.scratch}" alt="@label{playing.scratch}"> | |
21c8e53a | 52 | button next to it. For the currently playing track this can be |
53 | used to stop playing the track before it has finished; this is | |
54 | called “scratching”. For a track in the queue it | |
55 | removes the track from the queue.</p> | |
460b9539 | 56 | |
21c8e53a | 57 | <p>If you are not logged in, or if your user has limited rights, |
58 | you may only be able to scratch or remove certain tracks (for | |
59 | instance, those you picked yourself).</p> | |
460b9539 | 60 | |
21c8e53a | 61 | <p>Artist and album names are hyperlinks to the relevant locations |
62 | in the <a href="#choose">Choose</a> screen (see below).</p> | |
460b9539 | 63 | |
64 | </div> | |
65 | ||
21c8e53a | 66 | <h2 class=helptitle><a name=manage>Manage</a></h2> |
460b9539 | 67 | |
68 | <div class=helpsection> | |
69 | ||
70 | <p>This screen is almost identical to <a | |
71 | href="#playing">Playing</a> except that it includes extra | |
72 | management features.</p> | |
73 | ||
74 | <p>At the top of the screen are the following controls:</p> | |
75 | ||
76 | <ul> | |
77 | <li>Pause. This button can be used to pause playing (provided the | |
0d0253c9 RK |
78 | player supports it). <img width=@width height=@height class=imgbutton |
79 | src="@image{enabled}"> indicates that playing is paused, | |
80 | <img width=@width height=@height class=imgbutton | |
81 | src="@image{disabled}"> that it is not.</li> | |
460b9539 | 82 | |
83 | <li>Enable/disable random play. If disabled then queued tracks | |
84 | will still be played but if the queue is empty nothing will be | |
0d0253c9 RK |
85 | picked at random. <img width=@width height=@height class=imgbutton |
86 | src="@image{enabled}"> indicates that random play is | |
87 | enabled, <img width=@width height=@height class=imgbutton | |
88 | src="@image{disabled}"> that it is disabled.</li> | |
460b9539 | 89 | |
90 | <li>Enable/disable play. If disabled then tracks in the queue | |
91 | will not be played, but will remain in the queue instead. <img | |
0d0253c9 RK |
92 | width=@width height=@height class=imgbutton src="@image{enabled}"> |
93 | indicates that play is enabled, <img width=@width height=@height | |
94 | class=imgbutton src="@image{disabled}"> that it is | |
460b9539 | 95 | disabled.</li> |
96 | ||
97 | <li>Volume control. You can use the <img class=button | |
0d0253c9 RK |
98 | src="@image{up}" |
99 | title="@label{volume.up}" | |
100 | alt="@label{volume.up}"> and <img | |
101 | src="@image{down}" | |
102 | title="@label{volume.down}" | |
103 | alt="@label{volume.down}"> buttons to increase or | |
460b9539 | 104 | decrease the volume, or enter new volume settings for the left |
105 | and/or right speakers.</li> | |
106 | ||
107 | </ul> | |
108 | ||
109 | <p>Below this is the same table of current and queued tracks as for | |
110 | the main playing screen, but with extra buttons for managing the | |
111 | queue. | |
0d0253c9 RK |
112 | The <img class=button src="@image{up}" |
113 | title="@label{playing.up}" alt="@label{playing.up}"> and <img | |
114 | src="@image{down}" title="@label{playing.down}" | |
115 | alt="@label{playing.down}"> buttons on each track move that | |
460b9539 | 116 | track around in the queue. Similarly the <img class=button |
0d0253c9 RK |
117 | src="@image{upall}" title="@label{playing.upall}" |
118 | alt="@label{playing.upall}"> and <img | |
119 | src="@image{downall}" title="@label{playing.downall}" | |
120 | alt="@label{playing.downall}"> buttons move each track to the head or | |
21c8e53a | 121 | tail of the queue.</p> |
122 | ||
123 | <p>If you are not logged in, or if your user has limited rights, | |
124 | you may only be able to move certain tracks (for instance, those | |
125 | you picked yourself), and may not be able to adjust the volume, | |
126 | random play setting, etc.</p> | |
460b9539 | 127 | |
128 | </div> | |
129 | ||
21c8e53a | 130 | <h2 class=helptitle><a name=recent>Recent</a></h2> |
460b9539 | 131 | |
132 | <div class=helpsection> | |
133 | ||
134 | <p>This screen displays recently played tracks, most recent first. | |
0d0253c9 RK |
135 | The <img class=button src="@image{edit}" |
136 | title="@label{choose.prefs}" alt="@label{choose.prefs}"> | |
460b9539 | 137 | button can be used to edit the details for a track; see <a |
138 | href="#prefs">Editing Preferences</a> below.</p> | |
139 | ||
140 | <p>The number of tracks remembered is controlled by the server | |
21c8e53a | 141 | configuration. See the <span class=configuration>history</span> |
142 | option in <a | |
0d0253c9 | 143 | href="@url?action=disorder_config.5">disorder_config(5)</a> for |
21c8e53a | 144 | more details.</p> |
460b9539 | 145 | |
146 | </div> | |
147 | ||
21c8e53a | 148 | <h2 class=helptitle><a name=new>New</a></h2> |
78efa64e RK |
149 | |
150 | <div class=helpsection> | |
151 | ||
152 | <p>This screen displays tracks recently added to the database, | |
153 | most recent first. The <img class=button | |
0d0253c9 RK |
154 | src="@image{edit}" title="@label{choose.prefs}" |
155 | alt="@label{choose.prefs}"> button can be used to edit the details | |
78efa64e RK |
156 | for a track; see <a href="#prefs">Editing Preferences</a> below, |
157 | and clicking on the track title will add it to the queue.</p> | |
158 | ||
159 | <p>The time tracks are remembered for is controlled by the server | |
21c8e53a | 160 | configuration. See the <span |
161 | class=configuration>noticed_history</span> option in <a | |
0d0253c9 | 162 | href="@url?action=disorder_config.5">disorder_config(5)</a> for |
78efa64e RK |
163 | more details.</p> |
164 | ||
165 | </div> | |
166 | ||
21c8e53a | 167 | <h2 class=helptitle><a name=choose>Choose</a></h2> |
460b9539 | 168 | |
169 | <div class=helpsection> | |
170 | ||
171 | <p>This screen allows you to choose a track to be played, by navigating | |
172 | through the directory structure of the tracks filesystem. The following | |
173 | buttons appear:</p> | |
174 | ||
175 | <table class=helpbuttons> | |
176 | <tbody> | |
177 | <tr> | |
3225872d | 178 | <td><img |
0d0253c9 RK |
179 | class=button src="@image{edit}" |
180 | title="@label{choose.prefs}" | |
181 | alt="@label{choose.prefs}"></td> | |
3225872d | 182 | <td>This button can be used to edit the details for a |
460b9539 | 183 | track; see <a href="#prefs">Editing Preferences</a> below.</td> |
184 | </tr> | |
185 | <tr> | |
595b20dc | 186 | <td><span class=button>@label{choose.playall}</span></td> |
3225872d | 187 | <td>This button plays all the tracks in a directory, |
460b9539 | 188 | in order. This is used to efficiently play a whole album.</td> |
189 | </tr> | |
190 | </tbody> | |
191 | </table> | |
192 | ||
193 | <p>This screen has two forms: <a | |
0d0253c9 | 194 | href="@url?action=choose">choose</a>, which give |
460b9539 | 195 | you all the top-level directories at once, and <a |
0d0253c9 | 196 | href="@url?action=choosealpha">choosealpha</a>, |
460b9539 | 197 | which breaks them down by initial letter.</p> |
198 | ||
21c8e53a | 199 | <p>This screen will may not be available if you are not logged in |
200 | or if your user has limited rights.</p> | |
201 | ||
460b9539 | 202 | </div> |
203 | ||
21c8e53a | 204 | <h2 class=helptitle><a name=prefs>Editing Preferences</a></h2> |
460b9539 | 205 | |
206 | <div class=helpsection> | |
207 | ||
208 | <p>This screen, reached from <a href="#choose">Choose</a> or <a | |
21c8e53a | 209 | href="#recent">Recent</a>, is used to edit a track's preferences. |
210 | Note that if you are not logged in, or your user has limited | |
211 | rights, you may not be able to edit track preferences.</p> | |
460b9539 | 212 | |
4a4c673c | 213 | <p>The form can be used to |
68a1bff0 RK |
214 | edit artist, album and title fields for the track as displayed; or |
215 | to set the tags or weight for a track; or to enable or disable random play | |
460b9539 | 216 | for the track.</p> |
217 | ||
218 | <p>Tags are separated by commas and can contain any other printing | |
219 | characters (including spaces). Leading and trailing spaces are | |
220 | not significant.</p> | |
221 | ||
68a1bff0 RK |
222 | <p>Weights determine how likely a track is to be picked at |
223 | random. Tracks with higher weights are more likely to be picked. | |
224 | The default weight is 90000 and the maximum is 2147483647.</p> | |
225 | ||
21c8e53a | 226 | <p>By default, any track can be picked for random play. The check |
227 | box at the bottom can be used to selectivel enable or disable it | |
228 | for individual tracks.</p> | |
460b9539 | 229 | |
460b9539 | 230 | </div> |
231 | ||
21c8e53a | 232 | <h2 class=helptitle>Search</h2> |
460b9539 | 233 | |
b43dc0cc | 234 | |
460b9539 | 235 | <div class=helpsection> |
236 | ||
b43dc0cc RK |
237 | TODO search is folded into choose now |
238 | ||
239 | <p>This screen allows you to search for keywords in track names. If you | |
460b9539 | 240 | specify more than one keyword then only tracks containing all of them are |
241 | listed. Results are grouped by artist, album and title.</p> | |
242 | ||
243 | <p>It is possible to limit results to tracks with a particular | |
244 | tag, by using <b>tag:</b><i>TAG</i> among the search terms.</p> | |
245 | ||
21c8e53a | 246 | <p>Some keywords, known as “stopwords”, are excluded |
247 | from the search, and will never match. See the <span | |
248 | class=configuration>stopword</span> option in <a | |
0d0253c9 | 249 | href="@url?action=disorder_config.5">disorder_config(5)</a> for |
21c8e53a | 250 | further details about this.</p> |
251 | ||
252 | <p>This screen will may not be available if you are not logged in | |
253 | or if your user has limited rights.</p> | |
460b9539 | 254 | |
255 | </div> | |
256 | ||
21c8e53a | 257 | <h2 class=helptitle><a name=Login>Login</a></h2> |
460b9539 | 258 | |
4a4c673c | 259 | <div class=helpsection> |
460b9539 | 260 | |
4a4c673c | 261 | <p>This screen has two different versions.</p> |
460b9539 | 262 | |
4a4c673c | 263 | <p><b>1</b>. When no user is logged in, it has a login form and a |
264 | registration form. If you do not have a username and password, | |
265 | fill in and submit the registration form. You will be emailed an | |
266 | email with a confirmation URL that you must visit. Only after | |
267 | visiting this URL will your login become active.</p> | |
460b9539 | 268 | |
4a4c673c | 269 | <p>Once you have a username and password, you can use the login |
270 | form to authenticate yourself to the web interface. Note that this | |
271 | is your primary DisOrder password, which (in old installations) may | |
272 | differ from your original web password.</p> | |
273 | ||
274 | <p><b>2</b>. When you are logged in, this screen instead has a form | |
275 | to change your email address or password, and a logout button.</p> | |
460b9539 | 276 | |
4a4c673c | 277 | </div> |
460b9539 | 278 | |
21c8e53a | 279 | <h2 class=helptitle>Troubleshooting</h2> |
460b9539 | 280 | |
281 | <div class=helpsection> | |
282 | ||
283 | <p>If you cannot play a track, or it does not appear in the | |
284 | database even after a rescan, check the following things:</p> | |
285 | ||
286 | <ul> | |
287 | ||
288 | <li>Are there any error messages in the system log? The server | |
21c8e53a | 289 | logs to <span class=configuration>LOG_DAEMON</span>, which |
290 | typically ends up in <i>/var/log/daemon.log</i> or | |
291 | <i>/var/log/messages</i>, though this depends on local | |
292 | configuration. | |
460b9539 | 293 | |
21c8e53a | 294 | <li>Is the track in a known format? Out of the box, OGG, MP3, |
295 | FLAC and WAV are supported. You can look at the configuration | |
296 | file for additional formats recognized by the local installation. | |
460b9539 | 297 | |
21c8e53a | 298 | <li>Do permissions on the track allow the server to read it? If |
299 | the server cannot read it then it will not be able to play it. | |
460b9539 | 300 | |
301 | <li>Do the permissions on the containing directories allow the | |
302 | server to read and execute them? | |
303 | ||
304 | </ul> | |
305 | ||
21c8e53a | 306 | <p>The user the server runs as is determined by the <span |
307 | class=configuration>user</span> directive in the configuration | |
308 | file. The README recommends using <b>jukebox</b> for this purpose | |
309 | but it could be different locally.</p> | |
460b9539 | 310 | |
311 | </div> | |
312 | ||
21c8e53a | 313 | <h2 class=helptitle>Man Pages</h2> |
460b9539 | 314 | |
315 | <div class=helpsection> | |
316 | ||
0d0253c9 | 317 | <p><a href="@url?action=disorder_config.5">disorder_config(5)</a> - |
460b9539 | 318 | configuration</p> |
319 | ||
0d0253c9 | 320 | <p><a href="@url?action=disorder.1">disorder(1)</a> - command line |
460b9539 | 321 | client</p> |
322 | ||
0d0253c9 | 323 | <p><a href="@url?action=disobedience.1">disobedience(1)</a> - GTK+ |
460b9539 | 324 | client</p> |
325 | ||
0d0253c9 | 326 | <p><a href="@url?action=disorderd.8">disorderd(8)</a> - server</p> |
460b9539 | 327 | |
0d0253c9 | 328 | <p><a href="@url?action=disorder-dump.8">disorder-dump(8)</a> - |
460b9539 | 329 | dump/restore preferences database</p> |
330 | ||
0d0253c9 | 331 | <p><a href="@url?action=disorder.3">disorder(3)</a> - C API</p> |
460b9539 | 332 | |
0d0253c9 | 333 | <p><a href="@url?action=disorder_protocol.5">disorder_protocol(5)</a> - |
460b9539 | 334 | DisOrder control protocol</p> |
335 | ||
336 | </div> | |
337 | ||
0d0253c9 | 338 | @credits |
460b9539 | 339 | </div> |
340 | </body> | |
341 | </html> | |
0d0253c9 | 342 | @discard{ |
460b9539 | 343 | Local variables: |
344 | mode:sgml | |
345 | sgml-always-quote-attributes:nil | |
346 | sgml-indent-step:1 | |
347 | sgml-indent-data:t | |
0d0253c9 RK |
348 | indent-tabs-mode:nil |
349 | fill-column:79 | |
460b9539 | 350 | End: |
0d0253c9 | 351 | }@# |