aboutsummaryrefslogtreecommitdiffstats
path: root/config/example-extras.cfg
diff options
context:
space:
mode:
authorKevin O'Connor <kevin@koconnor.net>2019-06-07 11:57:54 -0400
committerKevin O'Connor <kevin@koconnor.net>2019-06-07 11:57:54 -0400
commit9d33ef4061e0ff669bf3dec349cd9b6dbc1576fa (patch)
treec80e7030f34dd4e62f6780bf5fcca4f11071b274 /config/example-extras.cfg
parentf1c6d043764a26eacd88bcd5b29c7262c586c4cb (diff)
downloadkutter-9d33ef4061e0ff669bf3dec349cd9b6dbc1576fa.tar.gz
kutter-9d33ef4061e0ff669bf3dec349cd9b6dbc1576fa.tar.xz
kutter-9d33ef4061e0ff669bf3dec349cd9b6dbc1576fa.zip
config: Update example-extras.cfg to point to Command_Templates.md
Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
Diffstat (limited to 'config/example-extras.cfg')
-rw-r--r--config/example-extras.cfg65
1 files changed, 32 insertions, 33 deletions
diff --git a/config/example-extras.cfg b/config/example-extras.cfg
index 2b0bdb1c..1a7835a1 100644
--- a/config/example-extras.cfg
+++ b/config/example-extras.cfg
@@ -40,14 +40,14 @@
# The calculation method when sampling more than once - either
# "median" or "average". The default is average.
#activate_gcode:
-# A list of G-Code commands (one per line; subsequent lines
-# indented) to execute prior to each probe attempt. This may be
+# A list of G-Code commands to execute prior to each probe attempt.
+# See docs/Command_Templates.md for G-Code format. This may be
# useful if the probe needs to be activated in some way. Do not
# issue any commands here that move the toolhead (eg, G1). The
# default is to not run any special G-Code commands on activation.
#deactivate_gcode:
-# A list of G-Code commands (one per line; subsequent lines
-# indented) to execute after each probe attempt completes. Do not
+# A list of G-Code commands to execute after each probe attempt
+# completes. See docs/Command_Templates.md for G-Code format. Do not
# issue any commands here that move the toolhead. The default is to
# not run any special G-Code commands on deactivation.
@@ -369,18 +369,18 @@
# should specify "shared_heater: extruder3". The default is to not
# reuse an existing heater.
#deactivate_gcode:
-# A list of G-Code commands (one per line; subsequent lines
-# indented) to execute on a G-Code tool change command (eg, "T1")
-# that deactivates this extruder and activates some other
-# extruder. It only makes sense to define this section on
+# A list of G-Code commands to execute on a G-Code tool change
+# command (eg, "T1") that deactivates this extruder and activates
+# some other extruder. See docs/Command_Templates.md for G-Code
+# format. It only makes sense to define this section on
# multi-extruder printers. The default is to not run any special
# G-Code commands on deactivation.
#activate_gcode:
-# A list of G-Code commands (one per line; subsequent lines
-# indented) to execute on a G-Code tool change command (eg, "T0")
-# that activates this extruder. It only makes sense to define this
-# section on multi-extruder printers. The default is to not run any
-# special G-Code commands on activation.
+# A list of G-Code commands to execute on a G-Code tool change
+# command (eg, "T0") that activates this extruder. See
+# docs/Command_Templates.md for G-Code format. It only makes sense
+# to define this section on multi-extruder printers. The default is
+# to not run any special G-Code commands on activation.
# Support for cartesian printers with dual carriages on a single
@@ -445,8 +445,8 @@
# explicit idle_timeout config section to change the default settings.
#[idle_timeout]
#gcode:
-# A list of G-Code commands (one per line; subsequent lines
-# indented) to execute on an idle timeout. The default is to run
+# A list of G-Code commands to execute on an idle timeout. See
+# docs/Command_Templates.md for G-Code format. The default is to run
# "TURN_OFF_HEATERS" and "M84".
#timeout: 600
# Idle time (in seconds) to wait before running the above G-Code
@@ -1202,12 +1202,12 @@
# home the machine.
#[homing_override]
#gcode:
-# A list of G-Code commands (one per line; subsequent lines
-# indented) to execute in place of G28 commands found in the normal
-# g-code input. If a G28 is contained in this list of commands then
-# it will invoke the normal homing procedure for the printer. The
-# commands listed here must home all axes. This parameter must be
-# provided.
+# A list of G-Code commands to execute in place of G28 commands
+# found in the normal g-code input. See docs/Command_Templates.md
+# for G-Code format. If a G28 is contained in this list of commands
+# then it will invoke the normal homing procedure for the printer.
+# The commands listed here must home all axes. This parameter must
+# be provided.
#axes: xyz
# The axes to override. For example, if this is set to "z" then the
# override script will only be run when the z axis is homed (eg, via
@@ -1441,13 +1441,9 @@
# "gcode_macro" prefix).
#[gcode_macro my_cmd]
#gcode:
-# A list of G-Code commands (one per line; subsequent lines
-# indented) to execute in place of "my_cmd". This parameter is
-# evaluated using Python "string format syntax" with the command
-# parameters as named arguments. For example, if one were to define
-# a macro MY_DELAY with gcode "G4 P{DELAY}" then the command
-# "MY_DELAY DELAY=100" would evaluate to "G4 P100". This parameter
-# must be provided.
+# A list of G-Code commands to execute in place of "my_cmd". See
+# docs/Command_Templates.md for G-Code format. This parameter must
+# be provided.
#default_parameter_<parameter>:
# One may define any number of options with a "default_parameter_"
# prefix. Use this to define default values for g-code parameters.
@@ -1537,12 +1533,15 @@
# runout_gcode is omitted then runout detection is disabled. Default
# is True.
#runout_gcode:
-# The gcode to run after a filament runout is detected. If
-# pause_on_runout is set to True this gcode will run after the PAUSE
-# is complete. The default is not to run any gcode commands.
+# A list of G-Code commands to execute after a filament runout is
+# detected. See docs/Command_Templates.md for G-Code format. If
+# pause_on_runout is set to True this G-Code will run after the
+# PAUSE is complete. The default is not to run any G-Code commands.
#insert_gcode:
-# The gcode to run after a filament insert is detected. The default
-# is not to run any gcode commands, which disables insert detection.
+# A list of G-Code commands to execute after a filament insert is
+# detected. See docs/Command_Templates.md for G-Code format. The
+# default is not to run any G-Code commands, which disables insert
+# detection.
#event_delay: 3.0
# The minimum amount of time in seconds to delay between events.
# Events triggered during this time period will be silently