diff --git a/docs/man/meshlab.1 b/docs/man/meshlab.1 index bb46f44b8..72269162c 100644 --- a/docs/man/meshlab.1 +++ b/docs/man/meshlab.1 @@ -1,30 +1,49 @@ -.TH MeshLab 1 "21 Feb 2020" "2020.02" -.SH NAME -MeshLab \- The open source mesh processing system -.SH SYNOPSIS -.B meshlab -file1.obj file2.ply view.xml ... -.SH DESCRIPTION -.B meshlab -opens the list of given files, to view and edit them. -.SH OPTIONS -.TP -.BR \-h ", " \-\-help +.Dd March 06, 2020 +.Dt MESHLAB 1 +.Os +.Sh NAME \" Section Header - required - don't modify +.Nm meshlab +.Nd The open source mesh processing system. +.Sh SYNOPSIS \" Section Header - required - don't modify +.Nm +.Op Fl h | Fl -help +.Nm +.Op Ar +.Op Ar viewxmlfile +.Nm +.Op Ar projectfile +.Sh DESCRIPTION \" Section Header - required - don't modify +.Nm +is an interactive tool for manipulating meshes. +.Pp +The arguments are as follows: +.Bl -tag -width -indent +.It Fl h | Fl -help Show a brief help. -.SH EXAMPLES -.B meshlab -mesh.obj -.TP -.R Run MeshLab opening the file mesh.obj -.P -.B meshlab -mesh1.obj mesh2.obj view.xml -.TP -.R Run MeshLab opening the files mesh1.obj and mesh2.obj with camera view set in view.xml -.P -.B meshlab -project.mlp -.TP -.R Run MeshLab opening the MeshLab project project.mlp -.SH AUTHOR -Paolo Cignoni - Visual Computing Lab - ISTI - CNR +.It Ar +Mesh/model file(s) to load. +.It Ar viewxmlfile +An XML file specifying the camera view +.It Ar projectfile +An .mlp MeshLab project file to load. +.El +.Sh EXIT STATUS +.Ex -std +.Sh EXAMPLES \" Section Header - required - don't modify +Run MeshLab opening the files +.Pa mesh1.obj +and +.Pa mesh2.obj +with camera view set in +.Pa view.xml +: +.Dl $ meshlab mesh1.obj mesh2.obj view.xml +.Pp +Run MeshLab opening the MeshLab project +.Pa project.mlp +: +.Dl $ meshlab project.mlp +.Pp +.Sh SEE ALSO +.Xr meshlabserver 1 +.An Paolo Cignoni, Visual Computing Lab - ISTI - CNR diff --git a/docs/man/meshlabserver.1 b/docs/man/meshlabserver.1 index dd362e956..e45d4159b 100644 --- a/docs/man/meshlabserver.1 +++ b/docs/man/meshlabserver.1 @@ -1,16 +1,166 @@ -.TH MeshLabServer 1 "21 Feb 2020" "2020.02" -.SH NAME -MeshLabServer \- The open source batch mesh processing system -.SH SYNOPSIS -.B meshlabserver -[logargs] [args] -.SH OPTIONS -.TP -.BR \-h ", " \-\-help -.SH SEE ALSO -.TP -https://github.com/cnr-isti-vclab/meshlab/blob/master/src/meshlabserver/README.md -.TP -https://github.com/cnr-isti-vclab/meshlab/blob/master/src/meshlabserver/meshlabserver.txt -.SH AUTHOR +.\" Written by Ryan Pavlik in mandoc format, +.\" based on the original help output from the meshlabserver program. +.Dd March 05, 2020 +.Dt MESHLABSERVER 1 +.Os +.Sh NAME +.Nm meshlabserver +.Nd The open source batch mesh processing system +.Sh SYNOPSIS +.Nm +.Op Fl d Ar output +.Nm +.Op Fl l Ar logfile +.Op Fl p Ar projectfile +.Op Fl w Ar outputprojectfile Op Fl x +.Oo Fl i Ar meshfile Oc ... +.Oo +.Fl o Ar outfile +.Op Fl l Ar opt_layer +.Op Fl m Ar opt_mask +.Oc +.Op Fl s Ar scriptfile +.Sh DESCRIPTION +.Nm +allows batch-processing usage of functionality available in the interactive +.Xr meshlab 1 +application. +.Pp +The arguments are as follows: +.Bl -tag -width Ds +.It Fl d Ar output +dump on a text file a list of all the filtering functions +.It Fl l Ar logfile +log of the filters is output on a file +.It Fl p Ar projectfile +meshlab project ( .mlp ) to be loaded +.It Fl w Ar outputprojectfile Op Fl x +output meshlab project (.mlp) to be saved. +If +.Fl x +flag is specified, any 3D model file(s) +.Pa meshfile.ext +contained in the input project will be overwritten. +Otherwise, for an input filename of +.Pa meshfile.ext , +the model will be saved in the same directory of +input mesh as a new file called +.Pa meshfile_out.ext . +ALL the mesh attributes will be exported in the saved files. +.It Fl i Ar file +mesh that has to be loaded +.It Fl o Ar outfile Oo Fl l Ar opt_layer Oc Oo Fl m Ar opt_mask Oc +the name of the file where to write the current layer of the project. +.Bl -tag -width Ds +.It Fl l Ar opt_layer +Save the specified layer to the chosen filename. Valid values for +.Ar opt_layer +can be +.Bl -tag -width Ds +.It A number in the range [0, last_layer_in_the_project] +to indicate the desired layer by its index. +.It Ql c +indicate the CURRENT layer in the project +.It Ql x +indicate the LAST layer in the project +.El +.It Fl m Ar opt_mask +the listed mesh attributes will be saved in the output file. +The parameter +.Ar opt_mask +can be a space-separated list of the following attributes: +.Bl -tag -width Ds +.It Ql vc +vertex colors +.It Ql vf +vertex flags +.It Ql vq +vertex quality +.It Ql vn +vertex normals +.It Ql vt +vertex texture coords +.It Ql vr +vertex radius +.It Ql fc +face colors +.It Ql ff +face flags +.It Ql fq +face quality +.It Ql fn +face normals +.It Ql wc +wedge colors +.It Ql wn +wedge normals +.It Ql wt +wedge texture coords +.It Ql mp +polygonal mesh info +.It Ql sa +save in ascii format +.El +.El +.It Fl s Ar scriptfile +the script to be applied. +Must be in the xml format saved by MeshLab. +.El +.Pp +.Sh NOTES +There can be multiple meshes loaded and the order they are listed matters +because filters that use meshes as parameters choose the mesh based on the +order. +.Pp +The format of the output mesh is guessed by the used extension. +.Sh EXIT STATUS +.Ex -std +.Sh EXAMPLES +Apply the script contained in the file +.Pa meshclean.mlx +to the mesh contained in +.Pa input.obj . +Save the per-vertex-color, the per-face-quality, and the per-wedge-texture attributes +contained in the current layer into +.Pa output.ply . +.Dl $ meshlabserver -i input.obj -o output.ply -m vc fq wt -s meshclean.mlx +.Pp +Apply the script contained in the file +.Pa meshclean.mlx +to the mesh contained in +.Pa input.obj . +Save the per-vertex-color, the per-face-quality and the per-wedge-texture attributes contained in the layer 2 +(if it exists!) into +.Pa output.ply . +Save the last layer of the project to +.Pa output_last +with the default geometric attributes. +.Dl $ meshlabserver -i input.obj -o output.ply -l 2 -m vc fq wt -o output_last.ply -l l -s meshclean.mlx +.Pp +Apply the script contained in the file +.Pa meshclean.mlx +to the mesh composed of +.Pa input0.obj +and +.Pa input1.ply . +Make +.Pa input1.ply +the current mesh of the project (i.e. the mesh to which the filters operating on a single model will be applied). +Generate a new output project +.Pa outproj.mlp +containing references to +.Pa input0.obj +and +.Pa input1.ply . +The files +.Pa input0.obj +and +.Pa input1.ply +will be overwritten. +A log will be written to +.Pa logfile.txt . +.Dl $ meshlabserver -l logfile.txt -p proj.mlp -i input.obj -w outproj.mlp -s meshclean.mlx +.Sh SEE ALSO +.Xr meshlab 1 +.Sh AUTHOR Paolo Cignoni - Visual Computing Lab - ISTI - CNR