Starting Yate

Revision as of 15:01, 9 April 2013

This page purpose is to describe how to use command line with all his available options when starting Yate server on different platforms.

Instructions to start Yate on linux

Yate installed from SVN

You can run YATE directly from the build directory - just use 'run' script from the main directory.
You can also install YATE - then you can run it from anywhere.
On the command line you can use '-v' to increase the verbosity level.
If in doubt run in shell the following command to get a list of possible options:

./run -h (or yate -h if installed) 

If Yate has a problem when starting you can increase the number of -v in the command to see more error messages.

Example:

./run -vvvvv (or yate -vvvvv if installed)

In some cases modules haven't been well compiled and you will get a message like "unresolved symbol", then you should verify if the used library is the same with linking library.

Below you can find a list with all possible command with their options to use when starting Yate:

Usage: yate [options] [commands ...]
  -h, --help     Display help message (this one) and exit
  -V, --version  Display program version and exit
  -v             Verbose debugging (you can use more than once)
  -q             Quieter debugging (you can use more than once)
  -d             Daemonify, suppress output unless logged
  -s             Supervised, restart if crashes or locks up
  -r             Enable rotation of log file (needs -s and -l)
  -p filename    Write PID to file
  -l filename    Log to file
  -n configname  Use specified configuration name ()
  -e pathname    Path to shared files directory (/usr/local/share/yate)
  -c pathname    Path to conf files directory (/usr/local/etc/yate)
  -u pathname    Path to user files directory (/home/username/.yate)
  -m pathname    Path to modules directory (/usr/local/lib/yate)
  -x relpath     Relative path to extra modules directory (can be repeated)
  -w directory   Change working directory
  -N nodename    Set the name of this node in a cluster
  -C             Enable core dumps if possible
  -F             Increase the maximum file handle to compiled value
  -t             Truncate log file, don't append to it
  -D[options]    Special debugging options
    a            Abort if bugs are encountered
    m            Attempt to debug mutex deadlocks
    d            Disable locking debugging and safety features
    l            Try to keep module symbols local
    c            Call dlclose() until it gets an error
    u            Do not unload modules on exit, just finalize
    i            Reinitialize after 1st initialization
    x            Exit immediately after initialization
    w            Delay creation of 1st worker thread
    o            Colorize output using ANSI codes
    s            Abort on bugs even during shutdown
    t            Timestamp debugging messages relative to program start
    e            Timestamp debugging messages based on EPOCH (1-1-1970 GMT)
    f            Timestamp debugging in GMT format YYYYMMDDhhmmss.uuuuuu
    z            Timestamp debugging in local timezone YYYYMMDDhhmmss.uuuuuu

Not all the options above may be available, they depend on the Yate version and the operating system's capabilities.

Yate installed from package

When Yate is installed from a package the init script in /etc/rc.d/init.d/ should take care of providing the proper init parameters for starting Yate as a service.
The most important options are -d and -s to run as a supervised daemon. This allows Yate to restart automatically if it crashes or locks up.
It is also important to provide -r so logs can be rotated without stopping Yate.

Instructions to start Yate on Windows

See Starting on windows for platform specific instructions.

See also

• Stopping and restarting Yate