Starting on windows

Latest revision as of 10:44, 7 August 2013

Yate can be used as server or as client on Windows platform. This page describes how to use the command line with all his available options when starting Yate as server and Yate Client.

[edit] Open a console window

To start Yate from a command line you must open a console window. From Start Menu choose "Run..." option. Type cmd in the edit box and then press the 'Ok' button.

We assume Yate is installed in c:\Program Files\Yate

In the console type:

c:
cd c:\Program Files\Yate

This is needed to run Yate in the install directory (with default paths to configuration files, modules ...).

[edit] Starting Yate as Server on Windows

Yate will install as a windows service with manual startup - you have to change it to "automatic" in a production environment. To start the service "net start yate" will do the trick.

Yate can also be started as a console program executing yate-console.exe - in this case the same command line options for linux can be used.

Please notice that if you want to enable logging while running as a windows service you have to manually change some registry keys.

Command line options may change, check them with:

yate-console -h

[edit] Command line with their options to use when starting Yate as a Server

Usage: yate-console [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)
  --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 ()
  -e pathname    Path to shared files directory (.\share)
  -c pathname    Path to conf files directory (.\conf.d)
  -u pathname    Path to user files directory (C:\users\paulc\Application Data\Yate)
  -m pathname    Path to modules directory (.\modules)
  -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
  -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
    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

[edit] Starting Yate as Client on Windows

The client has a different executable yate-qt4.exe and slightly different commad line options.

[edit] Command line with their options to use when starting Yate as a Client

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)
  -p filename    Write PID to file
  -l filename    Log to file
  -n configname  Use specified configuration name ()
  -e pathname    Path to shared files directory (.\share)
  -c pathname    Path to conf files directory (.\conf.d)
  -u pathname    Path to user files directory (C:\users\paulc\Application Data\Yate)
  -m pathname    Path to modules directory (.\modules)
  -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
  -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
    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

NOTE: There is no console output for yate-qt4 (it is a GUI application). Running yate-qt4 with '-V' or '-h' options won't show any output. Yate Client command line options are the same as server's options (except for service related options) so you may use yate-console to check for command line options.

See also

• Stopping and restarting Yate