chiark - git - mdw - disorder/blob - doc/disorder_preferences.5.in

   1 .\"
   2 .\" Copyright (C) 2008 Richard Kettlewell
   3 .\"
   4 .\" This program is free software: you can redistribute it and/or modify
   5 .\" it under the terms of the GNU General Public License as published by
   6 .\" the Free Software Foundation, either version 3 of the License, or
   7 .\" (at your option) any later version.
   8 .\"
   9 .\" This program is distributed in the hope that it will be useful,
  10 .\" but WITHOUT ANY WARRANTY; without even the implied warranty of
  11 .\" MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  12 .\" GNU General Public License for more details.
  13 .\"
  14 .\" You should have received a copy of the GNU General Public License
  15 .\" along with this program.  If not, see <http://www.gnu.org/licenses/>.
  16 .\"
  17 .TH disorder_preferences 5
  18 .SH NAME
  19 disorder_preferences \- DisOrder global and per-track preferences
  20 .SH "PER-TRACK PREFERENCES"
  21 Currently the following preferences are supported.
  22 Some are expected to be set by users, others updated automatically by plugins.
  23 .TP
  24 .B pick_at_random
  25 If this preference is present and set to "0" then the track will not
  26 be picked for random play.
  27 Otherwise it may be.
  28 .TP
  29 .B played
  30 A decimal integer giving the number times the track was played.
  31 This includes tracks that are scratched or were picked at random.
  32 .TP
  33 .B played_time
  34 The last time the track was played, as a \fBtime_t\fR converted to a
  35 decimal integer.
  36 .TP
  37 .B scratched
  38 The number of times the track has been scratched.
  39 .TP
  40 .B requested
  41 A decimal integer giving the number of times the track was requested.
  42 (Tracks that are removed before being played are not counted.)
  43 .TP
  44 .B tags
  45 Tags that apply to this track, separated by commas.
  46 Tags can contain any printing character except comma.
  47 Leading and trailing spaces are not significant but internal spaces are.
  48 .IP
  49 Using the
  50 .B required\-tags
  51 and
  52 .B prohibited\-tags
  53 global preferences, it is possible to limit the tracks that will be selected at
  54 random.
  55 .TP
  56 .B trackname_\fICONTEXT\fB_\fIPART\fR
  57 These preferences can be used to override the filename parsing rules
  58 to find a track name part.
  59 For backwards compatibility, \fBtrackname_\fIPART\fR will be used
  60 if the full version is not present.
  61 .TP
  62 .B unscratched
  63 The number of times the track has been played to completion without
  64 being scratched.
  65 .TP
  66 .B weight
  67 The weight for this track.  Weights are non-negative integers which determine
  68 the relative likelihood of a track being picked at random (i.e. if track A has
  69 twice the weight of track B then it is twice as likely to be picked at random).
  70 A track with weight 0 will not be picked at random, though \fBpick_at_random\fR
  71 is a more sensible way to configure this.
  72 .IP
  73 The default weight, used if no weight is set or the weight value is invalid, is
  74 90000.  Note that many other factors than track weight affect whether a track
  75 will be played - tracks already in the queue will not be picked at random for
  76 instance.
  77 .IP
  78 The maximum allowed weight is 2147483647.  If you set a larger value it will be
  79 clamped to this value.  Negative weights will be completely ignored and the
  80 default value used instead.
  81 .SH "GLOBAL PREFERENCES"
  82 These are the values set with \fBset\-global\fR.
  83 .TP
  84 .B required\-tags
  85 If this is set an nonempty then randomly played tracks will always have at
  86 least one of the listed tags.
  87 .TP
  88 .B prohibited\-tags
  89 If this is set an nonempty then randomly played tracks will never have any of
  90 the listed tags.
  91 .TP
  92 .B playing
  93 If unset or \fByes\fR then play is enabled.
  94 Otherwise it is disabled.
  95 Use \fBdisable\fR rather than setting it directly.
  96 .TP
  97 .B random\-play
  98 If unset or \fByes\fR then random play is enabled.
  99 Otherwise it is disabled.
 100 Use \fBdisable\fR rather than setting it directly.
 101 .PP
 102 Global preferences starting '_' are read-only (in the sense that you cannot
 103 modify them; the server may modify them as part of its normal operation).
 104 They are:
 105 .TP
 106 .B _dbversion
 107 The database version string.
 108 This is used by DisOrder to detect when it must
 109 modify the database after an upgrade.
 110 .SH "SEE ALSO"
 111 \fBdisorder\fR(1), \fBdisorderd\fR(8), \fBdisorder_config\fR(5)
 112 .\" Local Variables:
 113 .\" mode:nroff
 114 .\" fill-column:79
 115 .\" End: