Skip to content
Snippets Groups Projects
Commit 2bcb947e authored by Christophe Geuzaine's avatar Christophe Geuzaine
Browse files 

update command line help
parent 416af37c
No related branches found
No related tags found
No related merge requests found
Hide whitespace changes
Inline Side-by-side
Common/CommandLine.cpp
+ 14
− 18
View file @ 2bcb947e
// $Id: CommandLine.cpp,v 1.45 2004-06-30 17:49:51 geuzaine Exp $
// $Id: CommandLine.cpp,v 1.46 2004-07-01 22:23:10 geuzaine Exp $
//
// Copyright (C) 1997-2004 C. Geuzaine, J.-F. Remacle
//
......@@ -71,17 +71,15 @@ void Print_Usage(char *name){
Msg(DIRECT, " -1, -2, -3 perform batch 1D, 2D and 3D mesh generation");
Msg(DIRECT, " -saveall save all elements (discard physical group definitions)");
Msg(DIRECT, " -o file specify mesh output file name");
Msg(DIRECT, " -format msh|unv|gref set output mesh format (default: msh)");
Msg(DIRECT, " -algo iso|tri|aniso select mesh algorithm (default: iso)");
Msg(DIRECT, " -smooth int set mesh smoothing (default: 0)");
#if defined(HAVE_NETGEN)
Msg(DIRECT, " -format string set output mesh format (msh, unv, gref)");
Msg(DIRECT, " -algo string select mesh algorithm (iso, tri, aniso, netgen)");
Msg(DIRECT, " -smooth int set number of mesh smoothing steps");
Msg(DIRECT, " -optimize optimize quality of tetrahedral elements");
#endif
Msg(DIRECT, " -order int set mesh order (default: 1)");
Msg(DIRECT, " -scale float set global scaling factor (default: 1.0)");
Msg(DIRECT, " -meshscale float set mesh scaling factor (default: 1.0)");
Msg(DIRECT, " -clscale float set characteristic length scaling factor (default: 1.0)");
Msg(DIRECT, " -rand float set random perturbation factor (default: 1.e-4)");
Msg(DIRECT, " -order int set mesh order (1, 2)");
Msg(DIRECT, " -scale float set global scaling factor");
Msg(DIRECT, " -meshscale float set mesh scaling factor");
Msg(DIRECT, " -clscale float set characteristic length scaling factor");
Msg(DIRECT, " -rand float set random perturbation factor");
Msg(DIRECT, " -bgm file load backround mesh from file");
Msg(DIRECT, " -constrain constrain background mesh with characteristic lengths");
Msg(DIRECT, " -histogram print mesh quality histogram");
......@@ -91,24 +89,22 @@ void Print_Usage(char *name){
Msg(DIRECT, " -interactive display 2D mesh construction interactively");
Msg(DIRECT, "Post-processing options:");
Msg(DIRECT, " -noview hide all views on startup");
Msg(DIRECT, " -link int select link mode between views (default: 0)");
Msg(DIRECT, " -smoothview smooth views");
Msg(DIRECT, " -link int select link mode between views (0, 1, 2, 3, 4)");
Msg(DIRECT, " -combine combine input views into multi time step ones");
Msg(DIRECT, "Display options:");
Msg(DIRECT, " -nodb disable double buffering");
Msg(DIRECT, " -fontsize int specify the font size for the GUI (default: 12)");
Msg(DIRECT, " -fontsize int specify the font size for the GUI");
Msg(DIRECT, " -scheme string specify FLTK GUI scheme");
Msg(DIRECT, " -display string specify display");
#endif
Msg(DIRECT, "Other options:");
#if defined(HAVE_FLTK)
Msg(DIRECT, " -a, -g, -m, -s, -p start in automatic, geometry, mesh, solver or post-processing");
Msg(DIRECT, " mode (default: automatic)");
Msg(DIRECT, " -a, -g, -m, -s, -p start in automatic, geometry, mesh, solver or post-processing mode");
#endif
Msg(DIRECT, " -v int set verbosity level (default: 3)");
Msg(DIRECT, " -v int set verbosity level");
Msg(DIRECT, " -string \"string\" parse string before project file");
Msg(DIRECT, " -option file parse option file before GUI creation");
Msg(DIRECT, " -convert file file perform batch conversion of view(s)/mesh into latest file formats");
Msg(DIRECT, " -convert file file perform batch conversion of views and meshes into latest file formats");
Msg(DIRECT, " -version show version number");
Msg(DIRECT, " -info show detailed version information");
Msg(DIRECT, " -help show this message");
......
doc/gmsh.1
+ 27
− 34
View file @ 2bcb947e
.\" $Id: gmsh.1,v 1.56 2004-06-30 21:44:46 geuzaine Exp $
.TH Gmsh 1 "30 June 2004" "Gmsh 1.54" "Gmsh Manual Pages"
.\" $Id: gmsh.1,v 1.57 2004-07-01 22:23:11 geuzaine Exp $
.TH Gmsh 1 "1 July 2004" "Gmsh 1.54" "Gmsh Manual Pages"
.UC 4
.\" ********************************************************************
.SH NAME
......@@ -14,10 +14,7 @@ with built-in pre- and post-processing facilities
generator (primarily Delaunay) with build-in CAD and post-processing
facilities. Its design goal is to provide a simple meshing tool for
academic problems with parametric input and up to date visualization
capabilities. One of its strengths is the ability to respect a
characteristic length field for the generation of adapted meshes on
lines, surfaces and volumes, and to mix these meshes with simple
structured grids.
capabilities.
.PP
\fIGmsh\fR is built around four modules: geometry, mesh, solver and
post-processing. The specification of any input to these modules is
......@@ -32,15 +29,15 @@ parse all input files, output unrolled geometry, and exit.
.SH MESH OPTIONS
.TP 4
.B \-1
perform the one-dimensional mesh, i.e. discretize all the curves in
perform the one-dimensional mesh, i.e., discretize all the curves in
the geometry.
.TP 4
.B \-2
perform the two-dimensional mesh, i.e. discretize all the surfaces in
perform the two-dimensional mesh, i.e., discretize all the surfaces in
the geometry.
.TP 4
.B \-3
perform the three-dimensional mesh, i.e. discretize all the volumes in
perform the three-dimensional mesh, i.e., discretize all the volumes in
the geometry.
.TP 4
.B \-saveall
......@@ -49,33 +46,33 @@ save all elements (and discard all physical group definitions).
.B \-o file
specify mesh output file name.
.TP 4
.B \-format msh|unv|gref
set output mesh format (default: msh).
.B \-format string
set output mesh format (msh, unv, gref).
.TP 4
.B \-algo iso|tri|aniso
select the two-dimensional mesh algorithm (default: iso).
.B \-algo string
select mesh algorithm (iso, tri, aniso, netgen).
.TP 4
.B \-smooth int
set the number of smoothing steps (default value is 0).
set number of smoothing steps.
.TP 4
.B \-optimize
optimize quality of tetrahedral elements
optimize quality of tetrahedral elements.
.TP 4
.B \-order int
set the order of the generated elements (default value is 1).
set mesh order (1, 2).
.TP 4
.B \-scale float
apply a global scaling factor to the model (default value is 1.0).
set global scaling factor to the model.
.TP 4
.B \-meshscale float
apply a global scaling factor to the mesh output (default value is 1.0).
set global scaling factor to the mesh output.
.TP 4
.B \-clscale float
apply a global scaling factor to the mesh characteristic lengths in the
model (default value is 1.0).
set global scaling factor to the mesh characteristic lengths in the
model.
.TP 4
.B \-rand float
set random perturbation factor (default: 1.e-4).
set random perturbation factor.
.TP 4
.B \-bgm file
load the post-processing view in file as the current background mesh.
......@@ -103,16 +100,10 @@ algorithm is selected.
hide all views at startup.
.TP 4
.B \-link int
choose link mode between post-processing views (default: 0).
.TP 4
.B \-smoothview
smooth views at startup.
choose link mode between post-processing views (0, 1, 2, 3, 4).
.TP 4
.B \-combine
combine input views into multi time step ones.
.TP 4
.B \-convert file file
convert all views in a file into binary views.
.\" ********************************************************************
.SH DISPLAY OPTIONS
.TP 4
......@@ -121,10 +112,10 @@ suppress the double buffer. Use this options if you use \fIGmsh\fR on
a remote host without GLX.
.TP 4
.B \-fontsize int
specify the font size for the GUI (default: 12)
specify the font size for the GUI.
.TP 4
.B \-scheme string
specify FLTK scheme
specify the FLTK GUI scheme.
.TP 4
.B \-display string
specify display.
......@@ -132,11 +123,10 @@ specify display.
.SH OTHER OPTIONS
.TP 4
.B \-a, \-g, \-m, \-s, \-p
start in automatic, geometry, mesh, solver or post-processing mode
(default: automatic).
start in automatic, geometry, mesh, solver or post-processing mode.
.TP 4
.B \-v int
set verbosity level (default: 2).
set verbosity level.
.TP 4
.B \-string "string"
parse string before project file.
......@@ -144,6 +134,9 @@ parse string before project file.
.B \-option file
parse option file before GUI creation.
.TP 4
.B \-convert file file
perform batch conversion of views and meshes into latest file formats.
.TP 4
.B \-version
show version number.
.TP 4
......@@ -155,7 +148,7 @@ show help message.
.\" ********************************************************************
.SH AUTHORS
Christophe Geuzaine (geuzaine@acm.caltech.edu) and Jean-Francois
Remacle (Remacle@scorec.rpi.edu).
Remacle (remacle@gce.ucl.ac.be).
.\" ********************************************************************
.SH SEE ALSO
.BR getdp (1),
......
doc/texinfo/command_line.texi
+ 16
− 17
View file @ 2bcb947e
......@@ -16,24 +16,24 @@ perform batch 1D, 2D and 3D mesh generation
save all elements (discard physical group definitions)
@item -o file
specify mesh output file name
@item -format msh|unv|gref
set output mesh format (default: msh)
@item -algo iso|tri|aniso
select 2D mesh algorithm (default: iso)
@item -format string
set output mesh format (msh, unv, gref)
@item -algo string
select 2D mesh algorithm (iso, tri, aniso, netgen)
@item -smooth int
set mesh smoothing (default: 0)
set mesh smoothing
@item -optimize
optimize quality of tetrahedral elements
@item -order int
set the order of the generated elements (default: 1)
set the order of the generated elements (1, 2)
@item -scale float
set global scaling factor (default: 1.0)
set global scaling factor
@item -meshscale float
set mesh scaling factor (default: 1.0)
set mesh scaling factor
@item -clscale float
set characteristic length scaling factor (default: 1.0)
set characteristic length scaling factor
@item -rand float
set random perturbation factor (default: 1.e-4)
set random perturbation factor
@item -bgm file
load backround mesh from file
@item -constrain
......@@ -56,7 +56,7 @@ display 2D mesh construction interactively
@item -noview
hide all views on startup
@item -link int
select link mode between views (default: 0)
select link mode between views (0, 1, 2, 3, 4)
@item -smoothview
smooth views
@item -combine
......@@ -71,9 +71,9 @@ combine input views into multi time step ones
@item -nodb
disable double buffering
@item -fontsize int
specify the font size for the GUI (default: 12)
specify the font size for the GUI
@item -scheme string
specify FLTK scheme
specify FLTK GUI scheme
@item -display string
specify display
@end ftable
......@@ -84,16 +84,15 @@ specify display
@ftable @code
@item -a, -g, -m, -s, -p
start in automatic, geometry, mesh, solver or post-processing mode (default:
automatic)
start in automatic, geometry, mesh, solver or post-processing mode
@item -v int
set verbosity level (default: 2)
set verbosity level
@item -string "string"
parse string before project file
@item -option file
parse option file before GUI creation
@item -convert file file
perform batch conversion of view(s)/mesh into latest file formats
perform batch conversion of views and meshes into latest file formats
@item -version
show version number
@item -info
......
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Please register or to comment