Add manpage for solvespace-cli from notesalexp repo.
authorRyan Pavlik <ryan.pavlik@collabora.com>
Thu, 21 Jan 2021 17:22:56 +0000 (11:22 -0600)
committerRyan Pavlik <ryan.pavlik@collabora.com>
Thu, 21 Jan 2021 20:49:44 +0000 (14:49 -0600)
debian/copyright
debian/solvespace-cli.1 [new file with mode: 0644]
debian/solvespace.manpages

index f859b2fed5e165b837dfabb5c9c6aae376181361..8229718e4760c39dedc2ac9ae5b8368baeb5cc82 100644 (file)
@@ -18,6 +18,10 @@ Copyright: 2021, Ryan Pavlik <ryan@ryanpavlik.com>
   2015, 2016, whitequark <whitequark@whitequark.org>
 License: GPL-3.0+
 
+Files: debian/solvespace-cli.1
+Copyright: 2016 Alexander Pozdnyakov <almipo@mail.ru>
+License: GPL-3.0+
+
 Files: debian/missing_sources/res/threejs/hammer-2.0.8.js
   res/threejs/hammer-2.0.8.js.gz
 Copyright: 2016, Jorik Tangelder
diff --git a/debian/solvespace-cli.1 b/debian/solvespace-cli.1
new file mode 100644 (file)
index 0000000..f1d77c5
--- /dev/null
@@ -0,0 +1,96 @@
+.TH SOLVESPACE 1 "06 Oct 2019" "3.0.0"
+.SH NAME
+solvespace \- parametric 2d/3d CAD
+.SH SYNOPSIS
+.B solvespace-cli
+.RI <command> " [options] " <filename>
+.SH "DESCRIPTION"
+.B solvespace
+is a parametric 2d/3d CAD program. Applications include:
+  * modeling 3d parts — draw with extrudes, revolves, and Boolean
+    (union / difference) operations;
+  * modeling 2d parts — draw the part as a single section, and export DXF,
+    PDF, SVG; use 3d assembly to verify fit;
+  * 3d-printed parts — export the STL or other triangle mesh expected by
+    most 3d printers;
+  * preparing CAM data — export 2d vector art for a waterjet machine or
+    laser cutter; or generate STEP or STL, for import into third-party
+    CAM software for machining;
+  * mechanism design — use the constraint solver to simulate planar or
+    spatial linkages, with pin, ball, or slide joints;
+  * plane and solid geometry — replace hand-solved trigonometry and
+    spreadsheets with a live dimensioned drawing. 
+.PP
+.SH COMMON OPTIONS
+.TP
+.B \-o, \-\-output <pattern>
+For an input file <name>.slvs, replaces the '%' symbol in <pattern>
+with <name> and uses it as output file. For example, when using
+\-\-output %-2d.png for input files f/a.slvs and f/b.slvs, output files
+f/a-2d.png and f/b-2d.png will be written.
+.TP
+.B \-v, \-\-view <direction>
+Selects the camera direction. <direction> can be one of "top", "bottom",
+"left", "right", "front", "back", or "isometric".
+.TP
+.B \-t, \-\-chord-tol <tolerance>
+Selects the chord tolerance, used for converting exact curves to
+piecewise linear, and exact surfaces into triangle meshes.
+For export commands, the unit is mm, and the default is 1.0 mm.
+For non-export commands, the unit is %, and the default is 1.0 %.
+.PP
+.SH COMMANDS
+.TP
+.B thumbnail \-\-output <pattern> \-\-size <size> \-\-view <direction> [\-\-chord-tol <tolerance>]
+Outputs a rendered view of the sketch, like the SolveSpace GUI would. <size> is <width>x<height>, in pixels. Graphics acceleration is not used, and the output may look slightly different from the GUI.
+.TP
+.B export-view \-\-output <pattern> \-\-view <direction> [\-\-chord-tol <tolerance>]
+Exports a view of the sketch, in a 2d vector format.
+.TP
+.B export-wireframe \-\-output <pattern> [\-\-chord-tol <tolerance>]
+Exports a wireframe of the sketch, in a 3d vector format.
+.TP
+.B export-mesh \-\-output <pattern> [\-\-chord-tol <tolerance>]
+Exports a triangle mesh of solids in the sketch, with exact surfaces
+being triangulated first.
+.TP
+.B export-surfaces \-\-output <pattern>
+Exports exact surfaces of solids in the sketch, if any.
+.TP
+.B regenerate [\-\-chord-tol <tolerance>]
+Reloads all imported files, regenerates the sketch, and saves it.
+Note that, although this is not an export command, it uses absolute
+chord tolerance, and can be used to prepare assemblies for export.
+.PP
+.SH FILE FORMATS
+.TP
+.B thumbnail:
+    PNG image (png)
+.TP
+.B export-view:
+    PDF file (pdf)
+    Encapsulated PostScript (eps, ps)
+    Scalable Vector Graphics (svg)
+    STEP file (step, stp)
+    DXF file (AutoCAD 2007) (dxf)
+    HPGL file (plt, hpgl)
+    G Code (ngc, txt)
+.TP
+.B export-wireframe:
+    STEP file (step, stp)
+    DXF file (AutoCAD 2007) (dxf)
+.TP
+.B export-mesh:
+    STL mesh (stl)
+    Wavefront OBJ mesh (obj)
+    Three.js-compatible mesh, with viewer (html)
+    Three.js-compatible mesh, mesh only (js)
+    Q3D Object file (q3do)
+    VRML text file (wrl)
+.TP
+.B export-surfaces:
+    STEP file (step, stp)
+.PP
+.SH "AUTHORS"
+This manual page was written by Alexander Pozdnyakov <almipo@mail.ru>,
index be9c64acc2297da8604323dd35dbc5738774e528..46ff2a223512f99ba0a1e1a3b51f4006b5762382 100644 (file)
@@ -1 +1,3 @@
 debian/solvespace.1
+debian/solvespace-cli.1
+