doc/C/timidity.cfg.5

   1 .TH timidity.cfg 5 "Nov 24 1998" "1.0.0"
   2 .SH NAME
   3 timidity.cfg \- configure file of TiMidity++
   4
   5 .SH SYNOPSIS
   6 .TP
   7 .B /etc/timidity.cfg
   8 .TP
   9 .B /usr/local/lib/timidity/timidity.cfg
  10
  11 .P
  12 .SH DESCRIPTION
  13 The file \fItimidity.cfg\fP describes the runtime environments of
  14 timidity(1) that are the path of sound font, instruments configrations
  15 or else.
  16 .br
  17 \fITiMidity\fP looks for the configuration file \fItimidity.cfg\fP at
  18 startup, before processing any options.  If  it  can't  be
  19 accessed, and the library path is changed with a \-L option
  20 on the command line, then the default file will be  sought
  21 again  along  the  new  library  path after processing all
  22 options, unless another configuration file  was  specified
  23 with the \-c option.
  24 .sp
  25 Configuration files define the mapping of MIDI programs to
  26 instrument files. Multiple files may  be  specified, and
  27 statements in later ones will override earlier ones.
  28
  29
  30 .P
  31 .SH FORMAT
  32 Following statements can be used in a configuration file:
  33
  34 .TP
  35 .BI dir " directory"
  36 Adds \fIdirectory\fP to the search path in the same manner
  37 as the \fB\-L\fP command line option.
  38 .sh
  39 Archive file are also allowed. For example:
  40 .bp
  41 dir /usr/local/lib/timidity/inst/foo.zip#
  42 .br
  43 .bank 0
  44 .br
  45 1 baz.pat
  46 .br
  47 2 zoo.pat
  48 .br
  49 0 bar.pat
  50 .sp
  51 At first, \fBdir\fP specities the archive name (followed by '#') for the
  52 path of patch files same as directory name (in this case ,
  53 "/usr/local/lib/timidity/inst/foo.zip").
  54 TiMidity recognize the path is an archive file if the expression has
  55 the last character '#', and also read the files contained in this
  56 archive file.
  57 In previouns example the patch files bar.pat, baz.pat and zoo.pat
  58 contained in the foo.zip are also installed.
  59
  60 .TP
  61 .BI source " file "
  62 Reads  another  configuration  file, then continues
  63 processing the current one.
  64
  65 .TP
  66 .BI bank " number"
  67 Selects the tone bank to  modify.   Patch  mappings
  68 that follow will affect this tone bank.
  69
  70 .TP
  71 .BI progbase " number"
  72 Sets and displays the tone number from \fInumber\fP to \fInumber+128\fP.
  73 If \fB progbase 1\fP are specified, tone numbers that follow are setted
  74 and displayed as the numbers from 1 to 128.
  75
  76 .TP
  77 .BI drumset " number"
  78 Selects  the  drum  set  to modify.  Patch mappings
  79 that follow will affect this drum set.
  80
  81 .TP
  82 .BI number " file [options]"
  83 Specifies that the the MIDI program number in the
  84 current tone bank or drum set should be played
  85 using the patch file. options may be any of the
  86 following:
  87
  88 .RS
  89 .TP
  90 \fBamp=\fP\fIamplification\fP
  91 Amplifies the instrument's volume by \fIamplification\fP
  92 percent. If no value is specified,
  93 one will be automatically determined whenever
  94 the instrument is loaded.
  95
  96 .TP
  97 \fBnote=\fP\fInote\fP
  98 Specifies a fixed  MIDI  note  to  use  when
  99 playing  the  instrument.  If \fInote\fP is 0, the
 100 instrument will be played at  whatever  note
 101 the  Note  On  event  triggering it has. For
 102 percussion instruments, if no value is specified
 103 in the configuration file, the default
 104 in the patch file will be used.
 105
 106 .TP
 107 \fBpan=\fP\fIpanning\fP
 108 Sets the instrument's default panning. panning
 109 may be \fBleft\fP, \fBright\fP, \fBcenter\fP, or an
 110 nteger between \-100  and  100,  designating
 111 full  left  and full right respectively.  If
 112 no value is specified, the  default  in  the
 113 patch  file will be used.  Note that panning
 114 controls in MIDI files  will  override  this
 115 value.
 116
 117 .TP
 118 \fBkeep=\fP{\fBloop\fP|\fBenv\fP}
 119 By default, percussion instruments have
 120 their loop and envelope information
 121 stripped. Strangely shaped envelopes are
 122 removed automatically from melodic instruments
 123 as  well. \fBkeep\fP can be used to prevent
 124 stripping envelope or loop data.  For  example,
 125 the Short and Long Whistle percussion
 126 instruments (General Midi numbers 71 and 72)
 127 need to have `\fBkeep=loop keep=env\fP' specified
 128 in the configuration file.
 129
 130 .TP
 131 \fBstrip=\fP{\fBloop\fP|\fBenv\fP|\fBtail\fP}
 132 Force removal of loop or envelope information
 133 from all patches in the instrument, or
 134 strip the tail, i.e. all data after the
 135 loop.  Some third-party instruments have
 136 garbage after the loop, as evidenced by  a
 137 clicking noise whenever the instrument is
 138 played, so adding the strip=tail option will
 139 markedly improve sound quality.
 140 .RE
 141
 142 The following statements are available only latest TiMidity.
 143
 144 .TP
 145 .BI "#extension altassign" " program1 program2 ..."
 146 Sets the alternate assign for drum set.
 147 For example, if you want to pronounce Hi-Hat cymbals (note number 42/44/46)
 148 in the drumset 0 exclusively to each others, specify:
 149 .sp
 150 drumset 0
 151 .br
 152 altassign 42 44 46
 153 .sp
 154 Note that alternate assign of drumset 0 is used by default.
 155
 156 .TP
 157 .BI "#extension comm" " program secound"
 158 Specifies the comment \fIcomment\fP for the tone number \fIprogram\fP.
 159 These comments are displayed in the indicater line at the case
 160 TiMidity is booted with option \fB\-iNt\fP, \fB\-iTt\fP.
 161
 162 .TP
 163 .BI "#extension timeout" " program secound"
 164 Specifies the time\-out value of the \fIprogram\fP. If any notes
 165 pronounced with the tone number \fIprogram\fP are suspended
 166 more than \fIsecond\fP seconds, TiMidity kills the notes.
 167
 168 .TP
 169 .BI "#extension copydrumset" " drumset"
 170 Copies all settings of the \fIdrumset\fP to the current drumset.
 171
 172 .TP
 173 .BI "#extension copybank" " bank"
 174 Copies all settings of the \fIbank\fP to the current bank.
 175
 176 .TP
 177 .BI "#extension HTTPproxy" " hostname:port"
 178 Specifies the proxy of the HTTP protocol. \fIhostname\fP and
 179 \fIport\fB are of the proxy host's.
 180
 181 .TP
 182 .BI "#extension FTPproxy" " hostname:port"
 183 Specifies the prox of the FTP protocol. Same as HTTP.
 184
 185 .TP
 186 .BI "#extension mailaddr" " your\-mail\-address"
 187 Specifies user's mail address. This address is sended to the
 188 FTP server if TiMidity access any file via FTp.
 189
 190 .TP
 191 .BI "#extension [\-]{option}" " [optarg]"
 192 Sets the value of boot\-time options.
 193
 194 .TP
 195 .BI "#extension undef" " progno"
 196 Undefine the tone \fIprogno\fP of current tone bank.
 197 .RE
 198
 199 These "#extension" statements are beginning with character '#' that
 200 is the comment flag of old TiMidity(version 0.2i or earlier).
 201 So these statememts are treated as comment line.
 202 .br
 203 The latest TiMidity treats "#extension" as white\-space. So you can omit
 204 it.
 205
 206 .P
 207 If any \fIfile\-name\fP expression ended with character '|' (Ascii 0x7c),
 208 the file\-name is treated as command and outputs of the command
 209 are also examined as arguments of statements.
 210
 211 .P
 212 .SH SEE ALSO
 213 timidity(1), lsmidiprog(1), mididump(1), patinfo(1), sf2text(1), wav2pat(1)
 214
 215 .P
 216 .SH COPYRIGHT
 217 Copyright (C) 1999 Masanao Izumo <mo@goice.co.jp>
 218 Copyright (C) 1995 Tuukka Toivonen <tt@cgs.fi>
 219 .P
 220 Original version was developed under the name of Tuukka Toivonen
 221 <tt@cgs.fi> until the version of TiMidity-0.2i. His development was
 222 discontinued because of his busy work.
 223 .P
 224 This program is free software; you can redistribute it and/or modify
 225 it under the terms of the \fIGNU General Public License\fP as published by
 226 the Free Software Foundation; either version 2 of the License, or (at
 227 your option) any later version.
 228 .P
 229 This program is distributed in the hope that it will be useful, but
 230 WITHOUT ANY WARRANTY; without even the implied warranty of
 231 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the \fIGNU
 232 General Public License\fP for more details.
 233 .P
 234 You should have received a copy of the GNU General Public License
 235 along with this program; if not, write to the Free Software
 236 Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
 237
 238
 239 .SH AVAILABILITY
 240 The latest release is available on the TiMidity++ Page,
 241 .br
 242 URL http://www.goice.co.jp/member/mo/timidity/
 243 .br
 244