doc: generated cfg vars lists

doc/cfg_list/cfg_core.txt

@@ -0,0 +1,210 @@
+Configuration Variables for core
+================================
+
+                  [ this file is autogenerated, do not edit ]
+
+
+ 1. core.debug
+        debug level.
+        Default: 0.
+        Type: integer.
+
+ 2. core.log_facility
+        syslog facility, see "man 3 syslog".
+        Default: 24.
+        Type: string.
+
+ 3. core.memdbg
+        log level for memory debugging messages.
+        Default: 3.
+        Type: integer.
+
+ 4. core.use_dst_blacklist
+        enable/disable destination blacklisting.
+        Default: 0.
+        Range: 0 - 1.
+        Type: integer.
+
+ 5. core.dst_blacklist_expire
+        how much time (in s) a blacklisted destination is kept in the
+        list.
+        Default: 60.
+        Type: integer.
+
+ 6. core.dst_blacklist_mem
+        maximum shared memory amount (in KB) used for keeping the
+        blacklisted destinations.
+        Default: 250.
+        Type: integer.
+
+ 7. core.dns_try_ipv6
+        enable/disable IPv6 DNS lookups.
+        Default: 1.
+        Range: 0 - 1.
+        Type: integer.
+
+ 8. core.dns_try_naptr
+        enable/disable NAPTR DNS lookups.
+        Default: 0.
+        Range: 0 - 1.
+        Type: integer.
+
+ 9. core.dns_udp_pref
+        udp protocol preference when doing NAPTR lookups.
+        Default: 30.
+        Type: integer.
+
+10. core.dns_tcp_pref
+        tcp protocol preference when doing NAPTR lookups.
+        Default: 20.
+        Type: integer.
+
+11. core.dns_tls_pref
+        tls protocol preference when doing NAPTR lookups.
+        Default: 10.
+        Type: integer.
+
+12. core.dns_sctp_pref
+        sctp protocol preference when doing NAPTR lookups.
+        Default: 20.
+        Type: integer.
+
+13. core.dns_retr_time
+        time in s before retrying a dns request.
+        Default: -1.
+        Type: integer.
+
+14. core.dns_retr_no
+        number of dns retransmissions before giving up.
+        Default: -1.
+        Type: integer.
+
+15. core.dns_servers_no
+        how many dns servers from the ones defined in /etc/resolv.conf
+        will be used.
+        Default: -1.
+        Type: integer.
+
+16. core.dns_use_search_list
+        if set to 0, the search list in /etc/resolv.conf is ignored.
+        Default: 1.
+        Range: 0 - 1.
+        Type: integer.
+
+17. core.dns_search_full_match
+        enable/disable domain name checks against the search list in
+        DNS answers.
+        Default: 1.
+        Range: 0 - 1.
+        Type: integer.
+
+18. core.dns_reinit
+        set to 1 in order to reinitialize the DNS resolver.
+        Default: 0.
+        Range: 1 - 1.
+        Type: integer.
+
+19. core.use_dns_cache
+        enable/disable the dns cache.
+        Default: 1.
+        Range: 0 - 1.
+        Type: integer.
+
+20. core.dns_cache_flags
+        dns cache specific resolver flags (1=ipv4 only, 2=ipv6 only,
+        4=prefer ipv6.
+        Default: 0.
+        Range: 0 - 4.
+        Type: integer.
+
+21. core.use_dns_failover
+        enable/disable dns failover in case the destination resolves to
+        multiple ip addresses and/or multiple SRV records (depends on
+        use_dns_cache).
+        Default: 0.
+        Range: 0 - 1.
+        Type: integer.
+
+22. core.dns_srv_lb
+        enable/disable load balancing to different srv records of the
+        same priority based on the srv records weights (depends on
+        dns_failover).
+        Default: 0.
+        Range: 0 - 1.
+        Type: integer.
+
+23. core.dns_cache_negative_ttl
+        time to live for negative results ("not found") in seconds. Use
+        0 to disable.
+        Default: 60.
+        Type: integer.
+
+24. core.dns_cache_min_ttl
+        minimum accepted time to live for a record, in seconds.
+        Default: 0.
+        Type: integer.
+
+25. core.dns_cache_max_ttl
+        maximum accepted time to live for a record, in seconds.
+        Default: -1.
+        Type: integer.
+
+26. core.dns_cache_mem
+        maximum memory used for the dns cache in Kb.
+        Default: 500.
+        Type: integer.
+
+27. core.dns_cache_del_nonexp
+        allow deletion of non-expired records from the cache when there
+        is no more space left for new ones.
+        Default: 0.
+        Range: 0 - 1.
+        Type: integer.
+
+28. core.mem_dump_pkg
+        dump process memory status, parameter: pid_number.
+        Default: 0.
+        Type: integer.
+
+29. core.mem_dump_shm
+        dump shared memory status.
+        Default: 0.
+        Type: integer.
+
+30. core.max_while_loops
+        maximum iterations allowed for a while loop.
+        Default: 100.
+        Type: integer.
+
+31. core.udp_mtu
+        fallback to a congestion controlled protocol if send size
+        exceeds udp_mtu.
+        Default: 0.
+        Range: 0 - 65535.
+        Type: integer.
+
+32. core.udp_mtu_try_proto
+        if send size > udp_mtu use proto (1 udp, 2 tcp, 3 tls, 4 sctp).
+        Default: 0.
+        Range: 1 - 4.
+        Type: integer.
+
+33. core.force_rport
+        force rport for all the received messages.
+        Default: 0.
+        Range: 0 - 1.
+        Type: integer.
+
+34. core.memlog
+        log level for memory status/summary information.
+        Default: 3.
+        Type: integer.
+
+35. core.mem_summary
+        memory debugging information displayed on exit (flags):  0 -
+        off, 1 - dump all the used blocks (status), 2 - summary of used
+        blocks.
+        Default: 1.
+        Range: 0 - 3.
+        Type: integer.
+

doc/cfg_list/cfg_maxfwd.txt

@@ -0,0 +1,12 @@
+Configuration Variables for maxfwd
+==================================
+
+                  [ this file is autogenerated, do not edit ]
+
+
+ 1. maxfwd.max_limit
+        Max. maxfwd limit.
+        Default: 16.
+        Range: 0 - 255.
+        Type: integer.
+

doc/cfg_list/cfg_sctp.txt

@@ -0,0 +1,103 @@
+Configuration Variables for sctp
+================================
+
+                  [ this file is autogenerated, do not edit ]
+
+
+ 1. sctp.socket_rcvbuf
+        socket receive buffer size (read-only).
+        Range: 512 - 102400.
+        Type: integer. Read-only.
+
+ 2. sctp.socket_sndbuf
+        socket send buffer size (read-only).
+        Range: 512 - 102400.
+        Type: integer. Read-only.
+
+ 3. sctp.autoclose
+        seconds before closing and idle connection (must be non-zero).
+        Range: 1 - 1073741824.
+        Type: integer.
+
+ 4. sctp.send_ttl
+        milliseconds before aborting a send.
+        Range: 0 - 1073741824.
+        Type: integer.
+
+ 5. sctp.send_retries
+        re-send attempts on failure.
+        Range: 0 - 9.
+        Type: integer.
+
+ 6. sctp.assoc_tracking
+        connection/association tracking (see also assoc_reuse).
+        Range: 0 - 1.
+        Type: integer.
+
+ 7. sctp.assoc_reuse
+        connection/association reuse (for now used only for replies),
+        depends on assoc_tracking being set.
+        Range: 0 - 1.
+        Type: integer.
+
+ 8. sctp.max_assocs
+        maximum allowed open associations (-1 = disable, as many as
+        allowed by the OS).
+        Type: integer.
+
+ 9. sctp.srto_initial
+        initial value of the retr. timeout, used in RTO calculations,
+        in msecs.
+        Range: 0 - 1073741824.
+        Type: integer.
+
+10. sctp.srto_max
+        maximum value of the retransmission timeout (RTO), in msecs.
+        Range: 0 - 1073741824.
+        Type: integer.
+
+11. sctp.srto_min
+        minimum value of the retransmission timeout (RTO), in msecs.
+        Range: 0 - 1073741824.
+        Type: integer.
+
+12. sctp.asocmaxrxt
+        maximum retransmission attempts per association.
+        Range: 0 - 1024.
+        Type: integer.
+
+13. sctp.init_max_attempts
+        max INIT retransmission attempts.
+        Range: 0 - 1024.
+        Type: integer.
+
+14. sctp.init_max_timeo
+        max INIT retransmission timeout (RTO max for INIT), in msecs.
+        Range: 0 - 1024.
+        Type: integer.
+
+15. sctp.hbinterval
+        heartbeat interval in msecs.
+        Type: integer.
+
+16. sctp.pathmaxrxt
+        maximum retransmission attempts per path.
+        Range: 0 - 1024.
+        Type: integer.
+
+17. sctp.sack_delay
+        time since the last received packet before sending a SACK, in
+        msecs.
+        Range: 0 - 1073741824.
+        Type: integer.
+
+18. sctp.sack_freq
+        number of received packets that trigger the sending of a SACK.
+        Range: 0 - 1024.
+        Type: integer.
+
+19. sctp.max_burst
+        maximum burst of packets that can be emitted by an association.
+        Range: 0 - 1024.
+        Type: integer.
+

doc/cfg_list/cfg_tcp.txt

@@ -0,0 +1,136 @@
+Configuration Variables for tcp
+===============================
+
+                  [ this file is autogenerated, do not edit ]
+
+
+ 1. tcp.connect_timeout
+        used only in non-async mode, in seconds.
+        Range: -1 - 134217727.
+        Type: integer.
+
+ 2. tcp.send_timeout
+        in seconds.
+        Range: -1 - 2147483647.
+        Type: integer.
+
+ 3. tcp.connection_lifetime
+        connection lifetime (in seconds).
+        Range: -1 - 2147483647.
+        Type: integer.
+
+ 4. tcp.max_connections
+        maximum connection number, soft limit.
+        Range: 0 - 2147483647.
+        Type: integer.
+
+ 5. tcp.no_connect
+        if set only accept new connections, never actively open new
+        ones.
+        Range: 0 - 1.
+        Type: integer.
+
+ 6. tcp.fd_cache
+        file descriptor cache for tcp_send.
+        Range: 0 - 1.
+        Type: integer. Read-only.
+
+ 7. tcp.async
+        async mode for writes and connects.
+        Range: 0 - 1.
+        Type: integer. Read-only.
+
+ 8. tcp.connect_wait
+        parallel simultaneous connects to the same dst. (0) or one
+        connect.
+        Range: 0 - 1.
+        Type: integer. Read-only.
+
+ 9. tcp.conn_wq_max
+        maximum bytes queued for write per connection (depends on
+        async).
+        Range: 0 - 1048576.
+        Type: integer.
+
+10. tcp.wq_max
+        maximum bytes queued for write allowed globally (depends on
+        async).
+        Range: 0 - 1073741824.
+        Type: integer.
+
+11. tcp.defer_accept
+        0/1 on linux, seconds on freebsd (see docs).
+        Range: 0 - 3600.
+        Type: integer. Read-only.
+
+12. tcp.delayed_ack
+        initial ack will be delayed and sent with the first data
+        segment.
+        Range: 0 - 1.
+        Type: integer.
+
+13. tcp.syncnt
+        number of syn retransmissions before aborting a connect (0=not
+        set).
+        Range: 0 - 1024.
+        Type: integer.
+
+14. tcp.linger2
+        lifetime of orphaned sockets in FIN_WAIT2 state in s (0=not
+        set).
+        Range: 0 - 3600.
+        Type: integer.
+
+15. tcp.keepalive
+        enables/disables keepalives for tcp.
+        Range: 0 - 1.
+        Type: integer.
+
+16. tcp.keepidle
+        time before sending a keepalive if the connection is idle
+        (linux).
+        Range: 0 - 86400.
+        Type: integer.
+
+17. tcp.keepintvl
+        time interval between keepalive probes on failure (linux).
+        Range: 0 - 86400.
+        Type: integer.
+
+18. tcp.keepcnt
+        number of failed keepalives before dropping the connection
+        (linux).
+        Range: 0 - 1024.
+        Type: integer.
+
+19. tcp.crlf_ping
+        enable responding to CRLF SIP-level keepalives .
+        Range: 0 - 1.
+        Type: integer.
+
+20. tcp.accept_aliases
+        turn on/off tcp aliases (see tcp_accept_aliases) .
+        Range: 0 - 1.
+        Type: integer.
+
+21. tcp.alias_flags
+        flags used for adding new aliases (FORCE_ADD:1 , REPLACE:2) .
+        Range: 0 - 2.
+        Type: integer.
+
+22. tcp.new_conn_alias_flags
+        flags for the def. aliases for a new conn. (FORCE_ADD:1,
+        REPLACE:2 .
+        Range: 0 - 2.
+        Type: integer.
+
+23. tcp.rd_buf_size
+        internal read buffer size (should be > max. expected datagram).
+        Range: 512 - 65536.
+        Type: integer.
+
+24. tcp.wq_blk_size
+        internal async write block size (debugging use only for now).
+        Range: 1 - 65535.
+        Type: integer.
+

doc/cfg_list/cfg_tm.txt

@@ -0,0 +1,204 @@
+Configuration Variables for tm
+==============================
+
+                  [ this file is autogenerated, do not edit ]
+
+
+ 1. tm.ruri_matching
+        perform Request URI check in transaction matching.
+        Default: 1.
+        Range: 0 - 1.
+        Type: integer.
+
+ 2. tm.via1_matching
+        perform first Via header check in transaction matching.
+        Default: 1.
+        Range: 0 - 1.
+        Type: integer.
+
+ 3. tm.fr_timer
+        timer which hits if no final reply for a request or ACK for a
+        negative INVITE reply arrives (in milliseconds).
+        Default: 30000.
+        Type: integer.
+
+ 4. tm.fr_inv_timer
+        timer which hits if no final reply for an INVITE arrives after
+        a provisional message was received (in milliseconds).
+        Default: 120000.
+        Type: integer.
+
+ 5. tm.wt_timer
+        time for which a transaction stays in memory to absorb delayed
+        messages after it completed.
+        Default: 5000.
+        Type: integer.
+
+ 6. tm.delete_timer
+        time after which a to-be-deleted transaction currently ref-ed
+        by a process will be tried to be deleted again..
+        Default: 200.
+        Type: integer.
+
+ 7. tm.retr_timer1
+        initial retransmission period (in milliseconds).
+        Default: 500.
+        Type: integer.
+
+ 8. tm.retr_timer2
+        maximum retransmission period (in milliseconds).
+        Default: 4000.
+        Type: integer.
+
+ 9. tm.max_inv_lifetime
+        maximum time an invite transaction can live from the moment of
+        creation.
+        Default: 180000.
+        Type: integer.
+
+10. tm.max_noninv_lifetime
+        maximum time a non-invite transaction can live from the moment
+        of creation.
+        Default: 32000.
+        Type: integer.
+
+11. tm.noisy_ctimer
+        if set, INVITE transactions that time-out (FR INV timer) will
+        be always replied.
+        Default: 1.
+        Range: 0 - 1.
+        Type: integer.
+
+12. tm.auto_inv_100
+        automatically send 100 to an INVITE.
+        Default: 1.
+        Range: 0 - 1.
+        Type: integer.
+
+13. tm.auto_inv_100_reason
+        reason text of the automatically send 100 to an INVITE.
+        Default: trying -- your call is important to us.
+        Type: string.
+
+14. tm.unix_tx_timeout
+        Unix socket transmission timeout, in milliseconds.
+        Default: 500.
+        Type: integer.
+
+15. tm.restart_fr_on_each_reply
+        restart final response timer on each provisional reply.
+        Default: 1.
+        Range: 0 - 1.
+        Type: integer.
+
+16. tm.pass_provisional_replies
+        enable/disable passing of provisional replies to
+        TMCB_LOCAL_RESPONSE_OUT callbacks.
+        Default: 0.
+        Range: 0 - 1.
+        Type: integer.
+
+17. tm.aggregate_challenges
+        if the final response is a 401 or a 407, aggregate all the
+        authorization headers (challenges) (rfc3261 requires this to be
+        on).
+        Default: 1.
+        Range: 0 - 1.
+        Type: integer.
+
+18. tm.unmatched_cancel
+        determines how CANCELs with no matching transaction are handled
+        (0: statefull forwarding, 1: stateless forwarding, 2: drop).
+        Default: 0.
+        Range: 0 - 2.
+        Type: integer.
+
+19. tm.default_code
+        default SIP response code sent by t_reply(), if the function
+        cannot retrieve its parameters.
+        Default: 500.
+        Range: 400 - 699.
+        Type: integer.
+
+20. tm.default_reason
+        default SIP reason phrase sent by t_reply(), if the function
+        cannot retrieve its parameters.
+        Default: Server Internal Error.
+        Type: string.
+
+21. tm.reparse_invite
+        if set to 1, the CANCEL and negative ACK requests are
+        constructed from the INVITE message which was sent out instead
+        of building them from the received request.
+        Default: 1.
+        Range: 0 - 1.
+        Type: integer.
+
+22. tm.ac_extra_hdrs
+        header fields prefixed by this parameter value are included in
+        the CANCEL and negative ACK messages if they were present in
+        the outgoing INVITE (depends on reparse_invite).
+        Default: <unknown:str>.
+        Type: string.
+
+23. tm.blst_503
+        if set to 1, blacklist 503 SIP response sources.
+        Default: 0.
+        Range: 0 - 1.
+        Type: integer.
+
+24. tm.blst_503_def_timeout
+        default 503 blacklist time (in s), when no Retry-After header
+        is present.
+        Default: 0.
+        Type: integer.
+
+25. tm.blst_503_min_timeout
+        minimum 503 blacklist time (in s).
+        Default: 0.
+        Type: integer.
+
+26. tm.blst_503_max_timeout
+        maximum 503 blacklist time (in s).
+        Default: 3600.
+        Type: integer.
+
+27. tm.blst_methods_add
+        bitmap of method types that trigger blacklisting on transaction
+        timeouts.
+        Default: 1.
+        Type: integer.
+
+28. tm.blst_methods_lookup
+        Bitmap of method types that are looked-up in the blacklist
+        before statefull forwarding.
+        Default: -9.
+        Type: integer.
+
+29. tm.cancel_b_method
+        How to cancel branches on which no replies were received: 0 -
+        fake reply, 1 - retransmitting the request, 2 - send cancel.
+        Default: 1.
+        Range: 0 - 2.
+        Type: integer.
+
+30. tm.reparse_on_dns_failover
+        if set to 1, the SIP message after a DNS failover is
+        constructed from the outgoing message buffer of the failed
+        branch instead of from the received request.
+        Default: 1.
+        Range: 0 - 1.
+        Type: integer.
+
+31. tm.fr_inv_timer_next
+        The value of fr_inv_timer for subsequent branches during serial
+        forking.
+        Default: 30000.
+        Type: integer.
+
+32. tm.disable_6xx_block
+        if set to 1, 6xx is treated like a normal reply (breaks rfc).
+        Default: 0.
+        Range: 0 - 1.
+        Type: integer.
+