:lang: en
:toc:

[[cha:starting-linuxcnc]]
= Starting LinuxCNC(((Starting LinuxCNC)))

== Running LinuxCNC

LinuxCNC is started with the script file 'linuxcnc'.

----
linuxcnc [options] [<INI-file>]
----

.linuxcnc script options
----
linuxcnc: Run LINUXCNC

Usage:
  $ linuxcnc -h
    This help

  $ linuxcnc [Options]
    Choose the configuration inifile graphically

  $ linuxcnc [Options] path/to/your_ini_file
    Name the configuration inifile using its path

  $ linuxcnc [Options] -l
    Use the previously used configuration inifile

Options:
    -d: Turn on "debug" mode
    -v: Turn on "verbose" mode
    -k: Continue in the presence of errors in .hal files
    -t "tpmodulename [parameters]"
            specify custom trajectory_planning_module
            overrides optional ini setting [TRAJ]TPMOD
    -m "homemodulename [parameters]"
            specify custom homing_module
            overrides optional ini setting [EMCMOT]HOMEMOD
    -H "dirname": search dirname for Halfiles before searching
                  ini directory and system library:
                  /home/git/linuxcnc-dev/lib/hallib
Note:
    The -H "dirname" option may be specified multiple times
----

If the linuxcnc script is passed an INI file it reads the INI file and starts
LinuxCNC. The INI file [HAL] section specifies the order of loading up HAL
files if more than one is used. Once the HAL=xxx.hal files are loaded then the
GUI is loaded then the POSTGUI=.xxx.hal file is loaded. If you create PyVCP or
GladeVCP objects with HAL pins you must use the postgui HAL file to make any
connections to those pins. See the <<sub:ini:sec:hal,[HAL]>> section of the
INI configuration for more information.

[[sub:configuration-selector]]
=== Configuration Selector(((Configuration Selection)))

If no INI file is passed to the linuxcnc script it loads the configuration
selector so you can choose and save a sample configuration. Once a sample
configuration has been saved it can be modified to suit your application.
The configuration files are saved in linuxcnc/configs directory.

//.Configuration Selector
image::images/configuration-selector.png["LinuxCNC Configuration Selector",align="center"]

// vim: set syntax=asciidoc:
