cura-engine/CuraEngine.1

.\" DO NOT MODIFY THIS FILE!  It was generated by help2man 1.48.5.
.TH CURAENGINE "1" "February 2022" "CuraEngine " "User Commands"
.SH NAME
CuraEngine \- manual page for CuraEngine 
.SH DESCRIPTION
Cura_SteamEngine version 4.13.1
Copyright \(co 2021 Ultimaker
.PP
This program is free software: you can redistribute it and/or modify
it under the terms of the GNU Affero General Public License as published by
the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.
.PP
This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
GNU Affero General Public License for more details.
.PP
You should have received a copy of the GNU Affero General Public License
along with this program.  If not, see <http://www.gnu.org/licenses/>.
.PP
usage:
CuraEngine help
.IP
Show this help message
.PP
CuraEngine connect <host>[:<port>] [\-j <settings.def.json>]
.HP
\fB\-\-connect\fR <host>[:<port>]
.IP
Connect to <host> via a command socket,
instead of passing information via the command line
.HP
\fB\-v\fR
.IP
Increase the verbose level (show log messages).
.HP
\fB\-m\fR<thread_count>
.IP
Set the desired number of threads. Supports only a single digit.
.PP
CuraEngine slice [\-v] [\-p] [\-j <settings.json>] [\-s <settingkey>=<value>] [\-g] [\-e<extruder_nr>] [\-o <output.gcode>] [\-l <model.stl>] [\-\-next]
.HP
\fB\-v\fR
.IP
Increase the verbose level (show log messages).
.HP
\fB\-m\fR<thread_count>
.IP
Set the desired number of threads.
.HP
\fB\-p\fR
.IP
Log progress information.
.HP
\fB\-j\fR
.IP
Load settings.def.json file to register all settings and their defaults.
.HP
\fB\-s\fR <setting>=<value>
.IP
Set a setting to a value for the last supplied object,
extruder train, or general settings.
.HP
\fB\-l\fR <model_file>
.IP
Load an STL model.
.HP
\fB\-g\fR
.IP
Switch setting focus to the current mesh group only.
Used for one\-at\-a\-time printing.
.HP
\fB\-e\fR<extruder_nr>
.IP
Switch setting focus to the extruder train with the given number.
.HP
\fB\-\-next\fR
.IP
Generate gcode for the previously supplied mesh group and append that to
the gcode of further models for one\-at\-a\-time printing.
.HP
\fB\-o\fR <output_file>
.IP
Specify a file to which to write the generated gcode.
.PP
The settings are appended to the last supplied object:
CuraEngine slice [general settings]
.HP
\fB\-g\fR [current group settings]
.HP
\fB\-e0\fR [extruder train 0 settings]
.HP
\fB\-l\fR obj_inheriting_from_last_extruder_train.stl [object settings]
.HP
\fB\-\-next\fR [next group settings]
.IP
\&... etc.
.PP
In order to load machine definitions from custom locations, you need to create the environment variable CURA_ENGINE_SEARCH_PATH, which should contain all search paths delimited by a (semi\-)colon.
.PP
Cura_SteamEngine version 4.13.1
Copyright \(co 2021 Ultimaker
.PP
This program is free software: you can redistribute it and/or modify
it under the terms of the GNU Affero General Public License as published by
the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.
.PP
This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
GNU Affero General Public License for more details.
.PP
You should have received a copy of the GNU Affero General Public License
along with this program.  If not, see <http://www.gnu.org/licenses/>.
[ERROR] Unknown command: \fB\-\-version\fR
[ERROR] Command called:
[ERROR] CuraEngine [ERROR] \fB\-\-version\fR [ERROR]
.PP
usage:
CuraEngine help
.IP
Show this help message
.PP
CuraEngine connect <host>[:<port>] [\-j <settings.def.json>]
.HP
\fB\-\-connect\fR <host>[:<port>]
.IP
Connect to <host> via a command socket,
instead of passing information via the command line
.HP
\fB\-v\fR
.IP
Increase the verbose level (show log messages).
.HP
\fB\-m\fR<thread_count>
.IP
Set the desired number of threads. Supports only a single digit.
.PP
CuraEngine slice [\-v] [\-p] [\-j <settings.json>] [\-s <settingkey>=<value>] [\-g] [\-e<extruder_nr>] [\-o <output.gcode>] [\-l <model.stl>] [\-\-next]
.HP
\fB\-v\fR
.IP
Increase the verbose level (show log messages).
.HP
\fB\-m\fR<thread_count>
.IP
Set the desired number of threads.
.HP
\fB\-p\fR
.IP
Log progress information.
.HP
\fB\-j\fR
.IP
Load settings.def.json file to register all settings and their defaults.
.HP
\fB\-s\fR <setting>=<value>
.IP
Set a setting to a value for the last supplied object,
extruder train, or general settings.
.HP
\fB\-l\fR <model_file>
.IP
Load an STL model.
.HP
\fB\-g\fR
.IP
Switch setting focus to the current mesh group only.
Used for one\-at\-a\-time printing.
.HP
\fB\-e\fR<extruder_nr>
.IP
Switch setting focus to the extruder train with the given number.
.HP
\fB\-\-next\fR
.IP
Generate gcode for the previously supplied mesh group and append that to
the gcode of further models for one\-at\-a\-time printing.
.HP
\fB\-o\fR <output_file>
.IP
Specify a file to which to write the generated gcode.
.PP
The settings are appended to the last supplied object:
CuraEngine slice [general settings]
.HP
\fB\-g\fR [current group settings]
.HP
\fB\-e0\fR [extruder train 0 settings]
.HP
\fB\-l\fR obj_inheriting_from_last_extruder_train.stl [object settings]
.HP
\fB\-\-next\fR [next group settings]
.IP
\&... etc.
.PP
In order to load machine definitions from custom locations, you need to create the environment variable CURA_ENGINE_SEARCH_PATH, which should contain all search paths delimited by a (semi\-)colon.