added help

This commit is contained in:
Harvey Fong 2025-08-22 17:10:51 +00:00
parent 2c28ec6036
commit 4700b6d7f2

125
README.md
View File

@ -3,6 +3,131 @@
- first working
```
LPub3D v2.4.9 r86 (Release) for Linux AMD 64bit
==========================
Arguments: --help
Usage: lpub3d24 [Options] [LDraw file]
[LDraw file]:
Use absolute file path and, although no extension is required, consider using file
names with .ldr, .mpd or .dat extension.
[Options]:
Options preceded by '+/++' are only applicable when starting in Interactive (GUI)
mode. They have no effect in Console mode.
[lpub3d24 Options]
+ll, ++liblego: Load the LDraw LEGO archive parts library in GUI mode.
+lt, ++libtente: Load the LDraw TENTE archive parts library in GUI mode.
+lv, ++libvexiq: Load the LDraw VEXIQ archive parts library in GUI mode.
-aec, --automate-edge-color: Enable automatically adjusted edge colors.
-cc, --color-contrast <decimal>: Color contrast value between 0.0 and 1.0.
-bec, --black-edge-color <#AARRGGBB>: High contrast edge color for black parts.
-ccf, --color-config-file <file>: Full path for alternate LDConfig colour file.
-dec, --dark-edge-color <#AARRGGBB>: High contrast edge color for dark color parts.
-ec, --edge-color <#AARRGGBB>: High contrast edge color.
-emc, --export-meta-commands <file>: Export LPUB meta commands to specified file.
-fc, --fade-steps-color <LDraw_colour_name>: Set the global fade color. Overridden by
fade opacity - if opacity not 100 percent. Default is Light_Blue
-fo, --fade-step-opacity <percent>: Set the fade steps opacity percent. Overrides fade
color - if opacity not 100 percent. Default is 50 percent
-fs, --fade-steps: Turn on fade previous steps. Default is off.
-hc, --highlight-step-color <#AARRGGBB>: Set the step highlight color. Color code
optional. Format is #RRGGBB. Default is #C0FFFF00.
-hs, --highlight-step: Turn on highlight current step. Default is off.
-hw, --highlight-line-width: Set the width of the highlighted edge lines - Enabled for
LDGlite renderer only. Default is 1.0f.
-ldv, --light-dark-value <decimal>: Light/Dark color value between 0.0 and 1.0.
-ll, --liblego: Load the LDraw LEGO archive parts library in command console mode.
-lt, --libtente: Load the LDraw TENTE archive parts library in command console mode.
-lv, --libvexiq: Load the LDraw VEXIQ archive parts library in command console mode.
-ns, --no-stdout-log: Do not enable standard output for logged entries. Useful to
prevent double (stdout and QSLog) output. Default is off.
-nbec, --disable-black-edge-color: Disable high contrast edge color for black parts.
-ndec, --disable-dark-edge-color: Disable high contrast edge color for dark color parts.
-nec, --disable-edge-color: Disable high contrast edge color.
-nscc, --disable-stud-cylinder-color: Disable high contrast stud cylinder color.
-o, --export-option <option>: Set output format pdf, png, jpeg, bmp, stl, 3ds, pov,
csv, bl-xml, dae, htmlparts, htmlsteps, or obj. Used with process-export.
Default is pdf.
-od, --export-directory <path>: Designate the export option save folder using absolute
path. Used with export-option. Default is model file folder
-of, --output-file/--pdf-output-file <path>: Designate the document save file using
absolute path.
-p, --preferred-renderer <renderer>: Set renderer native, ldglite, ldview, ldview-sc,
ldview-scsl, povray, or povray-ldv. Default is native.
-pe, --process-export: Export instruction document, images, files, or objects. Used
with export-option. Default is pdf document.
-pf, --process-file: Process ldraw model file and generate images in png format.
-pr, --projection <p,perspective|o,orthographic>: Set camera projection.
-r, --range <page range>: Set page range - e.g. 1,2,9,10-42. Default is all pages.
-rs, --reset-search-dirs: Reset the LDraw parts directories to those searched by
default. Default is off.
-scc, --stud-cylinder-color <#AARRGGBB>: High contrast stud cylinder color.
-ss, --stud-style <id>: Set the stud style 0=Plain, 1=Thin Lines Logo, 2=Outline Logo,
3=Sharp Top Logo, 4=Rounded Top Logo, 5=Flattened Logo, 6=High Contrast,
7=High Contrast with Logo.
-v, --version: Output LPub3D version information and exit.
-x, --clear-cache: Reset the LDraw file and image caches. Used with export-option
change. Default is off.
[Visual Editor Options]
-c, --camera <camera>: Set the active camera.
-cl, --draw-conditional-lines: Enable draw conditional lines.
-f, --from <step>: Set the first step to save pictures.
-h, --height <height>: Set the picture height.
-i, --image <outfile.ext>: Save a picture in the format specified by ext.
-s, --submodel <submodel>: Set the active submodel.
-t, --to <step>: Set the last step to save pictures.
-w, --width <width>: Set the picture width.
-ve, --visual-editor-version: Output Visual Editor - by LeoCAD version information
and exit.
-3ds, --export-3ds <outfile.3ds>: Export the model to 3D Studio 3DS format.
-dae, --export-collada <outfile.dae>: Export the model to COLLADA DAE format.
-csv, --export-csv <outfile.csv>: Export the list of parts used in csv format.
-html, --export-html <folder>: Create an HTML page for the model.
-obj, --export-wavefront <outfile.obj>: Export the model to Wavefront OBJ format.
--aa-samples <count>: AntiAliasing sample size (1, 2, 4, or 8).
--camera-angles <latitude> <longitude>: Set the camera angles in degrees around
the model.
--camera-position <x> <y> <z> <tx> <ty> <tz> <ux> <uy> <uz>: Set the camera
position, target and up vector.
--camera-position-ldraw <x> <y> <z> <tx> <ty> <tz> <ux> <uy> <uz>: Set the camera
position, target and up vector using LDraw coordinates.
--fov <degrees>: Set the vertical field of view used to render images (< 180).
--zplanes <near> <far>: Set the near and far clipping planes used to render
images (1 <= <near> < <far>).
--fade-steps: Render parts from prior steps faded.
--no-fade-steps: Do not render parts from prior steps faded.
--fade-steps-color <rgba>: Rendering color for prior step parts (#AARRGGBB).
--highlight: Highlight parts in the steps they appear.
--no-highlight: Do not highlight parts in the steps they appear.
--highlight-color: Rendering color for highlighted parts (#AARRGGBB).
--line-width <width>: Set the width of the edge lines.
--shading <wireframe|flat|default|full>: Select shading mode for rendering.
--viewpoint <front|back|left|right|top|bottom|home>: Set the viewpoint.
[Environment Variables]
LDRAWDIR: Path the LDraw part library. /home/tofu/ldraw
LPUB3D_DISABLE_UPDATE_CHECK: Disable automatic available versions and update check.
LPUB3D_DISABLE_UPDATE_CHECK=1.
LPUB3D_MILLISECONDS_SLEEP: Pause at launch (before doing anything) for n milliseconds.
Useful for headless/console debugging. LPUB3D_MILLISECONDS_SLEEP=10000 (10 seconds).
[Help]
-?, --help: Display this help message and exit.
-ap, --app-paths: Display application data, cache and configuration paths.
```
```
sudo apt-get install -y build-essential git cmake autotools-dev