Resources -> Documentation -> Starting

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 "./run -h" (or "yate -h" if installed) to get a list of possible options. There is also a manual page - "man yate" and read.

If Yate have a problem when starting you can use -v several times to see more about error message. 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.

 
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)
   --service      Run as Windows service
   --install      Install the Windows service
   --remove       Remove the Windows service
   -p filename    Write PID to file
   -l filename    Log to file
   -n configname  Use specified configuration name ()
   -c pathname    Path to conf files directory (/etc/yate)
   -m pathname    Path to modules directory (/usr/lib/yate/modules)
   -w directory   Change working directory
   -C             Enable core dumps if possible
   -D[options]    Special debugging options
     a            Abort if bugs are encountered
     m            Attempt to debug mutex deadlocks
     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

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

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 stoping Yate.

Please notice: these are instructions to start Yate on linux - see Starting on windows for additional platform specific instructions.