add some more text about the build system
[asterisk/asterisk.git] / UPGRADE.txt
1 Information for Upgrading From Previous Asterisk Releases
2 =========================================================
3
4 Build Process (configure script):
5
6 Asterisk now uses an autoconf-generated configuration script to learn how it
7 should build itself for your system. As it is a standard script, running:
8
9 $ ./configure --help
10
11 will show you all the options available. This script can be used to tell the
12 build process what libraries you have on your system (if it cannot find them
13 automatically), which libraries you wish to have ignored even though they may
14 be present, etc.
15
16 You must run the configure script before Asterisk will build, although it will
17 attempt to automatically run it for you with no options specified; for most users,
18 that will result in a similar build to what they would have had before the
19 configure script was added to the build process (except for having to run 'make'
20 again after the configure script is run). Note that the configure script does NOT
21 need to be re-run just to rebuild Asterisk; you only need to re-run it when your
22 system configuration changes or you wish to build Asterisk with different options.
23
24 Build Process (module selection):
25
26 The Asterisk source tree now includes a basic module selection and build option
27 selection tool called 'menuselect'. Run 'make menuselect' to make your choices.
28 In this tool, you can disable building of modules that you don't care about,
29 turn on/off global options for the build and see which modules will not (and cannot)
30 be built because your system does not have the required external dependencies
31 installed.
32
33 The resulting file from menuselect is called 'menuselect.makeopts'. Note that
34 the resulting menuselect.makeopts file generally contains which modules *not*
35 to build. The modules listed in this file indicate which modules have unmet
36 dependencies, a present conflict, or have been disabled by the user in the
37 menuselect interface. Compiler Flags can also be set in the menuselect
38 interface.  In this case, the resulting file contains which CFLAGS are in use,
39 not which ones are not in use.
40
41 If you would like to save your choices and have them applied against all
42 builds, the file can be copied to '~/.asterisk.makeopts' or 
43 '/etc/asterisk.makeopts'.
44
45 PBX Core:
46
47 * The (very old and undocumented) ability to use BYEXTENSION for dialing
48   instead of ${EXTEN} has been removed.
49   
50 * Builtin (res_features) transfer functionality attempts to use the context
51   defined in TRANSFER_CONTEXT variable of the transferer channel first. If
52   not set, it uses the transferee variable. If not set in any channel, it will 
53   attempt to use the last non macro context. If not possible, it will default
54   to the current context.
55  
56 Command Line Interface:
57
58 * 'show channels concise', designed to be used by applications that will parse
59   its output, previously used ':' characters to separate fields. However, some
60   of those fields can easily contain that character, making the output not
61   parseable. The delimiter has been changed to '!'.
62
63 Applications:
64
65 * In previous Asterisk releases, many applications would jump to priority n+101
66   to indicate some kind of status or error condition.  This functionality was
67   marked deprecated in Asterisk 1.2.  An option to disable it was provided with
68   the default value set to 'on'.  The default value for the global priority
69   jumping option is now 'off'.
70
71 * The applications Cut, Sort, DBGet, DBPut, SetCIDNum, SetCIDName, SetRDNIS,
72   AbsoluteTimeout, DigitTimeout, ResponseTimeout, SetLanguage, GetGroupCount,
73   and GetGroupMatchCount were all deprecated in version 1.2, and therefore have
74   been removed in this version.  You should use the equivalent dialplan
75   function in places where you have previously used one of these applications.
76
77 * The application SetVar has been renamed to Set.  The syntax SetVar was marked
78   deprecated in version 1.2 and is no longer recognized in this version.
79
80 * app_read has been updated to use the newer options codes, using "skip" or
81   "noanswer" will not work.  Use s or n.  Also there is a new feature i, for
82   using indication tones, so typing in skip would give you unexpected results.
83
84 * OSPAuth is added to authenticate OSP tokens in in_bound call setup messages.
85
86 * The CONNECT event in the queue_log from app_queue now has a second field 
87   in addition to the holdtime field. It contains the unique ID of the 
88   queue member channel that is taking the call. This is useful when trying 
89   to link recording filenames back to a particular call from the queue.  
90
91 * The old/current behavior of app_queue has a serial type behavior
92   in that the queue will make all waiting callers wait in the queue
93   even if there is more than one available member ready to take
94   calls until the head caller is connected with the member they
95   were trying to get to. The next waiting caller in line then
96   becomes the head caller, and they are then connected with the
97   next available member and all available members and waiting callers
98   waits while this happens. This cycle continues until there are
99   no more available members or waiting callers, whichever comes first.
100   The new behavior, enabled by setting autofill=yes in queues.conf
101   either at the [general] level to default for all queues or 
102   to set on a per-queue level, makes sure that when the waiting 
103   callers are connecting with available members in a parallel fashion 
104   until there are no more available members or no more waiting callers,
105   whichever comes first. This is probably more along the lines of how
106   one would expect a queue should work and in most cases, you will want 
107   to enable this new behavior. If you do not specify or comment out this 
108   option, it will default to "no" to keep backward compatability with the old 
109   behavior.
110
111 * The app_queue application now has the ability to use MixMonitor to 
112   record conversations queue members are having with queue callers. Please
113   see configs/queues.conf.sample for more information on this option.
114
115 * app_meetme: The 'm' option (monitor) is renamed to 'l' (listen only), and
116   the 'm' option now provides the functionality of "initially muted". 
117   In practice, most existing dialplans using the 'm' flag should not notice
118   any difference, unless the keypad menu is enabled, allowing the user 
119   to unmute themsleves.
120
121 * ast_play_and_record would attempt to cancel the recording if a DTMF
122   '0' was received.  This behavior was not documented in most of the
123   applications that used ast_play_and_record and the return codes from
124   ast_play_and_record weren't checked for properly.
125   ast_play_and_record has been changed so that '0' no longer cancels a
126   recording.  If you want to allow DTMF digits to cancel an
127   in-progress recording use ast_play_and_record_full which allows you
128   to specify which DTMF digits can be used to accept a recording and
129   which digits can be used to cancel a recording.
130
131 * ast_app_messagecount has been renamed to ast_app_inboxcount.  There is now a
132   new ast_app_messagecount function which takes a single context/mailbox/folder
133   mailbox specification and returns the message count for that folder only.
134   This addresses the deficiency of not being able to count the number of
135   messages in folders other than INBOX and Old.
136
137 Manager:
138
139 * After executing the 'status' manager action, the "Status" manager events
140   included the header "CallerID:" which was actually only the CallerID number,
141   and not the full CallerID string.  This header has been renamed to
142   "CallerIDNum".  For compatibility purposes, the CallerID parameter will remain
143   until after the release of 1.4, when it will be removed.  Please use the time
144   during the 1.4 release to make this transition.
145
146 * The AgentConnect event now has an additional field called "BridgedChannel" 
147   which contains the unique ID of the queue member channel that is taking the 
148   call. This is useful when trying to link recording filenames back to 
149   a particular call from the queue.
150
151 * app_userevent has been modified to always send Event: UserEvent with the
152   additional header UserEvent: <userspec>.  Also, the Channel and UniqueID
153   headers are not automatically sent, unless you specify them as separate
154   arguments.  Please see the application help for the new syntax.
155
156 * app_meetme: Mute and Unmute events are now reported via the Manager API.
157   Native Manager API commands MeetMeMute and MeetMeUnmute are provided, which
158   are easier to use than "Action Command:". The MeetMeStopTalking event has
159   also been deprecated in favor of the already existing MeetmeTalking event
160   with a "Status" of "on" or "off" added.
161
162 Variables:
163
164 * The builtin variables ${CALLERID}, ${CALLERIDNAME}, ${CALLERIDNUM},
165   ${CALLERANI}, ${DNID}, ${RDNIS}, ${DATETIME}, ${TIMESTAMP}, ${ACCOUNTCODE},
166   and ${LANGUAGE} have all been deprecated in favor of their related dialplan
167   functions.  You are encouraged to move towards the associated dialplan
168   function, as these variables will be removed in a future release.
169
170 * The CDR-CSV variables uniqueid, userfield, and basing time on GMT are now 
171   adjustable from cdr.conf, instead of recompiling.
172
173 * OSP applications exports several new variables, ${OSPINHANDLE},
174   ${OSPOUTHANDLE}, ${OSPINTOKEN}, ${OSPOUTTOKEN}, ${OSPCALLING},
175   ${OSPINTIMELIMIT}, and ${OSPOUTTIMELIMIT}
176   
177 * Builtin transfer functionality sets the variable ${TRANSFERERNAME} in the new
178   created channel. This variables holds the channel name of the transferer.
179
180 Functions:
181
182 * The function ${CHECK_MD5()} has been deprecated in favor of using an
183   expression: $[${MD5(<string>)} = ${saved_md5}].
184
185 * The 'builtin' functions that used to be combined in pbx_functions.so are
186   now built as separate modules. If you are not using 'autoload=yes' in your
187   modules.conf file then you will need to explicitly load the modules that
188   contain the functions you want to use.
189
190 * The ENUMLOOKUP() function with the 'c' option (for counting the number of records),
191   but the lookup fails to match any records, the returned value will now be "0" instead of blank.
192
193 * The REALTIME() function is now available in version 1.4 and app_realtime has
194   been deprecated in favor of the new function. app_realtime will be removed
195   completely with the version 1.6 release so please take the time between
196   releases to make any necessary changes
197
198 The IAX2 channel:
199
200 * The "mailboxdetail" option has been deprecated.  Previously, if this option
201   was not enabled, the 2 byte MSGCOUNT information element would be set to all
202   1's to indicate there there is some number of messages waiting.  With this
203   option enabled, the number of new messages were placed in one byte and the
204   number of old messages are placed in the other.  This is now the default
205   (and the only) behavior.
206
207 The SIP channel:
208
209 * The "incominglimit" setting is replaced by the "call-limit" setting in sip.conf.
210
211 * OSP support code is removed from SIP channel to OSP applications. ospauth 
212   option in sip.conf is removed to osp.conf as authpolicy. allowguest option
213   in sip.conf cannot be set as osp anymore. 
214
215 The Zap channel:
216
217 * Support for MFC/R2 has been removed, as it has not been functional for some time
218   and it has no maintainer.
219
220 Installation:
221
222 * On BSD systems, the installation directories have changed to more "FreeBSDish" directories. On startup, Asterisk will look for the main configuration in /usr/local/etc/asterisk/asterisk.conf
223 If you have an old installation, you might want to remove the binaries and move the configuration files to the new locations. The following directories are now default:
224         ASTLIBDIR       /usr/local/lib/asterisk
225         ASTVARLIBDIR    /usr/local/share/asterisk
226         ASTETCDIR       /usr/local/etc/asterisk
227         ASTBINDIR       /usr/local/bin/asterisk
228         ASTSBINDIR      /usr/local/sbin/asterisk
229
230 Sounds:
231
232 * The phonetic sounds directory has been removed from the asterisk-sounds package
233   because they are now included directly in Asterisk.  However, it is important to
234   note that the phonetic sounds that existed in asterisk-sounds used a different
235   naming convention than the sounds in Asterisk.  For example, instead of alpha.gsm
236   and bravo.gsm, Asterisk has a_p.gsm and b_p.gsm.