This documentation refers to LinuxCNC version 2.6.13-1-gdf19ffe.

• Other languages available: Español Français

• LinuxCNC Document Overleaf
• LinuxCNC G Code Quick Reference
• LinuxCNC Wiki Community

• Getting Started with LinuxCNC
  • System Requirements
  • Getting LinuxCNC
  • Updating LinuxCNC
  • Stepper Quickstart
  • Stepper Configuration Wizard
  • Mesa Configuration Wizard
  • Running LinuxCNC
  • Stepper Diagnostics
  • Linux FAQ

• Using LinuxCNC
  • General User Information
    • User Foreword
    • LinuxCNC User Introduction
    • Important User Concepts
    • CNC Machine Overview
    • Lathe User Information
  • User Interfaces
    • Axis GUI
    • gmoccapy
    • Touchy GUI
    • NGCGUI
    • TkLinuxCNC GUI
    • Mini GUI
    • Keystick GUI
  • G code Programming
    • Coordinate System
    • Tool Compensation
    • Tool Table Editor
    • G Code Overview
    • G Codes
    • M Codes
    • O Codes
    • Other Codes
    • G Code Examples
    • Image to G Code
    • RS274/NGC Differences

• Configuring LinuxCNC
  • General Integrator Information
    • Integrator Concepts
    • Latency Test
    • Starting LinuxCNC
    • Stepper Tuning
  • Configuration
    • INI Configuration
    • Homing Configuration
    • Lathe Configuration
    • HAL TCL Files
    • Stepper Configuration
  • Virtual Control Panels
    • Python Virtual Control Panel
    • PyVCP Examples
    • Glade Virtual Control Panel
  • User Interface Programming
    • HAL User Interface
    • HAL UI examples
    • Python Interface
  • Hardware Drivers
    • Parallel Port Driver
    • AX5214H Driver
    • General Mechatronics GM6-PCI Driver
    • GS2 Driver
    • Mesa HostMot2 Driver
    • Motenc Driver
    • Opto22 Driver
    • Pico Drivers
    • Pluto P Driver
    • Servo To Go Driver
    • ShuttleXpress Driver
    • VFS11 Driver
  • Classicladder PLC (Programmable Logic Controller)
    • Classicladder Introduction
    • ClassicLadder Programming
    • ClassicLadder Examples
  • Hardware Examples
    • PCI Parallel Port Example
    • Spindle Control Example
    • MPG Example
    • GS2 Example
  • HAL the Hardware Abstract Layer
    • HAL Introduction
    • Basic HAL Tutorial
    • Core HAL Components
    • HAL Component List
    • HAL Component Descriptions
    • Halshow
  • Advanced Topics
    • Advanced HAL Tutorial
    • HAL Examples
    • Comp HAL Component Generator
    • Creating Userspace Python Components
    • Canonical Device Interfaces
    • HAL Tools
    • Kinematics
    • PID theory
    • Remapping: Extending LinuxCNC

• Developer Information
  • General Reference
  • Code Notes
  • NML Messages
  • Style Guide
  • Contributing to LinuxCNC

• Glossary, Copyright
  • LinuxCNC History
  • Glossary
  • Copyright and Documentation License

  The following Manual Pages can be viewed locally in a terminal by typing in man name of component. For example man axis-remote.

• Commands and userspace components
  • axis-remote.1
  • axis.1
  • comp.1
  • gladevcp.1
  • gs2.1
  • hal_input.1
  • halcmd.1
  • halmeter.1
  • halrun.1
  • halsampler.1
  • halstreamer.1
  • haltcl.1
  • halui.1
  • io.1
  • iocontrol.1
  • linuxcnc.1
  • linuxcncrsh.1
  • milltask.1
  • pyvcp.1
  • shuttlexpress.1
  • vfdb_vfd.1
  • vfs11_vfd.1
  
  
• Realtime components and kernel modules
  • abs.9
  • abs_s32.9
  • and2.9
  • at_pid.9
  • axis.9
  • bin2gray.9
  • biquad.9
  • bitslice.9
  • bitwise.9
  • bldc.9
  • bldc_hall3.9
  • blend.9
  • charge_pump.9
  • clarke2.9
  • clarke3.9
  • clarkeinv.9
  • classicladder.9
  • comp.9
  • constant.9
  • conv_bit_s32.9
  • conv_bit_u32.9
  • conv_float_s32.9
  • conv_float_u32.9
  • conv_s32_bit.9
  • conv_s32_float.9
  • conv_s32_u32.9
  • conv_u32_bit.9
  • conv_u32_float.9
  • conv_u32_s32.9
  • counter.9
  • ddt.9
  • deadzone.9
  • debounce.9
  • edge.9
  • encoder.9
  • encoder_ratio.9
  • estop_latch.9
  • feedcomp.9
  • flipflop.9
  • gantry.9
  • gantrykins.9
  • gearchange.9
  • genhexkins.9
  • genserkins.9
  • gladevcp.9
  • gray2bin.9
  • hm2_7i43.9
  • hm2_7i90.9
  • hm2_pci.9
  • hostmot2.9
  • hypot.9
  • ilowpass.9
  • integ.9
  • invert.9
  • joyhandle.9
  • kins.9
  • knob2float.9
  • latencybins.9
  • lcd.9
  • limit1.9
  • limit2.9
  • limit3.9
  • lincurve.9
  • logic.9
  • lowpass.9
  • lut5.9
  • maj3.9
  • match8.9
  • matrix_kb.9
  • maxkins.9
  • mesa_7i65.9
  • mesa_uart.9
  • message.9
  • minmax.9
  • motion.9
  • mult2.9
  • multiclick.9
  • multiswitch.9
  • mux16.9
  • mux2.9
  • mux4.9
  • mux8.9
  • mux_generic.9
  • near.9
  • not.9
  • offset.9
  • oneshot.9
  • opto_ac5.9
  • or2.9
  • orient.9
  • pcl720.9
  • pid.9
  • pluto_servo.9
  • pluto_step.9
  • pumakins.9
  • pwmgen.9
  • rotatekins.9
  • sample_hold.9
  • sampler.9
  • scale.9
  • scarakins.9
  • select8.9
  • serport.9
  • setsserial.9
  • siggen.9
  • sim_encoder.9
  • sim_spindle.9
  • sphereprobe.9
  • sserial.9
  • stepgen.9
  • steptest.9
  • streamer.9
  • sum2.9
  • supply.9
  • thc.9
  • thcud.9
  • threads.9
  • threadtest.9
  • time.9
  • timedelay.9
  • timedelta.9
  • toggle.9
  • toggle2nist.9
  • tripodkins.9
  • tristate_bit.9
  • tristate_float.9
  • trivkins.9
  • updown.9
  • watchdog.9
  • wcomp.9
  • weighted_sum.9
  • wj200_vfd.9
  • xhc_hb04_util.9
  • xor2.9
  
  
• API calls: HAL
  • hal_add_funct_to_thread.3hal
  • hal_bit_t.3hal
  • hal_bool.3hal
  • hal_create_thread.3hal
  • hal_del_funct_from_thread.3hal
  • hal_exit.3hal
  • hal_export_funct.3hal
  • hal_float_t.3hal
  • hal_get_lock.3hal
  • hal_init.3hal
  • hal_link.3hal
  • hal_malloc.3hal
  • hal_param_bit_new.3hal
  • hal_param_bit_newf.3hal
  • hal_param_float_new.3hal
  • hal_param_float_newf.3hal
  • hal_param_new.3hal
  • hal_param_s32_new.3hal
  • hal_param_s32_newf.3hal
  • hal_param_u32_new.3hal
  • hal_param_u32_newf.3hal
  • hal_parport.3hal
  • hal_pin_bit_new.3hal
  • hal_pin_bit_newf.3hal
  • hal_pin_float_new.3hal
  • hal_pin_float_newf.3hal
  • hal_pin_new.3hal
  • hal_pin_s32_new.3hal
  • hal_pin_s32_newf.3hal
  • hal_pin_u32_new.3hal
  • hal_pin_u32_newf.3hal
  • hal_ready.3hal
  • hal_s32_t.3hal
  • hal_set_constructor.3hal
  • hal_set_lock.3hal
  • hal_signal_delete.3hal
  • hal_signal_new.3hal
  • hal_start_threads.3hal
  • hal_type_t.3hal
  • hal_u32_t.3hal
  • hal_unlink.3hal
  • intro.3hal
  • undocumented.3hal
  
  
• API calls: RTAPI
  • EXPORT_FUNCTION.3rtapi
  • MODULE_AUTHOR.3rtapi
  • MODULE_DESCRIPTION.3rtapi
  • MODULE_LICENSE.3rtapi
  • RTAPI_MP_ARRAY_INT.3rtapi
  • RTAPI_MP_ARRAY_LONG.3rtapi
  • RTAPI_MP_ARRAY_STRING.3rtapi
  • RTAPI_MP_INT.3rtapi
  • RTAPI_MP_LONG.3rtapi
  • RTAPI_MP_STRING.3rtapi
  • intro.3rtapi
  • rtapi_app_exit.3rtapi
  • rtapi_app_main.3rtapi
  • rtapi_clock_set_period.3rtapi
  • rtapi_delay.3rtapi
  • rtapi_delay_max.3rtapi
  • rtapi_div_u64.3rtapi
  • rtapi_div_u64_rem.3rtapi
  • rtapi_exit.3rtapi
  • rtapi_get_clocks.3rtapi
  • rtapi_get_msg_level.3rtapi
  • rtapi_get_time.3rtapi
  • rtapi_inb.3rtapi
  • rtapi_init.3rtapi
  • rtapi_module_param.3rtapi
  • rtapi_mutex.3rtapi
  • rtapi_outb.3rtapi
  • rtapi_print.3rtapi
  • rtapi_prio.3rtapi
  • rtapi_prio_highest.3rtapi
  • rtapi_prio_lowest.3rtapi
  • rtapi_prio_next_higher.3rtapi
  • rtapi_prio_next_lower.3rtapi
  • rtapi_region.3rtapi
  • rtapi_release_region.3rtapi
  • rtapi_request_region.3rtapi
  • rtapi_set_msg_level.3rtapi
  • rtapi_shmem.3rtapi
  • rtapi_shmem_delete.3rtapi
  • rtapi_shmem_getptr.3rtapi
  • rtapi_shmem_new.3rtapi
  • rtapi_snprintf.3rtapi
  • rtapi_task_delete.3rtapi
  • rtapi_task_new.3rtapi
  • rtapi_task_pause.3rtapi
  • rtapi_task_resume.3rtapi
  • rtapi_task_start.3rtapi
  • rtapi_task_wait.3rtapi
  • undocumented.3rtapi
  
  
• API calls: Hostmot2
  • hm2_allocate_bspi_tram.3hm2
  • hm2_bspi_set_read_function.3hm2
  • hm2_bspi_set_write_function.3hm2
  • hm2_bspi_setup_chan.3hm2
  • hm2_bspi_write_chan.3hm2
  • hm2_tram_add_bspi_frame.3hm2
  • hm2_uart_read.3hm2
  • hm2_uart_send.3hm2
  • hm2_uart_setup.3hm2
  
  
• API calls: General
  • PM_ROTATION_VECTOR.3