Browse code

- modules documentation migrated from sgml to xml docbook format - many thanks to Edson <4lists (at) gmail (dot) com> for providing script to replace headers and rename files - contact updated - follows re-sync with todays changes and update of Makefile to generate README and html files from XML

git-svn-id: https://openser.svn.sourceforge.net/svnroot/openser/trunk@3886 689a6050-402a-0410-94f2-e92a70836424

Daniel-Constantin Mierla authored on 07/03/2008 18:19:45
Showing 274 changed files
... ...
@@ -3,25 +3,35 @@ Acc Module
3 3
 Jiri Kuthan
4 4
 
5 5
    iptel.org
6
+   <jiri@iptel.org>
6 7
 
7 8
 Bogdan-Andrei Iancu
8 9
 
9 10
    voice-system.ro
11
+   <bogdan@voice-system.ro>
10 12
 
11 13
 Ramona-Elena Modroiu
12 14
 
13 15
    rosdev.ro
16
+   <ramona@rosdev.ro>
14 17
 
15 18
 Edited by
16 19
 
17 20
 Bogdan-Andrei Iancu
18 21
 
22
+   voice-system.ro
23
+   <bogdan@voice-system.ro>
24
+
19 25
    Copyright � 2002, 2003 FhG FOKUS
20 26
 
21 27
    Copyright � 2004, 2006 voice-system.ro
28
+   Revision History
29
+   Revision $Revision$ $Date: 2008-03-04 15:15:47 +0200
30
+                              (Tue, 04 Mar 2008) $
22 31
      __________________________________________________________
23 32
 
24 33
    Table of Contents
34
+
25 35
    1. User's Guide
26 36
 
27 37
         1.1. Overview
... ...
@@ -92,45 +102,45 @@ Bogdan-Andrei Iancu
92 102
    2. Frequently Asked Questions
93 103
 
94 104
    List of Examples
95
-   1-1. early_media example
96
-   1-2. failed_transaction_flag example
97
-   1-3. report_ack example
98
-   1-4. report_cancels example
99
-   1-5. detect_direction example
100
-   1-6. multi_leg_info example
101
-   1-7. log_flag example
102
-   1-8. log_missed_flag example
103
-   1-9. log_level example
104
-   1-10. log_facility example
105
-   1-11. log_extra example
106
-   1-12. radius_config example
107
-   1-13. radius_flag example
108
-   1-14. radius_missed_flag example
109
-   1-15. service_type example
110
-   1-16. radius_extra example
111
-   1-17. db_flag example
112
-   1-18. db_missed_flag example
113
-   1-19. db_table_acc example
114
-   1-20. db_table_missed_calls example
115
-   1-21. db_url example
116
-   1-22. acc_method_column example
117
-   1-23. acc_from_tag_column example
118
-   1-24. acc_to_tag_column example
119
-   1-25. acc_callid_column example
120
-   1-26. acc_sip_code_column example
121
-   1-27. acc_sip_reason_column example
122
-   1-28. acc_time_column example
123
-   1-29. db_extra example
124
-   1-30. diameter_flag example
125
-   1-31. diameter_missed_flag example
126
-   1-32. diameter_client_host example
127
-   1-33. diameter_client_host example
128
-   1-34. diameter_extra example
129
-   1-35. acc_log_request usage
130
-   1-36. acc_db_request usage
131
-   1-37. acc_rad_request usage
132
-   1-38. acc_diam_request usage
133
-     __________________________________________________________
105
+
106
+   1.1. early_media example
107
+   1.2. failed_transaction_flag example
108
+   1.3. report_ack example
109
+   1.4. report_cancels example
110
+   1.5. detect_direction example
111
+   1.6. multi_leg_info example
112
+   1.7. log_flag example
113
+   1.8. log_missed_flag example
114
+   1.9. log_level example
115
+   1.10. log_facility example
116
+   1.11. log_extra example
117
+   1.12. radius_config example
118
+   1.13. radius_flag example
119
+   1.14. radius_missed_flag example
120
+   1.15. service_type example
121
+   1.16. radius_extra example
122
+   1.17. db_flag example
123
+   1.18. db_missed_flag example
124
+   1.19. db_table_acc example
125
+   1.20. db_table_missed_calls example
126
+   1.21. db_url example
127
+   1.22. acc_method_column example
128
+   1.23. acc_from_tag_column example
129
+   1.24. acc_to_tag_column example
130
+   1.25. acc_callid_column example
131
+   1.26. acc_sip_code_column example
132
+   1.27. acc_sip_reason_column example
133
+   1.28. acc_time_column example
134
+   1.29. db_extra example
135
+   1.30. diameter_flag example
136
+   1.31. diameter_missed_flag example
137
+   1.32. diameter_client_host example
138
+   1.33. diameter_client_host example
139
+   1.34. diameter_extra example
140
+   1.35. acc_log_request usage
141
+   1.36. acc_db_request usage
142
+   1.37. acc_rad_request usage
143
+   1.38. acc_diam_request usage
134 144
 
135 145
 Chapter 1. User's Guide
136 146
 
... ...
@@ -142,23 +152,23 @@ Chapter 1. User's Guide
142 152
 
143 153
    To account a transaction and to choose which set of backends to
144 154
    be used, the script writer just has to set some flags (see the
145
-   module parameters section for flag definitions Section 1.5). If
146
-   the accouting flag for a specific backend is set, the acc
147
-   module will then report on completed transaction. A typical
148
-   usage of the module takes no acc-specific script command -- the
149
-   functionality binds invisibly through transaction processing.
150
-   Script writers just need to mark the transaction for accounting
151
-   with proper setflag. Even so, the module allows the script
152
-   writter to force accouting in special cases via some script
153
-   functions.
155
+   module parameters section for flag definitions Section 1.5,
156
+   "Exported Parameters"). If the accouting flag for a specific
157
+   backend is set, the acc module will then report on completed
158
+   transaction. A typical usage of the module takes no
159
+   acc-specific script command -- the functionality binds
160
+   invisibly through transaction processing. Script writers just
161
+   need to mark the transaction for accounting with proper
162
+   setflag. Even so, the module allows the script writter to force
163
+   accouting in special cases via some script functions.
154 164
 
155 165
    The accouting module will log by default a fixed set of
156 166
    attributes for the transaction - if you customize you accouting
157 167
    by adding more information to be logged, please see the next
158
-   chapter about extra accouting - Section 1.2.
168
+   chapter about extra accouting - Section 1.2, "Extra
169
+   accounting".
159 170
 
160 171
    The fixed minimal accouting information is:
161
-
162 172
      * Request Method name
163 173
      * From header TAG parameter
164 174
      * To header TAG parameter
... ...
@@ -171,7 +181,6 @@ Chapter 1. User's Guide
171 181
    accounted instead.
172 182
 
173 183
    Note that:
174
-
175 184
      * A single INVITE may produce multiple accounting reports --
176 185
        that's due to SIP forking feature
177 186
      * All flags related to accouting need to be set in request
... ...
@@ -211,7 +220,6 @@ Chapter 1. User's Guide
211 220
    specifications were updated in the meantime. Thus, the DIAMETER
212 221
    part in the module is obsolete and needs rework to be usable
213 222
    with opendiameter or other DIAMETER servers.
214
-     __________________________________________________________
215 223
 
216 224
 1.1.1. General Example
217 225
 
... ...
@@ -227,7 +235,7 @@ if (uri=~"sip:+40") /* calls to Romania */ {
227 235
         exit;
228 236
     }
229 237
 
230
-    if (method=="INVITE" & !check_from()) {
238
+    if (method=="INVITE" && !check_from()) {
231 239
         log("from!=digest\n");
232 240
         sl_send_reply("403","Forbidden");
233 241
     }
... ...
@@ -235,7 +243,6 @@ if (uri=~"sip:+40") /* calls to Romania */ {
235 243
     setflag(1); /* set for accounting (the same value as in log_flag!)
236 244
     t_relay();  /* enter stateful mode now */
237 245
 };
238
-     __________________________________________________________
239 246
 
240 247
 1.2. Extra accounting
241 248
 
... ...
@@ -245,7 +252,6 @@ if (uri=~"sip:+40") /* calls to Romania */ {
245 252
    dynamical selection of extra information to be logged. This
246 253
    allows you to log any pseudo-variable (AVPs, parts of the
247 254
    request, etc).
248
-     __________________________________________________________
249 255
 
250 256
 1.2.2. Definitions and syntax
251 257
 
... ...
@@ -254,7 +260,6 @@ if (uri=~"sip:+40") /* calls to Romania */ {
254 260
    log. This information is defined via pseudo-variables and may
255 261
    include headers or AVPs values or other message or system
256 262
    values. The syntax of the parameter is:
257
-
258 263
      * xxx_extra = extra_definition (';'extra_definition)*
259 264
      * extra_definition = log_name '=' pseudo_variable
260 265
 
... ...
@@ -264,7 +269,6 @@ if (uri=~"sip:+40") /* calls to Romania */ {
264 269
 
265 270
    Via log_name you define how/where the data will be logged. Its
266 271
    meaning depends of the accounting support which is used:
267
-
268 272
      * LOG accounting - log_name will be just printed along with
269 273
        the data in log_name=data format;
270 274
      * DB accounting - log_name will be the name of the DB column
... ...
@@ -278,14 +282,12 @@ if (uri=~"sip:+40") /* calls to Romania */ {
278 282
        for packing the data into DIAMETER message. The AVP code is
279 283
        given directly as integer, since DIAMETER has no dictionary
280 284
        support yet. IMPORTANT: log_name must be a number.
281
-     __________________________________________________________
282 285
 
283 286
 1.2.3. How it works
284 287
 
285 288
    Some pseudo variables may return more than one value (like
286 289
    headers or AVPs). In this case, the returned values are
287 290
    embedded in a single string in a comma-separated format.
288
-     __________________________________________________________
289 291
 
290 292
 1.3. Multi Call-Legs accounting
291 293
 
... ...
@@ -301,7 +303,6 @@ if (uri=~"sip:+40") /* calls to Romania */ {
301 303
    Call forwarding on server is only one example which shows the
302 304
    necessity of the having an accounting engine with multiple legs
303 305
    support.
304
-     __________________________________________________________
305 306
 
306 307
 1.3.2. Configuration
307 308
 
... ...
@@ -323,14 +324,12 @@ if (uri=~"sip:+40") /* calls to Romania */ {
323 324
    By default, the multiple call-legs support is disabled - it can
324 325
    be enabled just be setting the per-leg set of AVPs via the
325 326
    multi_leg_info module parameter.
326
-     __________________________________________________________
327 327
 
328 328
 1.3.3. Logged data
329 329
 
330 330
    For each call, all the values of the AVP set (which defines a
331 331
    call-leg) will be logged. How the information will be actually
332 332
    logged, depends of the data backend:
333
-
334 333
      * syslog -- all leg-sets will be added to one record string
335 334
        as AVP1=xxx, AVP2=xxxx ,... sets.
336 335
      * database -- each pair will be separately logged (due DB
... ...
@@ -338,20 +337,18 @@ if (uri=~"sip:+40") /* calls to Romania */ {
338 337
        written, the difference between them being only the fields
339 338
        corresponding to the call-leg info.
340 339
 
341
-      Note
342
-
343
-           You will need to add in your DB (all acc related tables) the
344
-           colums for call-leg info (a column for each AVP for the set).
340
+Note
341
+       You will need to add in your DB (all acc related tables)
342
+       the colums for call-leg info (a column for each AVP for the
343
+       set).
345 344
      * Radius -- all sets will be added to same Radius accounting
346 345
        message as RADIUS AVPs - for each call-leg a set of RADIUS
347 346
        AVPs will be added (corresponding to the per-leg AVP set)
348 347
 
349
-    Note
350
-
351
-         You will need to add in your dictionaty the RADIUS AVPs used in
352
-         call-leg AVP set definition.
348
+Note
349
+       You will need to add in your dictionaty the RADIUS AVPs
350
+       used in call-leg AVP set definition.
353 351
      * Diameter same as for RADIUS.
354
-     __________________________________________________________
355 352
 
356 353
 1.4. Dependencies
357 354
 
... ...
@@ -359,22 +356,18 @@ if (uri=~"sip:+40") /* calls to Romania */ {
359 356
 
360 357
    The module depends on the following modules (in the other words
361 358
    the listed modules must be loaded before this module):
362
-
363 359
      * tm -- Transaction Manager
364 360
      * a database module -- If SQL support is used.
365 361
      * rr -- Record Route, if "detect_direction" module parameter
366 362
        is enabled.
367
-     __________________________________________________________
368 363
 
369 364
 1.4.2. External Libraries or Applications
370 365
 
371 366
    The following libraries or applications must be installed
372 367
    before running OpenSER with this module loaded:
373
-
374 368
      * radiusclient-ng 0.5.0 or higher -- if compiled with RADIUS
375 369
        support. See
376 370
        http://developer.berlios.de/projects/radiusclient-ng/.
377
-     __________________________________________________________
378 371
 
379 372
 1.5. Exported Parameters
380 373
 
... ...
@@ -384,9 +377,8 @@ if (uri=~"sip:+40") /* calls to Romania */ {
384 377
 
385 378
    Default value is 0 (no).
386 379
 
387
-   Example 1-1. early_media example
380
+   Example 1.1. early_media example
388 381
 modparam("acc", "early_media", 1)
389
-     __________________________________________________________
390 382
 
391 383
 1.5.2. failed_transaction_flag (integer)
392 384
 
... ...
@@ -395,9 +387,8 @@ modparam("acc", "early_media", 1)
395 387
 
396 388
    Default value is not-set (no flag).
397 389
 
398
-   Example 1-2. failed_transaction_flag example
390
+   Example 1.2. failed_transaction_flag example
399 391
 modparam("acc", "failed_transaction_flag", 4)
400
-     __________________________________________________________
401 392
 
402 393
 1.5.3. report_ack (integer)
403 394
 
... ...
@@ -408,9 +399,8 @@ modparam("acc", "failed_transaction_flag", 4)
408 399
 
409 400
    Default value is 0 (no).
410 401
 
411
-   Example 1-3. report_ack example
402
+   Example 1.3. report_ack example
412 403
 modparam("acc", "report_ack", 1)
413
-     __________________________________________________________
414 404
 
415 405
 1.5.4. report_cancels (integer)
416 406
 
... ...
@@ -420,9 +410,8 @@ modparam("acc", "report_ack", 1)
420 410
 
421 411
    Default value is 0 (no).
422 412
 
423
-   Example 1-4. report_cancels example
413
+   Example 1.4. report_cancels example
424 414
 modparam("acc", "report_cancels", 1)
425
-     __________________________________________________________
426 415
 
427 416
 1.5.5. detect_direction (integer)
428 417
 
... ...
@@ -437,21 +426,20 @@ modparam("acc", "report_cancels", 1)
437 426
 
438 427
    Default value is 0 (disabled).
439 428
 
440
-   Example 1-5. detect_direction example
429
+   Example 1.5. detect_direction example
441 430
 modparam("acc", "detect_direction", 1)
442
-     __________________________________________________________
443 431
 
444 432
 1.5.6. multi_leg_info (string)
445 433
 
446 434
    Defines the AVP set to be used in per-call-leg accoutning. See
447
-   Section 1.3 for a detailed description of the Multi Call-Legs
448
-   accounting.
435
+   Section 1.3, "Multi Call-Legs accounting" for a detailed
436
+   description of the Multi Call-Legs accounting.
449 437
 
450 438
    If empty, the multi-leg accouting support will be disabled.
451 439
 
452 440
    Default value is 0 (disabled).
453 441
 
454
-   Example 1-6. multi_leg_info example
442
+   Example 1.6. multi_leg_info example
455 443
 # for syslog-based accouting, use any text you want to be printed
456 444
 modparam("acc", "multi_leg_info",
457 445
     "text1=$avp(src);text2=$avp(dst)")
... ...
@@ -464,7 +452,6 @@ modparam("acc", "multi_leg_info",
464 452
 # for DIAMETER-based accouting, use the DIAMETER AVP ID (as integer)
465 453
 modparam("acc", "multi_leg_info",
466 454
     "2345=$avp(src);2346=$avp(dst)")
467
-     __________________________________________________________
468 455
 
469 456
 1.5.7. log_flag (integer)
470 457
 
... ...
@@ -473,9 +460,8 @@ modparam("acc", "multi_leg_info",
473 460
 
474 461
    Default value is not-set (no flag).
475 462
 
476
-   Example 1-7. log_flag example
463
+   Example 1.7. log_flag example
477 464
 modparam("acc", "log_flag", 2)
478
-     __________________________________________________________
479 465
 
480 466
 1.5.8. log_missed_flag (integer)
481 467
 
... ...
@@ -484,9 +470,8 @@ modparam("acc", "log_flag", 2)
484 470
 
485 471
    Default value is not-set (no flag).
486 472
 
487
-   Example 1-8. log_missed_flag example
473
+   Example 1.8. log_missed_flag example
488 474
 modparam("acc", "log_missed_flag", 3)
489
-     __________________________________________________________
490 475
 
491 476
 1.5.9. log_level (integer)
492 477
 
... ...
@@ -494,9 +479,8 @@ modparam("acc", "log_missed_flag", 3)
494 479
 
495 480
    Default value is L_NOTICE.
496 481
 
497
-   Example 1-9. log_level example
482
+   Example 1.9. log_level example
498 483
 modparam("acc", "log_level", 2)   # Set log_level to 2
499
-     __________________________________________________________
500 484
 
501 485
 1.5.10. log_facility (string)
502 486
 
... ...
@@ -506,9 +490,8 @@ modparam("acc", "log_level", 2)   # Set log_level to 2
506 490
 
507 491
    Default value is LOG_DAEMON.
508 492
 
509
-   Example 1-10. log_facility example
493
+   Example 1.10. log_facility example
510 494
 modparam("acc", "log_facility", "LOG_DAEMON")
511
-     __________________________________________________________
512 495
 
513 496
 1.5.11. log_extra (string)
514 497
 
... ...
@@ -516,9 +499,8 @@ modparam("acc", "log_facility", "LOG_DAEMON")
516 499
 
517 500
    Default value is NULL.
518 501
 
519
-   Example 1-11. log_extra example
502
+   Example 1.11. log_extra example
520 503
 modparam("acc", "log_extra", "ua=$hdr(User-Agent);uuid=$avp(i:123)")
521
-     __________________________________________________________
522 504
 
523 505
 1.5.12. radius_config (string)
524 506
 
... ...
@@ -535,9 +517,8 @@ modparam("acc", "log_extra", "ua=$hdr(User-Agent);uuid=$avp(i:123)")
535 517
    Default value is "/usr/local/etc/radiusclient/radiusclient.conf
536 518
    ".
537 519
 
538
-   Example 1-12. radius_config example
520
+   Example 1.12. radius_config example
539 521
 modparam("acc", "radius_config", "/etc/radiusclient/radiusclient.conf")
540
-     __________________________________________________________
541 522
 
542 523
 1.5.13. radius_flag (integer)
543 524
 
... ...
@@ -546,9 +527,8 @@ modparam("acc", "radius_config", "/etc/radiusclient/radiusclient.conf")
546 527
 
547 528
    Default value is not-set (no flag).
548 529
 
549
-   Example 1-13. radius_flag example
530
+   Example 1.13. radius_flag example
550 531
 modparam("acc", "radius_flag", 2)
551
-     __________________________________________________________
552 532
 
553 533
 1.5.14. radius_missed_flag (integer)
554 534
 
... ...
@@ -557,9 +537,8 @@ modparam("acc", "radius_flag", 2)
557 537
 
558 538
    Default value is not-set (no flag).
559 539
 
560
-   Example 1-14. radius_missed_flag example
540
+   Example 1.14. radius_missed_flag example
561 541
 modparam("acc", "radius_missed_flag", 3)
562
-     __________________________________________________________
563 542
 
564 543
 1.5.15. service_type (integer)
565 544
 
... ...
@@ -567,9 +546,8 @@ modparam("acc", "radius_missed_flag", 3)
567 546
 
568 547
    Default value is 15 (SIP).
569 548
 
570
-   Example 1-15. service_type example
549
+   Example 1.15. service_type example
571 550
 modparam("acc", "service_type", 16)
572
-     __________________________________________________________
573 551
 
574 552
 1.5.16. radius_extra (string)
575 553
 
... ...
@@ -577,9 +555,8 @@ modparam("acc", "service_type", 16)
577 555
 
578 556
    Default value is NULL.
579 557
 
580
-   Example 1-16. radius_extra example
558
+   Example 1.16. radius_extra example
581 559
 modparam("acc", "radius_extra", "via=$hdr(Via[*]); email=$avp(s:email)")
582
-     __________________________________________________________
583 560
 
584 561
 1.5.17. db_flag (integer)
585 562
 
... ...
@@ -588,9 +565,8 @@ modparam("acc", "radius_extra", "via=$hdr(Via[*]); email=$avp(s:email)")
588 565
 
589 566
    Default value is not-set (no flag).
590 567
 
591
-   Example 1-17. db_flag example
568
+   Example 1.17. db_flag example
592 569
 modparam("acc", "db_flag", 2)
593
-     __________________________________________________________
594 570
 
595 571
 1.5.18. db_missed_flag (integer)
596 572
 
... ...
@@ -599,9 +575,8 @@ modparam("acc", "db_flag", 2)
599 575
 
600 576
    Default value is not-set (no flag).
601 577
 
602
-   Example 1-18. db_missed_flag example
578
+   Example 1.18. db_missed_flag example
603 579
 modparam("acc", "db_missed_flag", 3)
604
-     __________________________________________________________
605 580
 
606 581
 1.5.19. db_table_acc (string)
607 582
 
... ...
@@ -610,9 +585,8 @@ modparam("acc", "db_missed_flag", 3)
610 585
 
611 586
    Default value is "acc"
612 587
 
613
-   Example 1-19. db_table_acc example
588
+   Example 1.19. db_table_acc example
614 589
 modparam("acc", "db_table_acc", "myacc_table")
615
-     __________________________________________________________
616 590
 
617 591
 1.5.20. db_table_missed_calls (string)
618 592
 
... ...
@@ -620,9 +594,8 @@ modparam("acc", "db_table_acc", "myacc_table")
620 594
 
621 595
    Default value is "missed_calls"
622 596
 
623
-   Example 1-20. db_table_missed_calls example
597
+   Example 1.20. db_table_missed_calls example
624 598
 modparam("acc", "db_table_missed_calls", "myMC_table")
625
-     __________________________________________________________
626 599
 
627 600
 1.5.21. db_url (string)
628 601
 
... ...
@@ -631,9 +604,8 @@ modparam("acc", "db_table_missed_calls", "myMC_table")
631 604
 
632 605
    Default value is "NULL" (SQL disabled).
633 606
 
634
-   Example 1-21. db_url example
607
+   Example 1.21. db_url example
635 608
 modparam("acc", "db_url", "mysql://user:password@localhost/openser")
636
-     __________________________________________________________
637 609
 
638 610
 1.5.22. acc_method_column (string)
639 611
 
... ...
@@ -642,9 +614,8 @@ modparam("acc", "db_url", "mysql://user:password@localhost/openser")
642 614
 
643 615
    Default value is "method".
644 616
 
645
-   Example 1-22. acc_method_column example
617
+   Example 1.22. acc_method_column example
646 618
 modparam("acc", "acc_method_column", "method")
647
-     __________________________________________________________
648 619
 
649 620
 1.5.23. acc_from_tag_column (string)
650 621
 
... ...
@@ -653,9 +624,8 @@ modparam("acc", "acc_method_column", "method")
653 624
 
654 625
    Default value is "from_tag".
655 626
 
656
-   Example 1-23. acc_from_tag_column example
627
+   Example 1.23. acc_from_tag_column example
657 628
 modparam("acc", "acc_from_tag_column", "from_tag")
658
-     __________________________________________________________
659 629
 
660 630
 1.5.24. acc_to_tag_column (string)
661 631
 
... ...
@@ -664,9 +634,8 @@ modparam("acc", "acc_from_tag_column", "from_tag")
664 634
 
665 635
    Default value is "to_tag".
666 636
 
667
-   Example 1-24. acc_to_tag_column example
637
+   Example 1.24. acc_to_tag_column example
668 638
 modparam("acc", "acc_to_tag_column", "to_tag")
669
-     __________________________________________________________
670 639
 
671 640
 1.5.25. acc_callid_column (string)
672 641
 
... ...
@@ -675,9 +644,8 @@ modparam("acc", "acc_to_tag_column", "to_tag")
675 644
 
676 645
    Default value is "callid".
677 646
 
678
-   Example 1-25. acc_callid_column example
647
+   Example 1.25. acc_callid_column example
679 648
 modparam("acc", "acc_callid_column", "callid")
680
-     __________________________________________________________
681 649
 
682 650
 1.5.26. acc_sip_code_column (string)
683 651
 
... ...
@@ -686,9 +654,8 @@ modparam("acc", "acc_callid_column", "callid")
686 654
 
687 655
    Default value is "sip_code".
688 656
 
689
-   Example 1-26. acc_sip_code_column example
657
+   Example 1.26. acc_sip_code_column example
690 658
 modparam("acc", "acc_sip_code_column", "sip_code")
691
-     __________________________________________________________
692 659
 
693 660
 1.5.27. acc_sip_reason_column (string)
694 661
 
... ...
@@ -697,9 +664,8 @@ modparam("acc", "acc_sip_code_column", "sip_code")
697 664
 
698 665
    Default value is "sip_reason".
699 666
 
700
-   Example 1-27. acc_sip_reason_column example
667
+   Example 1.27. acc_sip_reason_column example
701 668
 modparam("acc", "acc_sip_reason_column", "sip_reason")
702
-     __________________________________________________________
703 669
 
704 670
 1.5.28. acc_time_column (string)
705 671
 
... ...
@@ -708,9 +674,8 @@ modparam("acc", "acc_sip_reason_column", "sip_reason")
708 674
 
709 675
    Default value is "time".
710 676
 
711
-   Example 1-28. acc_time_column example
677
+   Example 1.28. acc_time_column example
712 678
 modparam("acc", "acc_time_column", "time")
713
-     __________________________________________________________
714 679
 
715 680
 1.5.29. db_extra (string)
716 681
 
... ...
@@ -718,10 +683,9 @@ modparam("acc", "acc_time_column", "time")
718 683
 
719 684
    Default value is NULL.
720 685
 
721
-   Example 1-29. db_extra example
686
+   Example 1.29. db_extra example
722 687
 modparam("acc", "db_extra", "ct=$hdr(Content-type); email=$avp(s:email)"
723 688
 )
724
-     __________________________________________________________
725 689
 
726 690
 1.5.30. diameter_flag (integer)
727 691
 
... ...
@@ -730,9 +694,8 @@ modparam("acc", "db_extra", "ct=$hdr(Content-type); email=$avp(s:email)"
730 694
 
731 695
    Default value is not-set (no flag).
732 696
 
733
-   Example 1-30. diameter_flag example
697
+   Example 1.30. diameter_flag example
734 698
 modparam("acc", "diameter_flag", 2)
735
-     __________________________________________________________
736 699
 
737 700
 1.5.31. diameter_missed_flag (integer)
738 701
 
... ...
@@ -741,9 +704,8 @@ modparam("acc", "diameter_flag", 2)
741 704
 
742 705
    Default value is not-set (no flag).
743 706
 
744
-   Example 1-31. diameter_missed_flag example
707
+   Example 1.31. diameter_missed_flag example
745 708
 modparam("acc", "diameter_missed_flag", 3)
746
-     __________________________________________________________
747 709
 
748 710
 1.5.32. diameter_client_host (string)
749 711
 
... ...
@@ -752,9 +714,8 @@ modparam("acc", "diameter_missed_flag", 3)
752 714
 
753 715
    Default value is "localhost".
754 716
 
755
-   Example 1-32. diameter_client_host example
717
+   Example 1.32. diameter_client_host example
756 718
 modparam("acc", "diameter_client_host", "3a_server.net")
757
-     __________________________________________________________
758 719
 
759 720
 1.5.33. diameter_client_port (int)
760 721
 
... ...
@@ -763,9 +724,8 @@ modparam("acc", "diameter_client_host", "3a_server.net")
763 724
 
764 725
    Default value is 3000.
765 726
 
766
-   Example 1-33. diameter_client_host example
727
+   Example 1.33. diameter_client_host example
767 728
 modparam("acc", "diameter_client_port", 3000)
768
-     __________________________________________________________
769 729
 
770 730
 1.5.34. diameter_extra (string)
771 731
 
... ...
@@ -773,14 +733,13 @@ modparam("acc", "diameter_client_port", 3000)
773 733
 
774 734
    Default value is NULL.
775 735
 
776
-   Example 1-34. diameter_extra example
736
+   Example 1.34. diameter_extra example
777 737
 modparam("acc", "diameter_extra", "7846=$hdr(Content-type);7847=$avp(s:e
778 738
 mail)")
779
-     __________________________________________________________
780 739
 
781 740
 1.6. Exported Functions
782 741
 
783
-1.6.1. acc_log_request(comment)
742
+1.6.1.  acc_log_request(comment)
784 743
 
785 744
    acc_request reports on a request, for example, it can be used
786 745
    to report on missed calls to off-line users who are replied 404
... ...
@@ -789,123 +748,117 @@ mail)")
789 748
    processing.
790 749
 
791 750
    Meaning of the parameters is as follows:
792
-
793 751
      * comment - Comment to be appended.
794 752
 
795 753
    This function can be used from REQUEST_ROUTE, FAILURE_ROUTE.
796 754
 
797
-   Example 1-35. acc_log_request usage
755
+   Example 1.35. acc_log_request usage
798 756
 ...
799 757
 acc_log_request("Some comment");
800 758
 ...
801
-     __________________________________________________________
802 759
 
803
-1.6.2. acc_db_request(comment, table)
760
+1.6.2.  acc_db_request(comment, table)
804 761
 
805 762
    Like acc_log_request, acc_db_request reports on a request. The
806 763
    report is sent to database at "db_url", in the table referred
807 764
    to in the second action parameter.
808 765
 
809 766
    Meaning of the parameters is as follows:
810
-
811 767
      * comment - Comment to be appended.
812 768
      * table - Database table to be used.
813 769
 
814 770
    This function can be used from REQUEST_ROUTE, FAILURE_ROUTE.
815 771
 
816
-   Example 1-36. acc_db_request usage
772
+   Example 1.36. acc_db_request usage
817 773
 ...
818 774
 acc_log_request("Some comment", "Some table");
819 775
 ...
820
-     __________________________________________________________
821 776
 
822
-1.6.3. acc_rad_request(comment)
777
+1.6.3.  acc_rad_request(comment)
823 778
 
824 779
    Like acc_log_request, acc_rad_request reports on a request. It
825 780
    reports to radius server as configured in "radius_config".
826 781
 
827 782
    Meaning of the parameters is as follows:
828
-
829 783
      * comment - Comment to be appended.
830 784
 
831 785
    This function can be used from REQUEST_ROUTE, FAILURE_ROUTE.
832 786
 
833
-   Example 1-37. acc_rad_request usage
787
+   Example 1.37. acc_rad_request usage
834 788
 ...
835 789
 acc_rad_request("Some comment");
836 790
 ...
837
-     __________________________________________________________
838 791
 
839
-1.6.4. acc_diam_request(comment)
792
+1.6.4.  acc_diam_request(comment)
840 793
 
841 794
    Like acc_log_request, acc_diam_request reports on a request. It
842 795
    reports to the configured Diameter server.
843 796
 
844 797
    Meaning of the parameters is as follows:
845
-
846 798
      * comment - Comment to be appended.
847 799
 
848 800
    This function can be used from REQUEST_ROUTE, FAILURE_ROUTE.
849 801
 
850
-   Example 1-38. acc_diam_request usage
802
+   Example 1.38. acc_diam_request usage
851 803
 ...
852 804
 acc_diam_request("Some comment");
853 805
 ...
854
-     __________________________________________________________
855 806
 
856 807
 Chapter 2. Frequently Asked Questions
857 808
 
858
-   2.1. What happend with old log_fmt parameter
859
-   2.2. What happend with old multi_leg_enabled parameter
860
-   2.3. What happend with old src_leg_avp_id & dst_leg_avp_id
861
-          parameters
809
+   2.1.
810
+
811
+       What happend with old log_fmt parameter
812
+
813
+       The parameter became obsolete with the restructure of the data
814
+       logged by ACC module (refer to the Overview chapter). For
815
+       similar behaviour you can use the extra accouting (see the
816
+       coresponding chapter).
817
+
818
+   2.2.
862 819
 
863
-   2.4. Where can I find more about OpenSER?
864
-   2.5. Where can I post a question about this module?
865
-   2.6. How can I report a bug?
820
+       What happend with old multi_leg_enabled parameter
866 821
 
867
-   2.1. What happend with old log_fmt parameter
822
+       The parameter becaome obsolete by the addition of the new
823
+       multi_leg_info parameter. The multi-leg accouting is
824
+       automatically enabled when multi_leg_info is defined.
868 825
 
869
-   The parameter became obsolete with the restructure of the data
870
-   logged by ACC module (refer to the Overview chapter). For
871
-   similar behaviour you can use the extra accouting (see the
872
-   coresponding chapter).
826
+   2.3.
873 827
 
874
-   2.2. What happend with old multi_leg_enabled parameter
828
+       What happend with old src_leg_avp_id and dst_leg_avp_id
829
+       parameters
875 830
 
876
-   The parameter becaome obsolete by the addition of the new
877
-   multi_leg_info parameter. The multi-leg accouting is
878
-   automatically enabled when multi_leg_info is defined.
831
+       The parameter was replaced by the more generic new parameter
832
+       multi_leg_info. This allows logging (per-leg) of more
833
+       information than just dst and src.
879 834
 
880
-   2.3. What happend with old src_leg_avp_id & dst_leg_avp_id
881
-   parameters
835
+   2.4.
882 836
 
883
-   The parameter was replaced by the more generic new parameter
884
-   multi_leg_info. This allows logging (per-leg) of more
885
-   information than just dst and src.
837
+       Where can I find more about OpenSER?
886 838
 
887
-   2.4. Where can I find more about OpenSER?
839
+       Take a look at http://openser.org/.
888 840
 
889
-   Take a look at http://openser.org/.
841
+   2.5.
890 842
 
891
-   2.5. Where can I post a question about this module?
843
+       Where can I post a question about this module?
892 844
 
893
-   First at all check if your question was already answered on one
894
-   of our mailing lists:
845
+       First at all check if your question was already answered on one
846
+       of our mailing lists:
847
+         * User Mailing List -
848
+           http://openser.org/cgi-bin/mailman/listinfo/users
849
+         * Developer Mailing List -
850
+           http://openser.org/cgi-bin/mailman/listinfo/devel
895 851
 
896
-     * User Mailing List -
897
-       http://openser.org/cgi-bin/mailman/listinfo/users
898
-     * Developer Mailing List -
899
-       http://openser.org/cgi-bin/mailman/listinfo/devel
852
+       E-mails regarding any stable OpenSER release should be sent to
853
+       <users@openser.org> and e-mails regarding development versions
854
+       should be sent to <devel@openser.org>.
900 855
 
901
-   E-mails regarding any stable OpenSER release should be sent to
902
-   <users@openser.org> and e-mails regarding development versions
903
-   should be sent to <devel@openser.org>.
856
+       If you want to keep the mail private, send it to
857
+       <team@openser.org>.
904 858
 
905
-   If you want to keep the mail private, send it to
906
-   <team@openser.org>.
859
+   2.6.
907 860
 
908
-   2.6. How can I report a bug?
861
+       How can I report a bug?
909 862
 
910
-   Please follow the guidelines provided at:
911
-   http://sourceforge.net/tracker/?group_id=139143.
863
+       Please follow the guidelines provided at:
864
+       http://sourceforge.net/tracker/?group_id=139143.
912 865
similarity index 75%
913 866
rename from modules_k/acc/doc/acc.sgml
914 867
rename to modules_k/acc/doc/acc.xml
... ...
@@ -1,10 +1,12 @@
1
-<!DOCTYPE Book PUBLIC "-//OASIS//DTD DocBook V4.2//EN" [
1
+<?xml version="1.0" encoding='ISO-8859-1'?>
2
+<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.4//EN"
3
+"http://www.oasis-open.org/docbook/xml/4.4/docbookx.dtd" [
2 4
 
3
-<!ENTITY user SYSTEM "acc_user.sgml">
4
-<!ENTITY faq SYSTEM "acc_faq.sgml">
5
+<!ENTITY user SYSTEM "acc_admin.xml">
6
+<!ENTITY faq SYSTEM "acc_faq.xml">
5 7
 
6 8
 <!-- Include general documentation entities -->
7
-<!ENTITY % docentities SYSTEM "../../../doc/entities.sgml">
9
+<!ENTITY % docentities SYSTEM "../../../doc/entities.xml">
8 10
 %docentities;
9 11
 
10 12
 ]>
... ...
@@ -51,8 +53,8 @@
51 53
 	</copyright>
52 54
 	<revhistory>
53 55
 		<revision>
54
-		<revnumber>$Revision$</revnumber>
55
-		<date>$Date$</date>
56
+		<revnumber>$Revision: 3839 $</revnumber>
57
+		<date>$Date: 2008-03-04 15:15:47 +0200 (Tue, 04 Mar 2008) $</date>
56 58
 		</revision>
57 59
 	</revhistory>
58 60
 	</bookinfo>
59 61
similarity index 98%
60 62
rename from modules_k/acc/doc/acc_user.sgml
61 63
rename to modules_k/acc/doc/acc_admin.xml
... ...
@@ -15,7 +15,7 @@
15 15
 	<para>
16 16
 		To account a transaction and to choose which set of backends to be 
17 17
 		used, the script writer just has to set some flags (see the module
18
-		parameters section for flag definitions <xref linkend="ACC-param-id">).
18
+		parameters section for flag definitions <xref linkend="ACC-param-id"/>).
19 19
 		If the accouting flag for a specific backend is set, the acc module 
20 20
 		will then report on completed transaction. A typical usage of the 
21 21
 		module takes no acc-specific script command -- the functionality 
... ...
@@ -28,7 +28,7 @@
28 28
 		The accouting module will log by default a fixed set of attributes 
29 29
 		for the transaction - if you customize you accouting by adding more
30 30
 		information to be logged, please see the next chapter about extra
31
-		accouting - <xref linkend="ACC-extra-id">.
31
+		accouting - <xref linkend="ACC-extra-id"/>.
32 32
 	</para>
33 33
 	<para>
34 34
 		The fixed minimal accouting information is: 
... ...
@@ -136,7 +136,7 @@ if (uri=~"sip:+40") /* calls to Romania */ {
136 136
         exit;
137 137
     }
138 138
 
139
-    if (method=="INVITE" & !check_from()) {
139
+    if (method=="INVITE" &amp;&amp; !check_from()) {
140 140
         log("from!=digest\n");
141 141
         sl_send_reply("403","Forbidden");
142 142
     }
... ...
@@ -163,7 +163,7 @@ if (uri=~"sip:+40") /* calls to Romania */ {
163 163
 			<title>Definitions and syntax</title>
164 164
 			<para>
165 165
 			Selection of extra information is done via 
166
-			<emphasis>xxx_extra<emphasis> parameters by specifying the names
166
+			<emphasis>xxx_extra</emphasis> parameters by specifying the names
167 167
 			of additional information you want to log. This information is 
168 168
 			defined via pseudo-variables and may include headers or AVPs values
169 169
 			or other message or system values. The syntax of the parameter is:
... ...
@@ -193,14 +193,14 @@ if (uri=~"sip:+40") /* calls to Romania */ {
193 193
 				</para></listitem>
194 194
 				<listitem><para><emphasis>DB accounting</emphasis> - log_name 
195 195
 				will be the name of the DB column where the data will be 
196
-				stored.<emphasis>IMPORTANT<emphasis>: add in db 
196
+				stored.<emphasis>IMPORTANT</emphasis>: add in db 
197 197
 				<emphasis>acc</emphasis> table the columns corresponding to 
198 198
 				each extra data;
199 199
 				</para></listitem>
200 200
 				<listitem><para><emphasis>RADIUS accounting</emphasis> - 
201 201
 				log_name will be the AVP name used for packing the data into 
202 202
 				RADIUS message. The log_name will be translated to AVP number 
203
-				via the dictionary. <emphasis>IMPORTANT<emphasis>: add in 
203
+				via the dictionary. <emphasis>IMPORTANT</emphasis>: add in 
204 204
 				RADIUS dictionary the <emphasis>log_name</emphasis> attribute.
205 205
 				</para></listitem>
206 206
 				<listitem><para><emphasis>DIAMETER accounting</emphasis> - 
... ...
@@ -335,6 +335,7 @@ if (uri=~"sip:+40") /* calls to Romania */ {
335 335
 			<para>
336 336
 			The following libraries or applications must be installed 
337 337
 			before running &ser; with this module loaded:
338
+			</para>
338 339
 			<itemizedlist>
339 340
 				<listitem>
340 341
 				<para><emphasis>radiusclient-ng</emphasis> 0.5.0 or higher -- 
... ...
@@ -442,7 +443,7 @@ modparam("acc", "detect_direction", 1)
442 443
 		<title><varname>multi_leg_info</varname> (string)</title>
443 444
 		<para>
444 445
 		Defines the AVP set to be used in per-call-leg accoutning.
445
-		See <xref linkend="multi-call-legs"> for a 
446
+		See <xref linkend="multi-call-legs"/> for a 
446 447
 		detailed description of the Multi Call-Legs accounting.
447 448
 		</para>
448 449
 		<para>
449 450
similarity index 96%
450 451
rename from modules_k/acc/doc/acc_faq.sgml
451 452
rename to modules_k/acc/doc/acc_faq.xml
... ...
@@ -34,7 +34,8 @@
34 34
 
35 35
 	<qandaentry>
36 36
 		<question>
37
-		<para>What happend with old src_leg_avp_id & dst_leg_avp_id parameters</para>
37
+			<para>What happend with old src_leg_avp_id and dst_leg_avp_id
38
+				parameters</para>
38 39
 		</question>
39 40
 		<answer>
40 41
 		<para>
... ...
@@ -2,16 +2,18 @@ ALIAS_DB Module
2 2
 
3 3
 Daniel-Constantin Mierla
4 4
 
5
-   voice-system.ro
6
-
7 5
 Edited by
8 6
 
9 7
 Daniel-Constantin Mierla
10 8
 
11 9
    Copyright � 2005 voice-system.ro
10
+   Revision History
11
+   Revision $Revision$ $Date: 2008-03-04 15:15:47 +0200
12
+                              (Tue, 04 Mar 2008) $
12 13
      __________________________________________________________
13 14
 
14 15
    Table of Contents
16
+
15 17
    1. User's Guide
16 18
 
17 19
         1.1. Overview
... ...
@@ -34,16 +36,18 @@ Daniel-Constantin Mierla
34 36
 
35 37
               1.4.1. alias_db_lookup(table_name)
36 38
 
39
+   2. Frequently Asked Questions
40
+
37 41
    List of Examples
38
-   1-1. Set db_url parameter
39
-   1-2. Set user_column parameter
40
-   1-3. Set domain_column parameter
41
-   1-4. Set alias_user_column parameter
42
-   1-5. Set alias_domain_column parameter
43
-   1-6. Set use_domain parameter
44
-   1-7. Set domain_prefix parameter
45
-   1-8. alias_db_lookup() usage
46
-     __________________________________________________________
42
+
43
+   1.1. Set db_url parameter
44
+   1.2. Set user_column parameter
45
+   1.3. Set domain_column parameter
46
+   1.4. Set alias_user_column parameter
47
+   1.5. Set alias_domain_column parameter
48
+   1.6. Set use_domain parameter
49
+   1.7. Set domain_prefix parameter
50
+   1.8. alias_db_lookup() usage
47 51
 
48 52
 Chapter 1. User's Guide
49 53
 
... ...
@@ -58,24 +62,19 @@ Chapter 1. User's Guide
58 62
    the provisioning is easier. With very fast databases like MySQL
59 63
    the speed penalty can be lowered. Also, the search can be
60 64
    performed on different tables in the same script.
61
-     __________________________________________________________
62 65
 
63 66
 1.2. Dependencies
64 67
 
65 68
 1.2.1. OpenSER Modules
66 69
 
67 70
    The following modules must be loaded before this module:
68
-
69 71
      * database module (mysql, dbtext, ...).
70
-     __________________________________________________________
71 72
 
72 73
 1.2.2. External Libraries or Applications
73 74
 
74 75
    The following libraries or applications must be installed
75 76
    before running OpenSER with this module loaded:
76
-
77 77
      * None.
78
-     __________________________________________________________
79 78
 
80 79
 1.3. Exported Parameters
81 80
 
... ...
@@ -85,11 +84,10 @@ Chapter 1. User's Guide
85 84
 
86 85
    Default value is "DEFAULT_RODB_URL".
87 86
 
88
-   Example 1-1. Set db_url parameter
87
+   Example 1.1. Set db_url parameter
89 88
 ...
90 89
 modparam("alias_db", "db_url", "mysql://user:passwd@localhost/openser")
91 90
 ...
92
-     __________________________________________________________
93 91
 
94 92
 1.3.2. user_column (str)
95 93
 
... ...
@@ -97,11 +95,10 @@ modparam("alias_db", "db_url", "mysql://user:passwd@localhost/openser")
97 95
 
98 96
    Default value is "username".
99 97
 
100
-   Example 1-2. Set user_column parameter
98
+   Example 1.2. Set user_column parameter
101 99
 ...
102 100
 modparam("alias_db", "user_column", "susername")
103 101
 ...
104
-     __________________________________________________________
105 102
 
106 103
 1.3.3. domain_column (str)
107 104
 
... ...
@@ -109,11 +106,10 @@ modparam("alias_db", "user_column", "susername")
109 106
 
110 107
    Default value is "domain".
111 108
 
112
-   Example 1-3. Set domain_column parameter
109
+   Example 1.3. Set domain_column parameter
113 110
 ...
114 111
 modparam("alias_db", "domain_column", "sdomain")
115 112
 ...
116
-     __________________________________________________________
117 113
 
118 114
 1.3.4. alias_user_column (str)
119 115
 
... ...
@@ -121,11 +117,10 @@ modparam("alias_db", "domain_column", "sdomain")
121 117
 
122 118
    Default value is "alias_username".
123 119
 
124
-   Example 1-4. Set alias_user_column parameter
120
+   Example 1.4. Set alias_user_column parameter
125 121
 ...
126 122
 modparam("alias_db", "alias_user_column", "auser")
127 123
 ...
128
-     __________________________________________________________
129 124
 
130 125
 1.3.5. alias_domain_column (str)
131 126
 
... ...
@@ -133,11 +128,10 @@ modparam("alias_db", "alias_user_column", "auser")
133 128
 
134 129
    Default value is "alias_domain".
135 130
 
136
-   Example 1-5. Set alias_domain_column parameter
131
+   Example 1.5. Set alias_domain_column parameter
137 132
 ...
138 133
 modparam("alias_db", "alias_domain_column", "adomain")
139 134
 ...
140
-     __________________________________________________________
141 135
 
142 136
 1.3.6. use_domain (int)
143 137
 
... ...
@@ -147,11 +141,10 @@ modparam("alias_db", "alias_domain_column", "adomain")
147 141
 
148 142
    Default value is "o".
149 143
 
150
-   Example 1-6. Set use_domain parameter
144
+   Example 1.6. Set use_domain parameter
151 145
 ...
152 146
 modparam("alias_db", "use_domain", 1)
153 147
 ...
154
-     __________________________________________________________
155 148
 
156 149
 1.3.7. domain_prefix (str)
157 150
 
... ...
@@ -160,15 +153,14 @@ modparam("alias_db", "use_domain", 1)
160 153
 
161 154
    Default value is "NULL".
162 155
 
163
-   Example 1-7. Set domain_prefix parameter
156
+   Example 1.7. Set domain_prefix parameter
164 157
 ...
165 158
 modparam("alias_db", "domain_prefix", "sip.")
166 159
 ...
167
-     __________________________________________________________
168 160
 
169 161
 1.4. Exported Functions
170 162
 
171
-1.4.1. alias_db_lookup(table_name)
163
+1.4.1.  alias_db_lookup(table_name)
172 164
 
173 165
    The function takes the R-URI and search to see whether it is an
174 166
    alias or not. If it is an alias for a local user, the R-URI is
... ...
@@ -178,13 +170,45 @@ modparam("alias_db", "domain_prefix", "sip.")
178 170
    by user's SIP uri.
179 171
 
180 172
    Meaning of the parameters is as follows:
181
-
182 173
      * table_name - the name of the table where to search for
183 174
        alias.
184 175
 
185 176
    This function can be used from REQUEST_ROUTE, FAILURE_ROUTE.
186 177
 
187
-   Example 1-8. alias_db_lookup() usage
178
+   Example 1.8. alias_db_lookup() usage
188 179
 ...
189 180
 alias_db_lookup("dbaliases");
190 181
 ...
182
+
183
+Chapter 2. Frequently Asked Questions
184
+
185
+   2.1.
186
+
187
+       Where can I find more about OpenSER?
188
+
189
+       Take a look at http://openser.org/.
190
+
191
+   2.2.
192
+
193
+       Where can I post a question about this module?
194
+
195
+       First at all check if your question was already answered on one
196
+       of our mailing lists:
197
+         * User Mailing List -
198
+           http://openser.org/cgi-bin/mailman/listinfo/users
199
+         * Developer Mailing List -
200
+           http://openser.org/cgi-bin/mailman/listinfo/devel
201
+
202
+       E-mails regarding any stable OpenSER release should be sent to
203
+       <users@openser.org> and e-mails regarding development versions
204
+       should be sent to <devel@openser.org>.
205
+
206
+       If you want to keep the mail private, send it to
207
+       <team@openser.org>.
208
+
209
+   2.3.
210
+
211
+       How can I report a bug?
212
+
213
+       Please follow the guidelines provided at:
214
+       http://sourceforge.net/tracker/?group_id=139143.
191 215
similarity index 58%
192 216
rename from modules_k/alias_db/doc/alias_db.sgml
193 217
rename to modules_k/alias_db/doc/alias_db.xml
... ...
@@ -1,14 +1,14 @@
1
-<!DOCTYPE Book PUBLIC "-//OASIS//DTD DocBook V4.2//EN" [
1
+<?xml version="1.0" encoding='ISO-8859-1'?>
2
+<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.4//EN"
3
+"http://www.oasis-open.org/docbook/xml/4.4/docbookx.dtd" [
2 4
 
3
-<!ENTITY user SYSTEM "alias_db_user.sgml">
4
-<!ENTITY faq SYSTEM "../../../doc/module_faq.sgml">
5
+<!ENTITY user SYSTEM "alias_db_admin.xml">
6
+<!ENTITY faq SYSTEM "../../../doc/module_faq.xml">
5 7
 
6 8
 <!ENTITY aliasdbsql SYSTEM "alias_db.sql">
7 9
 
8
-<!ENTITY developeremail "daniel@voice-system.ro">
9
-
10 10
 <!-- Include general documentation entities -->
11
-<!ENTITY % docentities SYSTEM "../../../doc/entities.sgml">
11
+<!ENTITY % docentities SYSTEM "../../../doc/entities.xml">
12 12
 %docentities;
13 13
 
14 14
 ]>
... ...
@@ -21,16 +21,15 @@
21 21
 	    <author>
22 22
 		<firstname>Daniel-Constantin</firstname>
23 23
 		<surname>Mierla</surname>
24
-		<affiliation><orgname>&voicesystem;</orgname></affiliation>
25 24
 		<address>
26
-		<email>&developeremail;</email>
25
+		<email>miconda@gmail.com</email>
27 26
 		</address>
28 27
 	    </author>
29 28
 	    <editor>
30 29
 		<firstname>Daniel-Constantin</firstname>
31 30
 		<surname>Mierla</surname>
32 31
 		<address>
33
-		<email>&developeremail;</email>
32
+		<email>miconda@gmail.com</email>
34 33
 		</address>
35 34
 	    </editor>
36 35
 	</authorgroup>
... ...
@@ -40,8 +39,8 @@
40 39
 	</copyright>
41 40
 	<revhistory>
42 41
 	    <revision>
43
-		<revnumber>$Revision$</revnumber>
44
-		<date>$Date$</date>
42
+		<revnumber>$Revision: 3839 $</revnumber>
43
+		<date>$Date: 2008-03-04 15:15:47 +0200 (Tue, 04 Mar 2008) $</date>
45 44
 	    </revision>
46 45
 	</revhistory>
47 46
     </bookinfo>
48 47
similarity index 100%
49 48
rename from modules_k/alias_db/doc/alias_db_user.sgml
50 49
rename to modules_k/alias_db/doc/alias_db_admin.xml
... ...
@@ -3,25 +3,34 @@ Auth Module
3 3
 Jan Janak
4 4
 
5 5
    FhG Fokus
6
+   <jan@iptel.org>
6 7
 
7 8
 Juha Heinanen
8 9
 
9 10
    Song Networks
11
+   <jh@song.fi>
10 12
 
11 13
 Bogdan-Andrei Iancu
12 14
 
13 15
    voice-system.ro
16
+   <bogdan@voice-system.ro>
14 17
 
15 18
 Edited by
16 19
 
17 20
 Jan Janak
18 21
 
22
+   <jan@iptel.org>
23
+
19 24
    Copyright � 2002, 2003 FhG FOKUS
20 25
 
21 26
    Copyright � 2005 voice-system.ro
27
+   Revision History
28
+   Revision $Revision$ $Date: 2008-03-04 15:15:47 +0200
29
+                              (Tue, 04 Mar 2008) $
22 30
      __________________________________________________________
23 31
 
24 32
    Table of Contents
33
+
25 34
    1. User's Guide
26 35
 
27 36
         1.1. Overview
... ...
@@ -53,25 +62,27 @@ Jan Janak
53 62
               1.4.7. pv_www_authorize(realm)
54 63
               1.4.8. pv_proxy_authorize(realm)
55 64
 
65
+   2. Frequently Asked Questions
66
+
56 67
    List of Examples
57
-   1-1. secret parameter example
58
-   1-2. nonce_expire parameter example
59
-   1-3. rpid_prefix parameter example
60
-   1-4. rpid_suffix parameter example
61
-   1-5. realm_prefix parameter example
62
-   1-6. rpid_avp parameter example
63
-   1-7. username_spec parameter usage
64
-   1-8. password_spec parameter usage
65
-   1-9. calculate_ha1 parameter usage
66
-   1-10. www_challenge usage
67
-   1-11. proxy_challenge usage
68
-   1-12. consume_credentials example
69
-   1-13. is_rpid_user_e164 usage
70
-   1-14. append_rpid_hf usage
71
-   1-15. append_rpid_hf(prefix, suffix) usage
72
-   1-16. pv_www_authorize usage
73
-   1-17. pv_proxy_authorize usage
74
-     __________________________________________________________
68
+
69
+   1.1. secret parameter example
70
+   1.2. nonce_expire parameter example
71
+   1.3. rpid_prefix parameter example
72
+   1.4. rpid_suffix parameter example
73
+   1.5. realm_prefix parameter example
74
+   1.6. rpid_avp parameter example
75
+   1.7. username_spec parameter usage
76
+   1.8. password_spec parameter usage
77
+   1.9. calculate_ha1 parameter usage
78
+   1.10. www_challenge usage
79
+   1.11. proxy_challenge usage
80
+   1.12. consume_credentials example
81
+   1.13. is_rpid_user_e164 usage
82
+   1.14. append_rpid_hf usage
83
+   1.15. append_rpid_hf(prefix, suffix) usage
84
+   1.16. pv_www_authorize usage
85
+   1.17. pv_proxy_authorize usage
75 86
 
76 87
 Chapter 1. User's Guide
77 88
 
... ...
@@ -81,7 +92,6 @@ Chapter 1. User's Guide
81 92
    by other authentication related modules. Also, it can perform
82 93
    authentication taking username and password from
83 94
    pseudo-variables.
84
-     __________________________________________________________
85 95
 
86 96
 1.2. Dependencies
87 97
 
... ...
@@ -89,17 +99,13 @@ Chapter 1. User's Guide
89 99
 
90 100
    The module depends on the following modules (in the other words
91 101
    the listed modules must be loaded before this module):
92
-
93 102
      * sl -- Stateless replies
94
-     __________________________________________________________
95 103
 
96 104
 1.2.2. External Libraries or Applications
97 105
 
98 106
    The following libraries or applications must be installed
99 107
    before running OpenSER with this module loaded:
100
-
101 108
      * none
102
-     __________________________________________________________
103 109
 
104 110
 1.3. Exported Parameters
105 111
 
... ...
@@ -118,9 +124,8 @@ Chapter 1. User's Guide
118 124
    to stay with the default. Any clients should send the reply to
119 125
    the server that issued the request.
120 126
 
121
-   Example 1-1. secret parameter example
127
+   Example 1.1. secret parameter example
122 128
 modparam("auth", "secret", "johndoessecretphrase")